chore: improve payment provider tsdocs + generate reference

[shahednasser]

Closes DX-1233

[changeset-bot]

⚠️ No Changeset found

Latest commit: 7694eed

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
api-reference	🔄 Building (Inspect)	Visit Preview	💬 Add feedback	Dec 26, 2024 11:42am
medusa-dashboard	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 26, 2024 11:42am

5 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
api-reference-v2	⬜️ Ignored (Inspect)	Visit Preview		Dec 26, 2024 11:42am
docs-ui	⬜️ Ignored (Inspect)	Visit Preview		Dec 26, 2024 11:42am
docs-v2	⬜️ Ignored (Inspect)	Visit Preview		Dec 26, 2024 11:42am
medusa-docs	⬜️ Ignored (Inspect)	Visit Preview		Dec 26, 2024 11:42am
resources-docs	⬜️ Ignored (Inspect)	Visit Preview		Dec 26, 2024 11:42am