@whop/sdk 0.0.26 → 0.0.28
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +78 -0
- package/client.d.mts +10 -9
- package/client.d.mts.map +1 -1
- package/client.d.ts +10 -9
- package/client.d.ts.map +1 -1
- package/client.js +16 -2
- package/client.js.map +1 -1
- package/client.mjs +16 -2
- package/client.mjs.map +1 -1
- package/package.json +3 -3
- package/resources/access-tokens.d.mts +34 -54
- package/resources/access-tokens.d.mts.map +1 -1
- package/resources/access-tokens.d.ts +34 -54
- package/resources/access-tokens.d.ts.map +1 -1
- package/resources/access-tokens.js +6 -8
- package/resources/access-tokens.js.map +1 -1
- package/resources/access-tokens.mjs +6 -8
- package/resources/access-tokens.mjs.map +1 -1
- package/resources/account-links.d.mts +15 -13
- package/resources/account-links.d.mts.map +1 -1
- package/resources/account-links.d.ts +15 -13
- package/resources/account-links.d.ts.map +1 -1
- package/resources/account-links.js +2 -3
- package/resources/account-links.js.map +1 -1
- package/resources/account-links.mjs +2 -3
- package/resources/account-links.mjs.map +1 -1
- package/resources/ai-chats.d.mts +70 -30
- package/resources/ai-chats.d.mts.map +1 -1
- package/resources/ai-chats.d.ts +70 -30
- package/resources/ai-chats.d.ts.map +1 -1
- package/resources/ai-chats.js +6 -6
- package/resources/ai-chats.js.map +1 -1
- package/resources/ai-chats.mjs +6 -6
- package/resources/ai-chats.mjs.map +1 -1
- package/resources/app-builds.d.mts +37 -35
- package/resources/app-builds.d.mts.map +1 -1
- package/resources/app-builds.d.ts +37 -35
- package/resources/app-builds.d.ts.map +1 -1
- package/resources/app-builds.js +7 -4
- package/resources/app-builds.js.map +1 -1
- package/resources/app-builds.mjs +7 -4
- package/resources/app-builds.mjs.map +1 -1
- package/resources/apps.d.mts +86 -60
- package/resources/apps.d.mts.map +1 -1
- package/resources/apps.d.ts +86 -60
- package/resources/apps.d.ts.map +1 -1
- package/resources/apps.js +7 -4
- package/resources/apps.js.map +1 -1
- package/resources/apps.mjs +7 -4
- package/resources/apps.mjs.map +1 -1
- package/resources/authorized-users.d.mts +38 -32
- package/resources/authorized-users.d.mts.map +1 -1
- package/resources/authorized-users.d.ts +38 -32
- package/resources/authorized-users.d.ts.map +1 -1
- package/resources/authorized-users.js +3 -2
- package/resources/authorized-users.js.map +1 -1
- package/resources/authorized-users.mjs +3 -2
- package/resources/authorized-users.mjs.map +1 -1
- package/resources/chat-channels.d.mts +28 -20
- package/resources/chat-channels.d.mts.map +1 -1
- package/resources/chat-channels.d.ts +28 -20
- package/resources/chat-channels.d.ts.map +1 -1
- package/resources/chat-channels.js +5 -3
- package/resources/chat-channels.js.map +1 -1
- package/resources/chat-channels.mjs +5 -3
- package/resources/chat-channels.mjs.map +1 -1
- package/resources/checkout-configurations.d.mts +75 -58
- package/resources/checkout-configurations.d.mts.map +1 -1
- package/resources/checkout-configurations.d.ts +75 -58
- package/resources/checkout-configurations.d.ts.map +1 -1
- package/resources/checkout-configurations.js +3 -2
- package/resources/checkout-configurations.js.map +1 -1
- package/resources/checkout-configurations.mjs +3 -2
- package/resources/checkout-configurations.mjs.map +1 -1
- package/resources/companies.d.mts +88 -56
- package/resources/companies.d.mts.map +1 -1
- package/resources/companies.d.ts +88 -56
- package/resources/companies.d.ts.map +1 -1
- package/resources/companies.js +9 -7
- package/resources/companies.js.map +1 -1
- package/resources/companies.mjs +9 -7
- package/resources/companies.mjs.map +1 -1
- package/resources/company-token-transactions.d.mts +90 -67
- package/resources/company-token-transactions.d.mts.map +1 -1
- package/resources/company-token-transactions.d.ts +90 -67
- package/resources/company-token-transactions.d.ts.map +1 -1
- package/resources/company-token-transactions.js +6 -3
- package/resources/company-token-transactions.js.map +1 -1
- package/resources/company-token-transactions.mjs +6 -3
- package/resources/company-token-transactions.mjs.map +1 -1
- package/resources/course-chapters.d.mts +27 -22
- package/resources/course-chapters.d.mts.map +1 -1
- package/resources/course-chapters.d.ts +27 -22
- package/resources/course-chapters.d.ts.map +1 -1
- package/resources/course-chapters.js +5 -5
- package/resources/course-chapters.mjs +5 -5
- package/resources/course-lesson-interactions.d.mts +7 -6
- package/resources/course-lesson-interactions.d.mts.map +1 -1
- package/resources/course-lesson-interactions.d.ts +7 -6
- package/resources/course-lesson-interactions.d.ts.map +1 -1
- package/resources/course-lesson-interactions.js +3 -2
- package/resources/course-lesson-interactions.js.map +1 -1
- package/resources/course-lesson-interactions.mjs +3 -2
- package/resources/course-lesson-interactions.mjs.map +1 -1
- package/resources/course-lessons.d.mts +141 -99
- package/resources/course-lessons.d.mts.map +1 -1
- package/resources/course-lessons.d.ts +141 -99
- package/resources/course-lessons.d.ts.map +1 -1
- package/resources/course-lessons.js +12 -8
- package/resources/course-lessons.js.map +1 -1
- package/resources/course-lessons.mjs +12 -8
- package/resources/course-lessons.mjs.map +1 -1
- package/resources/course-students.d.mts +44 -35
- package/resources/course-students.d.mts.map +1 -1
- package/resources/course-students.d.ts +44 -35
- package/resources/course-students.d.ts.map +1 -1
- package/resources/course-students.js +3 -2
- package/resources/course-students.js.map +1 -1
- package/resources/course-students.mjs +3 -2
- package/resources/course-students.mjs.map +1 -1
- package/resources/courses.d.mts +140 -99
- package/resources/courses.d.mts.map +1 -1
- package/resources/courses.d.ts +140 -99
- package/resources/courses.d.ts.map +1 -1
- package/resources/courses.js +9 -5
- package/resources/courses.js.map +1 -1
- package/resources/courses.mjs +9 -5
- package/resources/courses.mjs.map +1 -1
- package/resources/disputes.d.mts +176 -120
- package/resources/disputes.d.mts.map +1 -1
- package/resources/disputes.d.ts +176 -120
- package/resources/disputes.d.ts.map +1 -1
- package/resources/disputes.js +4 -2
- package/resources/disputes.js.map +1 -1
- package/resources/disputes.mjs +4 -2
- package/resources/disputes.mjs.map +1 -1
- package/resources/dm-channels.d.mts +29 -16
- package/resources/dm-channels.d.mts.map +1 -1
- package/resources/dm-channels.d.ts +29 -16
- package/resources/dm-channels.d.ts.map +1 -1
- package/resources/dm-channels.js +9 -5
- package/resources/dm-channels.js.map +1 -1
- package/resources/dm-channels.mjs +9 -5
- package/resources/dm-channels.mjs.map +1 -1
- package/resources/dm-members.d.mts +30 -21
- package/resources/dm-members.d.mts.map +1 -1
- package/resources/dm-members.d.ts +30 -21
- package/resources/dm-members.d.ts.map +1 -1
- package/resources/dm-members.js +9 -5
- package/resources/dm-members.js.map +1 -1
- package/resources/dm-members.mjs +9 -5
- package/resources/dm-members.mjs.map +1 -1
- package/resources/entries.d.mts +35 -27
- package/resources/entries.d.mts.map +1 -1
- package/resources/entries.d.ts +35 -27
- package/resources/entries.d.ts.map +1 -1
- package/resources/entries.js +7 -4
- package/resources/entries.js.map +1 -1
- package/resources/entries.mjs +7 -4
- package/resources/entries.mjs.map +1 -1
- package/resources/experiences.d.mts +58 -49
- package/resources/experiences.d.mts.map +1 -1
- package/resources/experiences.d.ts +58 -49
- package/resources/experiences.d.ts.map +1 -1
- package/resources/experiences.js +6 -5
- package/resources/experiences.js.map +1 -1
- package/resources/experiences.mjs +6 -5
- package/resources/experiences.mjs.map +1 -1
- package/resources/fee-markups.d.mts +38 -27
- package/resources/fee-markups.d.mts.map +1 -1
- package/resources/fee-markups.d.ts +38 -27
- package/resources/fee-markups.d.ts.map +1 -1
- package/resources/fee-markups.js +6 -3
- package/resources/fee-markups.js.map +1 -1
- package/resources/fee-markups.mjs +6 -3
- package/resources/fee-markups.mjs.map +1 -1
- package/resources/files.d.mts +23 -19
- package/resources/files.d.mts.map +1 -1
- package/resources/files.d.ts +23 -19
- package/resources/files.d.ts.map +1 -1
- package/resources/files.js +3 -2
- package/resources/files.js.map +1 -1
- package/resources/files.mjs +3 -2
- package/resources/files.mjs.map +1 -1
- package/resources/forum-posts.d.mts +68 -45
- package/resources/forum-posts.d.mts.map +1 -1
- package/resources/forum-posts.d.ts +68 -45
- package/resources/forum-posts.d.ts.map +1 -1
- package/resources/forum-posts.js +8 -4
- package/resources/forum-posts.js.map +1 -1
- package/resources/forum-posts.mjs +8 -4
- package/resources/forum-posts.mjs.map +1 -1
- package/resources/forums.d.mts +21 -13
- package/resources/forums.d.mts.map +1 -1
- package/resources/forums.d.ts +21 -13
- package/resources/forums.d.ts.map +1 -1
- package/resources/forums.js +5 -3
- package/resources/forums.js.map +1 -1
- package/resources/forums.mjs +5 -3
- package/resources/forums.mjs.map +1 -1
- package/resources/index.d.mts +3 -3
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +3 -3
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/invoices.d.mts +136 -100
- package/resources/invoices.d.mts.map +1 -1
- package/resources/invoices.d.ts +136 -100
- package/resources/invoices.d.ts.map +1 -1
- package/resources/invoices.js +7 -4
- package/resources/invoices.js.map +1 -1
- package/resources/invoices.mjs +7 -4
- package/resources/invoices.mjs.map +1 -1
- package/resources/leads.d.mts +76 -54
- package/resources/leads.d.mts.map +1 -1
- package/resources/leads.d.ts +76 -54
- package/resources/leads.d.ts.map +1 -1
- package/resources/leads.js +6 -4
- package/resources/leads.js.map +1 -1
- package/resources/leads.mjs +6 -4
- package/resources/leads.mjs.map +1 -1
- package/resources/ledger-accounts.d.mts +19 -15
- package/resources/ledger-accounts.d.mts.map +1 -1
- package/resources/ledger-accounts.d.ts +19 -15
- package/resources/ledger-accounts.d.ts.map +1 -1
- package/resources/ledger-accounts.js +1 -1
- package/resources/ledger-accounts.mjs +1 -1
- package/resources/members.d.mts +27 -28
- package/resources/members.d.mts.map +1 -1
- package/resources/members.d.ts +27 -28
- package/resources/members.d.ts.map +1 -1
- package/resources/members.js +3 -2
- package/resources/members.js.map +1 -1
- package/resources/members.mjs +3 -2
- package/resources/members.mjs.map +1 -1
- package/resources/memberships.d.mts +85 -62
- package/resources/memberships.d.mts.map +1 -1
- package/resources/memberships.d.ts +85 -62
- package/resources/memberships.d.ts.map +1 -1
- package/resources/memberships.js +12 -8
- package/resources/memberships.js.map +1 -1
- package/resources/memberships.mjs +12 -8
- package/resources/memberships.mjs.map +1 -1
- package/resources/messages.d.mts +53 -35
- package/resources/messages.d.mts.map +1 -1
- package/resources/messages.d.ts +53 -35
- package/resources/messages.d.ts.map +1 -1
- package/resources/messages.js +9 -5
- package/resources/messages.js.map +1 -1
- package/resources/messages.mjs +9 -5
- package/resources/messages.mjs.map +1 -1
- package/resources/notifications.d.mts +33 -25
- package/resources/notifications.d.mts.map +1 -1
- package/resources/notifications.d.ts +33 -25
- package/resources/notifications.d.ts.map +1 -1
- package/resources/notifications.js +2 -1
- package/resources/notifications.js.map +1 -1
- package/resources/notifications.mjs +2 -1
- package/resources/notifications.mjs.map +1 -1
- package/resources/payment-methods.d.mts +212 -114
- package/resources/payment-methods.d.mts.map +1 -1
- package/resources/payment-methods.d.ts +212 -114
- package/resources/payment-methods.d.ts.map +1 -1
- package/resources/payment-methods.js +5 -10
- package/resources/payment-methods.js.map +1 -1
- package/resources/payment-methods.mjs +5 -10
- package/resources/payment-methods.mjs.map +1 -1
- package/resources/payments.d.mts +96 -56
- package/resources/payments.d.mts.map +1 -1
- package/resources/payments.d.ts +96 -56
- package/resources/payments.d.ts.map +1 -1
- package/resources/payments.js +23 -10
- package/resources/payments.js.map +1 -1
- package/resources/payments.mjs +23 -10
- package/resources/payments.mjs.map +1 -1
- package/resources/payout-methods.d.mts +50 -35
- package/resources/payout-methods.d.mts.map +1 -1
- package/resources/payout-methods.d.ts +50 -35
- package/resources/payout-methods.d.ts.map +1 -1
- package/resources/payout-methods.js +3 -2
- package/resources/payout-methods.js.map +1 -1
- package/resources/payout-methods.mjs +3 -2
- package/resources/payout-methods.mjs.map +1 -1
- package/resources/plans.d.mts +136 -95
- package/resources/plans.d.mts.map +1 -1
- package/resources/plans.d.ts +136 -95
- package/resources/plans.d.ts.map +1 -1
- package/resources/plans.js +9 -5
- package/resources/plans.js.map +1 -1
- package/resources/plans.mjs +9 -5
- package/resources/plans.mjs.map +1 -1
- package/resources/products.d.mts +80 -67
- package/resources/products.d.mts.map +1 -1
- package/resources/products.d.ts +80 -67
- package/resources/products.d.ts.map +1 -1
- package/resources/products.js +7 -5
- package/resources/products.js.map +1 -1
- package/resources/products.mjs +7 -5
- package/resources/products.mjs.map +1 -1
- package/resources/promo-codes.d.mts +60 -40
- package/resources/promo-codes.d.mts.map +1 -1
- package/resources/promo-codes.d.ts +60 -40
- package/resources/promo-codes.d.ts.map +1 -1
- package/resources/promo-codes.js +7 -4
- package/resources/promo-codes.js.map +1 -1
- package/resources/promo-codes.mjs +7 -4
- package/resources/promo-codes.mjs.map +1 -1
- package/resources/reactions.d.mts +25 -19
- package/resources/reactions.d.mts.map +1 -1
- package/resources/reactions.d.ts +25 -19
- package/resources/reactions.d.ts.map +1 -1
- package/resources/reactions.js +7 -4
- package/resources/reactions.js.map +1 -1
- package/resources/reactions.mjs +7 -4
- package/resources/reactions.mjs.map +1 -1
- package/resources/refunds.d.mts +57 -39
- package/resources/refunds.d.mts.map +1 -1
- package/resources/refunds.d.ts +57 -39
- package/resources/refunds.d.ts.map +1 -1
- package/resources/refunds.js +3 -2
- package/resources/refunds.js.map +1 -1
- package/resources/refunds.mjs +3 -2
- package/resources/refunds.mjs.map +1 -1
- package/resources/reviews.d.mts +76 -60
- package/resources/reviews.d.mts.map +1 -1
- package/resources/reviews.d.ts +76 -60
- package/resources/reviews.d.ts.map +1 -1
- package/resources/reviews.js +3 -2
- package/resources/reviews.js.map +1 -1
- package/resources/reviews.mjs +3 -2
- package/resources/reviews.mjs.map +1 -1
- package/resources/setup-intents.d.mts +77 -61
- package/resources/setup-intents.d.mts.map +1 -1
- package/resources/setup-intents.d.ts +77 -61
- package/resources/setup-intents.d.ts.map +1 -1
- package/resources/setup-intents.js +4 -10
- package/resources/setup-intents.js.map +1 -1
- package/resources/setup-intents.mjs +4 -10
- package/resources/setup-intents.mjs.map +1 -1
- package/resources/shared.d.mts +854 -509
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +854 -509
- package/resources/shared.d.ts.map +1 -1
- package/resources/shipments.d.mts +30 -21
- package/resources/shipments.d.mts.map +1 -1
- package/resources/shipments.d.ts +30 -21
- package/resources/shipments.d.ts.map +1 -1
- package/resources/shipments.js +5 -3
- package/resources/shipments.js.map +1 -1
- package/resources/shipments.mjs +5 -3
- package/resources/shipments.mjs.map +1 -1
- package/resources/support-channels.d.mts +28 -20
- package/resources/support-channels.d.mts.map +1 -1
- package/resources/support-channels.d.ts +28 -20
- package/resources/support-channels.d.ts.map +1 -1
- package/resources/support-channels.js +5 -4
- package/resources/support-channels.js.map +1 -1
- package/resources/support-channels.mjs +5 -4
- package/resources/support-channels.mjs.map +1 -1
- package/resources/topups.d.mts +13 -9
- package/resources/topups.d.mts.map +1 -1
- package/resources/topups.d.ts +13 -9
- package/resources/topups.d.ts.map +1 -1
- package/resources/topups.js +2 -1
- package/resources/topups.js.map +1 -1
- package/resources/topups.mjs +2 -1
- package/resources/topups.mjs.map +1 -1
- package/resources/transfers.d.mts +37 -28
- package/resources/transfers.d.mts.map +1 -1
- package/resources/transfers.d.ts +37 -28
- package/resources/transfers.d.ts.map +1 -1
- package/resources/transfers.js +5 -3
- package/resources/transfers.js.map +1 -1
- package/resources/transfers.mjs +5 -3
- package/resources/transfers.mjs.map +1 -1
- package/resources/users.d.mts +60 -18
- package/resources/users.d.mts.map +1 -1
- package/resources/users.d.ts +60 -18
- package/resources/users.d.ts.map +1 -1
- package/resources/users.js +13 -2
- package/resources/users.js.map +1 -1
- package/resources/users.mjs +13 -2
- package/resources/users.mjs.map +1 -1
- package/resources/verifications.d.mts +7 -5
- package/resources/verifications.d.mts.map +1 -1
- package/resources/verifications.d.ts +7 -5
- package/resources/verifications.d.ts.map +1 -1
- package/resources/verifications.js +1 -1
- package/resources/verifications.mjs +1 -1
- package/resources/webhooks.d.mts +188 -133
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +188 -133
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/webhooks.js +3 -2
- package/resources/webhooks.js.map +1 -1
- package/resources/webhooks.mjs +3 -2
- package/resources/webhooks.mjs.map +1 -1
- package/resources/withdrawals.d.mts +60 -47
- package/resources/withdrawals.d.mts.map +1 -1
- package/resources/withdrawals.d.ts +60 -47
- package/resources/withdrawals.d.ts.map +1 -1
- package/resources/withdrawals.js +3 -2
- package/resources/withdrawals.js.map +1 -1
- package/resources/withdrawals.mjs +3 -2
- package/resources/withdrawals.mjs.map +1 -1
- package/src/client.ts +33 -11
- package/src/resources/access-tokens.ts +37 -59
- package/src/resources/account-links.ts +15 -13
- package/src/resources/ai-chats.ts +76 -30
- package/src/resources/app-builds.ts +37 -35
- package/src/resources/apps.ts +89 -60
- package/src/resources/authorized-users.ts +38 -32
- package/src/resources/chat-channels.ts +28 -20
- package/src/resources/checkout-configurations.ts +76 -58
- package/src/resources/companies.ts +94 -57
- package/src/resources/company-token-transactions.ts +91 -68
- package/src/resources/course-chapters.ts +27 -22
- package/src/resources/course-lesson-interactions.ts +7 -6
- package/src/resources/course-lessons.ts +141 -99
- package/src/resources/course-students.ts +44 -35
- package/src/resources/courses.ts +140 -99
- package/src/resources/disputes.ts +176 -120
- package/src/resources/dm-channels.ts +29 -16
- package/src/resources/dm-members.ts +30 -21
- package/src/resources/entries.ts +35 -27
- package/src/resources/experiences.ts +58 -49
- package/src/resources/fee-markups.ts +38 -27
- package/src/resources/files.ts +23 -19
- package/src/resources/forum-posts.ts +69 -45
- package/src/resources/forums.ts +21 -13
- package/src/resources/index.ts +4 -2
- package/src/resources/invoices.ts +140 -100
- package/src/resources/leads.ts +76 -54
- package/src/resources/ledger-accounts.ts +19 -15
- package/src/resources/members.ts +27 -28
- package/src/resources/memberships.ts +86 -62
- package/src/resources/messages.ts +53 -35
- package/src/resources/notifications.ts +33 -25
- package/src/resources/payment-methods.ts +212 -114
- package/src/resources/payments.ts +103 -55
- package/src/resources/payout-methods.ts +50 -35
- package/src/resources/plans.ts +136 -95
- package/src/resources/products.ts +219 -70
- package/src/resources/promo-codes.ts +60 -40
- package/src/resources/reactions.ts +25 -19
- package/src/resources/refunds.ts +59 -39
- package/src/resources/reviews.ts +76 -60
- package/src/resources/setup-intents.ts +77 -61
- package/src/resources/shared.ts +2797 -508
- package/src/resources/shipments.ts +30 -21
- package/src/resources/support-channels.ts +28 -20
- package/src/resources/topups.ts +13 -9
- package/src/resources/transfers.ts +37 -28
- package/src/resources/users.ts +72 -18
- package/src/resources/verifications.ts +7 -5
- package/src/resources/webhooks.ts +188 -133
- package/src/resources/withdrawals.ts +60 -46
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/payments.mjs
CHANGED
|
@@ -22,6 +22,8 @@ export class Payments extends APIResource {
|
|
|
22
22
|
* - `member:basic:read`
|
|
23
23
|
* - `member:phone:read`
|
|
24
24
|
* - `promo_code:basic:read`
|
|
25
|
+
* - `payment:dispute:read`
|
|
26
|
+
* - `payment:resolution_center_case:read`
|
|
25
27
|
*
|
|
26
28
|
* @example
|
|
27
29
|
* ```ts
|
|
@@ -37,7 +39,7 @@ export class Payments extends APIResource {
|
|
|
37
39
|
return this._client.post('/payments', { body, ...options });
|
|
38
40
|
}
|
|
39
41
|
/**
|
|
40
|
-
* Retrieves
|
|
42
|
+
* Retrieves the details of an existing payment.
|
|
41
43
|
*
|
|
42
44
|
* Required permissions:
|
|
43
45
|
*
|
|
@@ -48,6 +50,8 @@ export class Payments extends APIResource {
|
|
|
48
50
|
* - `member:basic:read`
|
|
49
51
|
* - `member:phone:read`
|
|
50
52
|
* - `promo_code:basic:read`
|
|
53
|
+
* - `payment:dispute:read`
|
|
54
|
+
* - `payment:resolution_center_case:read`
|
|
51
55
|
*
|
|
52
56
|
* @example
|
|
53
57
|
* ```ts
|
|
@@ -60,7 +64,8 @@ export class Payments extends APIResource {
|
|
|
60
64
|
return this._client.get(path `/payments/${id}`, options);
|
|
61
65
|
}
|
|
62
66
|
/**
|
|
63
|
-
*
|
|
67
|
+
* Returns a paginated list of payments for the actor in context, with optional
|
|
68
|
+
* filtering by product, plan, status, billing reason, currency, and creation date.
|
|
64
69
|
*
|
|
65
70
|
* Required permissions:
|
|
66
71
|
*
|
|
@@ -75,18 +80,17 @@ export class Payments extends APIResource {
|
|
|
75
80
|
* @example
|
|
76
81
|
* ```ts
|
|
77
82
|
* // Automatically fetches more pages as needed.
|
|
78
|
-
* for await (const paymentListResponse of client.payments.list(
|
|
79
|
-
* { company_id: 'biz_xxxxxxxxxxxxxx' },
|
|
80
|
-
* )) {
|
|
83
|
+
* for await (const paymentListResponse of client.payments.list()) {
|
|
81
84
|
* // ...
|
|
82
85
|
* }
|
|
83
86
|
* ```
|
|
84
87
|
*/
|
|
85
|
-
list(query, options) {
|
|
88
|
+
list(query = {}, options) {
|
|
86
89
|
return this._client.getAPIList('/payments', (CursorPage), { query, ...options });
|
|
87
90
|
}
|
|
88
91
|
/**
|
|
89
|
-
*
|
|
92
|
+
* Returns the list of fees associated with a specific payment, including platform
|
|
93
|
+
* fees and processing fees.
|
|
90
94
|
*
|
|
91
95
|
* Required permissions:
|
|
92
96
|
*
|
|
@@ -109,7 +113,8 @@ export class Payments extends APIResource {
|
|
|
109
113
|
});
|
|
110
114
|
}
|
|
111
115
|
/**
|
|
112
|
-
*
|
|
116
|
+
* Issue a full or partial refund for a payment. The refund is processed through
|
|
117
|
+
* the original payment processor and the membership status is updated accordingly.
|
|
113
118
|
*
|
|
114
119
|
* Required permissions:
|
|
115
120
|
*
|
|
@@ -120,6 +125,8 @@ export class Payments extends APIResource {
|
|
|
120
125
|
* - `member:basic:read`
|
|
121
126
|
* - `member:phone:read`
|
|
122
127
|
* - `promo_code:basic:read`
|
|
128
|
+
* - `payment:dispute:read`
|
|
129
|
+
* - `payment:resolution_center_case:read`
|
|
123
130
|
*
|
|
124
131
|
* @example
|
|
125
132
|
* ```ts
|
|
@@ -132,7 +139,8 @@ export class Payments extends APIResource {
|
|
|
132
139
|
return this._client.post(path `/payments/${id}/refund`, { body, ...options });
|
|
133
140
|
}
|
|
134
141
|
/**
|
|
135
|
-
*
|
|
142
|
+
* Retry a failed or pending payment. This re-attempts the charge using the
|
|
143
|
+
* original payment method and plan details.
|
|
136
144
|
*
|
|
137
145
|
* Required permissions:
|
|
138
146
|
*
|
|
@@ -143,6 +151,8 @@ export class Payments extends APIResource {
|
|
|
143
151
|
* - `member:basic:read`
|
|
144
152
|
* - `member:phone:read`
|
|
145
153
|
* - `promo_code:basic:read`
|
|
154
|
+
* - `payment:dispute:read`
|
|
155
|
+
* - `payment:resolution_center_case:read`
|
|
146
156
|
*
|
|
147
157
|
* @example
|
|
148
158
|
* ```ts
|
|
@@ -155,7 +165,8 @@ export class Payments extends APIResource {
|
|
|
155
165
|
return this._client.post(path `/payments/${id}/retry`, options);
|
|
156
166
|
}
|
|
157
167
|
/**
|
|
158
|
-
*
|
|
168
|
+
* Void a payment that has not yet been settled. Voiding cancels the payment before
|
|
169
|
+
* it is captured by the payment processor.
|
|
159
170
|
*
|
|
160
171
|
* Required permissions:
|
|
161
172
|
*
|
|
@@ -166,6 +177,8 @@ export class Payments extends APIResource {
|
|
|
166
177
|
* - `member:basic:read`
|
|
167
178
|
* - `member:phone:read`
|
|
168
179
|
* - `promo_code:basic:read`
|
|
180
|
+
* - `payment:dispute:read`
|
|
181
|
+
* - `payment:resolution_center_case:read`
|
|
169
182
|
*
|
|
170
183
|
* @example
|
|
171
184
|
* ```ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"payments.mjs","sourceRoot":"","sources":["../src/resources/payments.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;
|
|
1
|
+
{"version":3,"file":"payments.mjs","sourceRoot":"","sources":["../src/resources/payments.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAKf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA,UAA+B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CACN,EAAU,EACV,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAA,aAAa,EAAE,OAAO,EAAE,CAAA,UAAmC,CAAA,EAAE;YAC9F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CACJ,EAAU,EACV,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,EAAU,EAAE,OAAwB;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,IAAI,CAAC,EAAU,EAAE,OAAwB;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;CACF"}
|
|
@@ -5,7 +5,7 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
|
|
|
5
5
|
import { RequestOptions } from "../internal/request-options.mjs";
|
|
6
6
|
export declare class PayoutMethods extends APIResource {
|
|
7
7
|
/**
|
|
8
|
-
* Retrieves
|
|
8
|
+
* Retrieves the details of an existing payout method.
|
|
9
9
|
*
|
|
10
10
|
* Required permissions:
|
|
11
11
|
*
|
|
@@ -13,7 +13,8 @@ export declare class PayoutMethods extends APIResource {
|
|
|
13
13
|
*/
|
|
14
14
|
retrieve(id: string, options?: RequestOptions): APIPromise<PayoutMethodRetrieveResponse>;
|
|
15
15
|
/**
|
|
16
|
-
*
|
|
16
|
+
* Returns a list of active payout methods configured for a company, ordered by
|
|
17
|
+
* most recently created.
|
|
17
18
|
*
|
|
18
19
|
* Required permissions:
|
|
19
20
|
*
|
|
@@ -27,61 +28,68 @@ export type PayoutMethodListResponsesCursorPage = CursorPage<PayoutMethodListRes
|
|
|
27
28
|
*/
|
|
28
29
|
export type PayoutDestinationCategory = 'crypto' | 'rtp' | 'next_day_bank' | 'bank_wire' | 'digital_wallet' | 'unknown';
|
|
29
30
|
/**
|
|
30
|
-
*
|
|
31
|
+
* A configured payout destination where a user receives earned funds, such as a
|
|
32
|
+
* bank account or digital wallet.
|
|
31
33
|
*/
|
|
32
34
|
export interface PayoutMethodRetrieveResponse {
|
|
33
35
|
/**
|
|
34
|
-
* The
|
|
36
|
+
* The unique identifier for the payout token.
|
|
35
37
|
*/
|
|
36
38
|
id: string;
|
|
37
39
|
/**
|
|
38
|
-
* A
|
|
39
|
-
* account
|
|
40
|
+
* A masked identifier for the payout destination, such as the last four digits of
|
|
41
|
+
* a bank account or an email address. Null if no reference is available.
|
|
40
42
|
*/
|
|
41
43
|
account_reference: string | null;
|
|
42
44
|
/**
|
|
43
|
-
* The company associated with
|
|
45
|
+
* The company associated with this payout destination. Null if not linked to a
|
|
46
|
+
* specific company.
|
|
44
47
|
*/
|
|
45
48
|
company: PayoutMethodRetrieveResponse.Company | null;
|
|
46
49
|
/**
|
|
47
|
-
* The
|
|
50
|
+
* The datetime the payout token was created.
|
|
48
51
|
*/
|
|
49
52
|
created_at: string;
|
|
50
53
|
/**
|
|
51
|
-
* The currency code
|
|
52
|
-
*
|
|
54
|
+
* The three-letter ISO currency code that payouts are delivered in for this
|
|
55
|
+
* destination.
|
|
53
56
|
*/
|
|
54
57
|
currency: string;
|
|
55
58
|
/**
|
|
56
|
-
* The payout destination
|
|
59
|
+
* The payout destination configuration linked to this token. Null if not yet
|
|
60
|
+
* configured.
|
|
57
61
|
*/
|
|
58
62
|
destination: PayoutMethodRetrieveResponse.Destination | null;
|
|
59
63
|
/**
|
|
60
|
-
* The name of the bank or financial institution.
|
|
64
|
+
* The name of the bank or financial institution receiving payouts. Null if not
|
|
65
|
+
* applicable or not provided.
|
|
61
66
|
*/
|
|
62
67
|
institution_name: string | null;
|
|
63
68
|
/**
|
|
64
|
-
* Whether this
|
|
69
|
+
* Whether this is the default payout destination for the associated payout
|
|
70
|
+
* account.
|
|
65
71
|
*/
|
|
66
72
|
is_default: boolean;
|
|
67
73
|
/**
|
|
68
|
-
*
|
|
69
|
-
*
|
|
74
|
+
* A user-defined label to help identify this payout destination. Not sent to the
|
|
75
|
+
* provider. Null if no nickname has been set.
|
|
70
76
|
*/
|
|
71
77
|
nickname: string | null;
|
|
72
78
|
}
|
|
73
79
|
export declare namespace PayoutMethodRetrieveResponse {
|
|
74
80
|
/**
|
|
75
|
-
* The company associated with
|
|
81
|
+
* The company associated with this payout destination. Null if not linked to a
|
|
82
|
+
* specific company.
|
|
76
83
|
*/
|
|
77
84
|
interface Company {
|
|
78
85
|
/**
|
|
79
|
-
* The
|
|
86
|
+
* The unique identifier for the company.
|
|
80
87
|
*/
|
|
81
88
|
id: string;
|
|
82
89
|
}
|
|
83
90
|
/**
|
|
84
|
-
* The payout destination
|
|
91
|
+
* The payout destination configuration linked to this token. Null if not yet
|
|
92
|
+
* configured.
|
|
85
93
|
*/
|
|
86
94
|
interface Destination {
|
|
87
95
|
/**
|
|
@@ -99,61 +107,68 @@ export declare namespace PayoutMethodRetrieveResponse {
|
|
|
99
107
|
}
|
|
100
108
|
}
|
|
101
109
|
/**
|
|
102
|
-
*
|
|
110
|
+
* A configured payout destination where a user receives earned funds, such as a
|
|
111
|
+
* bank account or digital wallet.
|
|
103
112
|
*/
|
|
104
113
|
export interface PayoutMethodListResponse {
|
|
105
114
|
/**
|
|
106
|
-
* The
|
|
115
|
+
* The unique identifier for the payout token.
|
|
107
116
|
*/
|
|
108
117
|
id: string;
|
|
109
118
|
/**
|
|
110
|
-
* A
|
|
111
|
-
* account
|
|
119
|
+
* A masked identifier for the payout destination, such as the last four digits of
|
|
120
|
+
* a bank account or an email address. Null if no reference is available.
|
|
112
121
|
*/
|
|
113
122
|
account_reference: string | null;
|
|
114
123
|
/**
|
|
115
|
-
* The company associated with
|
|
124
|
+
* The company associated with this payout destination. Null if not linked to a
|
|
125
|
+
* specific company.
|
|
116
126
|
*/
|
|
117
127
|
company: PayoutMethodListResponse.Company | null;
|
|
118
128
|
/**
|
|
119
|
-
* The
|
|
129
|
+
* The datetime the payout token was created.
|
|
120
130
|
*/
|
|
121
131
|
created_at: string;
|
|
122
132
|
/**
|
|
123
|
-
* The currency code
|
|
124
|
-
*
|
|
133
|
+
* The three-letter ISO currency code that payouts are delivered in for this
|
|
134
|
+
* destination.
|
|
125
135
|
*/
|
|
126
136
|
currency: string;
|
|
127
137
|
/**
|
|
128
|
-
* The payout destination
|
|
138
|
+
* The payout destination configuration linked to this token. Null if not yet
|
|
139
|
+
* configured.
|
|
129
140
|
*/
|
|
130
141
|
destination: PayoutMethodListResponse.Destination | null;
|
|
131
142
|
/**
|
|
132
|
-
* The name of the bank or financial institution.
|
|
143
|
+
* The name of the bank or financial institution receiving payouts. Null if not
|
|
144
|
+
* applicable or not provided.
|
|
133
145
|
*/
|
|
134
146
|
institution_name: string | null;
|
|
135
147
|
/**
|
|
136
|
-
* Whether this
|
|
148
|
+
* Whether this is the default payout destination for the associated payout
|
|
149
|
+
* account.
|
|
137
150
|
*/
|
|
138
151
|
is_default: boolean;
|
|
139
152
|
/**
|
|
140
|
-
*
|
|
141
|
-
*
|
|
153
|
+
* A user-defined label to help identify this payout destination. Not sent to the
|
|
154
|
+
* provider. Null if no nickname has been set.
|
|
142
155
|
*/
|
|
143
156
|
nickname: string | null;
|
|
144
157
|
}
|
|
145
158
|
export declare namespace PayoutMethodListResponse {
|
|
146
159
|
/**
|
|
147
|
-
* The company associated with
|
|
160
|
+
* The company associated with this payout destination. Null if not linked to a
|
|
161
|
+
* specific company.
|
|
148
162
|
*/
|
|
149
163
|
interface Company {
|
|
150
164
|
/**
|
|
151
|
-
* The
|
|
165
|
+
* The unique identifier for the company.
|
|
152
166
|
*/
|
|
153
167
|
id: string;
|
|
154
168
|
}
|
|
155
169
|
/**
|
|
156
|
-
* The payout destination
|
|
170
|
+
* The payout destination configuration linked to this token. Null if not yet
|
|
171
|
+
* configured.
|
|
157
172
|
*/
|
|
158
173
|
interface Destination {
|
|
159
174
|
/**
|
|
@@ -172,7 +187,7 @@ export declare namespace PayoutMethodListResponse {
|
|
|
172
187
|
}
|
|
173
188
|
export interface PayoutMethodListParams extends CursorPageParams {
|
|
174
189
|
/**
|
|
175
|
-
* The company
|
|
190
|
+
* The unique identifier of the company to list payout methods for.
|
|
176
191
|
*/
|
|
177
192
|
company_id: string;
|
|
178
193
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"payout-methods.d.mts","sourceRoot":"","sources":["../src/resources/payout-methods.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,gBAAgB;OACrB,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,4BAA4B,CAAC;IAIxF
|
|
1
|
+
{"version":3,"file":"payout-methods.d.mts","sourceRoot":"","sources":["../src/resources/payout-methods.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,gBAAgB;OACrB,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,4BAA4B,CAAC;IAIxF;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,EAAE,sBAAsB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,wBAAwB,CAAC;CAM9E;AAED,MAAM,MAAM,mCAAmC,GAAG,UAAU,CAAC,wBAAwB,CAAC,CAAC;AAEvF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GACjC,QAAQ,GACR,KAAK,GACL,eAAe,GACf,WAAW,GACX,gBAAgB,GAChB,SAAS,CAAC;AAEd;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,OAAO,EAAE,4BAA4B,CAAC,OAAO,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,WAAW,EAAE,4BAA4B,CAAC,WAAW,GAAG,IAAI,CAAC;IAE7D;;;OAGG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;;OAGG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;;OAGG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,QAAQ,EAAE,gBAAgB,CAAC,yBAAyB,CAAC;QAErD;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,OAAO,EAAE,wBAAwB,CAAC,OAAO,GAAG,IAAI,CAAC;IAEjD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,WAAW,EAAE,wBAAwB,CAAC,WAAW,GAAG,IAAI,CAAC;IAEzD;;;OAGG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;;OAGG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;;OAGG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,QAAQ,EAAE,gBAAgB,CAAC,yBAAyB,CAAC;QAErD;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|
|
@@ -5,7 +5,7 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
|
|
|
5
5
|
import { RequestOptions } from "../internal/request-options.js";
|
|
6
6
|
export declare class PayoutMethods extends APIResource {
|
|
7
7
|
/**
|
|
8
|
-
* Retrieves
|
|
8
|
+
* Retrieves the details of an existing payout method.
|
|
9
9
|
*
|
|
10
10
|
* Required permissions:
|
|
11
11
|
*
|
|
@@ -13,7 +13,8 @@ export declare class PayoutMethods extends APIResource {
|
|
|
13
13
|
*/
|
|
14
14
|
retrieve(id: string, options?: RequestOptions): APIPromise<PayoutMethodRetrieveResponse>;
|
|
15
15
|
/**
|
|
16
|
-
*
|
|
16
|
+
* Returns a list of active payout methods configured for a company, ordered by
|
|
17
|
+
* most recently created.
|
|
17
18
|
*
|
|
18
19
|
* Required permissions:
|
|
19
20
|
*
|
|
@@ -27,61 +28,68 @@ export type PayoutMethodListResponsesCursorPage = CursorPage<PayoutMethodListRes
|
|
|
27
28
|
*/
|
|
28
29
|
export type PayoutDestinationCategory = 'crypto' | 'rtp' | 'next_day_bank' | 'bank_wire' | 'digital_wallet' | 'unknown';
|
|
29
30
|
/**
|
|
30
|
-
*
|
|
31
|
+
* A configured payout destination where a user receives earned funds, such as a
|
|
32
|
+
* bank account or digital wallet.
|
|
31
33
|
*/
|
|
32
34
|
export interface PayoutMethodRetrieveResponse {
|
|
33
35
|
/**
|
|
34
|
-
* The
|
|
36
|
+
* The unique identifier for the payout token.
|
|
35
37
|
*/
|
|
36
38
|
id: string;
|
|
37
39
|
/**
|
|
38
|
-
* A
|
|
39
|
-
* account
|
|
40
|
+
* A masked identifier for the payout destination, such as the last four digits of
|
|
41
|
+
* a bank account or an email address. Null if no reference is available.
|
|
40
42
|
*/
|
|
41
43
|
account_reference: string | null;
|
|
42
44
|
/**
|
|
43
|
-
* The company associated with
|
|
45
|
+
* The company associated with this payout destination. Null if not linked to a
|
|
46
|
+
* specific company.
|
|
44
47
|
*/
|
|
45
48
|
company: PayoutMethodRetrieveResponse.Company | null;
|
|
46
49
|
/**
|
|
47
|
-
* The
|
|
50
|
+
* The datetime the payout token was created.
|
|
48
51
|
*/
|
|
49
52
|
created_at: string;
|
|
50
53
|
/**
|
|
51
|
-
* The currency code
|
|
52
|
-
*
|
|
54
|
+
* The three-letter ISO currency code that payouts are delivered in for this
|
|
55
|
+
* destination.
|
|
53
56
|
*/
|
|
54
57
|
currency: string;
|
|
55
58
|
/**
|
|
56
|
-
* The payout destination
|
|
59
|
+
* The payout destination configuration linked to this token. Null if not yet
|
|
60
|
+
* configured.
|
|
57
61
|
*/
|
|
58
62
|
destination: PayoutMethodRetrieveResponse.Destination | null;
|
|
59
63
|
/**
|
|
60
|
-
* The name of the bank or financial institution.
|
|
64
|
+
* The name of the bank or financial institution receiving payouts. Null if not
|
|
65
|
+
* applicable or not provided.
|
|
61
66
|
*/
|
|
62
67
|
institution_name: string | null;
|
|
63
68
|
/**
|
|
64
|
-
* Whether this
|
|
69
|
+
* Whether this is the default payout destination for the associated payout
|
|
70
|
+
* account.
|
|
65
71
|
*/
|
|
66
72
|
is_default: boolean;
|
|
67
73
|
/**
|
|
68
|
-
*
|
|
69
|
-
*
|
|
74
|
+
* A user-defined label to help identify this payout destination. Not sent to the
|
|
75
|
+
* provider. Null if no nickname has been set.
|
|
70
76
|
*/
|
|
71
77
|
nickname: string | null;
|
|
72
78
|
}
|
|
73
79
|
export declare namespace PayoutMethodRetrieveResponse {
|
|
74
80
|
/**
|
|
75
|
-
* The company associated with
|
|
81
|
+
* The company associated with this payout destination. Null if not linked to a
|
|
82
|
+
* specific company.
|
|
76
83
|
*/
|
|
77
84
|
interface Company {
|
|
78
85
|
/**
|
|
79
|
-
* The
|
|
86
|
+
* The unique identifier for the company.
|
|
80
87
|
*/
|
|
81
88
|
id: string;
|
|
82
89
|
}
|
|
83
90
|
/**
|
|
84
|
-
* The payout destination
|
|
91
|
+
* The payout destination configuration linked to this token. Null if not yet
|
|
92
|
+
* configured.
|
|
85
93
|
*/
|
|
86
94
|
interface Destination {
|
|
87
95
|
/**
|
|
@@ -99,61 +107,68 @@ export declare namespace PayoutMethodRetrieveResponse {
|
|
|
99
107
|
}
|
|
100
108
|
}
|
|
101
109
|
/**
|
|
102
|
-
*
|
|
110
|
+
* A configured payout destination where a user receives earned funds, such as a
|
|
111
|
+
* bank account or digital wallet.
|
|
103
112
|
*/
|
|
104
113
|
export interface PayoutMethodListResponse {
|
|
105
114
|
/**
|
|
106
|
-
* The
|
|
115
|
+
* The unique identifier for the payout token.
|
|
107
116
|
*/
|
|
108
117
|
id: string;
|
|
109
118
|
/**
|
|
110
|
-
* A
|
|
111
|
-
* account
|
|
119
|
+
* A masked identifier for the payout destination, such as the last four digits of
|
|
120
|
+
* a bank account or an email address. Null if no reference is available.
|
|
112
121
|
*/
|
|
113
122
|
account_reference: string | null;
|
|
114
123
|
/**
|
|
115
|
-
* The company associated with
|
|
124
|
+
* The company associated with this payout destination. Null if not linked to a
|
|
125
|
+
* specific company.
|
|
116
126
|
*/
|
|
117
127
|
company: PayoutMethodListResponse.Company | null;
|
|
118
128
|
/**
|
|
119
|
-
* The
|
|
129
|
+
* The datetime the payout token was created.
|
|
120
130
|
*/
|
|
121
131
|
created_at: string;
|
|
122
132
|
/**
|
|
123
|
-
* The currency code
|
|
124
|
-
*
|
|
133
|
+
* The three-letter ISO currency code that payouts are delivered in for this
|
|
134
|
+
* destination.
|
|
125
135
|
*/
|
|
126
136
|
currency: string;
|
|
127
137
|
/**
|
|
128
|
-
* The payout destination
|
|
138
|
+
* The payout destination configuration linked to this token. Null if not yet
|
|
139
|
+
* configured.
|
|
129
140
|
*/
|
|
130
141
|
destination: PayoutMethodListResponse.Destination | null;
|
|
131
142
|
/**
|
|
132
|
-
* The name of the bank or financial institution.
|
|
143
|
+
* The name of the bank or financial institution receiving payouts. Null if not
|
|
144
|
+
* applicable or not provided.
|
|
133
145
|
*/
|
|
134
146
|
institution_name: string | null;
|
|
135
147
|
/**
|
|
136
|
-
* Whether this
|
|
148
|
+
* Whether this is the default payout destination for the associated payout
|
|
149
|
+
* account.
|
|
137
150
|
*/
|
|
138
151
|
is_default: boolean;
|
|
139
152
|
/**
|
|
140
|
-
*
|
|
141
|
-
*
|
|
153
|
+
* A user-defined label to help identify this payout destination. Not sent to the
|
|
154
|
+
* provider. Null if no nickname has been set.
|
|
142
155
|
*/
|
|
143
156
|
nickname: string | null;
|
|
144
157
|
}
|
|
145
158
|
export declare namespace PayoutMethodListResponse {
|
|
146
159
|
/**
|
|
147
|
-
* The company associated with
|
|
160
|
+
* The company associated with this payout destination. Null if not linked to a
|
|
161
|
+
* specific company.
|
|
148
162
|
*/
|
|
149
163
|
interface Company {
|
|
150
164
|
/**
|
|
151
|
-
* The
|
|
165
|
+
* The unique identifier for the company.
|
|
152
166
|
*/
|
|
153
167
|
id: string;
|
|
154
168
|
}
|
|
155
169
|
/**
|
|
156
|
-
* The payout destination
|
|
170
|
+
* The payout destination configuration linked to this token. Null if not yet
|
|
171
|
+
* configured.
|
|
157
172
|
*/
|
|
158
173
|
interface Destination {
|
|
159
174
|
/**
|
|
@@ -172,7 +187,7 @@ export declare namespace PayoutMethodListResponse {
|
|
|
172
187
|
}
|
|
173
188
|
export interface PayoutMethodListParams extends CursorPageParams {
|
|
174
189
|
/**
|
|
175
|
-
* The company
|
|
190
|
+
* The unique identifier of the company to list payout methods for.
|
|
176
191
|
*/
|
|
177
192
|
company_id: string;
|
|
178
193
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"payout-methods.d.ts","sourceRoot":"","sources":["../src/resources/payout-methods.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,gBAAgB;OACrB,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,4BAA4B,CAAC;IAIxF
|
|
1
|
+
{"version":3,"file":"payout-methods.d.ts","sourceRoot":"","sources":["../src/resources/payout-methods.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,gBAAgB;OACrB,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,4BAA4B,CAAC;IAIxF;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,EAAE,sBAAsB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,wBAAwB,CAAC;CAM9E;AAED,MAAM,MAAM,mCAAmC,GAAG,UAAU,CAAC,wBAAwB,CAAC,CAAC;AAEvF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GACjC,QAAQ,GACR,KAAK,GACL,eAAe,GACf,WAAW,GACX,gBAAgB,GAChB,SAAS,CAAC;AAEd;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,OAAO,EAAE,4BAA4B,CAAC,OAAO,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,WAAW,EAAE,4BAA4B,CAAC,WAAW,GAAG,IAAI,CAAC;IAE7D;;;OAGG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;;OAGG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;;OAGG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,QAAQ,EAAE,gBAAgB,CAAC,yBAAyB,CAAC;QAErD;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,OAAO,EAAE,wBAAwB,CAAC,OAAO,GAAG,IAAI,CAAC;IAEjD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,WAAW,EAAE,wBAAwB,CAAC,WAAW,GAAG,IAAI,CAAC;IAEzD;;;OAGG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;;OAGG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;;OAGG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,QAAQ,EAAE,gBAAgB,CAAC,yBAAyB,CAAC;QAErD;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|
|
@@ -7,7 +7,7 @@ const pagination_1 = require("../core/pagination.js");
|
|
|
7
7
|
const path_1 = require("../internal/utils/path.js");
|
|
8
8
|
class PayoutMethods extends resource_1.APIResource {
|
|
9
9
|
/**
|
|
10
|
-
* Retrieves
|
|
10
|
+
* Retrieves the details of an existing payout method.
|
|
11
11
|
*
|
|
12
12
|
* Required permissions:
|
|
13
13
|
*
|
|
@@ -17,7 +17,8 @@ class PayoutMethods extends resource_1.APIResource {
|
|
|
17
17
|
return this._client.get((0, path_1.path) `/payout_methods/${id}`, options);
|
|
18
18
|
}
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
20
|
+
* Returns a list of active payout methods configured for a company, ordered by
|
|
21
|
+
* most recently created.
|
|
21
22
|
*
|
|
22
23
|
* Required permissions:
|
|
23
24
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"payout-methods.js","sourceRoot":"","sources":["../src/resources/payout-methods.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;OAMG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"payout-methods.js","sourceRoot":"","sources":["../src/resources/payout-methods.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;OAMG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,KAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAA,uBAAoC,CAAA,EAAE;YACtF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA7BD,sCA6BC"}
|
|
@@ -4,7 +4,7 @@ import { CursorPage } from "../core/pagination.mjs";
|
|
|
4
4
|
import { path } from "../internal/utils/path.mjs";
|
|
5
5
|
export class PayoutMethods extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
* Retrieves
|
|
7
|
+
* Retrieves the details of an existing payout method.
|
|
8
8
|
*
|
|
9
9
|
* Required permissions:
|
|
10
10
|
*
|
|
@@ -14,7 +14,8 @@ export class PayoutMethods extends APIResource {
|
|
|
14
14
|
return this._client.get(path `/payout_methods/${id}`, options);
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
|
-
*
|
|
17
|
+
* Returns a list of active payout methods configured for a company, ordered by
|
|
18
|
+
* most recently created.
|
|
18
19
|
*
|
|
19
20
|
* Required permissions:
|
|
20
21
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"payout-methods.mjs","sourceRoot":"","sources":["../src/resources/payout-methods.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;OAMG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAmB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"payout-methods.mjs","sourceRoot":"","sources":["../src/resources/payout-methods.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;OAMG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAmB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,KAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAA,UAAoC,CAAA,EAAE;YACtF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
|