Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Singleton retrieve method now requires params to be passed as the first argument #1417

Merged

Conversation

prathmesh-stripe
Copy link
Contributor

@prathmesh-stripe prathmesh-stripe commented Jun 14, 2024

Changelog

  • Singleton retrieve method now requires params to be passed as the first argument. Existing calls to singleton retrieve method with only opts argument will have to be updated to account for the addition of params argument.
params = { expand: ["available"] }
opts = { stripe_account: "acct_123" }

# ❌ No longer works
Stripe::Balance.retrieve(opts)

# ✅ Correct way to call retrieve method
Stripe::Balance.retrieve(params, opts)

@ramya-stripe
Copy link
Contributor

Both the PR title and the changelog entry the description appear in the final changelog. Can we tweak them to have more clarity from a users perspective? Perhaps also include code snippets for before and after?

@prathmesh-stripe prathmesh-stripe changed the title Fixed support for passing params and options to retrieve methods Singleton retrieve method now require params to be passed as the first argument Jun 14, 2024
@prathmesh-stripe prathmesh-stripe changed the title Singleton retrieve method now require params to be passed as the first argument Singleton retrieve method now requires params to be passed as the first argument Jun 14, 2024
@prathmesh-stripe
Copy link
Contributor Author

@ramya-stripe what do you think about the updated title and changelog?

@ramya-stripe
Copy link
Contributor

Looks good, thanks!

@prathmesh-stripe prathmesh-stripe merged commit 7c73679 into sdk-release/next-major Jun 14, 2024
14 checks passed
@prathmesh-stripe prathmesh-stripe deleted the prathmesh_fix_params_opts_in_retrieve branch June 14, 2024 23:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants