diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
index 0f6e541..603dd96 100644
--- a/.speakeasy/gen.lock
+++ b/.speakeasy/gen.lock
@@ -1,30 +1,30 @@
lockVersion: 2.0.0
id: 833c6a67-4a4a-4ef1-ba24-165a29264e4a
management:
- docChecksum: 5d11683dc561ef88372ecf4ea4f43681
+ docChecksum: 19f8b1e71836e603dad3fab5291458c2
docVersion: 1.0.0
- speakeasyVersion: 1.703.0
- generationVersion: 2.803.3
- releaseVersion: 2.0.0
- configChecksum: 13351656d4f134a1c8efe1e6ff73eab9
+ speakeasyVersion: 1.713.2
+ generationVersion: 2.821.6
+ releaseVersion: 2.0.1
+ configChecksum: de6bcc909934f2c85e87d918c15a4049
repoURL: https://github.com/gr4vy/gr4vy-python.git
installationURL: https://github.com/gr4vy/gr4vy-python.git
published: true
persistentEdits:
- generation_id: 389dcbbb-780b-4727-9618-f395cecc70e1
- pristine_commit_hash: 40345a022c3778cd8545b0d5d9559bc31a0df6a7
- pristine_tree_hash: 62d22c885880f04fe5032a5555687113a3fa547c
+ generation_id: 16462c9f-c5d9-4633-80d0-143b1d760faa
+ pristine_commit_hash: 4bd0b03e3bbd8092506849f3c30da117b492c369
+ pristine_tree_hash: d7f77233628ec3b3aa78797ba0cb4cae238aba11
features:
python:
additionalDependencies: 1.0.0
- constsAndDefaults: 1.0.5
- core: 6.0.1
+ constsAndDefaults: 1.0.6
+ core: 6.0.4
defaultEnabledRetries: 0.2.0
enumUnions: 0.1.0
envVarSecurityUsage: 0.3.2
flatRequests: 1.0.1
flattening: 3.1.1
- globalSecurity: 3.0.4
+ globalSecurity: 3.0.5
globalSecurityCallbacks: 1.0.0
globalSecurityFlattening: 1.0.0
globalServerURLs: 3.2.0
@@ -40,7 +40,7 @@ features:
retries: 3.0.3
sdkHooks: 1.2.1
serverIDs: 3.0.0
- unions: 3.1.2
+ unions: 3.1.3
trackedFiles:
.gitattributes:
id: 24139dae6567
@@ -336,8 +336,8 @@ trackedFiles:
pristine_git_object: 3314949e7c9f4254b853a0294b4a940e3802ee42
docs/models/cartitem.md:
id: c5bd6fe27df2
- last_write_checksum: sha1:9a27a95db941d601ea6aab7aab05dfcb0b8e3131
- pristine_git_object: 421670bb7c6247b28f63f94c9df7f5fd28b38412
+ last_write_checksum: sha1:592fa063a7f7e9b7d2a0d22ce8cc163b8f3e1945
+ pristine_git_object: a053e9bf678afbee6a37652c54dec6313128687c
docs/models/chaseoptions.md:
id: 52e385f89b96
last_write_checksum: sha1:254f90381cbf29fd856d915293384d2f63e8d63b
@@ -348,12 +348,12 @@ trackedFiles:
pristine_git_object: 271aae77c2ca57c0f2c37824e99e56587625b4c9
docs/models/checkoutsession.md:
id: aad6b42907c7
- last_write_checksum: sha1:3827dccf06fbb8592246b513501cdc4956e32d41
- pristine_git_object: aca4ccced230f8853ee0572cfd3dfd5cf2992350
+ last_write_checksum: sha1:b0f268e0f30c3744ba87dadb745e16bc86cfd5bb
+ pristine_git_object: 07aa9b602f38880750d875eca49b685eefaa2722
docs/models/checkoutsessioncreate.md:
id: 217467f7c9a0
- last_write_checksum: sha1:927364a03122713a2df6caf946dfe467415acd64
- pristine_git_object: 789a35d78299b30a09312c89e0cf72045f610d66
+ last_write_checksum: sha1:d80c0920998c7ae0faa1de17d20f461a2a2dcebc
+ pristine_git_object: 08b12c68bdc4046d7eaba34f80be633241aa2c05
docs/models/checkoutsessionpaymentmethod.md:
id: a03eded2a6ca
last_write_checksum: sha1:95e8988a077dddf0d712d52e66c2e7fc3c0da4fc
@@ -676,8 +676,8 @@ trackedFiles:
pristine_git_object: a75011281f0b3e75c0c07d369949f48d277c0cf3
docs/models/digitalwalletcreate.md:
id: 1fbe5a1719ba
- last_write_checksum: sha1:2768d5b30bd311de45abba48ffce9893d32e43eb
- pristine_git_object: 655dc818e4b911660f4bcd4155e1c50d5c3447ac
+ last_write_checksum: sha1:64b0191c02e71aaa037a862c9a4ddbcbd06775e9
+ pristine_git_object: 8b36ecd835fa6dcb8a8592239c83f4f949d3ad7b
docs/models/digitalwalletdomain.md:
id: a533ab38391d
last_write_checksum: sha1:d2b58b75ab7197a0324fca37cbaa963d0ca3b9b1
@@ -692,8 +692,8 @@ trackedFiles:
pristine_git_object: 1ed0c23b1a1d89244b482481a67ca83e50eec7c6
docs/models/digitalwalletupdate.md:
id: e4504eeac3fc
- last_write_checksum: sha1:c9714a922fa3a142e732317a70f8750bbf7aadb1
- pristine_git_object: 62d25efc8cb42a73415df278a96e8d0824c6fc16
+ last_write_checksum: sha1:91c841b0cceb167c780c44d2e0cc1fa1ff76a9cc
+ pristine_git_object: 3d3ef86d17d4b3d26afd6166d552d42df7a6a991
docs/models/dlocaloptions.md:
id: cf957a390cd7
last_write_checksum: sha1:450510bcadf361be2a0584b59443b49d332076ef
@@ -776,8 +776,8 @@ trackedFiles:
pristine_git_object: 6a8bab0b2fe8655899fe07cd64f267ea445b4b40
docs/models/forterantifraudoptionscartitembeneficiaryaddress.md:
id: a2243c0df751
- last_write_checksum: sha1:550a7d48997e55c72d7993a94cb4405aac7081ce
- pristine_git_object: fb4a8dcf23042edc4518bcee8c02393bd5606c96
+ last_write_checksum: sha1:c19fd4027868ce364a44a3d1095f98b53f90b696
+ pristine_git_object: 3b425d9b90e715bb3ac249734c73cc8edf2a5325
docs/models/forterantifraudoptionscartitembeneficiarycomments.md:
id: 777f0770018b
last_write_checksum: sha1:b6f434f1c4854b26b5daad846dab81963c7cb260
@@ -808,8 +808,8 @@ trackedFiles:
pristine_git_object: 8d77695d40d01126ba8de5d53faa65eb385c8976
docs/models/forterantifraudoptionsdiscountcoupondiscountamount.md:
id: 890d742efb98
- last_write_checksum: sha1:1c7375f1d5f1b8a733b053dad7395bc6f182a5b4
- pristine_git_object: 47e0f93e489e5b47bcef3966700a9671f571daf4
+ last_write_checksum: sha1:d1281d87b8084566200b819bf579a98cdcf8e720
+ pristine_git_object: 49f18ee73874ea0c38c37161ebcdced4bab59767
docs/models/getbuyerglobals.md:
id: 4807b45868ff
last_write_checksum: sha1:4a60da1c956c982233ced133ae78004a4180f3ab
@@ -1020,8 +1020,8 @@ trackedFiles:
pristine_git_object: 60b23318fa15a249a44f90ab09be27b9982d657e
docs/models/gocardlessoptions.md:
id: 254502b90afb
- last_write_checksum: sha1:48a94dd163818b2fcc901d5193e43455fa8dadf3
- pristine_git_object: 18cf7ad90ba7cab35d8ce0c6b75d74bfbd70990d
+ last_write_checksum: sha1:b0569920c57bddcf6f62a5129f67f373b99faa6b
+ pristine_git_object: 3d38a5b7727a41ace3a3f847588d59850aa6815b
docs/models/googlepayassurancedetails.md:
id: c951c667724a
last_write_checksum: sha1:a33fd5dd57371f46f2751e5522eb81c09c7a6e9c
@@ -1280,8 +1280,8 @@ trackedFiles:
pristine_git_object: f5c8ceb6cda906b8f24dcd11986527c0e868a11a
docs/models/listthreedsconfigurationsrequest.md:
id: f39090671a4a
- last_write_checksum: sha1:60574191b63d4220c85e252f4fec005e361ff75f
- pristine_git_object: bd03877550c0542c5bd0a7202eb4d32acc12e830
+ last_write_checksum: sha1:e94a776b86836faac4debe98ab302dcb2957cac7
+ pristine_git_object: cd77ff04b0f0c41c8a71b67ab28e6479319e4b7d
docs/models/listtransactionactionsglobals.md:
id: 5ca55a449898
last_write_checksum: sha1:5d26cd8c1364806e7e8f2e40615d96fad48fe2b2
@@ -1340,36 +1340,36 @@ trackedFiles:
pristine_git_object: c7998af826fa652d70876ab931cbcb893c08ddad
docs/models/merchantaccount.md:
id: e086409ff0fa
- last_write_checksum: sha1:ecb7e11ebf20aace6669743c197ea588e37c27b8
- pristine_git_object: 5409eb010cc7fc4090a771d7908c67d28364b3ac
+ last_write_checksum: sha1:9a2946d09a6f0ec7fd4d9921d7b8faaec3b26516
+ pristine_git_object: dd12247d6e919ead2acb7bcc6df741596d9a530b
docs/models/merchantaccountcreate.md:
id: a82f978b5311
- last_write_checksum: sha1:be99efc2717224f0ce47f42b3fea6c644510f7fb
- pristine_git_object: 36a14eac77617ee95ba6e2de9cfc6784660df507
+ last_write_checksum: sha1:9625825b1179ce02c484031e64af4659a59580d8
+ pristine_git_object: 6b7c6456e0944dae56e4028448edfe7b21975d39
docs/models/merchantaccounts.md:
id: 2b8c0cb06a58
last_write_checksum: sha1:efa315d8d287df3315adabe99c61b0370675e1c2
pristine_git_object: 6b1087e840f2fe77db805fef5a2afba604bd0e02
docs/models/merchantaccountthreedsconfiguration.md:
id: 8b7af4499332
- last_write_checksum: sha1:f2b132fc52a2d92a48c2fb09c4334f93f50483a1
- pristine_git_object: 774bf34d292eb3fa2530e52a561dba554fb06cb3
+ last_write_checksum: sha1:1d4eeb0e06ec667981b29435d631e4db7607b309
+ pristine_git_object: 2b525b0d5508140b6167e0ee3a71e1fa134a1b48
docs/models/merchantaccountthreedsconfigurationcreate.md:
id: 3fbc5d3ca360
- last_write_checksum: sha1:458701fd1e72f70062d3db3fd00898f223fffdab
- pristine_git_object: daf9eec2ee743de1fbd26262552eb525b445061e
+ last_write_checksum: sha1:263ccb9af824edc1306b65d164d218508d473b97
+ pristine_git_object: 86410142a042bfa3504939eae991d352586271ca
docs/models/merchantaccountthreedsconfigurations.md:
id: 87d5ea2627cb
last_write_checksum: sha1:afd9946eb8be36693860689b5faf7f8a43ee7e06
pristine_git_object: 1d469a443f8a614bf3f355f0eb2fc6d34540e4ae
docs/models/merchantaccountthreedsconfigurationupdate.md:
id: 16d659f63040
- last_write_checksum: sha1:bc7dde7302ed175d40e1baf7a4f318338f38b8f4
- pristine_git_object: 4f28755103328aee270383df9932b8bf41d73484
+ last_write_checksum: sha1:ec4a515861f506e4cfe4b30032435bd4cedbeede
+ pristine_git_object: 927d0350bc20b6eb35b516c7b1840b9fcdcb0c70
docs/models/merchantaccountupdate.md:
id: ccd76c07dc8b
- last_write_checksum: sha1:11e06ed32edc38efd1ce4753d3c45e54fa29ae5c
- pristine_git_object: 178a0857ef74743179165ff709cd39a1294a1ded
+ last_write_checksum: sha1:ae814aed46013d1441e73d93bf325fd50bd35527
+ pristine_git_object: 26ebda8b7c49e0386812dfd920fb17322d337eaa
docs/models/merchantprofilescheme.md:
id: ce1ddf0f9116
last_write_checksum: sha1:48bda92c567d4c9339c0176aebafe93a7cd37b6e
@@ -1448,12 +1448,12 @@ trackedFiles:
pristine_git_object: e9ed05f71f900dc8b1ff14742840ef837e8e5a28
docs/models/paymentlink.md:
id: b2924fda489a
- last_write_checksum: sha1:6bcfc91153c323a7b57852061f5753e47a1d6010
- pristine_git_object: bd29b475428aa8a3b87d959b1940991efeb9be75
+ last_write_checksum: sha1:eb2588b1b60dcf21c60ebc56652870a120a882e9
+ pristine_git_object: 835ce3ccfdb1bb84f5828305b307460a08d268d6
docs/models/paymentlinkcreate.md:
id: f540e80d1489
- last_write_checksum: sha1:814f9137d9b1f218e93e5be40ff33844aafa8b23
- pristine_git_object: 546d9ecb154785be155a7c3acb107a41c760a920
+ last_write_checksum: sha1:7f1e0460d6082c21f5a3f7a46763481823e0b937
+ pristine_git_object: b98d2bf43f900326fef42c730055e3b12ea82481
docs/models/paymentlinks.md:
id: 174693489d9c
last_write_checksum: sha1:b3324bd45e4ac6987b7f474bbffb23a5dbe4256d
@@ -1516,20 +1516,20 @@ trackedFiles:
pristine_git_object: b02690103f92e5c6a4c9e3075ce0bfcc0776af19
docs/models/paymentservice.md:
id: cc0e491ca808
- last_write_checksum: sha1:c6b3686fdd3911e505255373801c6dfb8706d0ba
- pristine_git_object: 147b1ace36bc0fa15d2d9d29b64d37232a206c74
+ last_write_checksum: sha1:83913b2857fc3e4e7a1c50f533a26fa81d481759
+ pristine_git_object: 0458a5590262a02f06cc02134df0d147be98f172
docs/models/paymentserviceconfiguration.md:
id: 2db1b9ccfc74
- last_write_checksum: sha1:4a682c66e2ced4c709864bea560c1934eafd49e5
- pristine_git_object: 031a83f4e391759d1bbab024250e723404276379
+ last_write_checksum: sha1:b383fd319f207788c236a3dfea219535f737d9b1
+ pristine_git_object: b1675696d2997036cb35a5adceb949482d629e86
docs/models/paymentservicecreate.md:
id: c1855aba32cd
- last_write_checksum: sha1:51f3ae75930189371670751756afdf410e94af97
- pristine_git_object: 92856a91c7a7efaddfe1452ef176bc92e2b305f7
+ last_write_checksum: sha1:07c2f03d16ec27c3608f721c890d3f6513f5ee84
+ pristine_git_object: cbf2a4c2a8ce30e71c170b25b1ea75fc0f4e11d6
docs/models/paymentservicedefinition.md:
id: 8f9babf9c246
- last_write_checksum: sha1:8234dedf4f2675a644846b4b03df8bf59ef5b773
- pristine_git_object: e275b5f4bc392b8c01b29e2084ead11a7ee1f29b
+ last_write_checksum: sha1:546d49ff80a0fbb84573899dd619fc06c90c9aa0
+ pristine_git_object: f1265e26c275319917a8a1f5a768954e2966e08d
docs/models/paymentservicedefinitions.md:
id: 542c2205503a
last_write_checksum: sha1:1ecbc70276c6bf287559b614028a2b3c91edabfb
@@ -1556,8 +1556,8 @@ trackedFiles:
pristine_git_object: 5f8dc42c52ee9c5c269f483febd33983926d3202
docs/models/paymentserviceupdate.md:
id: 9022dcc9dba3
- last_write_checksum: sha1:e55a3aaf455f8fd1b15331f88b3da4d73602b15b
- pristine_git_object: 2228f5c0f312db030d893f6bc8a4b75c616db5b8
+ last_write_checksum: sha1:878ea2a6fc60848854e7a2f5503b018084673ed0
+ pristine_git_object: 66bc2649d27a58462bdaee8a05c8d7d61ffb9b49
docs/models/payoutcategory.md:
id: e48bd9808935
last_write_checksum: sha1:cb49ab3802ad82a47b9fd6bf1415f4fddf274271
@@ -1568,20 +1568,20 @@ trackedFiles:
pristine_git_object: cdbf3edcc6d926e9d76745fd6ab50b7614c4448d
docs/models/payoutcreate.md:
id: 7609344ac287
- last_write_checksum: sha1:270d9412abd692b4edccfbe0750e54eb8a8363ab
- pristine_git_object: 36b4a6bc47747ae9e168c41d39f976d582485c45
+ last_write_checksum: sha1:5eea99468d2f3e8cfa811f553d19b2aa6e8ea00c
+ pristine_git_object: 5e10daec850ef2a7bb9cd4d6de3fc5d30a6f5546
docs/models/payoutcreatepaymentmethod.md:
id: 76f4ca6399b9
last_write_checksum: sha1:f97f7d4611d837fa853274646c66ffaad5171411
pristine_git_object: c7ff00baaf13e73ac8d7dbabae229fca18f04f64
docs/models/payoutmerchant.md:
id: 31c3978e6726
- last_write_checksum: sha1:41c32ff0639ea971b7f1d8dfbb832c4f5b2fc659
- pristine_git_object: 8cc4e83a60211d3b0c3d8cc797c5fa209a1cf676
+ last_write_checksum: sha1:c2b07eff129f50e1ebbc3e9744ada75850913713
+ pristine_git_object: b9772913f34ccf04208dcfedd2a0fc1d97804cfd
docs/models/payoutmerchantsummary.md:
id: 0a74b8faaba2
- last_write_checksum: sha1:af5d0f2d4cea9be50c0c811c63f8862f830e7a1a
- pristine_git_object: e7d603b39b0f689b3d90fe9fa9a6ef60a6869874
+ last_write_checksum: sha1:30c603b08a834fc251eae955c09bd33fc82628dc
+ pristine_git_object: b68536f48a430ceece92d42e6cec583b39d77842
docs/models/payoutpaymentservice.md:
id: 05c74afe4e9d
last_write_checksum: sha1:413cbbff3db61562e17d1c5df5b31930920027fb
@@ -1596,8 +1596,8 @@ trackedFiles:
pristine_git_object: f7d4e5485b50874567505e9a7df62af289eacdb1
docs/models/payoutsummary.md:
id: f7c0f0ba7755
- last_write_checksum: sha1:7460a789a9ec62159fa9a35e8045ed5af9ed92ea
- pristine_git_object: 1c06530f4a96e39a72e2ffb490796deab0a5466f
+ last_write_checksum: sha1:32428cee5c57d1b34a2aa85a6558b543e23a13bc
+ pristine_git_object: 7c9107a87bc808e0c7b65d7ab9e2d0a49e33dd30
docs/models/paypaloptions.md:
id: b2170d26df0f
last_write_checksum: sha1:d46f898d5611bc634e4529aaedf947ba044e5df9
@@ -1608,12 +1608,12 @@ trackedFiles:
pristine_git_object: 0ed1b27fc0e2c68787bbe799deea82cf7893a89a
docs/models/paypalshippingoptionsitem.md:
id: 6e75ba7e94fa
- last_write_checksum: sha1:77242b0ca59fec0b4e2b13ae089429834ce9ecc4
- pristine_git_object: 14b9e60390f49b7e59a318444d69a20de56ca482
+ last_write_checksum: sha1:36e41a191e4f20f28635cdb695a705ce094f62f0
+ pristine_git_object: 3859606d10a59cb7204a1ee82bc915277f432bf4
docs/models/paypalshippingoptionsitemamount.md:
id: 335cd082a9f7
- last_write_checksum: sha1:5ec1c60c5d8e715dbdf8d8244830bf894ef874e9
- pristine_git_object: 3a9b23685f42024e3069a318665354b92fa5f056
+ last_write_checksum: sha1:8d1e68ef11eaa462fc6b6d33308eeb81376a8efc
+ pristine_git_object: 731d5f17b59f015a9025a15f11b641b990fce2ff
docs/models/paypalshippingoptionsitemtype.md:
id: a48982505684
last_write_checksum: sha1:951f5dbd7c96a58909aebc206074e961c519f833
@@ -1640,16 +1640,16 @@ trackedFiles:
pristine_git_object: 90898b90ef7bef80b021291fb4d5a45cc8de46a1
docs/models/redirectpaymentmethodcreate.md:
id: 8fe80d2339c7
- last_write_checksum: sha1:3f1b8b2846d43f214628325fed77953a03078744
- pristine_git_object: d9de294acfdaa1f3e0c9676f8156891d3db5defe
+ last_write_checksum: sha1:706f27e8c66e3cbda459ba70916b9ac203ca5f9a
+ pristine_git_object: 9fc5693a4598b46699b86b9e5fb8315cd15d2cc1
docs/models/redirectpaymentmethodcreatemethod.md:
id: ae93e1391b37
last_write_checksum: sha1:7351156683b12210fa746c90cd470707ef99a58f
pristine_git_object: e5342b477a64347c4c6097fc56b55bb6bf5aba74
docs/models/refund.md:
id: 3be36b1a2825
- last_write_checksum: sha1:ab6f6a574969fd445e40dfe2e6b69c8cfae86904
- pristine_git_object: bc3eafa6a0b31f159c9475416f0d6ed8a04c03a9
+ last_write_checksum: sha1:2fa86e07647644e2c424a89c39ea160d54559857
+ pristine_git_object: acb9e1ce3d88ccb71a71db3171d1422722b86d0a
docs/models/refunds.md:
id: 56cad80f02e4
last_write_checksum: sha1:142d11ec89618ca4f0d7d8c6637dfb354d3fe6cf
@@ -1776,8 +1776,8 @@ trackedFiles:
pristine_git_object: 8ca6325b43081d6b8849bf8cfab3d65678d3d386
docs/models/settlement.md:
id: 4aa6c164bdd4
- last_write_checksum: sha1:314b5590a2ad6a8605e02d59a0e7aa7b492b4205
- pristine_git_object: b4740c1ef4970d6acab87cfff02f333809d1f8e5
+ last_write_checksum: sha1:bdf260b90766c89cebe0ba8d6e42468fa7412c48
+ pristine_git_object: 7a5cf4335e02bb7be2663a8220a1c63f6ab018ab
docs/models/settlements.md:
id: 84e18a5f21e2
last_write_checksum: sha1:4d66254c4c66f886c93b60861a2c94f6222ff20c
@@ -1880,20 +1880,20 @@ trackedFiles:
pristine_git_object: 96bd6308267f7a9ff7e59d0e83e5c85cc1dbbf57
docs/models/threedsecurescenariooutcome.md:
id: c50999fee162
- last_write_checksum: sha1:3036ffce1cf2db782d3ec747f5441564dbb8d90a
- pristine_git_object: dac8bd990d10e1702fe385a468bc6029b23d467d
+ last_write_checksum: sha1:643fcd26ee6a529666734331155ac7ebaad70c8b
+ pristine_git_object: edf612c701e7ad3c35fde1faf4e7e80c64309ff3
docs/models/threedsecurescenariooutcomeauthentication.md:
id: 3c3e3953794a
- last_write_checksum: sha1:81a4bc03626f9c9e92563100a990b7b76848be0b
- pristine_git_object: e295b10a1424a19e744de210a813f3ad432fd3ef
+ last_write_checksum: sha1:de610b3a61f254edc5cf09285eed0fbd88136f55
+ pristine_git_object: 7b81d360b2e15ee28cd59d2408e6008ff956c5f0
docs/models/threedsecurescenariooutcomeauthenticationtransactionstatus.md:
id: 917e6b7d96cd
last_write_checksum: sha1:1392401e5ed0acf852a0e3323a417c6df9fc6daa
pristine_git_object: 8edeecd22fc11bfaf0de0a8d0a0a5ea1e9c19aea
docs/models/threedsecurescenariooutcomeresult.md:
id: fbdb7bf7e938
- last_write_checksum: sha1:6ba73cb72556ad4a17419a1b4092294b17849721
- pristine_git_object: 8034028f56152e5d222c94f998c3fb80a0b2a74f
+ last_write_checksum: sha1:675a0e47deadcf130769d8d026a9151412d3b234
+ pristine_git_object: 4dd7502dc626c671524924cec67c2a8d82124b40
docs/models/threedsecurescenariooutcomeresulttransactionstatus.md:
id: c3612aa180a5
last_write_checksum: sha1:87404b3a37c4eee2d484b3a82c6d8ab54d9cafc2
@@ -1928,8 +1928,8 @@ trackedFiles:
pristine_git_object: d2f2f1b9ed54bf1439bd346b6ecddfc5fbe17f2c
docs/models/transaction.md:
id: 24ab0958a449
- last_write_checksum: sha1:ec5b6fe771c52338c3bcf706986e61e45a448c8b
- pristine_git_object: f79bd5298a3a45bb8c302be4f173b59a1080a31a
+ last_write_checksum: sha1:0c4c2c2e57110707a17fa9fe9ba602f1ec31cbb5
+ pristine_git_object: 905adba32be03e2b4aa64c3ad4b6f31d3112d2a7
docs/models/transactionaction.md:
id: 5f03c1427673
last_write_checksum: sha1:5c7feaaf0b1cff6c198d59bdacd98037c2385390
@@ -1960,8 +1960,8 @@ trackedFiles:
pristine_git_object: 35cb4edd7c8625347cbafd9584db88d85a094cec
docs/models/transactioncreate.md:
id: 2eccca1e0d3d
- last_write_checksum: sha1:a097d65c9f0a1469d4908e1fb95ad63d4bb751bd
- pristine_git_object: c60289ac287648e6792f1e14e72dfae7f5c03d54
+ last_write_checksum: sha1:090a83933465e600bafa8aabdac68a3d2c163ac8
+ pristine_git_object: 77ba0cc41fb28dbfe4e71110c003abc07cd2024a
docs/models/transactioncreatepaymentmethod.md:
id: 3797152d0145
last_write_checksum: sha1:211519d39358f87544d49ed79a32215b747fdcf8
@@ -2024,8 +2024,8 @@ trackedFiles:
pristine_git_object: 913e63e5283dd1f1ec983459127266ac9c60881c
docs/models/transactionsummary.md:
id: 67e790637e68
- last_write_checksum: sha1:62a379616541f5e41fefdc9a96eea91537432ffb
- pristine_git_object: d72001a29a44aef022b474d36e28906c3481f475
+ last_write_checksum: sha1:430fe26dd2758366a2af2b77238e4a04378b84fd
+ pristine_git_object: b68fe387ffe60756129b100c82f1cb3df0589f09
docs/models/transactionthreedsecuresummary.md:
id: 3440c6822ffe
last_write_checksum: sha1:aee89cd9a9ed83b580c09150e14767db6cff3880
@@ -2232,12 +2232,12 @@ trackedFiles:
pristine_git_object: 67884b702a64f1b6ab11a1c3e86efdf2b90b63db
docs/sdks/checkoutsessions/README.md:
id: 093cc3fe624c
- last_write_checksum: sha1:8a02b5b17fb5de45a3d7213394cbc211e497f16c
- pristine_git_object: 60aedf6256eeeac782a5bf74f292c8427773cb95
+ last_write_checksum: sha1:3dd4bac2f6840dd99fe16902120cb12546c47a22
+ pristine_git_object: 3714b4e86732ac0cc7541a75bcedb53f9ef84392
docs/sdks/digitalwalletssdk/README.md:
id: 136b32c1fcd9
- last_write_checksum: sha1:375e760850d150f4c8d12be61bd6ebb90b367ba8
- pristine_git_object: 779b996f3d38b10d7b63afb05f2ab7df299a5682
+ last_write_checksum: sha1:7e03ec56f1bb045b4e430acd644d18c18a87baf7
+ pristine_git_object: 52292d7176dfb0a3886f26401ba9bd952d930178
docs/sdks/domains/README.md:
id: 06e9beb4063b
last_write_checksum: sha1:b50847245538c6edd87e42482ce092b12f4541a4
@@ -2260,16 +2260,16 @@ trackedFiles:
pristine_git_object: 1b2ca14485f19909d286ffa638d6fcdd333223ed
docs/sdks/merchantaccountssdk/README.md:
id: 39108cecfab1
- last_write_checksum: sha1:8aa01910d40dd76ff6ee257fa4a72f1e6c3e298f
- pristine_git_object: 9749df94530cd44f2fa5e1bc63fec27a759442ae
+ last_write_checksum: sha1:024733ab46ed79d89269adb517a2d945782bf2e3
+ pristine_git_object: 335a078f3578ca0e1068f873ea1f45a8139017ef
docs/sdks/networktokenscryptogram/README.md:
id: 7aef02dc3c54
last_write_checksum: sha1:3ac01232944c881072602290f8de7132617e85fc
pristine_git_object: 78e4c5293dd0b9d3491e6768e96ba50ef15c890c
docs/sdks/paymentlinkssdk/README.md:
id: 443d95cf5bd0
- last_write_checksum: sha1:a26c07320273f81e3d100d088d7c90e6ee85ebee
- pristine_git_object: b69aac433111a5a0fc87b5e8006785da290e121a
+ last_write_checksum: sha1:8dd512bc46d22840cc2a8e040e4f1a9d52331650
+ pristine_git_object: 3a4884105c436a24f774e7419d3196a0080a47ad
docs/sdks/paymentmethodsnetworktokens/README.md:
id: badc1bd37263
last_write_checksum: sha1:f651897772dc723efaccab6353ae53adfbea3b50
@@ -2292,12 +2292,12 @@ trackedFiles:
pristine_git_object: 868d80fc57d649914d4bc80d71f9a20d4a4ee761
docs/sdks/paymentservicessdk/README.md:
id: a24bcb6f30a4
- last_write_checksum: sha1:cd046c6d6952231691c6881bf9c9ac0e2b841245
- pristine_git_object: 5609d06a18ee8949a770c774c3ca16c37706dbf2
+ last_write_checksum: sha1:db5072a0fa201e34074acf7614b2fa3b0428a863
+ pristine_git_object: 3b5f1a278c8d2f9beccf1876a2bead5ae286d21c
docs/sdks/payouts/README.md:
id: 184ed4a74471
- last_write_checksum: sha1:140a9e90a57eeaa89e583b55012a3fb63ed97d0c
- pristine_git_object: 4078d7ed6d0da4bdb42728fdc1b304b7f5bfc7a2
+ last_write_checksum: sha1:732f160becbe57b2d497e35519f1a461ca0320a9
+ pristine_git_object: 8ec76ec5a46e4ab3e415651d05157fd529b8dea8
docs/sdks/refundssdk/README.md:
id: a95d23651926
last_write_checksum: sha1:dd0848e340e3d41b09855d461e94c2d282d8f5b8
@@ -2316,16 +2316,16 @@ trackedFiles:
pristine_git_object: a3f212b22be155a47de24e7e217168022f33403f
docs/sdks/threedsconfiguration/README.md:
id: 86aa349ed0d5
- last_write_checksum: sha1:d8ab26174170923418d1c012eb7cf6c943e2a486
- pristine_git_object: 2c30913680940bec79371dc01dafdb6e62bdcac2
+ last_write_checksum: sha1:eb880815995889d811a03a52adf476fc92625ed3
+ pristine_git_object: 9f060a0ad394c11fc36ee57cfb756689b4ab183c
docs/sdks/threedsscenarios/README.md:
id: 81ff4c3f8215
last_write_checksum: sha1:e7a911d50a015cfd120fd3e6863fbbf0bfe50cbb
pristine_git_object: 1c164f363de02939f9ce80cf4dc53933c585e5b2
docs/sdks/transactions/README.md:
id: 85592abe3c6b
- last_write_checksum: sha1:52bd9e446c5a80041ca37e0e0b3529182c257768
- pristine_git_object: 6273873ba6935b3c22b0b4db227c2c5adfc8fe70
+ last_write_checksum: sha1:4f471bf5b0008ac4d9f2f1002208d88e94157813
+ pristine_git_object: 8271182b1da6e504c3462ee1881dfeb42e35cf5e
docs/sdks/transactionsrefunds/README.md:
id: c6a0400f5020
last_write_checksum: sha1:9f066fc497802c0814246b158c659f494f74b520
@@ -2348,8 +2348,8 @@ trackedFiles:
pristine_git_object: ba6a998b82e6e5fce3f37f2c3a73b345395d952c
pyproject.toml:
id: 5d07e7d72637
- last_write_checksum: sha1:29ce9bd36859b995cc01b43a311c5e3ebf87410c
- pristine_git_object: 4e508ceba337305809d90bc7303bcfcca7e00a44
+ last_write_checksum: sha1:d2244d396ec7c5e5bcd50f72f541ad1a6380ec1d
+ pristine_git_object: ddb52e3c72235c52dd0b07d518a54552a3a8059d
scripts/prepare_readme.py:
id: e0c5957a6035
last_write_checksum: sha1:63a92abbd1de3323613f0d4c1ae4412076577710
@@ -2376,8 +2376,8 @@ trackedFiles:
pristine_git_object: 83a0d00f9b5b1a6d837643a32bfd0f82cd4f98ce
src/gr4vy/_version.py:
id: 1b5ad1da47aa
- last_write_checksum: sha1:1f0e0d320f316d10b2634a66bfa08714f4e2e127
- pristine_git_object: bf64007c188ee234918362fb93f3d63eb2773985
+ last_write_checksum: sha1:3ed7abe6477250f962f8b0012bcdea7789f81f12
+ pristine_git_object: 0e910cdc17b0cdf7a882365f85fcb0a9e81f4a83
src/gr4vy/account_updater.py:
id: 6dc8f39e2fb9
last_write_checksum: sha1:fabc79a59dd06fb927ce2d834fbafbcad5836a4b
@@ -4184,8 +4184,8 @@ trackedFiles:
pristine_git_object: 3324e1bc2668c54c4d5f5a1a845675319757a828
src/gr4vy/utils/eventstreaming.py:
id: 5efe1493cdda
- last_write_checksum: sha1:bababae5d54b7efc360db701daa49e18a92c2f3b
- pristine_git_object: 0969899bfc491e5e408d05643525f347ea95e4fc
+ last_write_checksum: sha1:ffa870a25a7e4e2015bfd7a467ccd3aa1de97f0e
+ pristine_git_object: f2052fc22d9fd6c663ba3dce019fe234ca37108b
src/gr4vy/utils/forms.py:
id: 52e38fbd730d
last_write_checksum: sha1:15fa7e9ab1611e062a9984cf06cb20969713d295
@@ -4216,8 +4216,8 @@ trackedFiles:
pristine_git_object: 88a91b10cd2076b4a2c6cff2ac6bfaa5e3c5ad13
src/gr4vy/utils/security.py:
id: 648156d4ba48
- last_write_checksum: sha1:77d0313d487c5c2f7a1690cecdadbb858a6784aa
- pristine_git_object: dd52aabc559405c88291b52d8139bb661466062f
+ last_write_checksum: sha1:1dd7e0af4f931ca6683a6f889b2d1c8a241b0950
+ pristine_git_object: 7ae8c4414a48c9876c13f0c94b2228ff00d7d563
src/gr4vy/utils/serializers.py:
id: fc34f2ffef43
last_write_checksum: sha1:ce1d8d7f500a9ccba0aeca5057cee9c271f4dfd7
@@ -7961,13 +7961,6 @@ examples:
application/json: {"type": "error", "code": "gateway_timeout", "status": 504, "message": "Request could not be processed"}
examplesVersion: 1.0.2
generatedTests: {}
-releaseNotes: |
- ## Python SDK Changes:
- * `gr4vy.merchant_accounts.three_ds_configuration.create()`: **Added**
- * `gr4vy.merchant_accounts.three_ds_configuration.list()`: **Added**
- * `gr4vy.merchant_accounts.three_ds_configuration.update()`: **Added**
- * `gr4vy.merchant_accounts.three_ds_configuration.delete()`: **Added**
- * `gr4vy.transactions.capture()`: `request.idempotency_key` **Added**
generatedFiles:
- .gitattributes
- .vscode/settings.json
diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
index b09334c..4ca124d 100644
--- a/.speakeasy/gen.yaml
+++ b/.speakeasy/gen.yaml
@@ -28,7 +28,7 @@ generation:
generateNewTests: false
skipResponseBodyAssertions: false
python:
- version: 2.0.0
+ version: 2.0.1
additionalDependencies:
dev:
freezegun: ^1.5.1
@@ -59,6 +59,8 @@ python:
flattenGlobalSecurity: true
flattenRequests: true
flatteningOrder: parameters-first
+ forwardCompatibleEnumsByDefault: false
+ forwardCompatibleUnionsByDefault: "false"
imports:
option: openapi
paths:
diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
index 82c0a67..225a155 100644
--- a/.speakeasy/workflow.lock
+++ b/.speakeasy/workflow.lock
@@ -1,21 +1,21 @@
-speakeasyVersion: 1.703.0
+speakeasyVersion: 1.713.2
sources:
openapi:
sourceNamespace: openapi
- sourceRevisionDigest: sha256:1ba900c18259e5144fc1b4120948569166301a24c175d97bba17cd2d2b5a42c4
- sourceBlobDigest: sha256:75fafb86259b7513599a49bbc17f3a3f9103b8795b9c145afa46eb839dcb555e
+ sourceRevisionDigest: sha256:9d727c066f096cb3cccc2fd67d888c05597097c2b7271292c798c2bc9029ee80
+ sourceBlobDigest: sha256:960fbab749a7764d4aa711fd6a9ff032f23746db51b8ce14b1d72d726768a96a
tags:
- latest
- - speakeasy-sdk-regen-1770229775
+ - speakeasy-sdk-regen-1770290460
- 1.0.0
targets:
python:
source: openapi
sourceNamespace: openapi
- sourceRevisionDigest: sha256:1ba900c18259e5144fc1b4120948569166301a24c175d97bba17cd2d2b5a42c4
- sourceBlobDigest: sha256:75fafb86259b7513599a49bbc17f3a3f9103b8795b9c145afa46eb839dcb555e
+ sourceRevisionDigest: sha256:9d727c066f096cb3cccc2fd67d888c05597097c2b7271292c798c2bc9029ee80
+ sourceBlobDigest: sha256:960fbab749a7764d4aa711fd6a9ff032f23746db51b8ce14b1d72d726768a96a
codeSamplesNamespace: openapi-python-code-samples
- codeSamplesRevisionDigest: sha256:a776c36cb4f3ddc729f1988396fba44ad3c3da77e436a54af6c7f81cf08121fd
+ codeSamplesRevisionDigest: sha256:36a6b26e6cb55d3b05aca901a51861feb7cfd6167053dbbbb569c96a5e5ab9f6
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
diff --git a/RELEASES.md b/RELEASES.md
index 6748cbb..98e9ade 100644
--- a/RELEASES.md
+++ b/RELEASES.md
@@ -1438,4 +1438,14 @@ Based on:
### Generated
- [python v2.0.0] .
### Releases
-- [PyPI v2.0.0] https://pypi.org/project/gr4vy/2.0.0 - .
\ No newline at end of file
+- [PyPI v2.0.0] https://pypi.org/project/gr4vy/2.0.0 - .
+
+## 2026-02-13 00:43:15
+### Changes
+Based on:
+- OpenAPI Doc
+- Speakeasy CLI 1.713.2 (2.821.6) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [python v2.0.1] .
+### Releases
+- [PyPI v2.0.1] https://pypi.org/project/gr4vy/2.0.1 - .
\ No newline at end of file
diff --git a/docs/models/cartitem.md b/docs/models/cartitem.md
index 421670b..a053e9b 100644
--- a/docs/models/cartitem.md
+++ b/docs/models/cartitem.md
@@ -17,10 +17,10 @@
| `image_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The URL for the image of the item. | https://example.com/images/go-pro-hd.jpg |
| `categories` | List[*str*] | :heavy_minus_sign: | A list of strings containing product categories for the item. | [
"camera",
"travel",
"gear"
] |
| `product_type` | [OptionalNullable[models.ProductType]](../models/producttype.md) | :heavy_minus_sign: | The product type of the cart item. | physical |
-| `seller_country` | *OptionalNullable[str]* | :heavy_minus_sign: | The seller country of the cart item. | US |
+| `seller_country` | *OptionalNullable[str]* | :heavy_minus_sign: | The seller country of the cart item. | **Example 1:** US
**Example 2:** GB |
| `tax_exempt` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether the item is exempt of tax. | false |
-| `unit_of_measure` | *OptionalNullable[str]* | :heavy_minus_sign: | The unit of measure or the unit of measure code. | feet |
-| `commodity_code` | *OptionalNullable[str]* | :heavy_minus_sign: | Item commodity code. Generally a UNSPSC code. | 43211503 |
+| `unit_of_measure` | *OptionalNullable[str]* | :heavy_minus_sign: | The unit of measure or the unit of measure code. | **Example 1:** feet
**Example 2:** kg |
+| `commodity_code` | *OptionalNullable[str]* | :heavy_minus_sign: | Item commodity code. Generally a UNSPSC code. | **Example 1:** 43211503
**Example 2:** 84111502 |
| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | Brief item description. | A brief description of an interesting item. |
| `duty_amount` | *OptionalNullable[int]* | :heavy_minus_sign: | Item import or export duties represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` cents to create an authorization for `$12.99` | 1299 |
| `shipping_amount` | *OptionalNullable[int]* | :heavy_minus_sign: | Freight/shipping amount represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` cents to create an authorization for `$12.99` | 1299 |
\ No newline at end of file
diff --git a/docs/models/checkoutsession.md b/docs/models/checkoutsession.md
index aca4ccc..07aa9b6 100644
--- a/docs/models/checkoutsession.md
+++ b/docs/models/checkoutsession.md
@@ -10,7 +10,7 @@
| `buyer` | [OptionalNullable[models.GuestBuyer]](../models/guestbuyer.md) | :heavy_minus_sign: | Provide buyer details for the transaction. No buyer resource will be created on Gr4vy when used. | |
| `airline` | [OptionalNullable[models.Airline]](../models/airline.md) | :heavy_minus_sign: | The airline addendum data which describes the airline booking associated with this transaction. | |
| `amount` | *OptionalNullable[int]* | :heavy_minus_sign: | The total amount for this transaction. | |
-| `currency` | *OptionalNullable[str]* | :heavy_minus_sign: | The currency code for this transaction. | EUR |
+| `currency` | *OptionalNullable[str]* | :heavy_minus_sign: | The currency code for this transaction. | **Example 1:** EUR
**Example 2:** GBP
**Example 3:** USD |
| `payment_service_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The unique identifier of an existing payment service. When provided, the created transaction will be processed by the given payment service and any routing rules will be skipped. | |
| `type` | *Optional[Literal["checkout-session"]]* | :heavy_minus_sign: | Always `checkout-session` | checkout-session |
| `id` | *str* | :heavy_check_mark: | The ID for the checkout session. | 4137b1cf-39ac-42a8-bad6-1c680d5dab6b |
diff --git a/docs/models/checkoutsessioncreate.md b/docs/models/checkoutsessioncreate.md
index 789a35d..08b12c6 100644
--- a/docs/models/checkoutsessioncreate.md
+++ b/docs/models/checkoutsessioncreate.md
@@ -10,6 +10,6 @@
| `buyer` | [OptionalNullable[models.GuestBuyer]](../models/guestbuyer.md) | :heavy_minus_sign: | Provide buyer details for the transaction. No buyer resource will be created on Gr4vy when used. | |
| `airline` | [OptionalNullable[models.Airline]](../models/airline.md) | :heavy_minus_sign: | The airline addendum data which describes the airline booking associated with this transaction. | |
| `amount` | *OptionalNullable[int]* | :heavy_minus_sign: | The total amount for this transaction. | |
-| `currency` | *OptionalNullable[str]* | :heavy_minus_sign: | The currency code for this transaction. | EUR |
+| `currency` | *OptionalNullable[str]* | :heavy_minus_sign: | The currency code for this transaction. | **Example 1:** EUR
**Example 2:** GBP
**Example 3:** USD |
| `payment_service_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The unique identifier of an existing payment service. When provided, the created transaction will be processed by the given payment service and any routing rules will be skipped. | |
| `expires_in` | *Optional[float]* | :heavy_minus_sign: | The time in seconds when this checkout session expires. | |
\ No newline at end of file
diff --git a/docs/models/digitalwalletcreate.md b/docs/models/digitalwalletcreate.md
index 655dc81..8b36ecd 100644
--- a/docs/models/digitalwalletcreate.md
+++ b/docs/models/digitalwalletcreate.md
@@ -11,6 +11,6 @@ Request body for registering a new digital wallet
| `merchant_name` | *str* | :heavy_check_mark: | N/A | |
| `merchant_display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | |
| `merchant_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | |
-| `merchant_country_code` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | DE |
+| `merchant_country_code` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | **Example 1:** DE
**Example 2:** GB
**Example 3:** US |
| `domain_names` | List[*str*] | :heavy_minus_sign: | N/A | |
| `accept_terms_and_conditions` | *bool* | :heavy_check_mark: | N/A | |
\ No newline at end of file
diff --git a/docs/models/digitalwalletupdate.md b/docs/models/digitalwalletupdate.md
index 62d25ef..3d3ef86 100644
--- a/docs/models/digitalwalletupdate.md
+++ b/docs/models/digitalwalletupdate.md
@@ -5,10 +5,10 @@ Request body for editing a registered digital wallet
## Fields
-| Field | Type | Required | Description | Example |
-| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- |
-| `merchant_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | |
-| `domain_names` | List[*str*] | :heavy_minus_sign: | N/A | |
-| `merchant_display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | |
-| `merchant_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | |
-| `merchant_country_code` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | DE |
\ No newline at end of file
+| Field | Type | Required | Description | Example |
+| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
+| `merchant_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | |
+| `domain_names` | List[*str*] | :heavy_minus_sign: | N/A | |
+| `merchant_display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | |
+| `merchant_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | |
+| `merchant_country_code` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | **Example 1:** DE
**Example 2:** GB
**Example 3:** US |
\ No newline at end of file
diff --git a/docs/models/forterantifraudoptionscartitembeneficiaryaddress.md b/docs/models/forterantifraudoptionscartitembeneficiaryaddress.md
index fb4a8dc..3b425d9 100644
--- a/docs/models/forterantifraudoptionscartitembeneficiaryaddress.md
+++ b/docs/models/forterantifraudoptionscartitembeneficiaryaddress.md
@@ -3,12 +3,12 @@
## Fields
-| Field | Type | Required | Description | Example |
-| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
-| `country` | *str* | :heavy_check_mark: | The country code of the beneficiary's address. | DE |
-| `address1` | *OptionalNullable[str]* | :heavy_minus_sign: | First line of the beneficiary's address. | |
-| `address2` | *OptionalNullable[str]* | :heavy_minus_sign: | Second line of the beneficiary's address. | |
-| `zip` | *OptionalNullable[str]* | :heavy_minus_sign: | Zip or postal code of the beneficiary's address. | |
-| `region` | *OptionalNullable[str]* | :heavy_minus_sign: | State or region of the beneficiary's address. | |
-| `company` | *OptionalNullable[str]* | :heavy_minus_sign: | Company name associated with the beneficiary's address. | |
-| `city` | *OptionalNullable[str]* | :heavy_minus_sign: | City of the beneficiary's address. | |
\ No newline at end of file
+| Field | Type | Required | Description | Example |
+| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
+| `country` | *str* | :heavy_check_mark: | The country code of the beneficiary's address. | **Example 1:** DE
**Example 2:** GB
**Example 3:** US |
+| `address1` | *OptionalNullable[str]* | :heavy_minus_sign: | First line of the beneficiary's address. | |
+| `address2` | *OptionalNullable[str]* | :heavy_minus_sign: | Second line of the beneficiary's address. | |
+| `zip` | *OptionalNullable[str]* | :heavy_minus_sign: | Zip or postal code of the beneficiary's address. | |
+| `region` | *OptionalNullable[str]* | :heavy_minus_sign: | State or region of the beneficiary's address. | |
+| `company` | *OptionalNullable[str]* | :heavy_minus_sign: | Company name associated with the beneficiary's address. | |
+| `city` | *OptionalNullable[str]* | :heavy_minus_sign: | City of the beneficiary's address. | |
\ No newline at end of file
diff --git a/docs/models/forterantifraudoptionsdiscountcoupondiscountamount.md b/docs/models/forterantifraudoptionsdiscountcoupondiscountamount.md
index 47e0f93..49f18ee 100644
--- a/docs/models/forterantifraudoptionsdiscountcoupondiscountamount.md
+++ b/docs/models/forterantifraudoptionsdiscountcoupondiscountamount.md
@@ -3,8 +3,8 @@
## Fields
-| Field | Type | Required | Description | Example |
-| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
-| `amount_usd` | *OptionalNullable[str]* | :heavy_minus_sign: | The discount amount in USD. | |
-| `amount_local_currency` | *OptionalNullable[str]* | :heavy_minus_sign: | The discount amount in local currency. | |
-| `currency` | *OptionalNullable[str]* | :heavy_minus_sign: | The currency code for the discount amount. | EUR |
\ No newline at end of file
+| Field | Type | Required | Description | Example |
+| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
+| `amount_usd` | *OptionalNullable[str]* | :heavy_minus_sign: | The discount amount in USD. | |
+| `amount_local_currency` | *OptionalNullable[str]* | :heavy_minus_sign: | The discount amount in local currency. | |
+| `currency` | *OptionalNullable[str]* | :heavy_minus_sign: | The currency code for the discount amount. | **Example 1:** EUR
**Example 2:** GBP
**Example 3:** USD |
\ No newline at end of file
diff --git a/docs/models/gocardlessoptions.md b/docs/models/gocardlessoptions.md
index 18cf7ad..3d38a5b 100644
--- a/docs/models/gocardlessoptions.md
+++ b/docs/models/gocardlessoptions.md
@@ -3,6 +3,6 @@
## Fields
-| Field | Type | Required | Description | Example |
-| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `purpose_code` | [OptionalNullable[models.PurposeCode]](../models/purposecode.md) | :heavy_minus_sign: | Specifies the high-level purpose of a mandate and/or payment using a set of pre-defined categories. Required for the PayTo scheme, optional for all others | mortgage |
\ No newline at end of file
+| Field | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `purpose_code` | [OptionalNullable[models.PurposeCode]](../models/purposecode.md) | :heavy_minus_sign: | Specifies the high-level purpose of a mandate and/or payment using a set of pre-defined categories. Required for the PayTo scheme, optional for all others | **Example 1:** mortgage
**Example 2:** utility
**Example 3:** loan
**Example 4:** dependant_support
**Example 5:** gambling
**Example 6:** retail
**Example 7:** salary
**Example 8:** personal
**Example 9:** government
**Example 10:** pension
**Example 11:** tax
**Example 12:** other |
\ No newline at end of file
diff --git a/docs/models/listthreedsconfigurationsrequest.md b/docs/models/listthreedsconfigurationsrequest.md
index bd03877..cd77ff0 100644
--- a/docs/models/listthreedsconfigurationsrequest.md
+++ b/docs/models/listthreedsconfigurationsrequest.md
@@ -6,4 +6,4 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `merchant_account_id` | *str* | :heavy_check_mark: | The ID of the merchant account. | merchant-12345 |
-| `currency` | *OptionalNullable[str]* | :heavy_minus_sign: | ISO 4217 currency code (3 characters) to filter 3DS configurations. | USD |
\ No newline at end of file
+| `currency` | *OptionalNullable[str]* | :heavy_minus_sign: | ISO 4217 currency code (3 characters) to filter 3DS configurations. | **Example 1:** USD
**Example 2:** EUR
**Example 3:** GBP |
\ No newline at end of file
diff --git a/docs/models/merchantaccount.md b/docs/models/merchantaccount.md
index 5409eb0..dd12247 100644
--- a/docs/models/merchantaccount.md
+++ b/docs/models/merchantaccount.md
@@ -24,6 +24,6 @@
| `amex_network_tokens_app_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Application ID provided for American Express after onboarding to use Network Tokens. | id-12345 |
| `mastercard_network_tokens_requestor_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Requestor ID provided for Mastercard after onboarding to use Network Tokens. | id-12345 |
| `mastercard_network_tokens_app_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Application ID provided for Mastercard after onboarding to use Network Tokens. | id-12345 |
-| `async_network_tokens_enabled` | *Optional[bool]* | :heavy_minus_sign: | When enabled network tokens will be generated asynchronously and only used on subsequent transactions to speed up transaction processing. | true |
+| `async_network_tokens_enabled` | *Optional[bool]* | :heavy_minus_sign: | When enabled network tokens will be generated asynchronously and only used on subsequent transactions to speed up transaction processing. | **Example 1:** true
**Example 2:** false |
| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date this merchant account was created at. | 2013-07-16T19:23:00.000+00:00 |
| `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date this merchant account was last updated at. | 2013-07-16T19:23:00.000+00:00 |
\ No newline at end of file
diff --git a/docs/models/merchantaccountcreate.md b/docs/models/merchantaccountcreate.md
index 36a14ea..6b7c645 100644
--- a/docs/models/merchantaccountcreate.md
+++ b/docs/models/merchantaccountcreate.md
@@ -21,6 +21,6 @@
| `amex_network_tokens_app_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Application ID provided for American Express after onboarding to use Network Tokens. | id-12345 |
| `mastercard_network_tokens_requestor_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Requestor ID provided for Mastercard after onboarding to use Network Tokens. | id-12345 |
| `mastercard_network_tokens_app_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Application ID provided for Mastercard after onboarding to use Network Tokens. | id-12345 |
-| `async_network_tokens_enabled` | *Optional[bool]* | :heavy_minus_sign: | When enabled network tokens will be generated asynchronously and only used on subsequent transactions to speed up transaction processing. | true |
+| `async_network_tokens_enabled` | *Optional[bool]* | :heavy_minus_sign: | When enabled network tokens will be generated asynchronously and only used on subsequent transactions to speed up transaction processing. | **Example 1:** true
**Example 2:** false |
| `id` | *str* | :heavy_check_mark: | The ID for the merchant account. | merchant-12345 |
| `display_name` | *str* | :heavy_check_mark: | The display name for the merchant account. | Example |
\ No newline at end of file
diff --git a/docs/models/merchantaccountthreedsconfiguration.md b/docs/models/merchantaccountthreedsconfiguration.md
index 774bf34..2b525b0 100644
--- a/docs/models/merchantaccountthreedsconfiguration.md
+++ b/docs/models/merchantaccountthreedsconfiguration.md
@@ -17,5 +17,5 @@
| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date and time when this 3DS configuration was first created in our system. | 2013-07-16T19:23:00.000+00:00 |
| `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date and time when this 3DS configuration was last updated in our system. | 2013-07-16T19:23:00.000+00:00 |
| `scheme` | [models.CardScheme](../models/cardscheme.md) | :heavy_check_mark: | N/A | visa |
-| `currency` | *Nullable[str]* | :heavy_check_mark: | ISO 4217 currency code (3 characters). If null, the configuration applies to all currencies. | USD |
+| `currency` | *Nullable[str]* | :heavy_check_mark: | ISO 4217 currency code (3 characters). If null, the configuration applies to all currencies. | **Example 1:** USD
**Example 2:** EUR
**Example 3:** GBP |
| `metadata` | Dict[str, *str*] | :heavy_check_mark: | Additional information about the 3DS configuration, stored as key-value pairs. | |
\ No newline at end of file
diff --git a/docs/models/merchantaccountthreedsconfigurationcreate.md b/docs/models/merchantaccountthreedsconfigurationcreate.md
index daf9eec..8641014 100644
--- a/docs/models/merchantaccountthreedsconfigurationcreate.md
+++ b/docs/models/merchantaccountthreedsconfigurationcreate.md
@@ -12,5 +12,5 @@
| `merchant_category_code` | *str* | :heavy_check_mark: | Merchant category code to use when calling 3DS through this scheme. | 1234 |
| `merchant_url` | *str* | :heavy_check_mark: | URL to send when calling 3DS through this scheme. | https://example.com |
| `scheme` | [models.CardScheme](../models/cardscheme.md) | :heavy_check_mark: | N/A | visa |
-| `currency` | *OptionalNullable[str]* | :heavy_minus_sign: | ISO 4217 currency code (3 characters). If left null, the configuration will apply to all currencies. | USD |
+| `currency` | *OptionalNullable[str]* | :heavy_minus_sign: | ISO 4217 currency code (3 characters). If left null, the configuration will apply to all currencies. | **Example 1:** USD
**Example 2:** EUR
**Example 3:** GBP |
| `metadata` | Dict[str, *str*] | :heavy_check_mark: | Any additional information about the 3DS configuration that you would like to store as key-value pairs. | |
\ No newline at end of file
diff --git a/docs/models/merchantaccountthreedsconfigurationupdate.md b/docs/models/merchantaccountthreedsconfigurationupdate.md
index 4f28755..927d035 100644
--- a/docs/models/merchantaccountthreedsconfigurationupdate.md
+++ b/docs/models/merchantaccountthreedsconfigurationupdate.md
@@ -12,5 +12,5 @@
| `merchant_category_code` | *OptionalNullable[str]* | :heavy_minus_sign: | Merchant category code to use when calling 3DS through this scheme. | 1234 |
| `merchant_url` | *OptionalNullable[str]* | :heavy_minus_sign: | URL to send when calling 3DS through this scheme. | https://example.com |
| `scheme` | [OptionalNullable[models.CardScheme]](../models/cardscheme.md) | :heavy_minus_sign: | The card scheme for this 3DS configuration | visa |
-| `currency` | *OptionalNullable[str]* | :heavy_minus_sign: | ISO 4217 currency code (3 characters). If left null, the configuration will apply to all currencies. | USD |
+| `currency` | *OptionalNullable[str]* | :heavy_minus_sign: | ISO 4217 currency code (3 characters). If left null, the configuration will apply to all currencies. | **Example 1:** USD
**Example 2:** EUR
**Example 3:** GBP |
| `metadata` | Dict[str, *str*] | :heavy_minus_sign: | Any additional information about the 3DS configuration that you would like to store as key-value pairs. | |
\ No newline at end of file
diff --git a/docs/models/merchantaccountupdate.md b/docs/models/merchantaccountupdate.md
index 178a085..26ebda8 100644
--- a/docs/models/merchantaccountupdate.md
+++ b/docs/models/merchantaccountupdate.md
@@ -21,5 +21,5 @@
| `amex_network_tokens_app_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Application ID provided for American Express after onboarding to use Network Tokens. | id-12345 |
| `mastercard_network_tokens_requestor_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Requestor ID provided for Mastercard after onboarding to use Network Tokens. | id-12345 |
| `mastercard_network_tokens_app_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Application ID provided for Mastercard after onboarding to use Network Tokens. | id-12345 |
-| `async_network_tokens_enabled` | *Optional[bool]* | :heavy_minus_sign: | When enabled network tokens will be generated asynchronously and only used on subsequent transactions to speed up transaction processing. | true |
+| `async_network_tokens_enabled` | *Optional[bool]* | :heavy_minus_sign: | When enabled network tokens will be generated asynchronously and only used on subsequent transactions to speed up transaction processing. | **Example 1:** true
**Example 2:** false |
| `display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The display name for the merchant account. | Example |
\ No newline at end of file
diff --git a/docs/models/paymentlink.md b/docs/models/paymentlink.md
index bd29b47..835ce3c 100644
--- a/docs/models/paymentlink.md
+++ b/docs/models/paymentlink.md
@@ -3,36 +3,36 @@
## Fields
-| Field | Type | Required | Description | Example |
-| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
-| `id` | *str* | :heavy_check_mark: | The unique identifier for the payment link. | a1b2c3d4-5678-90ab-cdef-1234567890ab |
-| `type` | *Optional[Literal["payment-link"]]* | :heavy_minus_sign: | Always `payment-link`. | payment-link |
-| `url` | *str* | :heavy_check_mark: | The URL for the payment link. | https://example.com/link/a1b2c3d4-5678-90ab-cdef-1234567890ab |
-| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | The expiration date and time for the payment link. | 2024-06-01T00:00:00.000Z |
-| `external_identifier` | *OptionalNullable[str]* | :heavy_minus_sign: | The merchant reference for the payment link. | external-12345 |
-| `statement_descriptor` | [OptionalNullable[models.StatementDescriptor]](../models/statementdescriptor.md) | :heavy_minus_sign: | The statement descriptor for the payment link. | |
-| `locale` | *OptionalNullable[str]* | :heavy_minus_sign: | The locale for the payment link. | en |
-| `merchant_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The merchant's display name. | ACME Inc. |
-| `merchant_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The merchant's website URL. | https://merchant.example.com |
-| `merchant_banner_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The merchant's banner image URL. | https://merchant.example.com/banner.png |
-| `merchant_color` | *OptionalNullable[str]* | :heavy_minus_sign: | The merchant's brand color. | #FF5733 |
-| `merchant_message` | *OptionalNullable[str]* | :heavy_minus_sign: | A message from the merchant. | Thank you for your purchase! |
-| `merchant_terms_and_conditions_url` | *OptionalNullable[str]* | :heavy_minus_sign: | URL to the merchant's terms and conditions. | https://merchant.example.com/terms |
-| `merchant_favicon_url` | *OptionalNullable[str]* | :heavy_minus_sign: | URL to the merchant's favicon. | https://merchant.example.com/favicon.ico |
-| `amount` | *int* | :heavy_check_mark: | The amount for the payment link. | 1299 |
-| `country` | *str* | :heavy_check_mark: | The country code for the payment link. | DE |
-| `currency` | *str* | :heavy_check_mark: | The currency code for the payment link. | EUR |
-| `intent` | [models.TransactionIntent](../models/transactionintent.md) | :heavy_check_mark: | N/A | |
-| `return_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The return URL after payment completion. | https://merchant.example.com/return |
-| `cart_items` | List[[models.CartItem](../models/cartitem.md)] | :heavy_check_mark: | The cart items for the payment link. | [
{
"amount": {
"currency": "USD",
"value": 500
},
"name": "Widget",
"quantity": 2
}
] |
-| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Arbitrary metadata for the payment link. | {
"order_id": "ORD-12345"
} |
-| `payment_source` | [models.TransactionPaymentSource](../models/transactionpaymentsource.md) | :heavy_check_mark: | The way payment method information made it to this transaction. | |
-| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date and time the payment link was created. | 2024-05-30T12:34:56.000Z |
-| `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date and time the payment link was last updated. | 2024-05-30T13:00:00.000Z |
-| `status` | [models.PaymentLinkStatus](../models/paymentlinkstatus.md) | :heavy_check_mark: | N/A | |
-| `buyer` | [OptionalNullable[models.TransactionBuyer]](../models/transactionbuyer.md) | :heavy_minus_sign: | The buyer associated with the payment link. | |
-| `shipping_details` | [OptionalNullable[models.ShippingDetails]](../models/shippingdetails.md) | :heavy_minus_sign: | The shipping details for the payment link. | |
-| `connection_options` | Dict[str, Dict[str, *Any*]] | :heavy_minus_sign: | The connection options for the payment link. | |
-| `store` | *Optional[bool]* | :heavy_minus_sign: | Whether the payment method was stored. | |
-| `buyer_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the buyer to associate with the stored payment method. | a1b2c3d4-5678-90ab-cdef-1234567890ab |
-| `installment_count` | *OptionalNullable[int]* | :heavy_minus_sign: | The number of installments a buyer is required to make. | |
\ No newline at end of file
+| Field | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
+| `id` | *str* | :heavy_check_mark: | The unique identifier for the payment link. | a1b2c3d4-5678-90ab-cdef-1234567890ab |
+| `type` | *Optional[Literal["payment-link"]]* | :heavy_minus_sign: | Always `payment-link`. | payment-link |
+| `url` | *str* | :heavy_check_mark: | The URL for the payment link. | https://example.com/link/a1b2c3d4-5678-90ab-cdef-1234567890ab |
+| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | The expiration date and time for the payment link. | 2024-06-01T00:00:00.000Z |
+| `external_identifier` | *OptionalNullable[str]* | :heavy_minus_sign: | The merchant reference for the payment link. | external-12345 |
+| `statement_descriptor` | [OptionalNullable[models.StatementDescriptor]](../models/statementdescriptor.md) | :heavy_minus_sign: | The statement descriptor for the payment link. | |
+| `locale` | *OptionalNullable[str]* | :heavy_minus_sign: | The locale for the payment link. | **Example 1:** en
**Example 2:** en-GB
**Example 3:** pt
**Example 4:** pt-BR
**Example 5:** es |
+| `merchant_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The merchant's display name. | ACME Inc. |
+| `merchant_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The merchant's website URL. | https://merchant.example.com |
+| `merchant_banner_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The merchant's banner image URL. | https://merchant.example.com/banner.png |
+| `merchant_color` | *OptionalNullable[str]* | :heavy_minus_sign: | The merchant's brand color. | #FF5733 |
+| `merchant_message` | *OptionalNullable[str]* | :heavy_minus_sign: | A message from the merchant. | Thank you for your purchase! |
+| `merchant_terms_and_conditions_url` | *OptionalNullable[str]* | :heavy_minus_sign: | URL to the merchant's terms and conditions. | https://merchant.example.com/terms |
+| `merchant_favicon_url` | *OptionalNullable[str]* | :heavy_minus_sign: | URL to the merchant's favicon. | https://merchant.example.com/favicon.ico |
+| `amount` | *int* | :heavy_check_mark: | The amount for the payment link. | 1299 |
+| `country` | *str* | :heavy_check_mark: | The country code for the payment link. | **Example 1:** DE
**Example 2:** GB
**Example 3:** US |
+| `currency` | *str* | :heavy_check_mark: | The currency code for the payment link. | **Example 1:** EUR
**Example 2:** GBP
**Example 3:** USD |
+| `intent` | [models.TransactionIntent](../models/transactionintent.md) | :heavy_check_mark: | N/A | |
+| `return_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The return URL after payment completion. | https://merchant.example.com/return |
+| `cart_items` | List[[models.CartItem](../models/cartitem.md)] | :heavy_check_mark: | The cart items for the payment link. | [
{
"amount": {
"currency": "USD",
"value": 500
},
"name": "Widget",
"quantity": 2
}
] |
+| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Arbitrary metadata for the payment link. | {
"order_id": "ORD-12345"
} |
+| `payment_source` | [models.TransactionPaymentSource](../models/transactionpaymentsource.md) | :heavy_check_mark: | The way payment method information made it to this transaction. | |
+| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date and time the payment link was created. | 2024-05-30T12:34:56.000Z |
+| `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date and time the payment link was last updated. | 2024-05-30T13:00:00.000Z |
+| `status` | [models.PaymentLinkStatus](../models/paymentlinkstatus.md) | :heavy_check_mark: | N/A | |
+| `buyer` | [OptionalNullable[models.TransactionBuyer]](../models/transactionbuyer.md) | :heavy_minus_sign: | The buyer associated with the payment link. | |
+| `shipping_details` | [OptionalNullable[models.ShippingDetails]](../models/shippingdetails.md) | :heavy_minus_sign: | The shipping details for the payment link. | |
+| `connection_options` | Dict[str, Dict[str, *Any*]] | :heavy_minus_sign: | The connection options for the payment link. | |
+| `store` | *Optional[bool]* | :heavy_minus_sign: | Whether the payment method was stored. | |
+| `buyer_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the buyer to associate with the stored payment method. | a1b2c3d4-5678-90ab-cdef-1234567890ab |
+| `installment_count` | *OptionalNullable[int]* | :heavy_minus_sign: | The number of installments a buyer is required to make. | |
\ No newline at end of file
diff --git a/docs/models/paymentlinkcreate.md b/docs/models/paymentlinkcreate.md
index 546d9ec..b98d2bf 100644
--- a/docs/models/paymentlinkcreate.md
+++ b/docs/models/paymentlinkcreate.md
@@ -10,7 +10,7 @@
| `connection_options` | [OptionalNullable[models.TransactionConnectionOptions]](../models/transactionconnectionoptions.md) | :heavy_minus_sign: | Connection options for the payment link. | |
| `external_identifier` | *OptionalNullable[str]* | :heavy_minus_sign: | The merchant reference for the payment link. | external-12345 |
| `statement_descriptor` | [OptionalNullable[models.StatementDescriptor]](../models/statementdescriptor.md) | :heavy_minus_sign: | The statement descriptor for the payment link. | |
-| `locale` | *OptionalNullable[str]* | :heavy_minus_sign: | The locale for the payment link. | en |
+| `locale` | *OptionalNullable[str]* | :heavy_minus_sign: | The locale for the payment link. | **Example 1:** en
**Example 2:** en-GB
**Example 3:** pt
**Example 4:** pt-BR
**Example 5:** es |
| `merchant_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The merchant's display name. | ACME Inc. |
| `merchant_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The merchant's website URL. | https://merchant.example.com |
| `merchant_banner_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The merchant's banner image URL. | https://merchant.example.com/banner.png |
@@ -19,8 +19,8 @@
| `merchant_terms_and_conditions_url` | *OptionalNullable[str]* | :heavy_minus_sign: | URL to the merchant's terms and conditions. | https://merchant.example.com/terms |
| `merchant_favicon_url` | *OptionalNullable[str]* | :heavy_minus_sign: | URL to the merchant's favicon. | https://merchant.example.com/favicon.ico |
| `amount` | *int* | :heavy_check_mark: | The amount for the payment link. | 1299 |
-| `country` | *str* | :heavy_check_mark: | The country code for the payment link. | DE |
-| `currency` | *str* | :heavy_check_mark: | The currency code for the payment link. | EUR |
+| `country` | *str* | :heavy_check_mark: | The country code for the payment link. | **Example 1:** DE
**Example 2:** GB
**Example 3:** US |
+| `currency` | *str* | :heavy_check_mark: | The currency code for the payment link. | **Example 1:** EUR
**Example 2:** GBP
**Example 3:** USD |
| `intent` | [Optional[models.TransactionIntent]](../models/transactionintent.md) | :heavy_minus_sign: | N/A | |
| `return_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The return URL after payment completion. | https://merchant.example.com/return |
| `cart_items` | List[[models.CartItem](../models/cartitem.md)] | :heavy_minus_sign: | The cart items for the payment link. | |
diff --git a/docs/models/paymentservice.md b/docs/models/paymentservice.md
index 147b1ac..0458a55 100644
--- a/docs/models/paymentservice.md
+++ b/docs/models/paymentservice.md
@@ -9,7 +9,7 @@
| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | fffd152a-9532-4087-9a4f-de58754210f0 |
| `merchant_account_id` | *str* | :heavy_check_mark: | The ID of the merchant account this job belongs to. | default |
| `payment_service_definition_id` | *str* | :heavy_check_mark: | The definition ID of the service that has been configured. | stripe-card |
-| `active` | *Optional[bool]* | :heavy_minus_sign: | Defines if this payment service is currently active. | true |
+| `active` | *Optional[bool]* | :heavy_minus_sign: | Defines if this payment service is currently active. | **Example 1:** true
**Example 2:** false |
| `method` | [models.Method](../models/method.md) | :heavy_check_mark: | N/A | |
| `display_name` | *str* | :heavy_check_mark: | The display name for the payment service. | Stripe |
| `position` | *int* | :heavy_check_mark: | Deprecated field used to define the order in which to process payment services | 1 |
diff --git a/docs/models/paymentserviceconfiguration.md b/docs/models/paymentserviceconfiguration.md
index 031a83f..b167569 100644
--- a/docs/models/paymentserviceconfiguration.md
+++ b/docs/models/paymentserviceconfiguration.md
@@ -6,8 +6,8 @@
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `approval_ui_target` | [models.ApprovalTarget](../models/approvaltarget.md) | :heavy_check_mark: | N/A | any |
-| `approval_ui_height` | *str* | :heavy_check_mark: | Height of the approval interface in either pixels or view height (vh). | 100px |
-| `approval_ui_width` | *str* | :heavy_check_mark: | Width of the approval interface in either pixels or view width (vw). | 100px |
+| `approval_ui_height` | *str* | :heavy_check_mark: | Height of the approval interface in either pixels or view height (vh). | **Example 1:** 100px
**Example 2:** 50vh |
+| `approval_ui_width` | *str* | :heavy_check_mark: | Width of the approval interface in either pixels or view width (vw). | **Example 1:** 100px
**Example 2:** 50vw |
| `cart_items_limit` | *int* | :heavy_check_mark: | The maximum number of cart items supported by this connector before we will truncate the list. | 100 |
| `cart_items_required` | *bool* | :heavy_check_mark: | Defines if cart items are required by this connector. | true |
| `cart_items_should_match_amount` | *bool* | :heavy_check_mark: | Defines if the cart items sum value should match the transaction amount. | true |
\ No newline at end of file
diff --git a/docs/models/paymentservicecreate.md b/docs/models/paymentservicecreate.md
index 92856a9..cbf2a4c 100644
--- a/docs/models/paymentservicecreate.md
+++ b/docs/models/paymentservicecreate.md
@@ -14,7 +14,7 @@ Request body for activating a payment service
| `position` | *OptionalNullable[int]* | :heavy_minus_sign: | Deprecated field used to define the order in which to process payment services | 1 |
| `accepted_currencies` | List[*str*] | :heavy_check_mark: | A list of currencies for which this service is enabled, in ISO 4217 three-letter code format. | [
"USD",
"EUR",
"GBP"
] |
| `accepted_countries` | List[*str*] | :heavy_check_mark: | A list of countries for which this service is enabled, in ISO two-letter code format. | [
"US",
"DE",
"GB"
] |
-| `active` | *OptionalNullable[bool]* | :heavy_minus_sign: | Defines if this payment service is currently active. | true |
+| `active` | *OptionalNullable[bool]* | :heavy_minus_sign: | Defines if this payment service is currently active. | **Example 1:** true
**Example 2:** false |
| `three_d_secure_enabled` | *Optional[bool]* | :heavy_minus_sign: | Defines if this payment service has 3DS enabled. | true |
| `merchant_profile` | Dict[str, [Nullable[models.MerchantProfileScheme]](../models/merchantprofilescheme.md)] | :heavy_minus_sign: | An object containing a key for each supported card schemes, and for each key an object with the 3DS profile for this service for that scheme. | |
| `payment_method_tokenization_enabled` | *OptionalNullable[bool]* | :heavy_minus_sign: | Defines if this payment service support payment method tokenization. | true |
diff --git a/docs/models/paymentservicedefinition.md b/docs/models/paymentservicedefinition.md
index e275b5f..f1265e2 100644
--- a/docs/models/paymentservicedefinition.md
+++ b/docs/models/paymentservicedefinition.md
@@ -5,14 +5,14 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *str* | :heavy_check_mark: | The definition ID of the payment service that can be configured. This is the underlying provider followed by a dash followed by the method. | adyen-ideal |
+| `id` | *str* | :heavy_check_mark: | The definition ID of the payment service that can be configured. This is the underlying provider followed by a dash followed by the method. | **Example 1:** adyen-ideal
**Example 2:** stripe-card |
| `type` | *Optional[Literal["payment-service-definition"]]* | :heavy_minus_sign: | Always `payment-service-definition`. | payment-service-definition |
-| `display_name` | *str* | :heavy_check_mark: | A human friendly name for this service. | iDEAL |
+| `display_name` | *str* | :heavy_check_mark: | A human friendly name for this service. | **Example 1:** iDEAL
**Example 2:** Stripe |
| `method` | [models.Method](../models/method.md) | :heavy_check_mark: | N/A | |
| `fields` | List[[models.DefinitionField](../models/definitionfield.md)] | :heavy_check_mark: | A list of credentials and related fields which can be configured for this service. | |
| `reporting_fields` | List[[models.DefinitionField](../models/definitionfield.md)] | :heavy_check_mark: | A list of reporting fields which can be configured for this service. | |
| `supported_currencies` | List[*str*] | :heavy_check_mark: | A list of three-letter ISO currency codes that this service supports. | [
"USD",
"GBP",
"EUR",
"AUD"
] |
-| `supported_countries` | List[*str*] | :heavy_check_mark: | A list of two-letter ISO country codes that this service supports. | US |
+| `supported_countries` | List[*str*] | :heavy_check_mark: | A list of two-letter ISO country codes that this service supports. | **Example 1:** US
**Example 2:** GB
**Example 3:** DE
**Example 4:** AUD |
| `mode` | [models.Mode](../models/mode.md) | :heavy_check_mark: | N/A | card |
| `icon_url` | *OptionalNullable[str]* | :heavy_minus_sign: | An icon to display for the payment service. | https://example.com/icons/adyen-ideal.svg |
| `supported_features` | Dict[str, *bool*] | :heavy_check_mark: | Features supported by the payment service. | |
diff --git a/docs/models/paymentserviceupdate.md b/docs/models/paymentserviceupdate.md
index 2228f5c..66bc264 100644
--- a/docs/models/paymentserviceupdate.md
+++ b/docs/models/paymentserviceupdate.md
@@ -13,7 +13,7 @@ Request body for updating a Payment Service
| `position` | *OptionalNullable[int]* | :heavy_minus_sign: | Deprecated field used to define the order in which to process payment services | 1 |
| `accepted_currencies` | List[*str*] | :heavy_minus_sign: | A list of currencies for which this service is enabled, in ISO 4217 three-letter code format. | [
"USD",
"EUR",
"GBP"
] |
| `accepted_countries` | List[*str*] | :heavy_minus_sign: | A list of countries for which this service is enabled, in ISO two-letter code format. | [
"US",
"DE",
"GB"
] |
-| `active` | *OptionalNullable[bool]* | :heavy_minus_sign: | Defines if this payment service is currently active. | true |
+| `active` | *OptionalNullable[bool]* | :heavy_minus_sign: | Defines if this payment service is currently active. | **Example 1:** true
**Example 2:** false |
| `three_d_secure_enabled` | *OptionalNullable[bool]* | :heavy_minus_sign: | Defines if this payment service has 3DS enabled. | true |
| `merchant_profile` | Dict[str, [Nullable[models.MerchantProfileScheme]](../models/merchantprofilescheme.md)] | :heavy_minus_sign: | An object containing a key for each supported card schemes, and for each key an object with the 3DS profile for this service for that scheme. | |
| `payment_method_tokenization_enabled` | *OptionalNullable[bool]* | :heavy_minus_sign: | Defines if this payment service support payment method tokenization. | true |
diff --git a/docs/models/payoutcreate.md b/docs/models/payoutcreate.md
index 36b4a6b..5e10dae 100644
--- a/docs/models/payoutcreate.md
+++ b/docs/models/payoutcreate.md
@@ -10,7 +10,7 @@ Represents the data required to create a new payout.
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `amount` | *int* | :heavy_check_mark: | The monetary amount for this payout, in the smallest currency unit for the given currency, for example `1299` cents to create an authorization for $12.99. | 1299 |
-| `currency` | *str* | :heavy_check_mark: | The ISO-4217 currency code for this payout. | EUR |
+| `currency` | *str* | :heavy_check_mark: | The ISO-4217 currency code for this payout. | **Example 1:** EUR
**Example 2:** GBP
**Example 3:** USD |
| `payment_service_id` | *str* | :heavy_check_mark: | The ID of the payment service to use for the payout. | ed8bd87d-85ad-40cf-8e8f-007e21e55aad |
| `payment_method` | [models.PayoutCreatePaymentMethod](../models/payoutcreatepaymentmethod.md) | :heavy_check_mark: | The type of payment method to send funds too. | |
| `category` | [OptionalNullable[models.PayoutCategory]](../models/payoutcategory.md) | :heavy_minus_sign: | The type of payout to process. | online_gambling |
diff --git a/docs/models/payoutmerchant.md b/docs/models/payoutmerchant.md
index 8cc4e83..b977291 100644
--- a/docs/models/payoutmerchant.md
+++ b/docs/models/payoutmerchant.md
@@ -7,7 +7,7 @@
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| `name` | *str* | :heavy_check_mark: | The name of the merchant. | Acme Inc |
| `identification_number` | *str* | :heavy_check_mark: | Unique value which identifies a merchant for processing transactions, also known as a MID. | 12345 |
-| `phone_number` | *str* | :heavy_check_mark: | The phone number for the merchant which should be formatted according to the E164 number standard. | +14155552671 |
+| `phone_number` | *str* | :heavy_check_mark: | The phone number for the merchant which should be formatted according to the E164 number standard. | **Example 1:** +14155552671
**Example 2:** +442071838750 |
| `url` | *str* | :heavy_check_mark: | Merchant website URL. | https://example.com |
| `statement_descriptor` | *str* | :heavy_check_mark: | Value to explain charges or payments on bank statements. | Winnings |
| `merchant_category_code` | *str* | :heavy_check_mark: | Merchant classification for the type of goods or services it provides. | 123456 |
diff --git a/docs/models/payoutmerchantsummary.md b/docs/models/payoutmerchantsummary.md
index e7d603b..b68536f 100644
--- a/docs/models/payoutmerchantsummary.md
+++ b/docs/models/payoutmerchantsummary.md
@@ -12,7 +12,7 @@ Represents a summary of a merchant.
| `type` | *Optional[Literal["merchant"]]* | :heavy_minus_sign: | Always `merchant`. | merchant |
| `name` | *str* | :heavy_check_mark: | The name of the merchant. | Acme Inc |
| `identification_number` | *str* | :heavy_check_mark: | Unique value which identifies a merchant for processing transactions, also known as a MID. | 12345 |
-| `phone_number` | *str* | :heavy_check_mark: | The phone number for the merchant which should be formatted according to the E164 number standard. | +14155552671 |
+| `phone_number` | *str* | :heavy_check_mark: | The phone number for the merchant which should be formatted according to the E164 number standard. | **Example 1:** +14155552671
**Example 2:** +442071838750 |
| `url` | *str* | :heavy_check_mark: | Merchant website URL. | https://example.com |
| `statement_descriptor` | *OptionalNullable[str]* | :heavy_minus_sign: | Value to explain charges or payments on bank statements. | Winnings |
| `merchant_category_code` | *str* | :heavy_check_mark: | Merchant classification for the type of goods or services it provides. | 1234 |
diff --git a/docs/models/payoutsummary.md b/docs/models/payoutsummary.md
index 1c06530..7c9107a 100644
--- a/docs/models/payoutsummary.md
+++ b/docs/models/payoutsummary.md
@@ -15,7 +15,7 @@ Represents a summary of a payout.
| `buyer` | [OptionalNullable[models.TransactionBuyer]](../models/transactionbuyer.md) | :heavy_minus_sign: | The buyer used for this payout. | |
| `category` | [OptionalNullable[models.PayoutCategory]](../models/payoutcategory.md) | :heavy_minus_sign: | The type of payout to process. | online_gambling |
| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date this payout was created at. | 2013-07-16T19:23:00.000+00:00 |
-| `currency` | *str* | :heavy_check_mark: | A supported ISO-4217 currency code. | EUR |
+| `currency` | *str* | :heavy_check_mark: | A supported ISO-4217 currency code. | **Example 1:** EUR
**Example 2:** GBP
**Example 3:** USD |
| `external_identifier` | *OptionalNullable[str]* | :heavy_minus_sign: | The merchant identifier for this payout. | payout-12345 |
| `merchant` | [OptionalNullable[models.PayoutMerchantSummary]](../models/payoutmerchantsummary.md) | :heavy_minus_sign: | The merchant details associated to this payout. | |
| `merchant_account_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the merchant account this payout was created for. | default |
diff --git a/docs/models/paypalshippingoptionsitem.md b/docs/models/paypalshippingoptionsitem.md
index 14b9e60..3859606 100644
--- a/docs/models/paypalshippingoptionsitem.md
+++ b/docs/models/paypalshippingoptionsitem.md
@@ -6,7 +6,7 @@
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *str* | :heavy_check_mark: | A unique ID that identifies a payer-selected shipping option. | |
-| `label` | *str* | :heavy_check_mark: | A description that the payer sees, which helps them choose an appropriate shipping option. | Free Shipping |
+| `label` | *str* | :heavy_check_mark: | A description that the payer sees, which helps them choose an appropriate shipping option. | **Example 1:** Free Shipping
**Example 2:** USPS Priority Shipping
**Example 3:** Expédition prioritaire USPS
**Example 4:** USPS yōuxiān fā huò |
| `selected` | *bool* | :heavy_check_mark: | If the API request sets selected = true, it represents the shipping option that the payee or merchant expects to be pre-selected for the payer when they first view the shipping.options in the PayPal Checkout experience. Only one shipping.option can be set to selected=true. | |
-| `type` | [OptionalNullable[models.PaypalShippingOptionsItemType]](../models/paypalshippingoptionsitemtype.md) | :heavy_minus_sign: | A classification for the method of purchase fulfillment. | SHIPPING |
+| `type` | [OptionalNullable[models.PaypalShippingOptionsItemType]](../models/paypalshippingoptionsitemtype.md) | :heavy_minus_sign: | A classification for the method of purchase fulfillment. | **Example 1:** SHIPPING
**Example 2:** PICKUP
**Example 3:** PICKUP_IN_STORE
**Example 4:** PICKUP_FROM_PERSON |
| `amount` | [OptionalNullable[models.PaypalShippingOptionsItemAmount]](../models/paypalshippingoptionsitemamount.md) | :heavy_minus_sign: | The shipping cost for the selected option. | |
\ No newline at end of file
diff --git a/docs/models/paypalshippingoptionsitemamount.md b/docs/models/paypalshippingoptionsitemamount.md
index 3a9b236..731d5f1 100644
--- a/docs/models/paypalshippingoptionsitemamount.md
+++ b/docs/models/paypalshippingoptionsitemamount.md
@@ -3,7 +3,7 @@
## Fields
-| Field | Type | Required | Description | Example |
-| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
-| `currency_code` | *str* | :heavy_check_mark: | The three-character ISO currency code. | EUR |
-| `value` | *str* | :heavy_check_mark: | The amount value, which might include a decimal portion. | 10.00 |
\ No newline at end of file
+| Field | Type | Required | Description | Example |
+| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
+| `currency_code` | *str* | :heavy_check_mark: | The three-character ISO currency code. | **Example 1:** EUR
**Example 2:** GBP
**Example 3:** USD |
+| `value` | *str* | :heavy_check_mark: | The amount value, which might include a decimal portion. | 10.00 |
\ No newline at end of file
diff --git a/docs/models/redirectpaymentmethodcreate.md b/docs/models/redirectpaymentmethodcreate.md
index d9de294..9fc5693 100644
--- a/docs/models/redirectpaymentmethodcreate.md
+++ b/docs/models/redirectpaymentmethodcreate.md
@@ -7,10 +7,10 @@ Create a transaction for an APM/LPM that requires a redirect.
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
-| `method` | [models.RedirectPaymentMethodCreateMethod](../models/redirectpaymentmethodcreatemethod.md) | :heavy_check_mark: | The method to use, this can be any of the methods that support redirect requests. | paypal |
+| `method` | [models.RedirectPaymentMethodCreateMethod](../models/redirectpaymentmethodcreatemethod.md) | :heavy_check_mark: | The method to use, this can be any of the methods that support redirect requests. | **Example 1:** paypal
**Example 2:** zippay |
| `buyer_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The `id` of a stored buyer to use Use this instead of the `buyer_external_identifier`. | fe26475d-ec3e-4884-9553-f7356683f7f9 |
| `buyer_external_identifier` | *OptionalNullable[str]* | :heavy_minus_sign: | The `external_identifier` of a stored buyer to use. Use this instead of the `buyer_id`. | buyer-12345 |
-| `country` | *str* | :heavy_check_mark: | The 2-letter ISO code of the country to use this payment method for. This is used to select the payment service to use. | DE |
-| `currency` | *str* | :heavy_check_mark: | The ISO-4217 currency code to use this payment method for. This is used to select the payment service to use. | EUR |
+| `country` | *str* | :heavy_check_mark: | The 2-letter ISO code of the country to use this payment method for. This is used to select the payment service to use. | **Example 1:** DE
**Example 2:** GB
**Example 3:** US |
+| `currency` | *str* | :heavy_check_mark: | The ISO-4217 currency code to use this payment method for. This is used to select the payment service to use. | **Example 1:** EUR
**Example 2:** GBP
**Example 3:** USD |
| `redirect_url` | *str* | :heavy_check_mark: | The redirect URL to redirect a buyer to after they have authorized the payment method. | https://example.com/callback |
| `external_identifier` | *OptionalNullable[str]* | :heavy_minus_sign: | The merchant identifier for this payment method. | payment-method-12345 |
\ No newline at end of file
diff --git a/docs/models/refund.md b/docs/models/refund.md
index bc3eafa..acb9e1c 100644
--- a/docs/models/refund.md
+++ b/docs/models/refund.md
@@ -10,7 +10,7 @@
| `transaction_id` | *str* | :heavy_check_mark: | The ID of the transaction associated with this refund. | 7099948d-7286-47e4-aad8-b68f7eb44591 |
| `payment_service_refund_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The payment service's unique ID for the refund. | refund_xYqd43gySMtori |
| `status` | [models.RefundStatus](../models/refundstatus.md) | :heavy_check_mark: | N/A | |
-| `currency` | *str* | :heavy_check_mark: | The ISO 4217 currency code for this refund. Will always match that of the associated transaction. | EUR |
+| `currency` | *str* | :heavy_check_mark: | The ISO 4217 currency code for this refund. Will always match that of the associated transaction. | **Example 1:** EUR
**Example 2:** GBP
**Example 3:** USD |
| `amount` | *int* | :heavy_check_mark: | The amount of this refund, in the smallest currency unit (for example, cents or pence). | 1299 |
| `reason` | *OptionalNullable[str]* | :heavy_minus_sign: | The reason for this refund. Could be a multiline string. | Refund due to user request. |
| `target_type` | [models.RefundTargetType](../models/refundtargettype.md) | :heavy_check_mark: | N/A | |
diff --git a/docs/models/settlement.md b/docs/models/settlement.md
index b4740c1..7a5cf43 100644
--- a/docs/models/settlement.md
+++ b/docs/models/settlement.md
@@ -13,7 +13,7 @@ A settlement record for a transaction.
| `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date and time the record was last updated, in ISO 8601 format. | 2024-06-01T12:00:00.000Z |
| `posted_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date and time the record was posted, in ISO 8601 format. | 2024-06-01T12:00:00.000Z |
| `ingested_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date and time the record was ingested, in ISO 8601 format. | 2024-06-01T12:00:00.000Z |
-| `currency` | *str* | :heavy_check_mark: | ISO 4217 currency code. | EUR |
+| `currency` | *str* | :heavy_check_mark: | ISO 4217 currency code. | **Example 1:** EUR
**Example 2:** GBP
**Example 3:** USD |
| `amount` | *int* | :heavy_check_mark: | The total amount in the smallest currency unit (e.g. cents). | 1100 |
| `exchange_rate` | *OptionalNullable[float]* | :heavy_minus_sign: | The exchange rate, if applicable. | 1 |
| `commission` | *int* | :heavy_check_mark: | The commission amount deducted in the smallest currency unit. | 100 |
diff --git a/docs/models/threedsecurescenariooutcome.md b/docs/models/threedsecurescenariooutcome.md
index dac8bd9..edf612c 100644
--- a/docs/models/threedsecurescenariooutcome.md
+++ b/docs/models/threedsecurescenariooutcome.md
@@ -5,6 +5,6 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
-| `version` | *str* | :heavy_check_mark: | The version of 3DS which will be simulated. | 2.2.0 |
+| `version` | *str* | :heavy_check_mark: | The version of 3DS which will be simulated. | **Example 1:** 2.2.0
**Example 2:** 2.3.1 |
| `authentication` | [models.ThreeDSecureScenarioOutcomeAuthentication](../models/threedsecurescenariooutcomeauthentication.md) | :heavy_check_mark: | N/A | |
| `result` | [OptionalNullable[models.ThreeDSecureScenarioOutcomeResult]](../models/threedsecurescenariooutcomeresult.md) | :heavy_minus_sign: | 3DS result value. Required if authentication status is "C". | {
"transaction_status": "Y"
} |
\ No newline at end of file
diff --git a/docs/models/threedsecurescenariooutcomeauthentication.md b/docs/models/threedsecurescenariooutcomeauthentication.md
index e295b10..7b81d36 100644
--- a/docs/models/threedsecurescenariooutcomeauthentication.md
+++ b/docs/models/threedsecurescenariooutcomeauthentication.md
@@ -3,6 +3,6 @@
## Fields
-| Field | Type | Required | Description | Example |
-| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
-| `transaction_status` | [models.ThreeDSecureScenarioOutcomeAuthenticationTransactionStatus](../models/threedsecurescenariooutcomeauthenticationtransactionstatus.md) | :heavy_check_mark: | 3DS transaction status. | Y |
\ No newline at end of file
+| Field | Type | Required | Description | Example |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `transaction_status` | [models.ThreeDSecureScenarioOutcomeAuthenticationTransactionStatus](../models/threedsecurescenariooutcomeauthenticationtransactionstatus.md) | :heavy_check_mark: | 3DS transaction status. | **Example 1:** Y
**Example 2:** N
**Example 3:** A
**Example 4:** R
**Example 5:** U
**Example 6:** C
**Example 7:** timeout |
\ No newline at end of file
diff --git a/docs/models/threedsecurescenariooutcomeresult.md b/docs/models/threedsecurescenariooutcomeresult.md
index 8034028..4dd7502 100644
--- a/docs/models/threedsecurescenariooutcomeresult.md
+++ b/docs/models/threedsecurescenariooutcomeresult.md
@@ -5,4 +5,4 @@
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
-| `transaction_status` | [models.ThreeDSecureScenarioOutcomeResultTransactionStatus](../models/threedsecurescenariooutcomeresulttransactionstatus.md) | :heavy_check_mark: | 3DS result. | Y |
\ No newline at end of file
+| `transaction_status` | [models.ThreeDSecureScenarioOutcomeResultTransactionStatus](../models/threedsecurescenariooutcomeresulttransactionstatus.md) | :heavy_check_mark: | 3DS result. | **Example 1:** Y
**Example 2:** N
**Example 3:** timeout |
\ No newline at end of file
diff --git a/docs/models/transaction.md b/docs/models/transaction.md
index f79bd52..905adba 100644
--- a/docs/models/transaction.md
+++ b/docs/models/transaction.md
@@ -11,7 +11,7 @@ A full transaction resource.
| `id` | *str* | :heavy_check_mark: | The ID for the transaction. | 7099948d-7286-47e4-aad8-b68f7eb44591 |
| `reconciliation_id` | *str* | :heavy_check_mark: | The base62 encoded transaction ID. This represents a shorter version of this transaction's `id` which is sent to payment services, anti-fraud services, and other connectors. You can use this ID to reconcile a payment service's transaction against our system. This ID is sent instead of the transaction ID because not all services support 36 digit identifiers. | default |
| `merchant_account_id` | *str* | :heavy_check_mark: | The ID of the merchant account this transaction belongs to. | default |
-| `currency` | *str* | :heavy_check_mark: | The currency code for this transaction. | EUR |
+| `currency` | *str* | :heavy_check_mark: | The currency code for this transaction. | **Example 1:** EUR
**Example 2:** GBP
**Example 3:** USD |
| `amount` | *int* | :heavy_check_mark: | The total amount for this transaction across all funding sources including gift cards. | 1299 |
| `status` | [models.TransactionStatus](../models/transactionstatus.md) | :heavy_check_mark: | N/A | |
| `authorized_amount` | *int* | :heavy_check_mark: | The amount for this transaction that has been authorized for the `payment_method`. This can be less than the `amount` if gift cards were used. | 1299 |
@@ -64,7 +64,7 @@ A full transaction resource.
| `multi_tender` | *bool* | :heavy_check_mark: | The outcome of the original intent of a transaction. This allows you to understand if the intent of the transaction (e.g. `capture` or `authorize`) has been achieved when dealing with multiple payment instruments. | true |
| `account_funding_transaction` | *bool* | :heavy_check_mark: | Marks the transaction as an AFT. Requires the payment service to support this feature, and might `recipient` and `buyer` data | true |
| `recipient` | [OptionalNullable[models.Recipient]](../models/recipient.md) | :heavy_minus_sign: | The recipient of any account to account funding. For use with AFTs. | |
-| `merchant_advice_code` | *OptionalNullable[str]* | :heavy_minus_sign: | An optional merchant advice code which provides insight into the type of transaction or reason why the payment failed. | 02 |
+| `merchant_advice_code` | *OptionalNullable[str]* | :heavy_minus_sign: | An optional merchant advice code which provides insight into the type of transaction or reason why the payment failed. | **Example 1:** 02
**Example 2:** 21 |
| `installment_count` | *OptionalNullable[int]* | :heavy_minus_sign: | The number of installments for this transaction, if applicable. | 3 |
| `session_token` | *OptionalNullable[str]* | :heavy_minus_sign: | A session token that can be used to fetch session data for direct client integrations. | j3CZf9Eg6nUygMAVA6PXsVWGHiccj |
| `tax_amount` | *OptionalNullable[int]* | :heavy_minus_sign: | The sales tax amount for this transaction, represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` cents to create an authorization for `$12.99` | 1299 |
diff --git a/docs/models/transactioncreate.md b/docs/models/transactioncreate.md
index c60289a..77ba0cc 100644
--- a/docs/models/transactioncreate.md
+++ b/docs/models/transactioncreate.md
@@ -6,7 +6,7 @@
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `amount` | *int* | :heavy_check_mark: | The monetary amount for this transaction, in the smallest currency unit for the given currency, for example `1299` cents to create an authorization for `$12.99`. If the `intent` is set to `capture`, an amount greater than zero must be supplied. All gift card amounts are subtracted from this amount before the remainder is charged to the provided `payment_method`. | 1299 |
-| `currency` | *str* | :heavy_check_mark: | A supported ISO 4217 currency code. For redirect requests, this value must match the one specified for `currency` in `payment_method`. | EUR |
+| `currency` | *str* | :heavy_check_mark: | A supported ISO 4217 currency code. For redirect requests, this value must match the one specified for `currency` in `payment_method`. | **Example 1:** EUR
**Example 2:** GBP
**Example 3:** USD |
| `country` | *OptionalNullable[str]* | :heavy_minus_sign: | The 2-letter ISO code of the country where the transaction is processed. This is also used to filter the payment services that can process the transaction. If this value is provided for redirect requests and it's not `null`, it must match the one specified for `country` in `payment_method`. Otherwise, the value specified for `country` in `payment_method` will be assumed implicitly. | US |
| `payment_method` | [OptionalNullable[models.TransactionCreatePaymentMethod]](../models/transactioncreatepaymentmethod.md) | :heavy_minus_sign: | The optional payment method to use for this transaction. This field is required if no `gift_cards` have been added. | |
| `buyer` | [OptionalNullable[models.GuestBuyer]](../models/guestbuyer.md) | :heavy_minus_sign: | Guest buyer details provided inline rather than creating a buyer resource beforehand and using the `buyer_id` or `buyer_external_identifier` keys. No buyer resource will be created on Gr4vy when used. | |
diff --git a/docs/models/transactionsummary.md b/docs/models/transactionsummary.md
index d72001a..b68fe38 100644
--- a/docs/models/transactionsummary.md
+++ b/docs/models/transactionsummary.md
@@ -11,7 +11,7 @@ A transaction, summarised
| `id` | *str* | :heavy_check_mark: | The ID for the transaction. | 7099948d-7286-47e4-aad8-b68f7eb44591 |
| `reconciliation_id` | *str* | :heavy_check_mark: | The base62 encoded transaction ID. This represents a shorter version of this transaction's `id` which is sent to payment services, anti-fraud services, and other connectors. You can use this ID to reconcile a payment service's transaction against our system. This ID is sent instead of the transaction ID because not all services support 36 digit identifiers. | default |
| `merchant_account_id` | *str* | :heavy_check_mark: | The ID of the merchant account this transaction belongs to. | default |
-| `currency` | *str* | :heavy_check_mark: | The currency code for this transaction. | EUR |
+| `currency` | *str* | :heavy_check_mark: | The currency code for this transaction. | **Example 1:** EUR
**Example 2:** GBP
**Example 3:** USD |
| `amount` | *int* | :heavy_check_mark: | The total amount for this transaction across all funding sources including gift cards. | 1299 |
| `status` | [models.TransactionStatus](../models/transactionstatus.md) | :heavy_check_mark: | N/A | |
| `authorized_amount` | *int* | :heavy_check_mark: | The amount for this transaction that has been authorized for the `payment_method`. This can be less than the `amount` if gift cards were used. | 1299 |
diff --git a/docs/sdks/checkoutsessions/README.md b/docs/sdks/checkoutsessions/README.md
index 60aedf6..3714b4e 100644
--- a/docs/sdks/checkoutsessions/README.md
+++ b/docs/sdks/checkoutsessions/README.md
@@ -327,7 +327,7 @@ with Gr4vy(
| `buyer` | [OptionalNullable[models.GuestBuyer]](../../models/guestbuyer.md) | :heavy_minus_sign: | Provide buyer details for the transaction. No buyer resource will be created on Gr4vy when used. | |
| `airline` | [OptionalNullable[models.Airline]](../../models/airline.md) | :heavy_minus_sign: | The airline addendum data which describes the airline booking associated with this transaction. | |
| `amount` | *OptionalNullable[int]* | :heavy_minus_sign: | The total amount for this transaction. | |
-| `currency` | *OptionalNullable[str]* | :heavy_minus_sign: | The currency code for this transaction. | EUR |
+| `currency` | *OptionalNullable[str]* | :heavy_minus_sign: | The currency code for this transaction. | **Example 1:** EUR
**Example 2:** GBP
**Example 3:** USD |
| `payment_service_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The unique identifier of an existing payment service. When provided, the created transaction will be processed by the given payment service and any routing rules will be skipped. | |
| `expires_in` | *Optional[float]* | :heavy_minus_sign: | The time in seconds when this checkout session expires. | |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
diff --git a/docs/sdks/digitalwalletssdk/README.md b/docs/sdks/digitalwalletssdk/README.md
index 779b996..52292d7 100644
--- a/docs/sdks/digitalwalletssdk/README.md
+++ b/docs/sdks/digitalwalletssdk/README.md
@@ -44,7 +44,7 @@ with Gr4vy(
| `merchant_account_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the merchant account to use for this request. | default |
| `merchant_display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | |
| `merchant_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | |
-| `merchant_country_code` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | DE |
+| `merchant_country_code` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | **Example 1:** DE
**Example 2:** GB
**Example 3:** US |
| `domain_names` | List[*str*] | :heavy_minus_sign: | N/A | |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
@@ -260,7 +260,7 @@ with Gr4vy(
| `domain_names` | List[*str*] | :heavy_minus_sign: | N/A | |
| `merchant_display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | |
| `merchant_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | |
-| `merchant_country_code` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | DE |
+| `merchant_country_code` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | **Example 1:** DE
**Example 2:** GB
**Example 3:** US |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
diff --git a/docs/sdks/merchantaccountssdk/README.md b/docs/sdks/merchantaccountssdk/README.md
index 9749df9..335a078 100644
--- a/docs/sdks/merchantaccountssdk/README.md
+++ b/docs/sdks/merchantaccountssdk/README.md
@@ -110,7 +110,7 @@ with Gr4vy(
| `amex_network_tokens_app_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Application ID provided for American Express after onboarding to use Network Tokens. | id-12345 |
| `mastercard_network_tokens_requestor_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Requestor ID provided for Mastercard after onboarding to use Network Tokens. | id-12345 |
| `mastercard_network_tokens_app_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Application ID provided for Mastercard after onboarding to use Network Tokens. | id-12345 |
-| `async_network_tokens_enabled` | *Optional[bool]* | :heavy_minus_sign: | When enabled network tokens will be generated asynchronously and only used on subsequent transactions to speed up transaction processing. | true |
+| `async_network_tokens_enabled` | *Optional[bool]* | :heavy_minus_sign: | When enabled network tokens will be generated asynchronously and only used on subsequent transactions to speed up transaction processing. | **Example 1:** true
**Example 2:** false |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -231,7 +231,7 @@ with Gr4vy(
| `amex_network_tokens_app_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Application ID provided for American Express after onboarding to use Network Tokens. | id-12345 |
| `mastercard_network_tokens_requestor_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Requestor ID provided for Mastercard after onboarding to use Network Tokens. | id-12345 |
| `mastercard_network_tokens_app_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Application ID provided for Mastercard after onboarding to use Network Tokens. | id-12345 |
-| `async_network_tokens_enabled` | *Optional[bool]* | :heavy_minus_sign: | When enabled network tokens will be generated asynchronously and only used on subsequent transactions to speed up transaction processing. | true |
+| `async_network_tokens_enabled` | *Optional[bool]* | :heavy_minus_sign: | When enabled network tokens will be generated asynchronously and only used on subsequent transactions to speed up transaction processing. | **Example 1:** true
**Example 2:** false |
| `display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The display name for the merchant account. | Example |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
diff --git a/docs/sdks/paymentlinkssdk/README.md b/docs/sdks/paymentlinkssdk/README.md
index b69aac4..3a48841 100644
--- a/docs/sdks/paymentlinkssdk/README.md
+++ b/docs/sdks/paymentlinkssdk/README.md
@@ -38,15 +38,15 @@ with Gr4vy(
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `amount` | *int* | :heavy_check_mark: | The amount for the payment link. | 1299 |
-| `country` | *str* | :heavy_check_mark: | The country code for the payment link. | DE |
-| `currency` | *str* | :heavy_check_mark: | The currency code for the payment link. | EUR |
+| `country` | *str* | :heavy_check_mark: | The country code for the payment link. | **Example 1:** DE
**Example 2:** GB
**Example 3:** US |
+| `currency` | *str* | :heavy_check_mark: | The currency code for the payment link. | **Example 1:** EUR
**Example 2:** GBP
**Example 3:** USD |
| `merchant_account_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the merchant account to use for this request. | default |
| `buyer` | [OptionalNullable[models.GuestBuyer]](../../models/guestbuyer.md) | :heavy_minus_sign: | The guest buyer for the payment link. | |
| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | The expiration date and time for the payment link. | 2024-06-01T00:00:00.000Z |
| `connection_options` | [OptionalNullable[models.TransactionConnectionOptions]](../../models/transactionconnectionoptions.md) | :heavy_minus_sign: | Connection options for the payment link. | |
| `external_identifier` | *OptionalNullable[str]* | :heavy_minus_sign: | The merchant reference for the payment link. | external-12345 |
| `statement_descriptor` | [OptionalNullable[models.StatementDescriptor]](../../models/statementdescriptor.md) | :heavy_minus_sign: | The statement descriptor for the payment link. | |
-| `locale` | *OptionalNullable[str]* | :heavy_minus_sign: | The locale for the payment link. | en |
+| `locale` | *OptionalNullable[str]* | :heavy_minus_sign: | The locale for the payment link. | **Example 1:** en
**Example 2:** en-GB
**Example 3:** pt
**Example 4:** pt-BR
**Example 5:** es |
| `merchant_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The merchant's display name. | ACME Inc. |
| `merchant_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The merchant's website URL. | https://merchant.example.com |
| `merchant_banner_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The merchant's banner image URL. | https://merchant.example.com/banner.png |
diff --git a/docs/sdks/paymentservicessdk/README.md b/docs/sdks/paymentservicessdk/README.md
index 5609d06..3b5f1a2 100644
--- a/docs/sdks/paymentservicessdk/README.md
+++ b/docs/sdks/paymentservicessdk/README.md
@@ -124,7 +124,7 @@ with Gr4vy(
| `merchant_account_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the merchant account to use for this request. | default |
| `reporting_fields` | List[[models.FieldT](../../models/fieldt.md)] | :heavy_minus_sign: | The non-secret reporting fields that have been configured for this payment service. Any secret fields are omitted. | |
| `position` | *OptionalNullable[int]* | :heavy_minus_sign: | Deprecated field used to define the order in which to process payment services | 1 |
-| `active` | *OptionalNullable[bool]* | :heavy_minus_sign: | Defines if this payment service is currently active. | true |
+| `active` | *OptionalNullable[bool]* | :heavy_minus_sign: | Defines if this payment service is currently active. | **Example 1:** true
**Example 2:** false |
| `three_d_secure_enabled` | *Optional[bool]* | :heavy_minus_sign: | Defines if this payment service has 3DS enabled. | true |
| `merchant_profile` | Dict[str, [Nullable[models.MerchantProfileScheme]](../../models/merchantprofilescheme.md)] | :heavy_minus_sign: | An object containing a key for each supported card schemes, and for each key an object with the 3DS profile for this service for that scheme. | |
| `payment_method_tokenization_enabled` | *OptionalNullable[bool]* | :heavy_minus_sign: | Defines if this payment service support payment method tokenization. | true |
@@ -245,7 +245,7 @@ with Gr4vy(
| `position` | *OptionalNullable[int]* | :heavy_minus_sign: | Deprecated field used to define the order in which to process payment services | 1 |
| `accepted_currencies` | List[*str*] | :heavy_minus_sign: | A list of currencies for which this service is enabled, in ISO 4217 three-letter code format. | [
"USD",
"EUR",
"GBP"
] |
| `accepted_countries` | List[*str*] | :heavy_minus_sign: | A list of countries for which this service is enabled, in ISO two-letter code format. | [
"US",
"DE",
"GB"
] |
-| `active` | *OptionalNullable[bool]* | :heavy_minus_sign: | Defines if this payment service is currently active. | true |
+| `active` | *OptionalNullable[bool]* | :heavy_minus_sign: | Defines if this payment service is currently active. | **Example 1:** true
**Example 2:** false |
| `three_d_secure_enabled` | *OptionalNullable[bool]* | :heavy_minus_sign: | Defines if this payment service has 3DS enabled. | true |
| `merchant_profile` | Dict[str, [Nullable[models.MerchantProfileScheme]](../../models/merchantprofilescheme.md)] | :heavy_minus_sign: | An object containing a key for each supported card schemes, and for each key an object with the 3DS profile for this service for that scheme. | |
| `payment_method_tokenization_enabled` | *OptionalNullable[bool]* | :heavy_minus_sign: | Defines if this payment service support payment method tokenization. | true |
diff --git a/docs/sdks/payouts/README.md b/docs/sdks/payouts/README.md
index 4078d7e..8ec76ec 100644
--- a/docs/sdks/payouts/README.md
+++ b/docs/sdks/payouts/README.md
@@ -97,7 +97,7 @@ with Gr4vy(
| Parameter | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `amount` | *int* | :heavy_check_mark: | The monetary amount for this payout, in the smallest currency unit for the given currency, for example `1299` cents to create an authorization for $12.99. | 1299 |
-| `currency` | *str* | :heavy_check_mark: | The ISO-4217 currency code for this payout. | EUR |
+| `currency` | *str* | :heavy_check_mark: | The ISO-4217 currency code for this payout. | **Example 1:** EUR
**Example 2:** GBP
**Example 3:** USD |
| `payment_service_id` | *str* | :heavy_check_mark: | The ID of the payment service to use for the payout. | ed8bd87d-85ad-40cf-8e8f-007e21e55aad |
| `payment_method` | [models.PayoutCreatePaymentMethod](../../models/payoutcreatepaymentmethod.md) | :heavy_check_mark: | The type of payment method to send funds too. | |
| `merchant_account_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the merchant account to use for this request. | default |
diff --git a/docs/sdks/threedsconfiguration/README.md b/docs/sdks/threedsconfiguration/README.md
index 2c30913..9f060a0 100644
--- a/docs/sdks/threedsconfiguration/README.md
+++ b/docs/sdks/threedsconfiguration/README.md
@@ -49,7 +49,7 @@ with Gr4vy(
| `merchant_url` | *str* | :heavy_check_mark: | URL to send when calling 3DS through this scheme. | https://example.com |
| `scheme` | [models.CardScheme](../../models/cardscheme.md) | :heavy_check_mark: | N/A | visa |
| `metadata` | Dict[str, *str*] | :heavy_check_mark: | Any additional information about the 3DS configuration that you would like to store as key-value pairs. | |
-| `currency` | *OptionalNullable[str]* | :heavy_minus_sign: | ISO 4217 currency code (3 characters). If left null, the configuration will apply to all currencies. | USD |
+| `currency` | *OptionalNullable[str]* | :heavy_minus_sign: | ISO 4217 currency code (3 characters). If left null, the configuration will apply to all currencies. | **Example 1:** USD
**Example 2:** EUR
**Example 3:** GBP |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -102,7 +102,7 @@ with Gr4vy(
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `merchant_account_id` | *str* | :heavy_check_mark: | The ID of the merchant account. | merchant-12345 |
-| `currency` | *OptionalNullable[str]* | :heavy_minus_sign: | ISO 4217 currency code (3 characters) to filter 3DS configurations. | USD |
+| `currency` | *OptionalNullable[str]* | :heavy_minus_sign: | ISO 4217 currency code (3 characters) to filter 3DS configurations. | **Example 1:** USD
**Example 2:** EUR
**Example 3:** GBP |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -163,7 +163,7 @@ with Gr4vy(
| `merchant_category_code` | *OptionalNullable[str]* | :heavy_minus_sign: | Merchant category code to use when calling 3DS through this scheme. | 1234 |
| `merchant_url` | *OptionalNullable[str]* | :heavy_minus_sign: | URL to send when calling 3DS through this scheme. | https://example.com |
| `scheme` | [OptionalNullable[models.CardScheme]](../../models/cardscheme.md) | :heavy_minus_sign: | The card scheme for this 3DS configuration | visa |
-| `currency` | *OptionalNullable[str]* | :heavy_minus_sign: | ISO 4217 currency code (3 characters). If left null, the configuration will apply to all currencies. | USD |
+| `currency` | *OptionalNullable[str]* | :heavy_minus_sign: | ISO 4217 currency code (3 characters). If left null, the configuration will apply to all currencies. | **Example 1:** USD
**Example 2:** EUR
**Example 3:** GBP |
| `metadata` | Dict[str, *str*] | :heavy_minus_sign: | Any additional information about the 3DS configuration that you would like to store as key-value pairs. | |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
diff --git a/docs/sdks/transactions/README.md b/docs/sdks/transactions/README.md
index 6273873..8271182 100644
--- a/docs/sdks/transactions/README.md
+++ b/docs/sdks/transactions/README.md
@@ -172,7 +172,7 @@ with Gr4vy(
| Parameter | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `amount` | *int* | :heavy_check_mark: | The monetary amount for this transaction, in the smallest currency unit for the given currency, for example `1299` cents to create an authorization for `$12.99`. If the `intent` is set to `capture`, an amount greater than zero must be supplied. All gift card amounts are subtracted from this amount before the remainder is charged to the provided `payment_method`. | 1299 |
-| `currency` | *str* | :heavy_check_mark: | A supported ISO 4217 currency code. For redirect requests, this value must match the one specified for `currency` in `payment_method`. | EUR |
+| `currency` | *str* | :heavy_check_mark: | A supported ISO 4217 currency code. For redirect requests, this value must match the one specified for `currency` in `payment_method`. | **Example 1:** EUR
**Example 2:** GBP
**Example 3:** USD |
| `merchant_account_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the merchant account to use for this request. | default |
| `idempotency_key` | *OptionalNullable[str]* | :heavy_minus_sign: | A unique key that identifies this request. Providing this header will make this an idempotent request. We recommend using V4 UUIDs, or another random string with enough entropy to avoid collisions. | request-12345 |
| `x_forwarded_for` | *Optional[str]* | :heavy_minus_sign: | The IP address to forward from the customer. Use this when calling
our API from the server side to ensure the customer's address is
passed to downstream services, rather than your server IP. | 192.168.0.2 |
diff --git a/pyproject.toml b/pyproject.toml
index 4e508ce..ddb52e3 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,7 +1,7 @@
[project]
name = "gr4vy"
-version = "2.0.0"
+version = "2.0.1"
description = "Python Client SDK Generated by Speakeasy."
authors = [{ name = "Gr4vy" },]
readme = "README-PYPI.md"
diff --git a/src/gr4vy/_version.py b/src/gr4vy/_version.py
index bf64007..0e910cd 100644
--- a/src/gr4vy/_version.py
+++ b/src/gr4vy/_version.py
@@ -3,10 +3,10 @@
import importlib.metadata
__title__: str = "gr4vy"
-__version__: str = "2.0.0"
+__version__: str = "2.0.1"
__openapi_doc_version__: str = "1.0.0"
-__gen_version__: str = "2.803.3"
-__user_agent__: str = "speakeasy-sdk/python 2.0.0 2.803.3 1.0.0 gr4vy"
+__gen_version__: str = "2.821.6"
+__user_agent__: str = "speakeasy-sdk/python 2.0.1 2.821.6 1.0.0 gr4vy"
try:
if __package__ is not None:
diff --git a/src/gr4vy/utils/eventstreaming.py b/src/gr4vy/utils/eventstreaming.py
index 0969899..f2052fc 100644
--- a/src/gr4vy/utils/eventstreaming.py
+++ b/src/gr4vy/utils/eventstreaming.py
@@ -2,7 +2,9 @@
import re
import json
+from dataclasses import dataclass, asdict
from typing import (
+ Any,
Callable,
Generic,
TypeVar,
@@ -22,6 +24,7 @@ class EventStream(Generic[T]):
client_ref: Optional[object]
response: httpx.Response
generator: Generator[T, None, None]
+ _closed: bool
def __init__(
self,
@@ -33,17 +36,21 @@ def __init__(
self.response = response
self.generator = stream_events(response, decoder, sentinel)
self.client_ref = client_ref
+ self._closed = False
def __iter__(self):
return self
def __next__(self):
+ if self._closed:
+ raise StopIteration
return next(self.generator)
def __enter__(self):
return self
def __exit__(self, exc_type, exc_val, exc_tb):
+ self._closed = True
self.response.close()
@@ -53,6 +60,7 @@ class EventStreamAsync(Generic[T]):
client_ref: Optional[object]
response: httpx.Response
generator: AsyncGenerator[T, None]
+ _closed: bool
def __init__(
self,
@@ -64,33 +72,45 @@ def __init__(
self.response = response
self.generator = stream_events_async(response, decoder, sentinel)
self.client_ref = client_ref
+ self._closed = False
def __aiter__(self):
return self
async def __anext__(self):
+ if self._closed:
+ raise StopAsyncIteration
return await self.generator.__anext__()
async def __aenter__(self):
return self
async def __aexit__(self, exc_type, exc_val, exc_tb):
+ self._closed = True
await self.response.aclose()
+@dataclass
class ServerEvent:
id: Optional[str] = None
event: Optional[str] = None
- data: Optional[str] = None
+ data: Any = None
retry: Optional[int] = None
MESSAGE_BOUNDARIES = [
b"\r\n\r\n",
- b"\n\n",
+ b"\r\n\r",
+ b"\r\n\n",
+ b"\r\r\n",
+ b"\n\r\n",
b"\r\r",
+ b"\n\r",
+ b"\n\n",
]
+UTF8_BOM = b"\xef\xbb\xbf"
+
async def stream_events_async(
response: httpx.Response,
@@ -99,14 +119,10 @@ async def stream_events_async(
) -> AsyncGenerator[T, None]:
buffer = bytearray()
position = 0
- discard = False
+ event_id: Optional[str] = None
async for chunk in response.aiter_bytes():
- # We've encountered the sentinel value and should no longer process
- # incoming data. Instead we throw new data away until the server closes
- # the connection.
- if discard:
- continue
-
+ if len(buffer) == 0 and chunk.startswith(UTF8_BOM):
+ chunk = chunk[len(UTF8_BOM) :]
buffer += chunk
for i in range(position, len(buffer)):
char = buffer[i : i + 1]
@@ -121,15 +137,22 @@ async def stream_events_async(
block = buffer[position:i]
position = i + len(seq)
- event, discard = _parse_event(block, decoder, sentinel)
+ event, discard, event_id = _parse_event(
+ raw=block, decoder=decoder, sentinel=sentinel, event_id=event_id
+ )
if event is not None:
yield event
+ if discard:
+ await response.aclose()
+ return
if position > 0:
buffer = buffer[position:]
position = 0
- event, discard = _parse_event(buffer, decoder, sentinel)
+ event, discard, _ = _parse_event(
+ raw=buffer, decoder=decoder, sentinel=sentinel, event_id=event_id
+ )
if event is not None:
yield event
@@ -141,14 +164,10 @@ def stream_events(
) -> Generator[T, None, None]:
buffer = bytearray()
position = 0
- discard = False
+ event_id: Optional[str] = None
for chunk in response.iter_bytes():
- # We've encountered the sentinel value and should no longer process
- # incoming data. Instead we throw new data away until the server closes
- # the connection.
- if discard:
- continue
-
+ if len(buffer) == 0 and chunk.startswith(UTF8_BOM):
+ chunk = chunk[len(UTF8_BOM) :]
buffer += chunk
for i in range(position, len(buffer)):
char = buffer[i : i + 1]
@@ -163,22 +182,33 @@ def stream_events(
block = buffer[position:i]
position = i + len(seq)
- event, discard = _parse_event(block, decoder, sentinel)
+ event, discard, event_id = _parse_event(
+ raw=block, decoder=decoder, sentinel=sentinel, event_id=event_id
+ )
if event is not None:
yield event
+ if discard:
+ response.close()
+ return
if position > 0:
buffer = buffer[position:]
position = 0
- event, discard = _parse_event(buffer, decoder, sentinel)
+ event, discard, _ = _parse_event(
+ raw=buffer, decoder=decoder, sentinel=sentinel, event_id=event_id
+ )
if event is not None:
yield event
def _parse_event(
- raw: bytearray, decoder: Callable[[str], T], sentinel: Optional[str] = None
-) -> Tuple[Optional[T], bool]:
+ *,
+ raw: bytearray,
+ decoder: Callable[[str], T],
+ sentinel: Optional[str] = None,
+ event_id: Optional[str] = None,
+) -> Tuple[Optional[T], bool, Optional[str]]:
block = raw.decode()
lines = re.split(r"\r?\n|\r", block)
publish = False
@@ -189,13 +219,16 @@ def _parse_event(
continue
delim = line.find(":")
- if delim <= 0:
+ if delim == 0:
continue
- field = line[0:delim]
- value = line[delim + 1 :] if delim < len(line) - 1 else ""
- if len(value) and value[0] == " ":
- value = value[1:]
+ field = line
+ value = ""
+ if delim > 0:
+ field = line[0:delim]
+ value = line[delim + 1 :] if delim < len(line) - 1 else ""
+ if len(value) and value[0] == " ":
+ value = value[1:]
if field == "event":
event.event = value
@@ -204,37 +237,36 @@ def _parse_event(
data += value + "\n"
publish = True
elif field == "id":
- event.id = value
publish = True
+ if "\x00" not in value:
+ event_id = value
elif field == "retry":
- event.retry = int(value) if value.isdigit() else None
+ if value.isdigit():
+ event.retry = int(value)
publish = True
+ event.id = event_id
+
if sentinel and data == f"{sentinel}\n":
- return None, True
+ return None, True, event_id
if data:
data = data[:-1]
- event.data = data
-
- data_is_primitive = (
- data.isnumeric() or data == "true" or data == "false" or data == "null"
- )
- data_is_json = (
- data.startswith("{") or data.startswith("[") or data.startswith('"')
- )
-
- if data_is_primitive or data_is_json:
- try:
- event.data = json.loads(data)
- except Exception:
- pass
+ try:
+ event.data = json.loads(data)
+ except json.JSONDecodeError:
+ event.data = data
out = None
if publish:
- out = decoder(json.dumps(event.__dict__))
-
- return out, False
+ out_dict = {
+ k: v
+ for k, v in asdict(event).items()
+ if v is not None or (k == "data" and data)
+ }
+ out = decoder(json.dumps(out_dict))
+
+ return out, False, event_id
def _peek_sequence(position: int, buffer: bytearray, sequence: bytes):
diff --git a/src/gr4vy/utils/security.py b/src/gr4vy/utils/security.py
index dd52aab..7ae8c44 100644
--- a/src/gr4vy/utils/security.py
+++ b/src/gr4vy/utils/security.py
@@ -153,6 +153,8 @@ def _parse_security_scheme_value(
elif scheme_type == "http":
if sub_type == "bearer":
headers[header_name] = _apply_bearer(value)
+ elif sub_type == "basic":
+ headers[header_name] = value
elif sub_type == "custom":
return
else: