@whop/sdk 0.0.38 → 0.0.40
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 +39 -0
- package/client.d.mts +88 -40
- package/client.d.mts.map +1 -1
- package/client.d.ts +88 -40
- package/client.d.ts.map +1 -1
- package/client.js +59 -0
- package/client.js.map +1 -1
- package/client.mjs +59 -0
- package/client.mjs.map +1 -1
- package/internal/types.d.mts +6 -6
- package/internal/types.d.mts.map +1 -1
- package/internal/types.d.ts +6 -6
- package/internal/types.d.ts.map +1 -1
- package/internal/utils/log.d.mts.map +1 -1
- package/internal/utils/log.d.ts.map +1 -1
- package/internal/utils/log.js +2 -0
- package/internal/utils/log.js.map +1 -1
- package/internal/utils/log.mjs +2 -0
- package/internal/utils/log.mjs.map +1 -1
- package/package.json +15 -9
- package/resources/accounts.d.mts +244 -0
- package/resources/accounts.d.mts.map +1 -0
- package/resources/accounts.d.ts +244 -0
- package/resources/accounts.d.ts.map +1 -0
- package/resources/accounts.js +46 -0
- package/resources/accounts.js.map +1 -0
- package/resources/accounts.mjs +42 -0
- package/resources/accounts.mjs.map +1 -0
- package/resources/ad-campaigns.d.mts +296 -0
- package/resources/ad-campaigns.d.mts.map +1 -0
- package/resources/ad-campaigns.d.ts +296 -0
- package/resources/ad-campaigns.d.ts.map +1 -0
- package/resources/ad-campaigns.js +104 -0
- package/resources/ad-campaigns.js.map +1 -0
- package/resources/ad-campaigns.mjs +100 -0
- package/resources/ad-campaigns.mjs.map +1 -0
- package/resources/ad-groups.d.mts +1461 -0
- package/resources/ad-groups.d.mts.map +1 -0
- package/resources/ad-groups.d.ts +1461 -0
- package/resources/ad-groups.d.ts.map +1 -0
- package/resources/ad-groups.js +121 -0
- package/resources/ad-groups.js.map +1 -0
- package/resources/ad-groups.mjs +117 -0
- package/resources/ad-groups.mjs.map +1 -0
- package/resources/ad-reports.d.mts +379 -0
- package/resources/ad-reports.d.mts.map +1 -0
- package/resources/ad-reports.d.ts +379 -0
- package/resources/ad-reports.d.ts.map +1 -0
- package/resources/ad-reports.js +26 -0
- package/resources/ad-reports.js.map +1 -0
- package/resources/ad-reports.mjs +22 -0
- package/resources/ad-reports.mjs.map +1 -0
- package/resources/ads.d.mts +234 -0
- package/resources/ads.d.mts.map +1 -0
- package/resources/ads.d.ts +234 -0
- package/resources/ads.d.ts.map +1 -0
- package/resources/ads.js +56 -0
- package/resources/ads.js.map +1 -0
- package/resources/ads.mjs +52 -0
- package/resources/ads.mjs.map +1 -0
- package/resources/affiliates/affiliates.d.mts +31 -31
- package/resources/affiliates/affiliates.d.mts.map +1 -1
- package/resources/affiliates/affiliates.d.ts +31 -31
- package/resources/affiliates/affiliates.d.ts.map +1 -1
- package/resources/affiliates/affiliates.js +21 -21
- package/resources/affiliates/affiliates.js.map +1 -1
- package/resources/affiliates/affiliates.mjs +21 -21
- package/resources/affiliates/affiliates.mjs.map +1 -1
- package/resources/affiliates/index.d.mts +2 -2
- package/resources/affiliates/index.d.mts.map +1 -1
- package/resources/affiliates/index.d.ts +2 -2
- package/resources/affiliates/index.d.ts.map +1 -1
- package/resources/affiliates/overrides.d.mts +37 -37
- package/resources/affiliates/overrides.d.mts.map +1 -1
- package/resources/affiliates/overrides.d.ts +37 -37
- package/resources/affiliates/overrides.d.ts.map +1 -1
- package/resources/affiliates/overrides.js +23 -23
- package/resources/affiliates/overrides.js.map +1 -1
- package/resources/affiliates/overrides.mjs +23 -23
- package/resources/affiliates/overrides.mjs.map +1 -1
- package/resources/ai-chats.d.mts +23 -23
- package/resources/ai-chats.d.mts.map +1 -1
- package/resources/ai-chats.d.ts +23 -23
- 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 +54 -54
- package/resources/app-builds.d.mts.map +1 -1
- package/resources/app-builds.d.ts +54 -54
- package/resources/app-builds.d.ts.map +1 -1
- package/resources/app-builds.js +21 -21
- package/resources/app-builds.js.map +1 -1
- package/resources/app-builds.mjs +21 -21
- package/resources/app-builds.mjs.map +1 -1
- package/resources/apps.d.mts +57 -57
- package/resources/apps.d.mts.map +1 -1
- package/resources/apps.d.ts +57 -57
- package/resources/apps.d.ts.map +1 -1
- package/resources/apps.js +15 -15
- package/resources/apps.js.map +1 -1
- package/resources/apps.mjs +15 -15
- package/resources/apps.mjs.map +1 -1
- package/resources/authorized-users.d.mts +36 -36
- package/resources/authorized-users.d.mts.map +1 -1
- package/resources/authorized-users.d.ts +36 -36
- package/resources/authorized-users.d.ts.map +1 -1
- package/resources/authorized-users.js +21 -21
- package/resources/authorized-users.js.map +1 -1
- package/resources/authorized-users.mjs +21 -21
- package/resources/authorized-users.mjs.map +1 -1
- package/resources/bounties.d.mts +281 -0
- package/resources/bounties.d.mts.map +1 -0
- package/resources/bounties.d.ts +281 -0
- package/resources/bounties.d.ts.map +1 -0
- package/resources/bounties.js +63 -0
- package/resources/bounties.js.map +1 -0
- package/resources/bounties.mjs +59 -0
- package/resources/bounties.mjs.map +1 -0
- package/resources/chat-channels.d.mts +43 -43
- package/resources/chat-channels.d.mts.map +1 -1
- package/resources/chat-channels.d.ts +43 -43
- package/resources/chat-channels.d.ts.map +1 -1
- package/resources/chat-channels.js +24 -24
- package/resources/chat-channels.js.map +1 -1
- package/resources/chat-channels.mjs +24 -24
- package/resources/chat-channels.mjs.map +1 -1
- package/resources/checkout-configurations.d.mts +77 -49
- package/resources/checkout-configurations.d.mts.map +1 -1
- package/resources/checkout-configurations.d.ts +77 -49
- package/resources/checkout-configurations.d.ts.map +1 -1
- package/resources/checkout-configurations.js +11 -11
- package/resources/checkout-configurations.js.map +1 -1
- package/resources/checkout-configurations.mjs +11 -11
- package/resources/checkout-configurations.mjs.map +1 -1
- package/resources/companies.d.mts +98 -35
- package/resources/companies.d.mts.map +1 -1
- package/resources/companies.d.ts +98 -35
- package/resources/companies.d.ts.map +1 -1
- package/resources/companies.js +24 -17
- package/resources/companies.js.map +1 -1
- package/resources/companies.mjs +24 -17
- package/resources/companies.mjs.map +1 -1
- package/resources/company-token-transactions.d.mts +39 -39
- package/resources/company-token-transactions.d.mts.map +1 -1
- package/resources/company-token-transactions.d.ts +39 -39
- package/resources/company-token-transactions.d.ts.map +1 -1
- package/resources/company-token-transactions.js +14 -14
- package/resources/company-token-transactions.js.map +1 -1
- package/resources/company-token-transactions.mjs +14 -14
- package/resources/company-token-transactions.mjs.map +1 -1
- package/resources/conversions.d.mts +248 -0
- package/resources/conversions.d.mts.map +1 -0
- package/resources/conversions.d.ts +248 -0
- package/resources/conversions.d.ts.map +1 -0
- package/resources/conversions.js +30 -0
- package/resources/conversions.js.map +1 -0
- package/resources/conversions.mjs +26 -0
- package/resources/conversions.mjs.map +1 -0
- package/resources/course-chapters.d.mts +36 -36
- package/resources/course-chapters.d.mts.map +1 -1
- package/resources/course-chapters.d.ts +36 -36
- package/resources/course-chapters.d.ts.map +1 -1
- package/resources/course-chapters.js +23 -23
- package/resources/course-chapters.js.map +1 -1
- package/resources/course-chapters.mjs +23 -23
- package/resources/course-chapters.mjs.map +1 -1
- package/resources/course-lesson-interactions.d.mts +5 -5
- package/resources/course-lesson-interactions.d.mts.map +1 -1
- package/resources/course-lesson-interactions.d.ts +5 -5
- package/resources/course-lesson-interactions.d.ts.map +1 -1
- package/resources/course-lesson-interactions.js +7 -7
- package/resources/course-lesson-interactions.js.map +1 -1
- package/resources/course-lesson-interactions.mjs +7 -7
- package/resources/course-lesson-interactions.mjs.map +1 -1
- package/resources/course-lessons.d.mts +40 -40
- package/resources/course-lessons.d.mts.map +1 -1
- package/resources/course-lessons.d.ts +40 -40
- package/resources/course-lessons.d.ts.map +1 -1
- package/resources/course-lessons.js +22 -22
- package/resources/course-lessons.js.map +1 -1
- package/resources/course-lessons.mjs +22 -22
- package/resources/course-lessons.mjs.map +1 -1
- package/resources/course-students.d.mts +5 -5
- package/resources/course-students.d.mts.map +1 -1
- package/resources/course-students.d.ts +5 -5
- package/resources/course-students.d.ts.map +1 -1
- package/resources/course-students.js +10 -10
- package/resources/course-students.js.map +1 -1
- package/resources/course-students.mjs +10 -10
- package/resources/course-students.mjs.map +1 -1
- package/resources/courses.d.mts +40 -40
- package/resources/courses.d.mts.map +1 -1
- package/resources/courses.d.ts +40 -40
- package/resources/courses.d.ts.map +1 -1
- package/resources/courses.js +19 -19
- package/resources/courses.js.map +1 -1
- package/resources/courses.mjs +19 -19
- package/resources/courses.mjs.map +1 -1
- package/resources/deposits.d.mts +64 -0
- package/resources/deposits.d.mts.map +1 -0
- package/resources/deposits.d.ts +64 -0
- package/resources/deposits.d.ts.map +1 -0
- package/resources/deposits.js +16 -0
- package/resources/deposits.js.map +1 -0
- package/resources/deposits.mjs +12 -0
- package/resources/deposits.mjs.map +1 -0
- package/resources/dispute-alerts.d.mts +10 -10
- package/resources/dispute-alerts.d.mts.map +1 -1
- package/resources/dispute-alerts.d.ts +10 -10
- package/resources/dispute-alerts.d.ts.map +1 -1
- package/resources/dispute-alerts.js +13 -13
- package/resources/dispute-alerts.js.map +1 -1
- package/resources/dispute-alerts.mjs +13 -13
- package/resources/dispute-alerts.mjs.map +1 -1
- package/resources/disputes.d.mts +13 -15
- package/resources/disputes.d.mts.map +1 -1
- package/resources/disputes.d.ts +13 -15
- package/resources/disputes.d.ts.map +1 -1
- package/resources/disputes.js +11 -11
- package/resources/disputes.js.map +1 -1
- package/resources/disputes.mjs +11 -11
- package/resources/disputes.mjs.map +1 -1
- package/resources/dm-channels.d.mts +37 -37
- package/resources/dm-channels.d.mts.map +1 -1
- package/resources/dm-channels.d.ts +37 -37
- package/resources/dm-channels.d.ts.map +1 -1
- package/resources/dm-channels.js +19 -19
- package/resources/dm-channels.js.map +1 -1
- package/resources/dm-channels.mjs +19 -19
- package/resources/dm-channels.mjs.map +1 -1
- package/resources/dm-members.d.mts +38 -38
- package/resources/dm-members.d.mts.map +1 -1
- package/resources/dm-members.d.ts +38 -38
- package/resources/dm-members.d.ts.map +1 -1
- package/resources/dm-members.js +21 -21
- package/resources/dm-members.js.map +1 -1
- package/resources/dm-members.mjs +21 -21
- package/resources/dm-members.mjs.map +1 -1
- package/resources/entries.d.mts +5 -5
- package/resources/entries.d.mts.map +1 -1
- package/resources/entries.d.ts +5 -5
- package/resources/entries.d.ts.map +1 -1
- package/resources/entries.js +7 -7
- package/resources/entries.js.map +1 -1
- package/resources/entries.mjs +7 -7
- package/resources/entries.mjs.map +1 -1
- package/resources/experiences.d.mts +50 -50
- package/resources/experiences.d.mts.map +1 -1
- package/resources/experiences.d.ts +50 -50
- package/resources/experiences.d.ts.map +1 -1
- package/resources/experiences.js +17 -17
- package/resources/experiences.js.map +1 -1
- package/resources/experiences.mjs +17 -17
- package/resources/experiences.mjs.map +1 -1
- package/resources/fee-markups.d.mts +36 -36
- package/resources/fee-markups.d.mts.map +1 -1
- package/resources/fee-markups.d.ts +36 -36
- package/resources/fee-markups.d.ts.map +1 -1
- package/resources/fee-markups.js +18 -18
- package/resources/fee-markups.js.map +1 -1
- package/resources/fee-markups.mjs +18 -18
- package/resources/fee-markups.mjs.map +1 -1
- package/resources/files.d.mts +18 -1
- package/resources/files.d.mts.map +1 -1
- package/resources/files.d.ts +18 -1
- package/resources/files.d.ts.map +1 -1
- package/resources/forum-posts.d.mts +52 -48
- package/resources/forum-posts.d.mts.map +1 -1
- package/resources/forum-posts.d.ts +52 -48
- package/resources/forum-posts.d.ts.map +1 -1
- package/resources/forum-posts.js +21 -21
- package/resources/forum-posts.js.map +1 -1
- package/resources/forum-posts.mjs +21 -21
- package/resources/forum-posts.mjs.map +1 -1
- package/resources/forums.d.mts +33 -33
- package/resources/forums.d.mts.map +1 -1
- package/resources/forums.d.ts +33 -33
- package/resources/forums.d.ts.map +1 -1
- package/resources/forums.js +11 -11
- package/resources/forums.js.map +1 -1
- package/resources/forums.mjs +11 -11
- package/resources/forums.mjs.map +1 -1
- package/resources/index.d.mts +45 -35
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +45 -35
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +22 -2
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +10 -0
- package/resources/index.mjs.map +1 -1
- package/resources/invoices.d.mts +89 -84
- package/resources/invoices.d.mts.map +1 -1
- package/resources/invoices.d.ts +89 -84
- package/resources/invoices.d.ts.map +1 -1
- package/resources/invoices.js +40 -40
- package/resources/invoices.js.map +1 -1
- package/resources/invoices.mjs +40 -40
- package/resources/invoices.mjs.map +1 -1
- package/resources/leads.d.mts +53 -53
- package/resources/leads.d.mts.map +1 -1
- package/resources/leads.d.ts +53 -53
- package/resources/leads.d.ts.map +1 -1
- package/resources/leads.js +24 -24
- package/resources/leads.js.map +1 -1
- package/resources/leads.mjs +24 -24
- package/resources/leads.mjs.map +1 -1
- package/resources/ledger-accounts.d.mts +34 -1
- package/resources/ledger-accounts.d.mts.map +1 -1
- package/resources/ledger-accounts.d.ts +34 -1
- package/resources/ledger-accounts.d.ts.map +1 -1
- package/resources/members.d.mts +9 -7
- package/resources/members.d.mts.map +1 -1
- package/resources/members.d.ts +9 -7
- package/resources/members.d.ts.map +1 -1
- package/resources/members.js +7 -7
- package/resources/members.js.map +1 -1
- package/resources/members.mjs +7 -7
- package/resources/members.mjs.map +1 -1
- package/resources/memberships.d.mts +67 -47
- package/resources/memberships.d.mts.map +1 -1
- package/resources/memberships.d.ts +67 -47
- package/resources/memberships.d.ts.map +1 -1
- package/resources/memberships.js +38 -38
- package/resources/memberships.js.map +1 -1
- package/resources/memberships.mjs +38 -38
- package/resources/memberships.mjs.map +1 -1
- package/resources/messages.d.mts +36 -36
- package/resources/messages.d.mts.map +1 -1
- package/resources/messages.d.ts +36 -36
- package/resources/messages.d.ts.map +1 -1
- package/resources/messages.js +16 -16
- package/resources/messages.js.map +1 -1
- package/resources/messages.mjs +16 -16
- package/resources/messages.mjs.map +1 -1
- package/resources/payment-methods.d.mts +20 -20
- package/resources/payment-methods.d.mts.map +1 -1
- package/resources/payment-methods.d.ts +20 -20
- package/resources/payment-methods.d.ts.map +1 -1
- package/resources/payment-methods.js +10 -10
- package/resources/payment-methods.js.map +1 -1
- package/resources/payment-methods.mjs +10 -10
- package/resources/payment-methods.mjs.map +1 -1
- package/resources/payments.d.mts +177 -145
- package/resources/payments.d.mts.map +1 -1
- package/resources/payments.d.ts +177 -145
- package/resources/payments.d.ts.map +1 -1
- package/resources/payments.js +68 -68
- package/resources/payments.js.map +1 -1
- package/resources/payments.mjs +68 -68
- package/resources/payments.mjs.map +1 -1
- package/resources/payout-accounts.d.mts +1 -1
- package/resources/payout-accounts.d.ts +1 -1
- package/resources/payout-methods.d.mts +5 -5
- package/resources/payout-methods.d.mts.map +1 -1
- package/resources/payout-methods.d.ts +5 -5
- package/resources/payout-methods.d.ts.map +1 -1
- package/resources/payout-methods.js +10 -10
- package/resources/payout-methods.js.map +1 -1
- package/resources/payout-methods.mjs +10 -10
- package/resources/payout-methods.mjs.map +1 -1
- package/resources/plans.d.mts +130 -72
- package/resources/plans.d.mts.map +1 -1
- package/resources/plans.d.ts +130 -72
- package/resources/plans.d.ts.map +1 -1
- package/resources/plans.js +21 -21
- package/resources/plans.js.map +1 -1
- package/resources/plans.mjs +21 -21
- package/resources/plans.mjs.map +1 -1
- package/resources/products.d.mts +81 -65
- package/resources/products.d.mts.map +1 -1
- package/resources/products.d.ts +81 -65
- package/resources/products.d.ts.map +1 -1
- package/resources/products.js +25 -25
- package/resources/products.js.map +1 -1
- package/resources/products.mjs +25 -25
- package/resources/products.mjs.map +1 -1
- package/resources/promo-codes.d.mts +59 -59
- package/resources/promo-codes.d.mts.map +1 -1
- package/resources/promo-codes.d.ts +59 -59
- package/resources/promo-codes.d.ts.map +1 -1
- package/resources/promo-codes.js +22 -22
- package/resources/promo-codes.js.map +1 -1
- package/resources/promo-codes.mjs +22 -22
- package/resources/promo-codes.mjs.map +1 -1
- package/resources/reactions.d.mts +25 -25
- package/resources/reactions.d.mts.map +1 -1
- package/resources/reactions.d.ts +25 -25
- package/resources/reactions.d.ts.map +1 -1
- package/resources/reactions.js +11 -11
- package/resources/reactions.js.map +1 -1
- package/resources/reactions.mjs +11 -11
- package/resources/reactions.mjs.map +1 -1
- package/resources/refunds.d.mts +59 -10
- package/resources/refunds.d.mts.map +1 -1
- package/resources/refunds.d.ts +59 -10
- package/resources/refunds.d.ts.map +1 -1
- package/resources/refunds.js +12 -10
- package/resources/refunds.js.map +1 -1
- package/resources/refunds.mjs +12 -10
- package/resources/refunds.mjs.map +1 -1
- package/resources/resolution-center-cases.d.mts +6 -6
- package/resources/resolution-center-cases.d.mts.map +1 -1
- package/resources/resolution-center-cases.d.ts +6 -6
- package/resources/resolution-center-cases.d.ts.map +1 -1
- package/resources/resolution-center-cases.js +10 -10
- package/resources/resolution-center-cases.js.map +1 -1
- package/resources/resolution-center-cases.mjs +10 -10
- package/resources/resolution-center-cases.mjs.map +1 -1
- package/resources/reviews.d.mts +4 -4
- package/resources/reviews.d.mts.map +1 -1
- package/resources/reviews.d.ts +4 -4
- package/resources/reviews.d.ts.map +1 -1
- package/resources/reviews.js +6 -6
- package/resources/reviews.js.map +1 -1
- package/resources/reviews.mjs +6 -6
- package/resources/reviews.mjs.map +1 -1
- package/resources/setup-intents.d.mts +6 -6
- package/resources/setup-intents.d.mts.map +1 -1
- package/resources/setup-intents.d.ts +6 -6
- package/resources/setup-intents.d.ts.map +1 -1
- package/resources/setup-intents.js +11 -11
- package/resources/setup-intents.js.map +1 -1
- package/resources/setup-intents.mjs +11 -11
- package/resources/setup-intents.mjs.map +1 -1
- package/resources/shared.d.mts +100 -6
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +100 -6
- package/resources/shared.d.ts.map +1 -1
- package/resources/shipments.d.mts +35 -35
- package/resources/shipments.d.mts.map +1 -1
- package/resources/shipments.d.ts +35 -35
- package/resources/shipments.d.ts.map +1 -1
- package/resources/shipments.js +20 -20
- package/resources/shipments.js.map +1 -1
- package/resources/shipments.mjs +20 -20
- package/resources/shipments.mjs.map +1 -1
- package/resources/support-channels.d.mts +42 -38
- package/resources/support-channels.d.mts.map +1 -1
- package/resources/support-channels.d.ts +42 -38
- package/resources/support-channels.d.ts.map +1 -1
- package/resources/support-channels.js +21 -23
- package/resources/support-channels.js.map +1 -1
- package/resources/support-channels.mjs +21 -23
- package/resources/support-channels.mjs.map +1 -1
- package/resources/swaps.d.mts +62 -0
- package/resources/swaps.d.mts.map +1 -0
- package/resources/swaps.d.ts +62 -0
- package/resources/swaps.d.ts.map +1 -0
- package/resources/swaps.js +15 -0
- package/resources/swaps.js.map +1 -0
- package/resources/swaps.mjs +11 -0
- package/resources/swaps.mjs.map +1 -0
- package/resources/transfers.d.mts +57 -55
- package/resources/transfers.d.mts.map +1 -1
- package/resources/transfers.d.ts +57 -55
- package/resources/transfers.d.ts.map +1 -1
- package/resources/transfers.js +19 -19
- package/resources/transfers.js.map +1 -1
- package/resources/transfers.mjs +19 -19
- package/resources/transfers.mjs.map +1 -1
- package/resources/users.d.mts +20 -20
- package/resources/users.d.mts.map +1 -1
- package/resources/users.d.ts +20 -20
- package/resources/users.d.ts.map +1 -1
- package/resources/users.js +16 -16
- package/resources/users.js.map +1 -1
- package/resources/users.mjs +16 -16
- package/resources/users.mjs.map +1 -1
- package/resources/verifications.d.mts +2 -2
- package/resources/verifications.d.ts +2 -2
- package/resources/wallets.d.mts +89 -0
- package/resources/wallets.d.mts.map +1 -0
- package/resources/wallets.d.ts +89 -0
- package/resources/wallets.d.ts.map +1 -0
- package/resources/wallets.js +28 -0
- package/resources/wallets.js.map +1 -0
- package/resources/wallets.mjs +24 -0
- package/resources/wallets.mjs.map +1 -0
- package/resources/webhooks.d.mts +2182 -1196
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +2182 -1196
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/webhooks.js +31 -31
- package/resources/webhooks.js.map +1 -1
- package/resources/webhooks.mjs +31 -31
- package/resources/webhooks.mjs.map +1 -1
- package/resources/withdrawals.d.mts +47 -47
- package/resources/withdrawals.d.mts.map +1 -1
- package/resources/withdrawals.d.ts +47 -47
- package/resources/withdrawals.d.ts.map +1 -1
- package/resources/withdrawals.js +21 -21
- package/resources/withdrawals.js.map +1 -1
- package/resources/withdrawals.mjs +21 -21
- package/resources/withdrawals.mjs.map +1 -1
- package/src/client.ts +277 -60
- package/src/internal/types.ts +6 -8
- package/src/internal/utils/log.ts +2 -0
- package/src/resources/accounts.ts +318 -0
- package/src/resources/ad-campaigns.ts +376 -0
- package/src/resources/ad-groups.ts +1958 -0
- package/src/resources/ad-reports.ts +484 -0
- package/src/resources/ads.ts +295 -0
- package/src/resources/affiliates/affiliates.ts +39 -39
- package/src/resources/affiliates/index.ts +2 -2
- package/src/resources/affiliates/overrides.ts +51 -51
- package/src/resources/ai-chats.ts +33 -33
- package/src/resources/app-builds.ts +68 -68
- package/src/resources/apps.ts +86 -86
- package/src/resources/authorized-users.ts +48 -48
- package/src/resources/bounties.ts +353 -0
- package/src/resources/chat-channels.ts +57 -57
- package/src/resources/checkout-configurations.ts +101 -67
- package/src/resources/companies.ts +123 -41
- package/src/resources/company-token-transactions.ts +55 -55
- package/src/resources/conversions.ts +316 -0
- package/src/resources/course-chapters.ts +47 -47
- package/src/resources/course-lesson-interactions.ts +12 -12
- package/src/resources/course-lessons.ts +54 -54
- package/src/resources/course-students.ts +12 -12
- package/src/resources/courses.ts +51 -51
- package/src/resources/deposits.ts +87 -0
- package/src/resources/dispute-alerts.ts +18 -18
- package/src/resources/disputes.ts +18 -20
- package/src/resources/dm-channels.ts +45 -45
- package/src/resources/dm-members.ts +45 -45
- package/src/resources/entries.ts +10 -10
- package/src/resources/experiences.ts +64 -64
- package/src/resources/fee-markups.ts +44 -44
- package/src/resources/files.ts +22 -0
- package/src/resources/forum-posts.ts +65 -60
- package/src/resources/forums.ts +44 -44
- package/src/resources/index.ts +129 -57
- package/src/resources/invoices.ts +116 -110
- package/src/resources/leads.ts +64 -64
- package/src/resources/ledger-accounts.ts +41 -1
- package/src/resources/members.ts +14 -12
- package/src/resources/memberships.ts +80 -61
- package/src/resources/messages.ts +48 -48
- package/src/resources/payment-methods.ts +30 -30
- package/src/resources/payments.ts +229 -183
- package/src/resources/payout-accounts.ts +1 -1
- package/src/resources/payout-methods.ts +11 -11
- package/src/resources/plans.ts +153 -90
- package/src/resources/products.ts +98 -84
- package/src/resources/promo-codes.ts +74 -74
- package/src/resources/reactions.ts +33 -33
- package/src/resources/refunds.ts +65 -15
- package/src/resources/resolution-center-cases.ts +11 -12
- package/src/resources/reviews.ts +7 -7
- package/src/resources/setup-intents.ts +13 -13
- package/src/resources/shared.ts +107 -5
- package/src/resources/shipments.ts +44 -44
- package/src/resources/support-channels.ts +54 -49
- package/src/resources/swaps.ts +87 -0
- package/src/resources/transfers.ts +68 -66
- package/src/resources/users.ts +29 -29
- package/src/resources/verifications.ts +2 -2
- package/src/resources/wallets.ts +136 -0
- package/src/resources/webhooks.ts +2449 -1277
- package/src/resources/withdrawals.ts +55 -55
- 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
|
@@ -22,6 +22,44 @@ import { path } from '../internal/utils/path';
|
|
|
22
22
|
* Webhooks
|
|
23
23
|
*/
|
|
24
24
|
export class Webhooks extends APIResource {
|
|
25
|
+
unwrap(
|
|
26
|
+
body: string,
|
|
27
|
+
{ headers, key }: { headers: Record<string, string>; key?: string },
|
|
28
|
+
): UnwrapWebhookEvent {
|
|
29
|
+
if (headers !== undefined) {
|
|
30
|
+
const keyStr: string | null = key === undefined ? this._client.webhookKey : key;
|
|
31
|
+
if (keyStr === null) throw new Error('Webhook key must not be null in order to unwrap');
|
|
32
|
+
const wh = new Webhook_(keyStr);
|
|
33
|
+
wh.verify(body, headers);
|
|
34
|
+
}
|
|
35
|
+
return JSON.parse(body) as UnwrapWebhookEvent;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* Returns a paginated list of webhook endpoints configured for a company, ordered
|
|
40
|
+
* by most recently created.
|
|
41
|
+
*
|
|
42
|
+
* Required permissions:
|
|
43
|
+
*
|
|
44
|
+
* - `developer:manage_webhook`
|
|
45
|
+
*
|
|
46
|
+
* @example
|
|
47
|
+
* ```ts
|
|
48
|
+
* // Automatically fetches more pages as needed.
|
|
49
|
+
* for await (const webhookListResponse of client.webhooks.list(
|
|
50
|
+
* { company_id: 'biz_xxxxxxxxxxxxxx' },
|
|
51
|
+
* )) {
|
|
52
|
+
* // ...
|
|
53
|
+
* }
|
|
54
|
+
* ```
|
|
55
|
+
*/
|
|
56
|
+
list(
|
|
57
|
+
query: WebhookListParams,
|
|
58
|
+
options?: RequestOptions,
|
|
59
|
+
): PagePromise<WebhookListResponsesCursorPage, WebhookListResponse> {
|
|
60
|
+
return this._client.getAPIList('/webhooks', CursorPage<WebhookListResponse>, { query, ...options });
|
|
61
|
+
}
|
|
62
|
+
|
|
25
63
|
/**
|
|
26
64
|
* Creates a new webhook
|
|
27
65
|
*
|
|
@@ -80,31 +118,6 @@ export class Webhooks extends APIResource {
|
|
|
80
118
|
return this._client.patch(path`/webhooks/${id}`, { body, ...options });
|
|
81
119
|
}
|
|
82
120
|
|
|
83
|
-
/**
|
|
84
|
-
* Returns a paginated list of webhook endpoints configured for a company, ordered
|
|
85
|
-
* by most recently created.
|
|
86
|
-
*
|
|
87
|
-
* Required permissions:
|
|
88
|
-
*
|
|
89
|
-
* - `developer:manage_webhook`
|
|
90
|
-
*
|
|
91
|
-
* @example
|
|
92
|
-
* ```ts
|
|
93
|
-
* // Automatically fetches more pages as needed.
|
|
94
|
-
* for await (const webhookListResponse of client.webhooks.list(
|
|
95
|
-
* { company_id: 'biz_xxxxxxxxxxxxxx' },
|
|
96
|
-
* )) {
|
|
97
|
-
* // ...
|
|
98
|
-
* }
|
|
99
|
-
* ```
|
|
100
|
-
*/
|
|
101
|
-
list(
|
|
102
|
-
query: WebhookListParams,
|
|
103
|
-
options?: RequestOptions,
|
|
104
|
-
): PagePromise<WebhookListResponsesCursorPage, WebhookListResponse> {
|
|
105
|
-
return this._client.getAPIList('/webhooks', CursorPage<WebhookListResponse>, { query, ...options });
|
|
106
|
-
}
|
|
107
|
-
|
|
108
121
|
/**
|
|
109
122
|
* Deletes a webhook
|
|
110
123
|
*
|
|
@@ -122,19 +135,6 @@ export class Webhooks extends APIResource {
|
|
|
122
135
|
delete(id: string, options?: RequestOptions): APIPromise<WebhookDeleteResponse> {
|
|
123
136
|
return this._client.delete(path`/webhooks/${id}`, options);
|
|
124
137
|
}
|
|
125
|
-
|
|
126
|
-
unwrap(
|
|
127
|
-
body: string,
|
|
128
|
-
{ headers, key }: { headers: Record<string, string>; key?: string },
|
|
129
|
-
): UnwrapWebhookEvent {
|
|
130
|
-
if (headers !== undefined) {
|
|
131
|
-
const keyStr: string | null = key === undefined ? this._client.webhookKey : key;
|
|
132
|
-
if (keyStr === null) throw new Error('Webhook key must not be null in order to unwrap');
|
|
133
|
-
const wh = new Webhook_(keyStr);
|
|
134
|
-
wh.verify(body, headers);
|
|
135
|
-
}
|
|
136
|
-
return JSON.parse(body) as UnwrapWebhookEvent;
|
|
137
|
-
}
|
|
138
138
|
}
|
|
139
139
|
|
|
140
140
|
export type WebhookListResponsesCursorPage = CursorPage<WebhookListResponse>;
|
|
@@ -220,6 +220,10 @@ export type WebhookEvent =
|
|
|
220
220
|
| 'course_lesson_interaction.completed'
|
|
221
221
|
| 'payout_method.created'
|
|
222
222
|
| 'verification.succeeded'
|
|
223
|
+
| 'identity_profile.approved'
|
|
224
|
+
| 'identity_profile.rejected'
|
|
225
|
+
| 'identity_profile.needs_action'
|
|
226
|
+
| 'identity_profile.updated'
|
|
223
227
|
| 'payout_account.status_updated'
|
|
224
228
|
| 'resolution_center_case.created'
|
|
225
229
|
| 'resolution_center_case.updated'
|
|
@@ -342,7 +346,7 @@ export interface WebhookListResponse {
|
|
|
342
346
|
*/
|
|
343
347
|
export type WebhookDeleteResponse = boolean;
|
|
344
348
|
|
|
345
|
-
export interface
|
|
349
|
+
export interface CourseLessonInteractionCompletedWebhookEvent {
|
|
346
350
|
/**
|
|
347
351
|
* A unique ID for every single webhook request
|
|
348
352
|
*/
|
|
@@ -354,11 +358,10 @@ export interface InvoiceCreatedWebhookEvent {
|
|
|
354
358
|
api_version: 'v1';
|
|
355
359
|
|
|
356
360
|
/**
|
|
357
|
-
*
|
|
358
|
-
*
|
|
359
|
-
* status.
|
|
361
|
+
* A record of a user's progress on a specific lesson, tracking whether they have
|
|
362
|
+
* completed it.
|
|
360
363
|
*/
|
|
361
|
-
data: Shared.
|
|
364
|
+
data: Shared.CourseLessonInteraction;
|
|
362
365
|
|
|
363
366
|
/**
|
|
364
367
|
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
@@ -368,7 +371,7 @@ export interface InvoiceCreatedWebhookEvent {
|
|
|
368
371
|
/**
|
|
369
372
|
* The webhook event type
|
|
370
373
|
*/
|
|
371
|
-
type: '
|
|
374
|
+
type: 'course_lesson_interaction.completed';
|
|
372
375
|
|
|
373
376
|
/**
|
|
374
377
|
* The company ID that this webhook event is associated with
|
|
@@ -376,7 +379,7 @@ export interface InvoiceCreatedWebhookEvent {
|
|
|
376
379
|
company_id?: string | null;
|
|
377
380
|
}
|
|
378
381
|
|
|
379
|
-
export interface
|
|
382
|
+
export interface DisputeCreatedWebhookEvent {
|
|
380
383
|
/**
|
|
381
384
|
* A unique ID for every single webhook request
|
|
382
385
|
*/
|
|
@@ -388,11 +391,10 @@ export interface InvoiceMarkedUncollectibleWebhookEvent {
|
|
|
388
391
|
api_version: 'v1';
|
|
389
392
|
|
|
390
393
|
/**
|
|
391
|
-
*
|
|
392
|
-
*
|
|
393
|
-
* status.
|
|
394
|
+
* A dispute is a chargeback or payment challenge filed against a company,
|
|
395
|
+
* including evidence and response status.
|
|
394
396
|
*/
|
|
395
|
-
data:
|
|
397
|
+
data: DisputesAPI.Dispute;
|
|
396
398
|
|
|
397
399
|
/**
|
|
398
400
|
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
@@ -402,7 +404,7 @@ export interface InvoiceMarkedUncollectibleWebhookEvent {
|
|
|
402
404
|
/**
|
|
403
405
|
* The webhook event type
|
|
404
406
|
*/
|
|
405
|
-
type: '
|
|
407
|
+
type: 'dispute.created';
|
|
406
408
|
|
|
407
409
|
/**
|
|
408
410
|
* The company ID that this webhook event is associated with
|
|
@@ -410,7 +412,7 @@ export interface InvoiceMarkedUncollectibleWebhookEvent {
|
|
|
410
412
|
company_id?: string | null;
|
|
411
413
|
}
|
|
412
414
|
|
|
413
|
-
export interface
|
|
415
|
+
export interface DisputeUpdatedWebhookEvent {
|
|
414
416
|
/**
|
|
415
417
|
* A unique ID for every single webhook request
|
|
416
418
|
*/
|
|
@@ -422,11 +424,10 @@ export interface InvoicePaidWebhookEvent {
|
|
|
422
424
|
api_version: 'v1';
|
|
423
425
|
|
|
424
426
|
/**
|
|
425
|
-
*
|
|
426
|
-
*
|
|
427
|
-
* status.
|
|
427
|
+
* A dispute is a chargeback or payment challenge filed against a company,
|
|
428
|
+
* including evidence and response status.
|
|
428
429
|
*/
|
|
429
|
-
data:
|
|
430
|
+
data: DisputesAPI.Dispute;
|
|
430
431
|
|
|
431
432
|
/**
|
|
432
433
|
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
@@ -436,7 +437,7 @@ export interface InvoicePaidWebhookEvent {
|
|
|
436
437
|
/**
|
|
437
438
|
* The webhook event type
|
|
438
439
|
*/
|
|
439
|
-
type: '
|
|
440
|
+
type: 'dispute.updated';
|
|
440
441
|
|
|
441
442
|
/**
|
|
442
443
|
* The company ID that this webhook event is associated with
|
|
@@ -444,7 +445,7 @@ export interface InvoicePaidWebhookEvent {
|
|
|
444
445
|
company_id?: string | null;
|
|
445
446
|
}
|
|
446
447
|
|
|
447
|
-
export interface
|
|
448
|
+
export interface DisputeAlertCreatedWebhookEvent {
|
|
448
449
|
/**
|
|
449
450
|
* A unique ID for every single webhook request
|
|
450
451
|
*/
|
|
@@ -456,11 +457,10 @@ export interface InvoicePastDueWebhookEvent {
|
|
|
456
457
|
api_version: 'v1';
|
|
457
458
|
|
|
458
459
|
/**
|
|
459
|
-
*
|
|
460
|
-
*
|
|
461
|
-
* status.
|
|
460
|
+
* A dispute alert represents an early warning notification from a payment
|
|
461
|
+
* processor about a potential dispute or chargeback.
|
|
462
462
|
*/
|
|
463
|
-
data:
|
|
463
|
+
data: DisputeAlertCreatedWebhookEvent.Data;
|
|
464
464
|
|
|
465
465
|
/**
|
|
466
466
|
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
@@ -470,7 +470,7 @@ export interface InvoicePastDueWebhookEvent {
|
|
|
470
470
|
/**
|
|
471
471
|
* The webhook event type
|
|
472
472
|
*/
|
|
473
|
-
type: '
|
|
473
|
+
type: 'dispute_alert.created';
|
|
474
474
|
|
|
475
475
|
/**
|
|
476
476
|
* The company ID that this webhook event is associated with
|
|
@@ -478,136 +478,235 @@ export interface InvoicePastDueWebhookEvent {
|
|
|
478
478
|
company_id?: string | null;
|
|
479
479
|
}
|
|
480
480
|
|
|
481
|
-
export
|
|
482
|
-
/**
|
|
483
|
-
* A unique ID for every single webhook request
|
|
484
|
-
*/
|
|
485
|
-
id: string;
|
|
486
|
-
|
|
481
|
+
export namespace DisputeAlertCreatedWebhookEvent {
|
|
487
482
|
/**
|
|
488
|
-
*
|
|
483
|
+
* A dispute alert represents an early warning notification from a payment
|
|
484
|
+
* processor about a potential dispute or chargeback.
|
|
489
485
|
*/
|
|
490
|
-
|
|
486
|
+
export interface Data {
|
|
487
|
+
/**
|
|
488
|
+
* The unique identifier of the dispute alert.
|
|
489
|
+
*/
|
|
490
|
+
id: string;
|
|
491
491
|
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
*/
|
|
497
|
-
data: Shared.Invoice;
|
|
492
|
+
/**
|
|
493
|
+
* The type of the dispute alert.
|
|
494
|
+
*/
|
|
495
|
+
alert_type: DisputeAlertsAPI.DisputeAlertType;
|
|
498
496
|
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
497
|
+
/**
|
|
498
|
+
* The alerted amount in the specified currency.
|
|
499
|
+
*/
|
|
500
|
+
amount: number;
|
|
503
501
|
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
502
|
+
/**
|
|
503
|
+
* Whether this alert incurs a charge.
|
|
504
|
+
*/
|
|
505
|
+
charge_for_alert: boolean;
|
|
508
506
|
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
}
|
|
507
|
+
/**
|
|
508
|
+
* The time the dispute alert was created.
|
|
509
|
+
*/
|
|
510
|
+
created_at: string;
|
|
514
511
|
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
id: string;
|
|
512
|
+
/**
|
|
513
|
+
* The three-letter ISO currency code for the alerted amount.
|
|
514
|
+
*/
|
|
515
|
+
currency: Shared.Currency;
|
|
520
516
|
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
517
|
+
/**
|
|
518
|
+
* The dispute associated with the dispute alert.
|
|
519
|
+
*/
|
|
520
|
+
dispute: Data.Dispute | null;
|
|
525
521
|
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
data: Shared.Membership;
|
|
522
|
+
/**
|
|
523
|
+
* The payment associated with the dispute alert.
|
|
524
|
+
*/
|
|
525
|
+
payment: Data.Payment | null;
|
|
531
526
|
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
527
|
+
/**
|
|
528
|
+
* The date of the original transaction.
|
|
529
|
+
*/
|
|
530
|
+
transaction_date: string | null;
|
|
531
|
+
}
|
|
536
532
|
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
533
|
+
export namespace Data {
|
|
534
|
+
/**
|
|
535
|
+
* The dispute associated with the dispute alert.
|
|
536
|
+
*/
|
|
537
|
+
export interface Dispute {
|
|
538
|
+
/**
|
|
539
|
+
* The unique identifier for the dispute.
|
|
540
|
+
*/
|
|
541
|
+
id: string;
|
|
541
542
|
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
}
|
|
543
|
+
/**
|
|
544
|
+
* The disputed amount in the specified currency, formatted as a decimal.
|
|
545
|
+
*/
|
|
546
|
+
amount: number;
|
|
547
547
|
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
id: string;
|
|
548
|
+
/**
|
|
549
|
+
* The datetime the dispute was created.
|
|
550
|
+
*/
|
|
551
|
+
created_at: string | null;
|
|
553
552
|
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
553
|
+
/**
|
|
554
|
+
* The three-letter ISO currency code for the disputed amount.
|
|
555
|
+
*/
|
|
556
|
+
currency: Shared.Currency;
|
|
558
557
|
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
data: Shared.Membership;
|
|
558
|
+
/**
|
|
559
|
+
* A human-readable reason for the dispute.
|
|
560
|
+
*/
|
|
561
|
+
reason: string | null;
|
|
564
562
|
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
563
|
+
/**
|
|
564
|
+
* The current status of the dispute lifecycle, such as needs_response,
|
|
565
|
+
* under_review, won, or lost.
|
|
566
|
+
*/
|
|
567
|
+
status: DisputesAPI.DisputeStatuses;
|
|
568
|
+
}
|
|
569
569
|
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
570
|
+
/**
|
|
571
|
+
* The payment associated with the dispute alert.
|
|
572
|
+
*/
|
|
573
|
+
export interface Payment {
|
|
574
|
+
/**
|
|
575
|
+
* The unique identifier for the payment.
|
|
576
|
+
*/
|
|
577
|
+
id: string;
|
|
574
578
|
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
}
|
|
579
|
+
/**
|
|
580
|
+
* The reason why a specific payment was billed
|
|
581
|
+
*/
|
|
582
|
+
billing_reason: PaymentsAPI.BillingReasons | null;
|
|
580
583
|
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
id: string;
|
|
584
|
+
/**
|
|
585
|
+
* Possible card brands that a payment token can have
|
|
586
|
+
*/
|
|
587
|
+
card_brand: PaymentsAPI.CardBrands | null;
|
|
586
588
|
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
589
|
+
/**
|
|
590
|
+
* The last four digits of the card used to make this payment. Null if the payment
|
|
591
|
+
* was not made with a card.
|
|
592
|
+
*/
|
|
593
|
+
card_last4: string | null;
|
|
591
594
|
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
595
|
+
/**
|
|
596
|
+
* The datetime the payment was created.
|
|
597
|
+
*/
|
|
598
|
+
created_at: string;
|
|
596
599
|
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
600
|
+
/**
|
|
601
|
+
* The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
|
|
602
|
+
*/
|
|
603
|
+
currency: Shared.Currency;
|
|
601
604
|
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
605
|
+
/**
|
|
606
|
+
* When an alert came in that this transaction will be disputed
|
|
607
|
+
*/
|
|
608
|
+
dispute_alerted_at: string | null;
|
|
606
609
|
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
610
|
+
/**
|
|
611
|
+
* The member attached to this payment.
|
|
612
|
+
*/
|
|
613
|
+
member: Payment.Member | null;
|
|
614
|
+
|
|
615
|
+
/**
|
|
616
|
+
* The membership attached to this payment.
|
|
617
|
+
*/
|
|
618
|
+
membership: Payment.Membership | null;
|
|
619
|
+
|
|
620
|
+
/**
|
|
621
|
+
* The time at which this payment was successfully collected. Null if the payment
|
|
622
|
+
* has not yet succeeded. As a Unix timestamp.
|
|
623
|
+
*/
|
|
624
|
+
paid_at: string | null;
|
|
625
|
+
|
|
626
|
+
/**
|
|
627
|
+
* The different types of payment methods that can be used.
|
|
628
|
+
*/
|
|
629
|
+
payment_method_type: PaymentsAPI.PaymentMethodTypes | null;
|
|
630
|
+
|
|
631
|
+
/**
|
|
632
|
+
* The subtotal to show to the creator (excluding buyer fees).
|
|
633
|
+
*/
|
|
634
|
+
subtotal: number | null;
|
|
635
|
+
|
|
636
|
+
/**
|
|
637
|
+
* The total to show to the creator (excluding buyer fees).
|
|
638
|
+
*/
|
|
639
|
+
total: number | null;
|
|
640
|
+
|
|
641
|
+
/**
|
|
642
|
+
* The total in USD to show to the creator (excluding buyer fees).
|
|
643
|
+
*/
|
|
644
|
+
usd_total: number | null;
|
|
645
|
+
|
|
646
|
+
/**
|
|
647
|
+
* The user that made this payment.
|
|
648
|
+
*/
|
|
649
|
+
user: Payment.User | null;
|
|
650
|
+
}
|
|
651
|
+
|
|
652
|
+
export namespace Payment {
|
|
653
|
+
/**
|
|
654
|
+
* The member attached to this payment.
|
|
655
|
+
*/
|
|
656
|
+
export interface Member {
|
|
657
|
+
/**
|
|
658
|
+
* The unique identifier for the company member.
|
|
659
|
+
*/
|
|
660
|
+
id: string;
|
|
661
|
+
|
|
662
|
+
/**
|
|
663
|
+
* The phone number for the member, if available.
|
|
664
|
+
*/
|
|
665
|
+
phone: string | null;
|
|
666
|
+
}
|
|
667
|
+
|
|
668
|
+
/**
|
|
669
|
+
* The membership attached to this payment.
|
|
670
|
+
*/
|
|
671
|
+
export interface Membership {
|
|
672
|
+
/**
|
|
673
|
+
* The unique identifier for the membership.
|
|
674
|
+
*/
|
|
675
|
+
id: string;
|
|
676
|
+
|
|
677
|
+
/**
|
|
678
|
+
* The state of the membership.
|
|
679
|
+
*/
|
|
680
|
+
status: Shared.MembershipStatus;
|
|
681
|
+
}
|
|
682
|
+
|
|
683
|
+
/**
|
|
684
|
+
* The user that made this payment.
|
|
685
|
+
*/
|
|
686
|
+
export interface User {
|
|
687
|
+
/**
|
|
688
|
+
* The unique identifier for the user.
|
|
689
|
+
*/
|
|
690
|
+
id: string;
|
|
691
|
+
|
|
692
|
+
/**
|
|
693
|
+
* The user's email address. Requires the member:email:read permission to access.
|
|
694
|
+
* Null if not authorized.
|
|
695
|
+
*/
|
|
696
|
+
email: string | null;
|
|
697
|
+
|
|
698
|
+
/**
|
|
699
|
+
* The user's display name shown on their public profile.
|
|
700
|
+
*/
|
|
701
|
+
name: string | null;
|
|
702
|
+
|
|
703
|
+
/**
|
|
704
|
+
* The user's unique username shown on their public profile.
|
|
705
|
+
*/
|
|
706
|
+
username: string;
|
|
707
|
+
}
|
|
708
|
+
}
|
|
709
|
+
}
|
|
611
710
|
}
|
|
612
711
|
|
|
613
712
|
export interface EntryApprovedWebhookEvent {
|
|
@@ -642,7 +741,7 @@ export interface EntryApprovedWebhookEvent {
|
|
|
642
741
|
company_id?: string | null;
|
|
643
742
|
}
|
|
644
743
|
|
|
645
|
-
export interface
|
|
744
|
+
export interface EntryCreatedWebhookEvent {
|
|
646
745
|
/**
|
|
647
746
|
* A unique ID for every single webhook request
|
|
648
747
|
*/
|
|
@@ -666,7 +765,7 @@ export interface EntryDeniedWebhookEvent {
|
|
|
666
765
|
/**
|
|
667
766
|
* The webhook event type
|
|
668
767
|
*/
|
|
669
|
-
type: 'entry.
|
|
768
|
+
type: 'entry.created';
|
|
670
769
|
|
|
671
770
|
/**
|
|
672
771
|
* The company ID that this webhook event is associated with
|
|
@@ -706,7 +805,7 @@ export interface EntryDeletedWebhookEvent {
|
|
|
706
805
|
company_id?: string | null;
|
|
707
806
|
}
|
|
708
807
|
|
|
709
|
-
export interface
|
|
808
|
+
export interface EntryDeniedWebhookEvent {
|
|
710
809
|
/**
|
|
711
810
|
* A unique ID for every single webhook request
|
|
712
811
|
*/
|
|
@@ -718,10 +817,9 @@ export interface SetupIntentRequiresActionWebhookEvent {
|
|
|
718
817
|
api_version: 'v1';
|
|
719
818
|
|
|
720
819
|
/**
|
|
721
|
-
*
|
|
722
|
-
* making an immediate purchase.
|
|
820
|
+
* An entry represents a user's signup for a waitlisted plan.
|
|
723
821
|
*/
|
|
724
|
-
data:
|
|
822
|
+
data: Shared.Entry;
|
|
725
823
|
|
|
726
824
|
/**
|
|
727
825
|
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
@@ -731,7 +829,7 @@ export interface SetupIntentRequiresActionWebhookEvent {
|
|
|
731
829
|
/**
|
|
732
830
|
* The webhook event type
|
|
733
831
|
*/
|
|
734
|
-
type: '
|
|
832
|
+
type: 'entry.denied';
|
|
735
833
|
|
|
736
834
|
/**
|
|
737
835
|
* The company ID that this webhook event is associated with
|
|
@@ -739,7 +837,7 @@ export interface SetupIntentRequiresActionWebhookEvent {
|
|
|
739
837
|
company_id?: string | null;
|
|
740
838
|
}
|
|
741
839
|
|
|
742
|
-
export interface
|
|
840
|
+
export interface IdentityProfileApprovedWebhookEvent {
|
|
743
841
|
/**
|
|
744
842
|
* A unique ID for every single webhook request
|
|
745
843
|
*/
|
|
@@ -751,10 +849,10 @@ export interface SetupIntentSucceededWebhookEvent {
|
|
|
751
849
|
api_version: 'v1';
|
|
752
850
|
|
|
753
851
|
/**
|
|
754
|
-
* A
|
|
755
|
-
*
|
|
852
|
+
* A consolidated identity or business profile synced from verification provider
|
|
853
|
+
* data.
|
|
756
854
|
*/
|
|
757
|
-
data:
|
|
855
|
+
data: IdentityProfileApprovedWebhookEvent.Data;
|
|
758
856
|
|
|
759
857
|
/**
|
|
760
858
|
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
@@ -764,7 +862,7 @@ export interface SetupIntentSucceededWebhookEvent {
|
|
|
764
862
|
/**
|
|
765
863
|
* The webhook event type
|
|
766
864
|
*/
|
|
767
|
-
type: '
|
|
865
|
+
type: 'identity_profile.approved';
|
|
768
866
|
|
|
769
867
|
/**
|
|
770
868
|
* The company ID that this webhook event is associated with
|
|
@@ -772,266 +870,240 @@ export interface SetupIntentSucceededWebhookEvent {
|
|
|
772
870
|
company_id?: string | null;
|
|
773
871
|
}
|
|
774
872
|
|
|
775
|
-
export
|
|
873
|
+
export namespace IdentityProfileApprovedWebhookEvent {
|
|
776
874
|
/**
|
|
777
|
-
* A
|
|
875
|
+
* A consolidated identity or business profile synced from verification provider
|
|
876
|
+
* data.
|
|
778
877
|
*/
|
|
779
|
-
|
|
878
|
+
export interface Data {
|
|
879
|
+
/**
|
|
880
|
+
* The tag of the identity profile (idpf_xxx).
|
|
881
|
+
*/
|
|
882
|
+
id: string;
|
|
780
883
|
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
884
|
+
/**
|
|
885
|
+
* Registered business address reported by the identity provider. Present on
|
|
886
|
+
* `business` profiles.
|
|
887
|
+
*/
|
|
888
|
+
business_address: Data.BusinessAddress | null;
|
|
785
889
|
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
data: SetupIntentsAPI.SetupIntent;
|
|
890
|
+
/**
|
|
891
|
+
* Business entity name. Present on `business` profiles.
|
|
892
|
+
*/
|
|
893
|
+
business_name: string | null;
|
|
791
894
|
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
|
|
895
|
+
/**
|
|
896
|
+
* Reported legal structure of a business profile (e.g. `corp`, `llc`).
|
|
897
|
+
* Provider-specific values; present on `business` profiles.
|
|
898
|
+
*/
|
|
899
|
+
business_structure: string | null;
|
|
796
900
|
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
|
|
800
|
-
|
|
901
|
+
/**
|
|
902
|
+
* ISO 3166-1 alpha-3 country code (e.g. `USA`, `GBR`). For individuals this is the
|
|
903
|
+
* country of citizenship or residence reported by the identity provider; for
|
|
904
|
+
* businesses this is the country of incorporation.
|
|
905
|
+
*/
|
|
906
|
+
country: string | null;
|
|
801
907
|
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
}
|
|
908
|
+
/**
|
|
909
|
+
* When the identity profile was first created.
|
|
910
|
+
*/
|
|
911
|
+
created_at: string;
|
|
807
912
|
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
|
|
913
|
+
/**
|
|
914
|
+
* ISO date (`YYYY-MM-DD`) reported by the identity provider. Present on
|
|
915
|
+
* `individual` profiles.
|
|
916
|
+
*/
|
|
917
|
+
date_of_birth: string | null;
|
|
813
918
|
|
|
814
|
-
|
|
815
|
-
|
|
816
|
-
|
|
817
|
-
|
|
919
|
+
/**
|
|
920
|
+
* Email address reported by the identity provider. Typically present on
|
|
921
|
+
* `individual` profiles.
|
|
922
|
+
*/
|
|
923
|
+
email: string | null;
|
|
818
924
|
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
data: WithdrawalsAPI.Withdrawal;
|
|
925
|
+
/**
|
|
926
|
+
* Individual's first name.
|
|
927
|
+
*/
|
|
928
|
+
first_name: string | null;
|
|
824
929
|
|
|
825
|
-
/**
|
|
826
|
-
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
827
|
-
*/
|
|
828
|
-
timestamp: string;
|
|
829
|
-
|
|
830
|
-
/**
|
|
831
|
-
* The webhook event type
|
|
832
|
-
*/
|
|
833
|
-
type: 'withdrawal.created';
|
|
834
|
-
|
|
835
|
-
/**
|
|
836
|
-
* The company ID that this webhook event is associated with
|
|
837
|
-
*/
|
|
838
|
-
company_id?: string | null;
|
|
839
|
-
}
|
|
840
|
-
|
|
841
|
-
export interface WithdrawalUpdatedWebhookEvent {
|
|
842
|
-
/**
|
|
843
|
-
* A unique ID for every single webhook request
|
|
844
|
-
*/
|
|
845
|
-
id: string;
|
|
846
|
-
|
|
847
|
-
/**
|
|
848
|
-
* The API version for this webhook
|
|
849
|
-
*/
|
|
850
|
-
api_version: 'v1';
|
|
851
|
-
|
|
852
|
-
/**
|
|
853
|
-
* A withdrawal represents a request to transfer funds from a ledger account to an
|
|
854
|
-
* external payout method.
|
|
855
|
-
*/
|
|
856
|
-
data: WithdrawalsAPI.Withdrawal;
|
|
857
|
-
|
|
858
|
-
/**
|
|
859
|
-
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
860
|
-
*/
|
|
861
|
-
timestamp: string;
|
|
862
|
-
|
|
863
|
-
/**
|
|
864
|
-
* The webhook event type
|
|
865
|
-
*/
|
|
866
|
-
type: 'withdrawal.updated';
|
|
867
|
-
|
|
868
|
-
/**
|
|
869
|
-
* The company ID that this webhook event is associated with
|
|
870
|
-
*/
|
|
871
|
-
company_id?: string | null;
|
|
872
|
-
}
|
|
873
|
-
|
|
874
|
-
export interface CourseLessonInteractionCompletedWebhookEvent {
|
|
875
|
-
/**
|
|
876
|
-
* A unique ID for every single webhook request
|
|
877
|
-
*/
|
|
878
|
-
id: string;
|
|
879
|
-
|
|
880
|
-
/**
|
|
881
|
-
* The API version for this webhook
|
|
882
|
-
*/
|
|
883
|
-
api_version: 'v1';
|
|
884
|
-
|
|
885
|
-
/**
|
|
886
|
-
* A record of a user's progress on a specific lesson, tracking whether they have
|
|
887
|
-
* completed it.
|
|
888
|
-
*/
|
|
889
|
-
data: Shared.CourseLessonInteraction;
|
|
890
|
-
|
|
891
|
-
/**
|
|
892
|
-
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
893
|
-
*/
|
|
894
|
-
timestamp: string;
|
|
895
|
-
|
|
896
|
-
/**
|
|
897
|
-
* The webhook event type
|
|
898
|
-
*/
|
|
899
|
-
type: 'course_lesson_interaction.completed';
|
|
900
|
-
|
|
901
|
-
/**
|
|
902
|
-
* The company ID that this webhook event is associated with
|
|
903
|
-
*/
|
|
904
|
-
company_id?: string | null;
|
|
905
|
-
}
|
|
906
|
-
|
|
907
|
-
export interface PayoutMethodCreatedWebhookEvent {
|
|
908
|
-
/**
|
|
909
|
-
* A unique ID for every single webhook request
|
|
910
|
-
*/
|
|
911
|
-
id: string;
|
|
912
|
-
|
|
913
|
-
/**
|
|
914
|
-
* The API version for this webhook
|
|
915
|
-
*/
|
|
916
|
-
api_version: 'v1';
|
|
917
|
-
|
|
918
|
-
/**
|
|
919
|
-
* A configured payout destination where a user receives earned funds, such as a
|
|
920
|
-
* bank account or digital wallet.
|
|
921
|
-
*/
|
|
922
|
-
data: PayoutMethodCreatedWebhookEvent.Data;
|
|
923
|
-
|
|
924
|
-
/**
|
|
925
|
-
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
926
|
-
*/
|
|
927
|
-
timestamp: string;
|
|
928
|
-
|
|
929
|
-
/**
|
|
930
|
-
* The webhook event type
|
|
931
|
-
*/
|
|
932
|
-
type: 'payout_method.created';
|
|
933
|
-
|
|
934
|
-
/**
|
|
935
|
-
* The company ID that this webhook event is associated with
|
|
936
|
-
*/
|
|
937
|
-
company_id?: string | null;
|
|
938
|
-
}
|
|
939
|
-
|
|
940
|
-
export namespace PayoutMethodCreatedWebhookEvent {
|
|
941
|
-
/**
|
|
942
|
-
* A configured payout destination where a user receives earned funds, such as a
|
|
943
|
-
* bank account or digital wallet.
|
|
944
|
-
*/
|
|
945
|
-
export interface Data {
|
|
946
930
|
/**
|
|
947
|
-
*
|
|
931
|
+
* Individual's last name.
|
|
948
932
|
*/
|
|
949
|
-
|
|
933
|
+
last_name: string | null;
|
|
950
934
|
|
|
951
935
|
/**
|
|
952
|
-
*
|
|
953
|
-
*
|
|
936
|
+
* The companies this identity profile is currently linked to. Only populated for
|
|
937
|
+
* direct Whop user sessions; always empty when authenticated via API key, app, or
|
|
938
|
+
* OAuth scope (a single identity can be linked to companies the calling platform
|
|
939
|
+
* is not entitled to see).
|
|
954
940
|
*/
|
|
955
|
-
|
|
941
|
+
linked_companies: Array<Data.LinkedCompany>;
|
|
956
942
|
|
|
957
943
|
/**
|
|
958
|
-
*
|
|
959
|
-
*
|
|
944
|
+
* Residential address reported by the identity provider. Present on `individual`
|
|
945
|
+
* profiles.
|
|
960
946
|
*/
|
|
961
|
-
|
|
947
|
+
personal_address: Data.PersonalAddress | null;
|
|
962
948
|
|
|
963
949
|
/**
|
|
964
|
-
*
|
|
950
|
+
* Phone number reported by the identity provider. Typically present on
|
|
951
|
+
* `individual` profiles.
|
|
965
952
|
*/
|
|
966
|
-
|
|
953
|
+
phone: string | null;
|
|
967
954
|
|
|
968
955
|
/**
|
|
969
|
-
*
|
|
970
|
-
* destination.
|
|
956
|
+
* Whether this is an 'individual' or 'business' profile.
|
|
971
957
|
*/
|
|
972
|
-
|
|
958
|
+
profile_type: string;
|
|
973
959
|
|
|
974
960
|
/**
|
|
975
|
-
*
|
|
976
|
-
* configured.
|
|
961
|
+
* Derived verification status across all linked verifications.
|
|
977
962
|
*/
|
|
978
|
-
|
|
963
|
+
status: 'not_started' | 'pending' | 'approved' | 'rejected';
|
|
979
964
|
|
|
980
965
|
/**
|
|
981
|
-
*
|
|
982
|
-
* applicable or not provided.
|
|
966
|
+
* When the identity profile was last synced from a verification.
|
|
983
967
|
*/
|
|
984
|
-
|
|
968
|
+
updated_at: string;
|
|
985
969
|
|
|
986
970
|
/**
|
|
987
|
-
*
|
|
988
|
-
*
|
|
971
|
+
* All verification attempts attached to this identity profile, ordered most-recent
|
|
972
|
+
* first.
|
|
989
973
|
*/
|
|
990
|
-
|
|
974
|
+
verifications: Array<Data.Verification>;
|
|
975
|
+
}
|
|
991
976
|
|
|
977
|
+
export namespace Data {
|
|
992
978
|
/**
|
|
993
|
-
*
|
|
994
|
-
*
|
|
979
|
+
* Registered business address reported by the identity provider. Present on
|
|
980
|
+
* `business` profiles.
|
|
995
981
|
*/
|
|
996
|
-
|
|
997
|
-
|
|
982
|
+
export interface BusinessAddress {
|
|
983
|
+
/**
|
|
984
|
+
* The city of the address.
|
|
985
|
+
*/
|
|
986
|
+
city: string | null;
|
|
987
|
+
|
|
988
|
+
/**
|
|
989
|
+
* The country of the address.
|
|
990
|
+
*/
|
|
991
|
+
country: string | null;
|
|
992
|
+
|
|
993
|
+
/**
|
|
994
|
+
* The line 1 of the address.
|
|
995
|
+
*/
|
|
996
|
+
line1: string | null;
|
|
997
|
+
|
|
998
|
+
/**
|
|
999
|
+
* The line 2 of the address.
|
|
1000
|
+
*/
|
|
1001
|
+
line2: string | null;
|
|
1002
|
+
|
|
1003
|
+
/**
|
|
1004
|
+
* The postal code of the address.
|
|
1005
|
+
*/
|
|
1006
|
+
postal_code: string | null;
|
|
1007
|
+
|
|
1008
|
+
/**
|
|
1009
|
+
* The state of the address.
|
|
1010
|
+
*/
|
|
1011
|
+
state: string | null;
|
|
1012
|
+
}
|
|
998
1013
|
|
|
999
|
-
export namespace Data {
|
|
1000
1014
|
/**
|
|
1001
|
-
*
|
|
1002
|
-
*
|
|
1015
|
+
* A company is a seller on Whop. Companies own products, manage members, and
|
|
1016
|
+
* receive payouts.
|
|
1003
1017
|
*/
|
|
1004
|
-
export interface
|
|
1018
|
+
export interface LinkedCompany {
|
|
1005
1019
|
/**
|
|
1006
1020
|
* The unique identifier for the company.
|
|
1007
1021
|
*/
|
|
1008
1022
|
id: string;
|
|
1023
|
+
|
|
1024
|
+
/**
|
|
1025
|
+
* The display name of the company shown to customers.
|
|
1026
|
+
*/
|
|
1027
|
+
title: string;
|
|
1009
1028
|
}
|
|
1010
1029
|
|
|
1011
1030
|
/**
|
|
1012
|
-
*
|
|
1013
|
-
*
|
|
1031
|
+
* Residential address reported by the identity provider. Present on `individual`
|
|
1032
|
+
* profiles.
|
|
1014
1033
|
*/
|
|
1015
|
-
export interface
|
|
1034
|
+
export interface PersonalAddress {
|
|
1016
1035
|
/**
|
|
1017
|
-
* The
|
|
1036
|
+
* The city of the address.
|
|
1018
1037
|
*/
|
|
1019
|
-
|
|
1038
|
+
city: string | null;
|
|
1020
1039
|
|
|
1021
1040
|
/**
|
|
1022
|
-
* The country
|
|
1041
|
+
* The country of the address.
|
|
1023
1042
|
*/
|
|
1024
|
-
|
|
1043
|
+
country: string | null;
|
|
1025
1044
|
|
|
1026
1045
|
/**
|
|
1027
|
-
* The
|
|
1046
|
+
* The line 1 of the address.
|
|
1028
1047
|
*/
|
|
1029
|
-
|
|
1048
|
+
line1: string | null;
|
|
1049
|
+
|
|
1050
|
+
/**
|
|
1051
|
+
* The line 2 of the address.
|
|
1052
|
+
*/
|
|
1053
|
+
line2: string | null;
|
|
1054
|
+
|
|
1055
|
+
/**
|
|
1056
|
+
* The postal code of the address.
|
|
1057
|
+
*/
|
|
1058
|
+
postal_code: string | null;
|
|
1059
|
+
|
|
1060
|
+
/**
|
|
1061
|
+
* The state of the address.
|
|
1062
|
+
*/
|
|
1063
|
+
state: string | null;
|
|
1064
|
+
}
|
|
1065
|
+
|
|
1066
|
+
/**
|
|
1067
|
+
* An identity verification session used to confirm a person or entity's identity
|
|
1068
|
+
* for payout account eligibility.
|
|
1069
|
+
*/
|
|
1070
|
+
export interface Verification {
|
|
1071
|
+
/**
|
|
1072
|
+
* The numeric id of the verification record.
|
|
1073
|
+
*/
|
|
1074
|
+
id: string;
|
|
1075
|
+
|
|
1076
|
+
/**
|
|
1077
|
+
* When the verification record was created.
|
|
1078
|
+
*/
|
|
1079
|
+
created_at: string;
|
|
1080
|
+
|
|
1081
|
+
/**
|
|
1082
|
+
* An error code for a verification attempt.
|
|
1083
|
+
*/
|
|
1084
|
+
last_error_code: VerificationsAPI.VerificationErrorCode | null;
|
|
1085
|
+
|
|
1086
|
+
/**
|
|
1087
|
+
* A human-readable explanation of the most recent verification error. Null if no
|
|
1088
|
+
* error has occurred.
|
|
1089
|
+
*/
|
|
1090
|
+
last_error_reason: string | null;
|
|
1091
|
+
|
|
1092
|
+
/**
|
|
1093
|
+
* A URL the user can visit to complete the verification process. Null if the
|
|
1094
|
+
* session does not require user interaction.
|
|
1095
|
+
*/
|
|
1096
|
+
session_url: string | null;
|
|
1097
|
+
|
|
1098
|
+
/**
|
|
1099
|
+
* The current status of this verification session.
|
|
1100
|
+
*/
|
|
1101
|
+
status: VerificationsAPI.VerificationStatus;
|
|
1030
1102
|
}
|
|
1031
1103
|
}
|
|
1032
1104
|
}
|
|
1033
1105
|
|
|
1034
|
-
export interface
|
|
1106
|
+
export interface IdentityProfileNeedsActionWebhookEvent {
|
|
1035
1107
|
/**
|
|
1036
1108
|
* A unique ID for every single webhook request
|
|
1037
1109
|
*/
|
|
@@ -1043,10 +1115,10 @@ export interface VerificationSucceededWebhookEvent {
|
|
|
1043
1115
|
api_version: 'v1';
|
|
1044
1116
|
|
|
1045
1117
|
/**
|
|
1046
|
-
*
|
|
1047
|
-
*
|
|
1118
|
+
* A consolidated identity or business profile synced from verification provider
|
|
1119
|
+
* data.
|
|
1048
1120
|
*/
|
|
1049
|
-
data:
|
|
1121
|
+
data: IdentityProfileNeedsActionWebhookEvent.Data;
|
|
1050
1122
|
|
|
1051
1123
|
/**
|
|
1052
1124
|
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
@@ -1056,7 +1128,7 @@ export interface VerificationSucceededWebhookEvent {
|
|
|
1056
1128
|
/**
|
|
1057
1129
|
* The webhook event type
|
|
1058
1130
|
*/
|
|
1059
|
-
type: '
|
|
1131
|
+
type: 'identity_profile.needs_action';
|
|
1060
1132
|
|
|
1061
1133
|
/**
|
|
1062
1134
|
* The company ID that this webhook event is associated with
|
|
@@ -1064,119 +1136,116 @@ export interface VerificationSucceededWebhookEvent {
|
|
|
1064
1136
|
company_id?: string | null;
|
|
1065
1137
|
}
|
|
1066
1138
|
|
|
1067
|
-
export namespace
|
|
1139
|
+
export namespace IdentityProfileNeedsActionWebhookEvent {
|
|
1068
1140
|
/**
|
|
1069
|
-
*
|
|
1070
|
-
*
|
|
1141
|
+
* A consolidated identity or business profile synced from verification provider
|
|
1142
|
+
* data.
|
|
1071
1143
|
*/
|
|
1072
1144
|
export interface Data {
|
|
1073
1145
|
/**
|
|
1074
|
-
* The
|
|
1146
|
+
* The tag of the identity profile (idpf_xxx).
|
|
1075
1147
|
*/
|
|
1076
1148
|
id: string;
|
|
1077
1149
|
|
|
1078
1150
|
/**
|
|
1079
|
-
*
|
|
1151
|
+
* Registered business address reported by the identity provider. Present on
|
|
1152
|
+
* `business` profiles.
|
|
1080
1153
|
*/
|
|
1081
|
-
|
|
1154
|
+
business_address: Data.BusinessAddress | null;
|
|
1082
1155
|
|
|
1083
1156
|
/**
|
|
1084
|
-
*
|
|
1085
|
-
* error has occurred.
|
|
1157
|
+
* Business entity name. Present on `business` profiles.
|
|
1086
1158
|
*/
|
|
1087
|
-
|
|
1159
|
+
business_name: string | null;
|
|
1088
1160
|
|
|
1089
1161
|
/**
|
|
1090
|
-
*
|
|
1162
|
+
* Reported legal structure of a business profile (e.g. `corp`, `llc`).
|
|
1163
|
+
* Provider-specific values; present on `business` profiles.
|
|
1091
1164
|
*/
|
|
1092
|
-
|
|
1093
|
-
}
|
|
1094
|
-
}
|
|
1095
|
-
|
|
1096
|
-
export interface PayoutAccountStatusUpdatedWebhookEvent {
|
|
1097
|
-
/**
|
|
1098
|
-
* A unique ID for every single webhook request
|
|
1099
|
-
*/
|
|
1100
|
-
id: string;
|
|
1165
|
+
business_structure: string | null;
|
|
1101
1166
|
|
|
1102
|
-
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
|
|
1167
|
+
/**
|
|
1168
|
+
* ISO 3166-1 alpha-3 country code (e.g. `USA`, `GBR`). For individuals this is the
|
|
1169
|
+
* country of citizenship or residence reported by the identity provider; for
|
|
1170
|
+
* businesses this is the country of incorporation.
|
|
1171
|
+
*/
|
|
1172
|
+
country: string | null;
|
|
1106
1173
|
|
|
1107
|
-
|
|
1108
|
-
|
|
1109
|
-
|
|
1110
|
-
|
|
1174
|
+
/**
|
|
1175
|
+
* When the identity profile was first created.
|
|
1176
|
+
*/
|
|
1177
|
+
created_at: string;
|
|
1111
1178
|
|
|
1112
|
-
|
|
1113
|
-
|
|
1114
|
-
|
|
1115
|
-
|
|
1179
|
+
/**
|
|
1180
|
+
* ISO date (`YYYY-MM-DD`) reported by the identity provider. Present on
|
|
1181
|
+
* `individual` profiles.
|
|
1182
|
+
*/
|
|
1183
|
+
date_of_birth: string | null;
|
|
1116
1184
|
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
|
|
1185
|
+
/**
|
|
1186
|
+
* Email address reported by the identity provider. Typically present on
|
|
1187
|
+
* `individual` profiles.
|
|
1188
|
+
*/
|
|
1189
|
+
email: string | null;
|
|
1121
1190
|
|
|
1122
|
-
|
|
1123
|
-
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
}
|
|
1191
|
+
/**
|
|
1192
|
+
* Individual's first name.
|
|
1193
|
+
*/
|
|
1194
|
+
first_name: string | null;
|
|
1127
1195
|
|
|
1128
|
-
export namespace PayoutAccountStatusUpdatedWebhookEvent {
|
|
1129
|
-
/**
|
|
1130
|
-
* An object representing an account used for payouts.
|
|
1131
|
-
*/
|
|
1132
|
-
export interface Data {
|
|
1133
1196
|
/**
|
|
1134
|
-
*
|
|
1197
|
+
* Individual's last name.
|
|
1135
1198
|
*/
|
|
1136
|
-
|
|
1199
|
+
last_name: string | null;
|
|
1137
1200
|
|
|
1138
1201
|
/**
|
|
1139
|
-
* The
|
|
1202
|
+
* The companies this identity profile is currently linked to. Only populated for
|
|
1203
|
+
* direct Whop user sessions; always empty when authenticated via API key, app, or
|
|
1204
|
+
* OAuth scope (a single identity can be linked to companies the calling platform
|
|
1205
|
+
* is not entitled to see).
|
|
1140
1206
|
*/
|
|
1141
|
-
|
|
1207
|
+
linked_companies: Array<Data.LinkedCompany>;
|
|
1142
1208
|
|
|
1143
1209
|
/**
|
|
1144
|
-
*
|
|
1210
|
+
* Residential address reported by the identity provider. Present on `individual`
|
|
1211
|
+
* profiles.
|
|
1145
1212
|
*/
|
|
1146
|
-
|
|
1213
|
+
personal_address: Data.PersonalAddress | null;
|
|
1147
1214
|
|
|
1148
1215
|
/**
|
|
1149
|
-
*
|
|
1216
|
+
* Phone number reported by the identity provider. Typically present on
|
|
1217
|
+
* `individual` profiles.
|
|
1150
1218
|
*/
|
|
1151
|
-
|
|
1219
|
+
phone: string | null;
|
|
1152
1220
|
|
|
1153
1221
|
/**
|
|
1154
|
-
*
|
|
1222
|
+
* Whether this is an 'individual' or 'business' profile.
|
|
1155
1223
|
*/
|
|
1156
|
-
|
|
1224
|
+
profile_type: string;
|
|
1157
1225
|
|
|
1158
1226
|
/**
|
|
1159
|
-
*
|
|
1227
|
+
* Derived verification status across all linked verifications.
|
|
1160
1228
|
*/
|
|
1161
|
-
|
|
1229
|
+
status: 'not_started' | 'pending' | 'approved' | 'rejected';
|
|
1162
1230
|
|
|
1163
1231
|
/**
|
|
1164
|
-
*
|
|
1232
|
+
* When the identity profile was last synced from a verification.
|
|
1165
1233
|
*/
|
|
1166
|
-
|
|
1234
|
+
updated_at: string;
|
|
1167
1235
|
|
|
1168
1236
|
/**
|
|
1169
|
-
*
|
|
1170
|
-
*
|
|
1237
|
+
* All verification attempts attached to this identity profile, ordered most-recent
|
|
1238
|
+
* first.
|
|
1171
1239
|
*/
|
|
1172
|
-
|
|
1240
|
+
verifications: Array<Data.Verification>;
|
|
1173
1241
|
}
|
|
1174
1242
|
|
|
1175
1243
|
export namespace Data {
|
|
1176
1244
|
/**
|
|
1177
|
-
*
|
|
1245
|
+
* Registered business address reported by the identity provider. Present on
|
|
1246
|
+
* `business` profiles.
|
|
1178
1247
|
*/
|
|
1179
|
-
export interface
|
|
1248
|
+
export interface BusinessAddress {
|
|
1180
1249
|
/**
|
|
1181
1250
|
* The city of the address.
|
|
1182
1251
|
*/
|
|
@@ -1209,40 +1278,72 @@ export namespace PayoutAccountStatusUpdatedWebhookEvent {
|
|
|
1209
1278
|
}
|
|
1210
1279
|
|
|
1211
1280
|
/**
|
|
1212
|
-
*
|
|
1281
|
+
* A company is a seller on Whop. Companies own products, manage members, and
|
|
1282
|
+
* receive payouts.
|
|
1213
1283
|
*/
|
|
1214
|
-
export interface
|
|
1284
|
+
export interface LinkedCompany {
|
|
1215
1285
|
/**
|
|
1216
|
-
* The
|
|
1217
|
-
* (YYYY-MM-DD).
|
|
1286
|
+
* The unique identifier for the company.
|
|
1218
1287
|
*/
|
|
1219
|
-
|
|
1288
|
+
id: string;
|
|
1220
1289
|
|
|
1221
1290
|
/**
|
|
1222
|
-
* The
|
|
1291
|
+
* The display name of the company shown to customers.
|
|
1223
1292
|
*/
|
|
1224
|
-
|
|
1293
|
+
title: string;
|
|
1294
|
+
}
|
|
1225
1295
|
|
|
1296
|
+
/**
|
|
1297
|
+
* Residential address reported by the identity provider. Present on `individual`
|
|
1298
|
+
* profiles.
|
|
1299
|
+
*/
|
|
1300
|
+
export interface PersonalAddress {
|
|
1226
1301
|
/**
|
|
1227
|
-
* The
|
|
1302
|
+
* The city of the address.
|
|
1228
1303
|
*/
|
|
1229
|
-
|
|
1304
|
+
city: string | null;
|
|
1230
1305
|
|
|
1231
1306
|
/**
|
|
1232
|
-
* The
|
|
1307
|
+
* The country of the address.
|
|
1233
1308
|
*/
|
|
1234
|
-
|
|
1309
|
+
country: string | null;
|
|
1310
|
+
|
|
1311
|
+
/**
|
|
1312
|
+
* The line 1 of the address.
|
|
1313
|
+
*/
|
|
1314
|
+
line1: string | null;
|
|
1315
|
+
|
|
1316
|
+
/**
|
|
1317
|
+
* The line 2 of the address.
|
|
1318
|
+
*/
|
|
1319
|
+
line2: string | null;
|
|
1320
|
+
|
|
1321
|
+
/**
|
|
1322
|
+
* The postal code of the address.
|
|
1323
|
+
*/
|
|
1324
|
+
postal_code: string | null;
|
|
1325
|
+
|
|
1326
|
+
/**
|
|
1327
|
+
* The state of the address.
|
|
1328
|
+
*/
|
|
1329
|
+
state: string | null;
|
|
1235
1330
|
}
|
|
1236
1331
|
|
|
1237
1332
|
/**
|
|
1238
|
-
*
|
|
1333
|
+
* An identity verification session used to confirm a person or entity's identity
|
|
1334
|
+
* for payout account eligibility.
|
|
1239
1335
|
*/
|
|
1240
|
-
export interface
|
|
1336
|
+
export interface Verification {
|
|
1241
1337
|
/**
|
|
1242
|
-
* The
|
|
1338
|
+
* The numeric id of the verification record.
|
|
1243
1339
|
*/
|
|
1244
1340
|
id: string;
|
|
1245
1341
|
|
|
1342
|
+
/**
|
|
1343
|
+
* When the verification record was created.
|
|
1344
|
+
*/
|
|
1345
|
+
created_at: string;
|
|
1346
|
+
|
|
1246
1347
|
/**
|
|
1247
1348
|
* An error code for a verification attempt.
|
|
1248
1349
|
*/
|
|
@@ -1254,6 +1355,12 @@ export namespace PayoutAccountStatusUpdatedWebhookEvent {
|
|
|
1254
1355
|
*/
|
|
1255
1356
|
last_error_reason: string | null;
|
|
1256
1357
|
|
|
1358
|
+
/**
|
|
1359
|
+
* A URL the user can visit to complete the verification process. Null if the
|
|
1360
|
+
* session does not require user interaction.
|
|
1361
|
+
*/
|
|
1362
|
+
session_url: string | null;
|
|
1363
|
+
|
|
1257
1364
|
/**
|
|
1258
1365
|
* The current status of this verification session.
|
|
1259
1366
|
*/
|
|
@@ -1262,7 +1369,7 @@ export namespace PayoutAccountStatusUpdatedWebhookEvent {
|
|
|
1262
1369
|
}
|
|
1263
1370
|
}
|
|
1264
1371
|
|
|
1265
|
-
export interface
|
|
1372
|
+
export interface IdentityProfileRejectedWebhookEvent {
|
|
1266
1373
|
/**
|
|
1267
1374
|
* A unique ID for every single webhook request
|
|
1268
1375
|
*/
|
|
@@ -1274,10 +1381,10 @@ export interface ResolutionCenterCaseCreatedWebhookEvent {
|
|
|
1274
1381
|
api_version: 'v1';
|
|
1275
1382
|
|
|
1276
1383
|
/**
|
|
1277
|
-
* A
|
|
1278
|
-
*
|
|
1384
|
+
* A consolidated identity or business profile synced from verification provider
|
|
1385
|
+
* data.
|
|
1279
1386
|
*/
|
|
1280
|
-
data:
|
|
1387
|
+
data: IdentityProfileRejectedWebhookEvent.Data;
|
|
1281
1388
|
|
|
1282
1389
|
/**
|
|
1283
1390
|
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
@@ -1287,7 +1394,7 @@ export interface ResolutionCenterCaseCreatedWebhookEvent {
|
|
|
1287
1394
|
/**
|
|
1288
1395
|
* The webhook event type
|
|
1289
1396
|
*/
|
|
1290
|
-
type: '
|
|
1397
|
+
type: 'identity_profile.rejected';
|
|
1291
1398
|
|
|
1292
1399
|
/**
|
|
1293
1400
|
* The company ID that this webhook event is associated with
|
|
@@ -1295,231 +1402,240 @@ export interface ResolutionCenterCaseCreatedWebhookEvent {
|
|
|
1295
1402
|
company_id?: string | null;
|
|
1296
1403
|
}
|
|
1297
1404
|
|
|
1298
|
-
export namespace
|
|
1405
|
+
export namespace IdentityProfileRejectedWebhookEvent {
|
|
1299
1406
|
/**
|
|
1300
|
-
* A
|
|
1301
|
-
*
|
|
1407
|
+
* A consolidated identity or business profile synced from verification provider
|
|
1408
|
+
* data.
|
|
1302
1409
|
*/
|
|
1303
1410
|
export interface Data {
|
|
1304
1411
|
/**
|
|
1305
|
-
* The
|
|
1412
|
+
* The tag of the identity profile (idpf_xxx).
|
|
1306
1413
|
*/
|
|
1307
1414
|
id: string;
|
|
1308
1415
|
|
|
1309
1416
|
/**
|
|
1310
|
-
*
|
|
1311
|
-
*
|
|
1417
|
+
* Registered business address reported by the identity provider. Present on
|
|
1418
|
+
* `business` profiles.
|
|
1312
1419
|
*/
|
|
1313
|
-
|
|
1420
|
+
business_address: Data.BusinessAddress | null;
|
|
1314
1421
|
|
|
1315
1422
|
/**
|
|
1316
|
-
*
|
|
1423
|
+
* Business entity name. Present on `business` profiles.
|
|
1317
1424
|
*/
|
|
1318
|
-
|
|
1425
|
+
business_name: string | null;
|
|
1319
1426
|
|
|
1320
1427
|
/**
|
|
1321
|
-
*
|
|
1428
|
+
* Reported legal structure of a business profile (e.g. `corp`, `llc`).
|
|
1429
|
+
* Provider-specific values; present on `business` profiles.
|
|
1322
1430
|
*/
|
|
1323
|
-
|
|
1431
|
+
business_structure: string | null;
|
|
1324
1432
|
|
|
1325
1433
|
/**
|
|
1326
|
-
*
|
|
1434
|
+
* ISO 3166-1 alpha-3 country code (e.g. `USA`, `GBR`). For individuals this is the
|
|
1435
|
+
* country of citizenship or residence reported by the identity provider; for
|
|
1436
|
+
* businesses this is the country of incorporation.
|
|
1327
1437
|
*/
|
|
1328
|
-
|
|
1438
|
+
country: string | null;
|
|
1329
1439
|
|
|
1330
1440
|
/**
|
|
1331
|
-
*
|
|
1332
|
-
* currently active. As a Unix timestamp.
|
|
1441
|
+
* When the identity profile was first created.
|
|
1333
1442
|
*/
|
|
1334
|
-
|
|
1443
|
+
created_at: string;
|
|
1335
1444
|
|
|
1336
1445
|
/**
|
|
1337
|
-
*
|
|
1446
|
+
* ISO date (`YYYY-MM-DD`) reported by the identity provider. Present on
|
|
1447
|
+
* `individual` profiles.
|
|
1338
1448
|
*/
|
|
1339
|
-
|
|
1449
|
+
date_of_birth: string | null;
|
|
1340
1450
|
|
|
1341
1451
|
/**
|
|
1342
|
-
*
|
|
1343
|
-
*
|
|
1452
|
+
* Email address reported by the identity provider. Typically present on
|
|
1453
|
+
* `individual` profiles.
|
|
1344
1454
|
*/
|
|
1345
|
-
|
|
1455
|
+
email: string | null;
|
|
1346
1456
|
|
|
1347
1457
|
/**
|
|
1348
|
-
*
|
|
1458
|
+
* Individual's first name.
|
|
1349
1459
|
*/
|
|
1350
|
-
|
|
1460
|
+
first_name: string | null;
|
|
1351
1461
|
|
|
1352
1462
|
/**
|
|
1353
|
-
*
|
|
1463
|
+
* Individual's last name.
|
|
1354
1464
|
*/
|
|
1355
|
-
|
|
1465
|
+
last_name: string | null;
|
|
1356
1466
|
|
|
1357
1467
|
/**
|
|
1358
|
-
* The
|
|
1468
|
+
* The companies this identity profile is currently linked to. Only populated for
|
|
1469
|
+
* direct Whop user sessions; always empty when authenticated via API key, app, or
|
|
1470
|
+
* OAuth scope (a single identity can be linked to companies the calling platform
|
|
1471
|
+
* is not entitled to see).
|
|
1359
1472
|
*/
|
|
1360
|
-
|
|
1473
|
+
linked_companies: Array<Data.LinkedCompany>;
|
|
1361
1474
|
|
|
1362
1475
|
/**
|
|
1363
|
-
*
|
|
1364
|
-
*
|
|
1476
|
+
* Residential address reported by the identity provider. Present on `individual`
|
|
1477
|
+
* profiles.
|
|
1365
1478
|
*/
|
|
1366
|
-
|
|
1479
|
+
personal_address: Data.PersonalAddress | null;
|
|
1367
1480
|
|
|
1368
1481
|
/**
|
|
1369
|
-
*
|
|
1370
|
-
*
|
|
1482
|
+
* Phone number reported by the identity provider. Typically present on
|
|
1483
|
+
* `individual` profiles.
|
|
1371
1484
|
*/
|
|
1372
|
-
|
|
1485
|
+
phone: string | null;
|
|
1373
1486
|
|
|
1374
1487
|
/**
|
|
1375
|
-
*
|
|
1376
|
-
* respond or if the case is closed.
|
|
1488
|
+
* Whether this is an 'individual' or 'business' profile.
|
|
1377
1489
|
*/
|
|
1378
|
-
|
|
1490
|
+
profile_type: string;
|
|
1379
1491
|
|
|
1380
1492
|
/**
|
|
1381
|
-
*
|
|
1493
|
+
* Derived verification status across all linked verifications.
|
|
1494
|
+
*/
|
|
1495
|
+
status: 'not_started' | 'pending' | 'approved' | 'rejected';
|
|
1496
|
+
|
|
1497
|
+
/**
|
|
1498
|
+
* When the identity profile was last synced from a verification.
|
|
1382
1499
|
*/
|
|
1383
1500
|
updated_at: string;
|
|
1384
1501
|
|
|
1385
1502
|
/**
|
|
1386
|
-
*
|
|
1503
|
+
* All verification attempts attached to this identity profile, ordered most-recent
|
|
1504
|
+
* first.
|
|
1387
1505
|
*/
|
|
1388
|
-
|
|
1506
|
+
verifications: Array<Data.Verification>;
|
|
1389
1507
|
}
|
|
1390
1508
|
|
|
1391
1509
|
export namespace Data {
|
|
1392
1510
|
/**
|
|
1393
|
-
*
|
|
1394
|
-
*
|
|
1511
|
+
* Registered business address reported by the identity provider. Present on
|
|
1512
|
+
* `business` profiles.
|
|
1395
1513
|
*/
|
|
1396
|
-
export interface
|
|
1514
|
+
export interface BusinessAddress {
|
|
1397
1515
|
/**
|
|
1398
|
-
* The
|
|
1516
|
+
* The city of the address.
|
|
1399
1517
|
*/
|
|
1400
|
-
|
|
1518
|
+
city: string | null;
|
|
1401
1519
|
|
|
1402
1520
|
/**
|
|
1403
|
-
* The
|
|
1521
|
+
* The country of the address.
|
|
1404
1522
|
*/
|
|
1405
|
-
|
|
1523
|
+
country: string | null;
|
|
1524
|
+
|
|
1525
|
+
/**
|
|
1526
|
+
* The line 1 of the address.
|
|
1527
|
+
*/
|
|
1528
|
+
line1: string | null;
|
|
1529
|
+
|
|
1530
|
+
/**
|
|
1531
|
+
* The line 2 of the address.
|
|
1532
|
+
*/
|
|
1533
|
+
line2: string | null;
|
|
1534
|
+
|
|
1535
|
+
/**
|
|
1536
|
+
* The postal code of the address.
|
|
1537
|
+
*/
|
|
1538
|
+
postal_code: string | null;
|
|
1539
|
+
|
|
1540
|
+
/**
|
|
1541
|
+
* The state of the address.
|
|
1542
|
+
*/
|
|
1543
|
+
state: string | null;
|
|
1406
1544
|
}
|
|
1407
1545
|
|
|
1408
1546
|
/**
|
|
1409
|
-
*
|
|
1410
|
-
*
|
|
1547
|
+
* A company is a seller on Whop. Companies own products, manage members, and
|
|
1548
|
+
* receive payouts.
|
|
1411
1549
|
*/
|
|
1412
|
-
export interface
|
|
1550
|
+
export interface LinkedCompany {
|
|
1413
1551
|
/**
|
|
1414
|
-
* The unique identifier for the
|
|
1552
|
+
* The unique identifier for the company.
|
|
1415
1553
|
*/
|
|
1416
1554
|
id: string;
|
|
1555
|
+
|
|
1556
|
+
/**
|
|
1557
|
+
* The display name of the company shown to customers.
|
|
1558
|
+
*/
|
|
1559
|
+
title: string;
|
|
1417
1560
|
}
|
|
1418
1561
|
|
|
1419
1562
|
/**
|
|
1420
|
-
*
|
|
1563
|
+
* Residential address reported by the identity provider. Present on `individual`
|
|
1564
|
+
* profiles.
|
|
1421
1565
|
*/
|
|
1422
|
-
export interface
|
|
1566
|
+
export interface PersonalAddress {
|
|
1423
1567
|
/**
|
|
1424
|
-
* The
|
|
1568
|
+
* The city of the address.
|
|
1425
1569
|
*/
|
|
1426
|
-
|
|
1570
|
+
city: string | null;
|
|
1427
1571
|
|
|
1428
1572
|
/**
|
|
1429
|
-
* The
|
|
1573
|
+
* The country of the address.
|
|
1430
1574
|
*/
|
|
1431
|
-
|
|
1575
|
+
country: string | null;
|
|
1432
1576
|
|
|
1433
1577
|
/**
|
|
1434
|
-
* The
|
|
1578
|
+
* The line 1 of the address.
|
|
1435
1579
|
*/
|
|
1436
|
-
|
|
1580
|
+
line1: string | null;
|
|
1437
1581
|
|
|
1438
1582
|
/**
|
|
1439
|
-
* The
|
|
1440
|
-
* has not yet succeeded. As a Unix timestamp.
|
|
1583
|
+
* The line 2 of the address.
|
|
1441
1584
|
*/
|
|
1442
|
-
|
|
1585
|
+
line2: string | null;
|
|
1443
1586
|
|
|
1444
1587
|
/**
|
|
1445
|
-
* The
|
|
1446
|
-
* specified by the currency field.
|
|
1588
|
+
* The postal code of the address.
|
|
1447
1589
|
*/
|
|
1448
|
-
|
|
1590
|
+
postal_code: string | null;
|
|
1449
1591
|
|
|
1450
1592
|
/**
|
|
1451
|
-
* The
|
|
1452
|
-
* after any discounts. In the currency specified by the currency field.
|
|
1593
|
+
* The state of the address.
|
|
1453
1594
|
*/
|
|
1454
|
-
|
|
1595
|
+
state: string | null;
|
|
1455
1596
|
}
|
|
1456
1597
|
|
|
1457
1598
|
/**
|
|
1458
|
-
*
|
|
1459
|
-
*
|
|
1599
|
+
* An identity verification session used to confirm a person or entity's identity
|
|
1600
|
+
* for payout account eligibility.
|
|
1460
1601
|
*/
|
|
1461
|
-
export interface
|
|
1602
|
+
export interface Verification {
|
|
1462
1603
|
/**
|
|
1463
|
-
* The
|
|
1604
|
+
* The numeric id of the verification record.
|
|
1464
1605
|
*/
|
|
1465
1606
|
id: string;
|
|
1466
1607
|
|
|
1467
1608
|
/**
|
|
1468
|
-
*
|
|
1469
|
-
*/
|
|
1470
|
-
action:
|
|
1471
|
-
| 'created'
|
|
1472
|
-
| 'responded'
|
|
1473
|
-
| 'accepted'
|
|
1474
|
-
| 'denied'
|
|
1475
|
-
| 'appealed'
|
|
1476
|
-
| 'withdrew'
|
|
1477
|
-
| 'requested_more_info'
|
|
1478
|
-
| 'escalated'
|
|
1479
|
-
| 'dispute_opened'
|
|
1480
|
-
| 'dispute_customer_won'
|
|
1481
|
-
| 'dispute_merchant_won';
|
|
1482
|
-
|
|
1483
|
-
/**
|
|
1484
|
-
* The datetime the resolution event was created.
|
|
1609
|
+
* When the verification record was created.
|
|
1485
1610
|
*/
|
|
1486
1611
|
created_at: string;
|
|
1487
1612
|
|
|
1488
1613
|
/**
|
|
1489
|
-
*
|
|
1490
|
-
* if no details were included.
|
|
1491
|
-
*/
|
|
1492
|
-
details: string | null;
|
|
1493
|
-
|
|
1494
|
-
/**
|
|
1495
|
-
* The party who performed this action.
|
|
1614
|
+
* An error code for a verification attempt.
|
|
1496
1615
|
*/
|
|
1497
|
-
|
|
1498
|
-
}
|
|
1616
|
+
last_error_code: VerificationsAPI.VerificationErrorCode | null;
|
|
1499
1617
|
|
|
1500
|
-
/**
|
|
1501
|
-
* The customer (buyer) who filed this resolution case.
|
|
1502
|
-
*/
|
|
1503
|
-
export interface User {
|
|
1504
1618
|
/**
|
|
1505
|
-
*
|
|
1619
|
+
* A human-readable explanation of the most recent verification error. Null if no
|
|
1620
|
+
* error has occurred.
|
|
1506
1621
|
*/
|
|
1507
|
-
|
|
1622
|
+
last_error_reason: string | null;
|
|
1508
1623
|
|
|
1509
1624
|
/**
|
|
1510
|
-
*
|
|
1625
|
+
* A URL the user can visit to complete the verification process. Null if the
|
|
1626
|
+
* session does not require user interaction.
|
|
1511
1627
|
*/
|
|
1512
|
-
|
|
1628
|
+
session_url: string | null;
|
|
1513
1629
|
|
|
1514
1630
|
/**
|
|
1515
|
-
* The
|
|
1631
|
+
* The current status of this verification session.
|
|
1516
1632
|
*/
|
|
1517
|
-
|
|
1633
|
+
status: VerificationsAPI.VerificationStatus;
|
|
1518
1634
|
}
|
|
1519
1635
|
}
|
|
1520
1636
|
}
|
|
1521
1637
|
|
|
1522
|
-
export interface
|
|
1638
|
+
export interface IdentityProfileUpdatedWebhookEvent {
|
|
1523
1639
|
/**
|
|
1524
1640
|
* A unique ID for every single webhook request
|
|
1525
1641
|
*/
|
|
@@ -1531,10 +1647,10 @@ export interface ResolutionCenterCaseUpdatedWebhookEvent {
|
|
|
1531
1647
|
api_version: 'v1';
|
|
1532
1648
|
|
|
1533
1649
|
/**
|
|
1534
|
-
* A
|
|
1535
|
-
*
|
|
1650
|
+
* A consolidated identity or business profile synced from verification provider
|
|
1651
|
+
* data.
|
|
1536
1652
|
*/
|
|
1537
|
-
data:
|
|
1653
|
+
data: IdentityProfileUpdatedWebhookEvent.Data;
|
|
1538
1654
|
|
|
1539
1655
|
/**
|
|
1540
1656
|
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
@@ -1544,7 +1660,7 @@ export interface ResolutionCenterCaseUpdatedWebhookEvent {
|
|
|
1544
1660
|
/**
|
|
1545
1661
|
* The webhook event type
|
|
1546
1662
|
*/
|
|
1547
|
-
type: '
|
|
1663
|
+
type: 'identity_profile.updated';
|
|
1548
1664
|
|
|
1549
1665
|
/**
|
|
1550
1666
|
* The company ID that this webhook event is associated with
|
|
@@ -1552,231 +1668,240 @@ export interface ResolutionCenterCaseUpdatedWebhookEvent {
|
|
|
1552
1668
|
company_id?: string | null;
|
|
1553
1669
|
}
|
|
1554
1670
|
|
|
1555
|
-
export namespace
|
|
1671
|
+
export namespace IdentityProfileUpdatedWebhookEvent {
|
|
1556
1672
|
/**
|
|
1557
|
-
* A
|
|
1558
|
-
*
|
|
1673
|
+
* A consolidated identity or business profile synced from verification provider
|
|
1674
|
+
* data.
|
|
1559
1675
|
*/
|
|
1560
1676
|
export interface Data {
|
|
1561
1677
|
/**
|
|
1562
|
-
* The
|
|
1678
|
+
* The tag of the identity profile (idpf_xxx).
|
|
1563
1679
|
*/
|
|
1564
1680
|
id: string;
|
|
1565
1681
|
|
|
1566
1682
|
/**
|
|
1567
|
-
*
|
|
1568
|
-
*
|
|
1683
|
+
* Registered business address reported by the identity provider. Present on
|
|
1684
|
+
* `business` profiles.
|
|
1569
1685
|
*/
|
|
1570
|
-
|
|
1686
|
+
business_address: Data.BusinessAddress | null;
|
|
1571
1687
|
|
|
1572
1688
|
/**
|
|
1573
|
-
*
|
|
1689
|
+
* Business entity name. Present on `business` profiles.
|
|
1574
1690
|
*/
|
|
1575
|
-
|
|
1691
|
+
business_name: string | null;
|
|
1576
1692
|
|
|
1577
1693
|
/**
|
|
1578
|
-
*
|
|
1694
|
+
* Reported legal structure of a business profile (e.g. `corp`, `llc`).
|
|
1695
|
+
* Provider-specific values; present on `business` profiles.
|
|
1579
1696
|
*/
|
|
1580
|
-
|
|
1697
|
+
business_structure: string | null;
|
|
1581
1698
|
|
|
1582
1699
|
/**
|
|
1583
|
-
*
|
|
1700
|
+
* ISO 3166-1 alpha-3 country code (e.g. `USA`, `GBR`). For individuals this is the
|
|
1701
|
+
* country of citizenship or residence reported by the identity provider; for
|
|
1702
|
+
* businesses this is the country of incorporation.
|
|
1584
1703
|
*/
|
|
1585
|
-
|
|
1704
|
+
country: string | null;
|
|
1586
1705
|
|
|
1587
1706
|
/**
|
|
1588
|
-
*
|
|
1589
|
-
* currently active. As a Unix timestamp.
|
|
1707
|
+
* When the identity profile was first created.
|
|
1590
1708
|
*/
|
|
1591
|
-
|
|
1709
|
+
created_at: string;
|
|
1592
1710
|
|
|
1593
1711
|
/**
|
|
1594
|
-
*
|
|
1712
|
+
* ISO date (`YYYY-MM-DD`) reported by the identity provider. Present on
|
|
1713
|
+
* `individual` profiles.
|
|
1595
1714
|
*/
|
|
1596
|
-
|
|
1715
|
+
date_of_birth: string | null;
|
|
1597
1716
|
|
|
1598
1717
|
/**
|
|
1599
|
-
*
|
|
1600
|
-
*
|
|
1718
|
+
* Email address reported by the identity provider. Typically present on
|
|
1719
|
+
* `individual` profiles.
|
|
1601
1720
|
*/
|
|
1602
|
-
|
|
1721
|
+
email: string | null;
|
|
1603
1722
|
|
|
1604
1723
|
/**
|
|
1605
|
-
*
|
|
1724
|
+
* Individual's first name.
|
|
1606
1725
|
*/
|
|
1607
|
-
|
|
1726
|
+
first_name: string | null;
|
|
1608
1727
|
|
|
1609
1728
|
/**
|
|
1610
|
-
*
|
|
1729
|
+
* Individual's last name.
|
|
1611
1730
|
*/
|
|
1612
|
-
|
|
1731
|
+
last_name: string | null;
|
|
1613
1732
|
|
|
1614
1733
|
/**
|
|
1615
|
-
* The
|
|
1734
|
+
* The companies this identity profile is currently linked to. Only populated for
|
|
1735
|
+
* direct Whop user sessions; always empty when authenticated via API key, app, or
|
|
1736
|
+
* OAuth scope (a single identity can be linked to companies the calling platform
|
|
1737
|
+
* is not entitled to see).
|
|
1616
1738
|
*/
|
|
1617
|
-
|
|
1739
|
+
linked_companies: Array<Data.LinkedCompany>;
|
|
1618
1740
|
|
|
1619
1741
|
/**
|
|
1620
|
-
*
|
|
1621
|
-
*
|
|
1742
|
+
* Residential address reported by the identity provider. Present on `individual`
|
|
1743
|
+
* profiles.
|
|
1622
1744
|
*/
|
|
1623
|
-
|
|
1745
|
+
personal_address: Data.PersonalAddress | null;
|
|
1624
1746
|
|
|
1625
1747
|
/**
|
|
1626
|
-
*
|
|
1627
|
-
*
|
|
1748
|
+
* Phone number reported by the identity provider. Typically present on
|
|
1749
|
+
* `individual` profiles.
|
|
1628
1750
|
*/
|
|
1629
|
-
|
|
1751
|
+
phone: string | null;
|
|
1630
1752
|
|
|
1631
1753
|
/**
|
|
1632
|
-
*
|
|
1633
|
-
* respond or if the case is closed.
|
|
1754
|
+
* Whether this is an 'individual' or 'business' profile.
|
|
1634
1755
|
*/
|
|
1635
|
-
|
|
1756
|
+
profile_type: string;
|
|
1636
1757
|
|
|
1637
1758
|
/**
|
|
1638
|
-
*
|
|
1759
|
+
* Derived verification status across all linked verifications.
|
|
1760
|
+
*/
|
|
1761
|
+
status: 'not_started' | 'pending' | 'approved' | 'rejected';
|
|
1762
|
+
|
|
1763
|
+
/**
|
|
1764
|
+
* When the identity profile was last synced from a verification.
|
|
1639
1765
|
*/
|
|
1640
1766
|
updated_at: string;
|
|
1641
1767
|
|
|
1642
1768
|
/**
|
|
1643
|
-
*
|
|
1769
|
+
* All verification attempts attached to this identity profile, ordered most-recent
|
|
1770
|
+
* first.
|
|
1644
1771
|
*/
|
|
1645
|
-
|
|
1772
|
+
verifications: Array<Data.Verification>;
|
|
1646
1773
|
}
|
|
1647
1774
|
|
|
1648
1775
|
export namespace Data {
|
|
1649
1776
|
/**
|
|
1650
|
-
*
|
|
1651
|
-
*
|
|
1777
|
+
* Registered business address reported by the identity provider. Present on
|
|
1778
|
+
* `business` profiles.
|
|
1652
1779
|
*/
|
|
1653
|
-
export interface
|
|
1780
|
+
export interface BusinessAddress {
|
|
1654
1781
|
/**
|
|
1655
|
-
* The
|
|
1782
|
+
* The city of the address.
|
|
1656
1783
|
*/
|
|
1657
|
-
|
|
1784
|
+
city: string | null;
|
|
1658
1785
|
|
|
1659
1786
|
/**
|
|
1660
|
-
* The
|
|
1787
|
+
* The country of the address.
|
|
1661
1788
|
*/
|
|
1662
|
-
|
|
1789
|
+
country: string | null;
|
|
1790
|
+
|
|
1791
|
+
/**
|
|
1792
|
+
* The line 1 of the address.
|
|
1793
|
+
*/
|
|
1794
|
+
line1: string | null;
|
|
1795
|
+
|
|
1796
|
+
/**
|
|
1797
|
+
* The line 2 of the address.
|
|
1798
|
+
*/
|
|
1799
|
+
line2: string | null;
|
|
1800
|
+
|
|
1801
|
+
/**
|
|
1802
|
+
* The postal code of the address.
|
|
1803
|
+
*/
|
|
1804
|
+
postal_code: string | null;
|
|
1805
|
+
|
|
1806
|
+
/**
|
|
1807
|
+
* The state of the address.
|
|
1808
|
+
*/
|
|
1809
|
+
state: string | null;
|
|
1663
1810
|
}
|
|
1664
1811
|
|
|
1665
1812
|
/**
|
|
1666
|
-
*
|
|
1667
|
-
*
|
|
1813
|
+
* A company is a seller on Whop. Companies own products, manage members, and
|
|
1814
|
+
* receive payouts.
|
|
1668
1815
|
*/
|
|
1669
|
-
export interface
|
|
1816
|
+
export interface LinkedCompany {
|
|
1670
1817
|
/**
|
|
1671
|
-
* The unique identifier for the
|
|
1818
|
+
* The unique identifier for the company.
|
|
1672
1819
|
*/
|
|
1673
1820
|
id: string;
|
|
1821
|
+
|
|
1822
|
+
/**
|
|
1823
|
+
* The display name of the company shown to customers.
|
|
1824
|
+
*/
|
|
1825
|
+
title: string;
|
|
1674
1826
|
}
|
|
1675
1827
|
|
|
1676
1828
|
/**
|
|
1677
|
-
*
|
|
1829
|
+
* Residential address reported by the identity provider. Present on `individual`
|
|
1830
|
+
* profiles.
|
|
1678
1831
|
*/
|
|
1679
|
-
export interface
|
|
1832
|
+
export interface PersonalAddress {
|
|
1680
1833
|
/**
|
|
1681
|
-
* The
|
|
1834
|
+
* The city of the address.
|
|
1682
1835
|
*/
|
|
1683
|
-
|
|
1836
|
+
city: string | null;
|
|
1684
1837
|
|
|
1685
1838
|
/**
|
|
1686
|
-
* The
|
|
1839
|
+
* The country of the address.
|
|
1687
1840
|
*/
|
|
1688
|
-
|
|
1841
|
+
country: string | null;
|
|
1689
1842
|
|
|
1690
1843
|
/**
|
|
1691
|
-
* The
|
|
1844
|
+
* The line 1 of the address.
|
|
1692
1845
|
*/
|
|
1693
|
-
|
|
1846
|
+
line1: string | null;
|
|
1694
1847
|
|
|
1695
1848
|
/**
|
|
1696
|
-
* The
|
|
1697
|
-
* has not yet succeeded. As a Unix timestamp.
|
|
1849
|
+
* The line 2 of the address.
|
|
1698
1850
|
*/
|
|
1699
|
-
|
|
1851
|
+
line2: string | null;
|
|
1700
1852
|
|
|
1701
1853
|
/**
|
|
1702
|
-
* The
|
|
1703
|
-
* specified by the currency field.
|
|
1854
|
+
* The postal code of the address.
|
|
1704
1855
|
*/
|
|
1705
|
-
|
|
1856
|
+
postal_code: string | null;
|
|
1706
1857
|
|
|
1707
1858
|
/**
|
|
1708
|
-
* The
|
|
1709
|
-
* after any discounts. In the currency specified by the currency field.
|
|
1859
|
+
* The state of the address.
|
|
1710
1860
|
*/
|
|
1711
|
-
|
|
1861
|
+
state: string | null;
|
|
1712
1862
|
}
|
|
1713
1863
|
|
|
1714
1864
|
/**
|
|
1715
|
-
*
|
|
1716
|
-
*
|
|
1865
|
+
* An identity verification session used to confirm a person or entity's identity
|
|
1866
|
+
* for payout account eligibility.
|
|
1717
1867
|
*/
|
|
1718
|
-
export interface
|
|
1868
|
+
export interface Verification {
|
|
1719
1869
|
/**
|
|
1720
|
-
* The
|
|
1870
|
+
* The numeric id of the verification record.
|
|
1721
1871
|
*/
|
|
1722
1872
|
id: string;
|
|
1723
1873
|
|
|
1724
1874
|
/**
|
|
1725
|
-
*
|
|
1726
|
-
*/
|
|
1727
|
-
action:
|
|
1728
|
-
| 'created'
|
|
1729
|
-
| 'responded'
|
|
1730
|
-
| 'accepted'
|
|
1731
|
-
| 'denied'
|
|
1732
|
-
| 'appealed'
|
|
1733
|
-
| 'withdrew'
|
|
1734
|
-
| 'requested_more_info'
|
|
1735
|
-
| 'escalated'
|
|
1736
|
-
| 'dispute_opened'
|
|
1737
|
-
| 'dispute_customer_won'
|
|
1738
|
-
| 'dispute_merchant_won';
|
|
1739
|
-
|
|
1740
|
-
/**
|
|
1741
|
-
* The datetime the resolution event was created.
|
|
1875
|
+
* When the verification record was created.
|
|
1742
1876
|
*/
|
|
1743
1877
|
created_at: string;
|
|
1744
1878
|
|
|
1745
1879
|
/**
|
|
1746
|
-
*
|
|
1747
|
-
* if no details were included.
|
|
1748
|
-
*/
|
|
1749
|
-
details: string | null;
|
|
1750
|
-
|
|
1751
|
-
/**
|
|
1752
|
-
* The party who performed this action.
|
|
1880
|
+
* An error code for a verification attempt.
|
|
1753
1881
|
*/
|
|
1754
|
-
|
|
1755
|
-
}
|
|
1882
|
+
last_error_code: VerificationsAPI.VerificationErrorCode | null;
|
|
1756
1883
|
|
|
1757
|
-
/**
|
|
1758
|
-
* The customer (buyer) who filed this resolution case.
|
|
1759
|
-
*/
|
|
1760
|
-
export interface User {
|
|
1761
1884
|
/**
|
|
1762
|
-
*
|
|
1885
|
+
* A human-readable explanation of the most recent verification error. Null if no
|
|
1886
|
+
* error has occurred.
|
|
1763
1887
|
*/
|
|
1764
|
-
|
|
1888
|
+
last_error_reason: string | null;
|
|
1765
1889
|
|
|
1766
1890
|
/**
|
|
1767
|
-
*
|
|
1891
|
+
* A URL the user can visit to complete the verification process. Null if the
|
|
1892
|
+
* session does not require user interaction.
|
|
1768
1893
|
*/
|
|
1769
|
-
|
|
1894
|
+
session_url: string | null;
|
|
1770
1895
|
|
|
1771
1896
|
/**
|
|
1772
|
-
* The
|
|
1897
|
+
* The current status of this verification session.
|
|
1773
1898
|
*/
|
|
1774
|
-
|
|
1899
|
+
status: VerificationsAPI.VerificationStatus;
|
|
1775
1900
|
}
|
|
1776
1901
|
}
|
|
1777
1902
|
}
|
|
1778
1903
|
|
|
1779
|
-
export interface
|
|
1904
|
+
export interface InvoiceCreatedWebhookEvent {
|
|
1780
1905
|
/**
|
|
1781
1906
|
* A unique ID for every single webhook request
|
|
1782
1907
|
*/
|
|
@@ -1788,10 +1913,11 @@ export interface ResolutionCenterCaseDecidedWebhookEvent {
|
|
|
1788
1913
|
api_version: 'v1';
|
|
1789
1914
|
|
|
1790
1915
|
/**
|
|
1791
|
-
*
|
|
1792
|
-
*
|
|
1916
|
+
* An invoice represents an itemized bill sent by a company to a customer for a
|
|
1917
|
+
* specific product and plan, tracking the amount owed, due date, and payment
|
|
1918
|
+
* status.
|
|
1793
1919
|
*/
|
|
1794
|
-
data:
|
|
1920
|
+
data: Shared.Invoice;
|
|
1795
1921
|
|
|
1796
1922
|
/**
|
|
1797
1923
|
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
@@ -1801,7 +1927,7 @@ export interface ResolutionCenterCaseDecidedWebhookEvent {
|
|
|
1801
1927
|
/**
|
|
1802
1928
|
* The webhook event type
|
|
1803
1929
|
*/
|
|
1804
|
-
type: '
|
|
1930
|
+
type: 'invoice.created';
|
|
1805
1931
|
|
|
1806
1932
|
/**
|
|
1807
1933
|
* The company ID that this webhook event is associated with
|
|
@@ -1809,231 +1935,41 @@ export interface ResolutionCenterCaseDecidedWebhookEvent {
|
|
|
1809
1935
|
company_id?: string | null;
|
|
1810
1936
|
}
|
|
1811
1937
|
|
|
1812
|
-
export
|
|
1938
|
+
export interface InvoiceMarkedUncollectibleWebhookEvent {
|
|
1813
1939
|
/**
|
|
1814
|
-
* A
|
|
1815
|
-
* company, tracking the issue, status, and outcome.
|
|
1940
|
+
* A unique ID for every single webhook request
|
|
1816
1941
|
*/
|
|
1817
|
-
|
|
1818
|
-
/**
|
|
1819
|
-
* The unique identifier for the resolution.
|
|
1820
|
-
*/
|
|
1821
|
-
id: string;
|
|
1942
|
+
id: string;
|
|
1822
1943
|
|
|
1823
|
-
|
|
1824
|
-
|
|
1825
|
-
|
|
1826
|
-
|
|
1827
|
-
company: Data.Company | null;
|
|
1944
|
+
/**
|
|
1945
|
+
* The API version for this webhook
|
|
1946
|
+
*/
|
|
1947
|
+
api_version: 'v1';
|
|
1828
1948
|
|
|
1829
|
-
|
|
1830
|
-
|
|
1831
|
-
|
|
1832
|
-
|
|
1949
|
+
/**
|
|
1950
|
+
* An invoice represents an itemized bill sent by a company to a customer for a
|
|
1951
|
+
* specific product and plan, tracking the amount owed, due date, and payment
|
|
1952
|
+
* status.
|
|
1953
|
+
*/
|
|
1954
|
+
data: Shared.Invoice;
|
|
1833
1955
|
|
|
1834
|
-
|
|
1835
|
-
|
|
1836
|
-
|
|
1837
|
-
|
|
1956
|
+
/**
|
|
1957
|
+
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
1958
|
+
*/
|
|
1959
|
+
timestamp: string;
|
|
1838
1960
|
|
|
1839
|
-
|
|
1840
|
-
|
|
1841
|
-
|
|
1842
|
-
|
|
1843
|
-
|
|
1844
|
-
/**
|
|
1845
|
-
* The deadline by which the next response is required. Null if no deadline is
|
|
1846
|
-
* currently active. As a Unix timestamp.
|
|
1847
|
-
*/
|
|
1848
|
-
due_date: string | null;
|
|
1849
|
-
|
|
1850
|
-
/**
|
|
1851
|
-
* The category of the dispute.
|
|
1852
|
-
*/
|
|
1853
|
-
issue: ResolutionCenterCasesAPI.ResolutionCenterCaseIssueType;
|
|
1854
|
-
|
|
1855
|
-
/**
|
|
1856
|
-
* The membership record associated with the disputed payment. Null if the
|
|
1857
|
-
* membership no longer exists.
|
|
1858
|
-
*/
|
|
1859
|
-
member: Data.Member | null;
|
|
1860
|
-
|
|
1861
|
-
/**
|
|
1862
|
-
* Whether the merchant has filed an appeal after the initial resolution decision.
|
|
1863
|
-
*/
|
|
1864
|
-
merchant_appealed: boolean;
|
|
1865
|
-
|
|
1866
|
-
/**
|
|
1867
|
-
* The list of actions currently available to the merchant.
|
|
1868
|
-
*/
|
|
1869
|
-
merchant_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCaseMerchantResponse>;
|
|
1870
|
-
|
|
1871
|
-
/**
|
|
1872
|
-
* The payment record that is the subject of this resolution case.
|
|
1873
|
-
*/
|
|
1874
|
-
payment: Data.Payment;
|
|
1875
|
-
|
|
1876
|
-
/**
|
|
1877
|
-
* The list of actions currently available to the Whop platform for moderating this
|
|
1878
|
-
* resolution.
|
|
1879
|
-
*/
|
|
1880
|
-
platform_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCasePlatformResponse>;
|
|
1881
|
-
|
|
1882
|
-
/**
|
|
1883
|
-
* The most recent 50 messages, actions, and status changes that have occurred
|
|
1884
|
-
* during this resolution case.
|
|
1885
|
-
*/
|
|
1886
|
-
resolution_events: Array<Data.ResolutionEvent>;
|
|
1887
|
-
|
|
1888
|
-
/**
|
|
1889
|
-
* The current status of the resolution case, indicating which party needs to
|
|
1890
|
-
* respond or if the case is closed.
|
|
1891
|
-
*/
|
|
1892
|
-
status: ResolutionCenterCasesAPI.ResolutionCenterCaseStatus;
|
|
1893
|
-
|
|
1894
|
-
/**
|
|
1895
|
-
* The datetime the resolution was last updated.
|
|
1896
|
-
*/
|
|
1897
|
-
updated_at: string;
|
|
1898
|
-
|
|
1899
|
-
/**
|
|
1900
|
-
* The customer (buyer) who filed this resolution case.
|
|
1901
|
-
*/
|
|
1902
|
-
user: Data.User;
|
|
1903
|
-
}
|
|
1904
|
-
|
|
1905
|
-
export namespace Data {
|
|
1906
|
-
/**
|
|
1907
|
-
* The company involved in this resolution case. Null if the company no longer
|
|
1908
|
-
* exists.
|
|
1909
|
-
*/
|
|
1910
|
-
export interface Company {
|
|
1911
|
-
/**
|
|
1912
|
-
* The unique identifier for the company.
|
|
1913
|
-
*/
|
|
1914
|
-
id: string;
|
|
1915
|
-
|
|
1916
|
-
/**
|
|
1917
|
-
* The display name of the company shown to customers.
|
|
1918
|
-
*/
|
|
1919
|
-
title: string;
|
|
1920
|
-
}
|
|
1921
|
-
|
|
1922
|
-
/**
|
|
1923
|
-
* The membership record associated with the disputed payment. Null if the
|
|
1924
|
-
* membership no longer exists.
|
|
1925
|
-
*/
|
|
1926
|
-
export interface Member {
|
|
1927
|
-
/**
|
|
1928
|
-
* The unique identifier for the extra public member.
|
|
1929
|
-
*/
|
|
1930
|
-
id: string;
|
|
1931
|
-
}
|
|
1932
|
-
|
|
1933
|
-
/**
|
|
1934
|
-
* The payment record that is the subject of this resolution case.
|
|
1935
|
-
*/
|
|
1936
|
-
export interface Payment {
|
|
1937
|
-
/**
|
|
1938
|
-
* The unique identifier for the payment.
|
|
1939
|
-
*/
|
|
1940
|
-
id: string;
|
|
1941
|
-
|
|
1942
|
-
/**
|
|
1943
|
-
* The datetime the payment was created.
|
|
1944
|
-
*/
|
|
1945
|
-
created_at: string;
|
|
1946
|
-
|
|
1947
|
-
/**
|
|
1948
|
-
* The available currencies on the platform
|
|
1949
|
-
*/
|
|
1950
|
-
currency: Shared.Currency | null;
|
|
1951
|
-
|
|
1952
|
-
/**
|
|
1953
|
-
* The time at which this payment was successfully collected. Null if the payment
|
|
1954
|
-
* has not yet succeeded. As a Unix timestamp.
|
|
1955
|
-
*/
|
|
1956
|
-
paid_at: string | null;
|
|
1957
|
-
|
|
1958
|
-
/**
|
|
1959
|
-
* The payment amount before taxes and discounts are applied. In the currency
|
|
1960
|
-
* specified by the currency field.
|
|
1961
|
-
*/
|
|
1962
|
-
subtotal: number | null;
|
|
1963
|
-
|
|
1964
|
-
/**
|
|
1965
|
-
* The total amount charged to the customer for this payment, including taxes and
|
|
1966
|
-
* after any discounts. In the currency specified by the currency field.
|
|
1967
|
-
*/
|
|
1968
|
-
total: number;
|
|
1969
|
-
}
|
|
1970
|
-
|
|
1971
|
-
/**
|
|
1972
|
-
* A resolution event is a message or action within a resolution case, such as a
|
|
1973
|
-
* response, escalation, or status change.
|
|
1974
|
-
*/
|
|
1975
|
-
export interface ResolutionEvent {
|
|
1976
|
-
/**
|
|
1977
|
-
* The unique identifier for the resolution event.
|
|
1978
|
-
*/
|
|
1979
|
-
id: string;
|
|
1980
|
-
|
|
1981
|
-
/**
|
|
1982
|
-
* The type of action recorded in this event.
|
|
1983
|
-
*/
|
|
1984
|
-
action:
|
|
1985
|
-
| 'created'
|
|
1986
|
-
| 'responded'
|
|
1987
|
-
| 'accepted'
|
|
1988
|
-
| 'denied'
|
|
1989
|
-
| 'appealed'
|
|
1990
|
-
| 'withdrew'
|
|
1991
|
-
| 'requested_more_info'
|
|
1992
|
-
| 'escalated'
|
|
1993
|
-
| 'dispute_opened'
|
|
1994
|
-
| 'dispute_customer_won'
|
|
1995
|
-
| 'dispute_merchant_won';
|
|
1996
|
-
|
|
1997
|
-
/**
|
|
1998
|
-
* The datetime the resolution event was created.
|
|
1999
|
-
*/
|
|
2000
|
-
created_at: string;
|
|
2001
|
-
|
|
2002
|
-
/**
|
|
2003
|
-
* The message body or additional context provided with this resolution event. Null
|
|
2004
|
-
* if no details were included.
|
|
2005
|
-
*/
|
|
2006
|
-
details: string | null;
|
|
2007
|
-
|
|
2008
|
-
/**
|
|
2009
|
-
* The party who performed this action.
|
|
2010
|
-
*/
|
|
2011
|
-
reporter_type: 'merchant' | 'customer' | 'platform' | 'system';
|
|
2012
|
-
}
|
|
2013
|
-
|
|
2014
|
-
/**
|
|
2015
|
-
* The customer (buyer) who filed this resolution case.
|
|
2016
|
-
*/
|
|
2017
|
-
export interface User {
|
|
2018
|
-
/**
|
|
2019
|
-
* The unique identifier for the user.
|
|
2020
|
-
*/
|
|
2021
|
-
id: string;
|
|
2022
|
-
|
|
2023
|
-
/**
|
|
2024
|
-
* The user's display name shown on their public profile.
|
|
2025
|
-
*/
|
|
2026
|
-
name: string | null;
|
|
1961
|
+
/**
|
|
1962
|
+
* The webhook event type
|
|
1963
|
+
*/
|
|
1964
|
+
type: 'invoice.marked_uncollectible';
|
|
2027
1965
|
|
|
2028
|
-
|
|
2029
|
-
|
|
2030
|
-
|
|
2031
|
-
|
|
2032
|
-
}
|
|
2033
|
-
}
|
|
1966
|
+
/**
|
|
1967
|
+
* The company ID that this webhook event is associated with
|
|
1968
|
+
*/
|
|
1969
|
+
company_id?: string | null;
|
|
2034
1970
|
}
|
|
2035
1971
|
|
|
2036
|
-
export interface
|
|
1972
|
+
export interface InvoicePaidWebhookEvent {
|
|
2037
1973
|
/**
|
|
2038
1974
|
* A unique ID for every single webhook request
|
|
2039
1975
|
*/
|
|
@@ -2045,10 +1981,11 @@ export interface PaymentCreatedWebhookEvent {
|
|
|
2045
1981
|
api_version: 'v1';
|
|
2046
1982
|
|
|
2047
1983
|
/**
|
|
2048
|
-
*
|
|
2049
|
-
*
|
|
1984
|
+
* An invoice represents an itemized bill sent by a company to a customer for a
|
|
1985
|
+
* specific product and plan, tracking the amount owed, due date, and payment
|
|
1986
|
+
* status.
|
|
2050
1987
|
*/
|
|
2051
|
-
data: Shared.
|
|
1988
|
+
data: Shared.Invoice;
|
|
2052
1989
|
|
|
2053
1990
|
/**
|
|
2054
1991
|
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
@@ -2058,7 +1995,7 @@ export interface PaymentCreatedWebhookEvent {
|
|
|
2058
1995
|
/**
|
|
2059
1996
|
* The webhook event type
|
|
2060
1997
|
*/
|
|
2061
|
-
type: '
|
|
1998
|
+
type: 'invoice.paid';
|
|
2062
1999
|
|
|
2063
2000
|
/**
|
|
2064
2001
|
* The company ID that this webhook event is associated with
|
|
@@ -2066,7 +2003,7 @@ export interface PaymentCreatedWebhookEvent {
|
|
|
2066
2003
|
company_id?: string | null;
|
|
2067
2004
|
}
|
|
2068
2005
|
|
|
2069
|
-
export interface
|
|
2006
|
+
export interface InvoicePastDueWebhookEvent {
|
|
2070
2007
|
/**
|
|
2071
2008
|
* A unique ID for every single webhook request
|
|
2072
2009
|
*/
|
|
@@ -2078,10 +2015,11 @@ export interface PaymentSucceededWebhookEvent {
|
|
|
2078
2015
|
api_version: 'v1';
|
|
2079
2016
|
|
|
2080
2017
|
/**
|
|
2081
|
-
*
|
|
2082
|
-
*
|
|
2018
|
+
* An invoice represents an itemized bill sent by a company to a customer for a
|
|
2019
|
+
* specific product and plan, tracking the amount owed, due date, and payment
|
|
2020
|
+
* status.
|
|
2083
2021
|
*/
|
|
2084
|
-
data: Shared.
|
|
2022
|
+
data: Shared.Invoice;
|
|
2085
2023
|
|
|
2086
2024
|
/**
|
|
2087
2025
|
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
@@ -2091,7 +2029,7 @@ export interface PaymentSucceededWebhookEvent {
|
|
|
2091
2029
|
/**
|
|
2092
2030
|
* The webhook event type
|
|
2093
2031
|
*/
|
|
2094
|
-
type: '
|
|
2032
|
+
type: 'invoice.past_due';
|
|
2095
2033
|
|
|
2096
2034
|
/**
|
|
2097
2035
|
* The company ID that this webhook event is associated with
|
|
@@ -2099,7 +2037,7 @@ export interface PaymentSucceededWebhookEvent {
|
|
|
2099
2037
|
company_id?: string | null;
|
|
2100
2038
|
}
|
|
2101
2039
|
|
|
2102
|
-
export interface
|
|
2040
|
+
export interface InvoiceVoidedWebhookEvent {
|
|
2103
2041
|
/**
|
|
2104
2042
|
* A unique ID for every single webhook request
|
|
2105
2043
|
*/
|
|
@@ -2111,10 +2049,11 @@ export interface PaymentFailedWebhookEvent {
|
|
|
2111
2049
|
api_version: 'v1';
|
|
2112
2050
|
|
|
2113
2051
|
/**
|
|
2114
|
-
*
|
|
2115
|
-
*
|
|
2052
|
+
* An invoice represents an itemized bill sent by a company to a customer for a
|
|
2053
|
+
* specific product and plan, tracking the amount owed, due date, and payment
|
|
2054
|
+
* status.
|
|
2116
2055
|
*/
|
|
2117
|
-
data: Shared.
|
|
2056
|
+
data: Shared.Invoice;
|
|
2118
2057
|
|
|
2119
2058
|
/**
|
|
2120
2059
|
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
@@ -2124,7 +2063,7 @@ export interface PaymentFailedWebhookEvent {
|
|
|
2124
2063
|
/**
|
|
2125
2064
|
* The webhook event type
|
|
2126
2065
|
*/
|
|
2127
|
-
type: '
|
|
2066
|
+
type: 'invoice.voided';
|
|
2128
2067
|
|
|
2129
2068
|
/**
|
|
2130
2069
|
* The company ID that this webhook event is associated with
|
|
@@ -2132,7 +2071,7 @@ export interface PaymentFailedWebhookEvent {
|
|
|
2132
2071
|
company_id?: string | null;
|
|
2133
2072
|
}
|
|
2134
2073
|
|
|
2135
|
-
export interface
|
|
2074
|
+
export interface MembershipActivatedWebhookEvent {
|
|
2136
2075
|
/**
|
|
2137
2076
|
* A unique ID for every single webhook request
|
|
2138
2077
|
*/
|
|
@@ -2144,10 +2083,10 @@ export interface PaymentPendingWebhookEvent {
|
|
|
2144
2083
|
api_version: 'v1';
|
|
2145
2084
|
|
|
2146
2085
|
/**
|
|
2147
|
-
* A
|
|
2148
|
-
*
|
|
2086
|
+
* A membership represents an active relationship between a user and a product. It
|
|
2087
|
+
* tracks the user's access, billing status, and renewal schedule.
|
|
2149
2088
|
*/
|
|
2150
|
-
data: Shared.
|
|
2089
|
+
data: Shared.Membership;
|
|
2151
2090
|
|
|
2152
2091
|
/**
|
|
2153
2092
|
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
@@ -2157,7 +2096,7 @@ export interface PaymentPendingWebhookEvent {
|
|
|
2157
2096
|
/**
|
|
2158
2097
|
* The webhook event type
|
|
2159
2098
|
*/
|
|
2160
|
-
type: '
|
|
2099
|
+
type: 'membership.activated';
|
|
2161
2100
|
|
|
2162
2101
|
/**
|
|
2163
2102
|
* The company ID that this webhook event is associated with
|
|
@@ -2165,7 +2104,7 @@ export interface PaymentPendingWebhookEvent {
|
|
|
2165
2104
|
company_id?: string | null;
|
|
2166
2105
|
}
|
|
2167
2106
|
|
|
2168
|
-
export interface
|
|
2107
|
+
export interface MembershipCancelAtPeriodEndChangedWebhookEvent {
|
|
2169
2108
|
/**
|
|
2170
2109
|
* A unique ID for every single webhook request
|
|
2171
2110
|
*/
|
|
@@ -2177,10 +2116,10 @@ export interface DisputeCreatedWebhookEvent {
|
|
|
2177
2116
|
api_version: 'v1';
|
|
2178
2117
|
|
|
2179
2118
|
/**
|
|
2180
|
-
* A
|
|
2181
|
-
*
|
|
2119
|
+
* A membership represents an active relationship between a user and a product. It
|
|
2120
|
+
* tracks the user's access, billing status, and renewal schedule.
|
|
2182
2121
|
*/
|
|
2183
|
-
data:
|
|
2122
|
+
data: Shared.Membership;
|
|
2184
2123
|
|
|
2185
2124
|
/**
|
|
2186
2125
|
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
@@ -2190,7 +2129,7 @@ export interface DisputeCreatedWebhookEvent {
|
|
|
2190
2129
|
/**
|
|
2191
2130
|
* The webhook event type
|
|
2192
2131
|
*/
|
|
2193
|
-
type: '
|
|
2132
|
+
type: 'membership.cancel_at_period_end_changed';
|
|
2194
2133
|
|
|
2195
2134
|
/**
|
|
2196
2135
|
* The company ID that this webhook event is associated with
|
|
@@ -2198,7 +2137,7 @@ export interface DisputeCreatedWebhookEvent {
|
|
|
2198
2137
|
company_id?: string | null;
|
|
2199
2138
|
}
|
|
2200
2139
|
|
|
2201
|
-
export interface
|
|
2140
|
+
export interface MembershipDeactivatedWebhookEvent {
|
|
2202
2141
|
/**
|
|
2203
2142
|
* A unique ID for every single webhook request
|
|
2204
2143
|
*/
|
|
@@ -2210,10 +2149,10 @@ export interface DisputeUpdatedWebhookEvent {
|
|
|
2210
2149
|
api_version: 'v1';
|
|
2211
2150
|
|
|
2212
2151
|
/**
|
|
2213
|
-
* A
|
|
2214
|
-
*
|
|
2152
|
+
* A membership represents an active relationship between a user and a product. It
|
|
2153
|
+
* tracks the user's access, billing status, and renewal schedule.
|
|
2215
2154
|
*/
|
|
2216
|
-
data:
|
|
2155
|
+
data: Shared.Membership;
|
|
2217
2156
|
|
|
2218
2157
|
/**
|
|
2219
2158
|
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
@@ -2223,7 +2162,7 @@ export interface DisputeUpdatedWebhookEvent {
|
|
|
2223
2162
|
/**
|
|
2224
2163
|
* The webhook event type
|
|
2225
2164
|
*/
|
|
2226
|
-
type: '
|
|
2165
|
+
type: 'membership.deactivated';
|
|
2227
2166
|
|
|
2228
2167
|
/**
|
|
2229
2168
|
* The company ID that this webhook event is associated with
|
|
@@ -2231,7 +2170,7 @@ export interface DisputeUpdatedWebhookEvent {
|
|
|
2231
2170
|
company_id?: string | null;
|
|
2232
2171
|
}
|
|
2233
2172
|
|
|
2234
|
-
export interface
|
|
2173
|
+
export interface PaymentCreatedWebhookEvent {
|
|
2235
2174
|
/**
|
|
2236
2175
|
* A unique ID for every single webhook request
|
|
2237
2176
|
*/
|
|
@@ -2243,10 +2182,10 @@ export interface RefundCreatedWebhookEvent {
|
|
|
2243
2182
|
api_version: 'v1';
|
|
2244
2183
|
|
|
2245
2184
|
/**
|
|
2246
|
-
* A
|
|
2247
|
-
*
|
|
2185
|
+
* A payment represents a completed or attempted charge. Payments track the amount,
|
|
2186
|
+
* status, currency, and payment method used.
|
|
2248
2187
|
*/
|
|
2249
|
-
data:
|
|
2188
|
+
data: Shared.Payment;
|
|
2250
2189
|
|
|
2251
2190
|
/**
|
|
2252
2191
|
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
@@ -2256,7 +2195,7 @@ export interface RefundCreatedWebhookEvent {
|
|
|
2256
2195
|
/**
|
|
2257
2196
|
* The webhook event type
|
|
2258
2197
|
*/
|
|
2259
|
-
type: '
|
|
2198
|
+
type: 'payment.created';
|
|
2260
2199
|
|
|
2261
2200
|
/**
|
|
2262
2201
|
* The company ID that this webhook event is associated with
|
|
@@ -2264,234 +2203,402 @@ export interface RefundCreatedWebhookEvent {
|
|
|
2264
2203
|
company_id?: string | null;
|
|
2265
2204
|
}
|
|
2266
2205
|
|
|
2267
|
-
export
|
|
2206
|
+
export interface PaymentFailedWebhookEvent {
|
|
2268
2207
|
/**
|
|
2269
|
-
* A
|
|
2270
|
-
* amount, status, and payment provider.
|
|
2208
|
+
* A unique ID for every single webhook request
|
|
2271
2209
|
*/
|
|
2272
|
-
|
|
2273
|
-
/**
|
|
2274
|
-
* The unique identifier for the refund.
|
|
2275
|
-
*/
|
|
2276
|
-
id: string;
|
|
2210
|
+
id: string;
|
|
2277
2211
|
|
|
2278
|
-
|
|
2279
|
-
|
|
2280
|
-
|
|
2281
|
-
|
|
2282
|
-
amount: number;
|
|
2212
|
+
/**
|
|
2213
|
+
* The API version for this webhook
|
|
2214
|
+
*/
|
|
2215
|
+
api_version: 'v1';
|
|
2283
2216
|
|
|
2284
|
-
|
|
2285
|
-
|
|
2286
|
-
|
|
2287
|
-
|
|
2217
|
+
/**
|
|
2218
|
+
* A payment represents a completed or attempted charge. Payments track the amount,
|
|
2219
|
+
* status, currency, and payment method used.
|
|
2220
|
+
*/
|
|
2221
|
+
data: Shared.Payment;
|
|
2222
|
+
|
|
2223
|
+
/**
|
|
2224
|
+
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
2225
|
+
*/
|
|
2226
|
+
timestamp: string;
|
|
2227
|
+
|
|
2228
|
+
/**
|
|
2229
|
+
* The webhook event type
|
|
2230
|
+
*/
|
|
2231
|
+
type: 'payment.failed';
|
|
2232
|
+
|
|
2233
|
+
/**
|
|
2234
|
+
* The company ID that this webhook event is associated with
|
|
2235
|
+
*/
|
|
2236
|
+
company_id?: string | null;
|
|
2237
|
+
}
|
|
2238
|
+
|
|
2239
|
+
export interface PaymentPendingWebhookEvent {
|
|
2240
|
+
/**
|
|
2241
|
+
* A unique ID for every single webhook request
|
|
2242
|
+
*/
|
|
2243
|
+
id: string;
|
|
2244
|
+
|
|
2245
|
+
/**
|
|
2246
|
+
* The API version for this webhook
|
|
2247
|
+
*/
|
|
2248
|
+
api_version: 'v1';
|
|
2249
|
+
|
|
2250
|
+
/**
|
|
2251
|
+
* A payment represents a completed or attempted charge. Payments track the amount,
|
|
2252
|
+
* status, currency, and payment method used.
|
|
2253
|
+
*/
|
|
2254
|
+
data: Shared.Payment;
|
|
2255
|
+
|
|
2256
|
+
/**
|
|
2257
|
+
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
2258
|
+
*/
|
|
2259
|
+
timestamp: string;
|
|
2260
|
+
|
|
2261
|
+
/**
|
|
2262
|
+
* The webhook event type
|
|
2263
|
+
*/
|
|
2264
|
+
type: 'payment.pending';
|
|
2265
|
+
|
|
2266
|
+
/**
|
|
2267
|
+
* The company ID that this webhook event is associated with
|
|
2268
|
+
*/
|
|
2269
|
+
company_id?: string | null;
|
|
2270
|
+
}
|
|
2271
|
+
|
|
2272
|
+
export interface PaymentSucceededWebhookEvent {
|
|
2273
|
+
/**
|
|
2274
|
+
* A unique ID for every single webhook request
|
|
2275
|
+
*/
|
|
2276
|
+
id: string;
|
|
2277
|
+
|
|
2278
|
+
/**
|
|
2279
|
+
* The API version for this webhook
|
|
2280
|
+
*/
|
|
2281
|
+
api_version: 'v1';
|
|
2282
|
+
|
|
2283
|
+
/**
|
|
2284
|
+
* A payment represents a completed or attempted charge. Payments track the amount,
|
|
2285
|
+
* status, currency, and payment method used.
|
|
2286
|
+
*/
|
|
2287
|
+
data: Shared.Payment;
|
|
2288
|
+
|
|
2289
|
+
/**
|
|
2290
|
+
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
2291
|
+
*/
|
|
2292
|
+
timestamp: string;
|
|
2293
|
+
|
|
2294
|
+
/**
|
|
2295
|
+
* The webhook event type
|
|
2296
|
+
*/
|
|
2297
|
+
type: 'payment.succeeded';
|
|
2298
|
+
|
|
2299
|
+
/**
|
|
2300
|
+
* The company ID that this webhook event is associated with
|
|
2301
|
+
*/
|
|
2302
|
+
company_id?: string | null;
|
|
2303
|
+
}
|
|
2304
|
+
|
|
2305
|
+
export interface PayoutAccountStatusUpdatedWebhookEvent {
|
|
2306
|
+
/**
|
|
2307
|
+
* A unique ID for every single webhook request
|
|
2308
|
+
*/
|
|
2309
|
+
id: string;
|
|
2310
|
+
|
|
2311
|
+
/**
|
|
2312
|
+
* The API version for this webhook
|
|
2313
|
+
*/
|
|
2314
|
+
api_version: 'v1';
|
|
2315
|
+
|
|
2316
|
+
/**
|
|
2317
|
+
* An object representing an account used for payouts.
|
|
2318
|
+
*/
|
|
2319
|
+
data: PayoutAccountStatusUpdatedWebhookEvent.Data;
|
|
2320
|
+
|
|
2321
|
+
/**
|
|
2322
|
+
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
2323
|
+
*/
|
|
2324
|
+
timestamp: string;
|
|
2325
|
+
|
|
2326
|
+
/**
|
|
2327
|
+
* The webhook event type
|
|
2328
|
+
*/
|
|
2329
|
+
type: 'payout_account.status_updated';
|
|
2330
|
+
|
|
2331
|
+
/**
|
|
2332
|
+
* The company ID that this webhook event is associated with
|
|
2333
|
+
*/
|
|
2334
|
+
company_id?: string | null;
|
|
2335
|
+
}
|
|
2288
2336
|
|
|
2337
|
+
export namespace PayoutAccountStatusUpdatedWebhookEvent {
|
|
2338
|
+
/**
|
|
2339
|
+
* An object representing an account used for payouts.
|
|
2340
|
+
*/
|
|
2341
|
+
export interface Data {
|
|
2289
2342
|
/**
|
|
2290
|
-
* The
|
|
2343
|
+
* The unique identifier for the payout account.
|
|
2291
2344
|
*/
|
|
2292
|
-
|
|
2345
|
+
id: string;
|
|
2293
2346
|
|
|
2294
2347
|
/**
|
|
2295
|
-
* The
|
|
2296
|
-
* no longer available.
|
|
2348
|
+
* The physical address associated with this payout account
|
|
2297
2349
|
*/
|
|
2298
|
-
|
|
2350
|
+
address: Data.Address | null;
|
|
2299
2351
|
|
|
2300
2352
|
/**
|
|
2301
|
-
* The
|
|
2353
|
+
* The company's legal name
|
|
2302
2354
|
*/
|
|
2303
|
-
|
|
2355
|
+
business_name: string | null;
|
|
2304
2356
|
|
|
2305
2357
|
/**
|
|
2306
|
-
* The
|
|
2307
|
-
* if not available from the provider.
|
|
2358
|
+
* The business representative for this payout account
|
|
2308
2359
|
*/
|
|
2309
|
-
|
|
2360
|
+
business_representative: Data.BusinessRepresentative | null;
|
|
2310
2361
|
|
|
2311
2362
|
/**
|
|
2312
|
-
* The
|
|
2363
|
+
* The email address of the representative
|
|
2313
2364
|
*/
|
|
2314
|
-
|
|
2365
|
+
email: string | null;
|
|
2315
2366
|
|
|
2316
2367
|
/**
|
|
2317
|
-
* The
|
|
2368
|
+
* The latest verification for the connected account.
|
|
2318
2369
|
*/
|
|
2319
|
-
|
|
2370
|
+
latest_verification: Data.LatestVerification | null;
|
|
2320
2371
|
|
|
2321
2372
|
/**
|
|
2322
|
-
* The
|
|
2323
|
-
* refund through banking networks. Null if no reference was provided.
|
|
2373
|
+
* The business representative's phone
|
|
2324
2374
|
*/
|
|
2325
|
-
|
|
2375
|
+
phone: string | null;
|
|
2326
2376
|
|
|
2327
2377
|
/**
|
|
2328
|
-
* The
|
|
2329
|
-
*
|
|
2378
|
+
* The granular calculated statuses reflecting payout account KYC and withdrawal
|
|
2379
|
+
* readiness.
|
|
2330
2380
|
*/
|
|
2331
|
-
status:
|
|
2381
|
+
status: PayoutAccountsAPI.PayoutAccountCalculatedStatuses | null;
|
|
2332
2382
|
}
|
|
2333
2383
|
|
|
2334
2384
|
export namespace Data {
|
|
2335
2385
|
/**
|
|
2336
|
-
* The
|
|
2337
|
-
* no longer available.
|
|
2386
|
+
* The physical address associated with this payout account
|
|
2338
2387
|
*/
|
|
2339
|
-
export interface
|
|
2388
|
+
export interface Address {
|
|
2340
2389
|
/**
|
|
2341
|
-
* The
|
|
2390
|
+
* The city of the address.
|
|
2342
2391
|
*/
|
|
2343
|
-
|
|
2392
|
+
city: string | null;
|
|
2344
2393
|
|
|
2345
2394
|
/**
|
|
2346
|
-
* The
|
|
2395
|
+
* The country of the address.
|
|
2347
2396
|
*/
|
|
2348
|
-
|
|
2397
|
+
country: string | null;
|
|
2349
2398
|
|
|
2350
2399
|
/**
|
|
2351
|
-
*
|
|
2400
|
+
* The line 1 of the address.
|
|
2352
2401
|
*/
|
|
2353
|
-
|
|
2402
|
+
line1: string | null;
|
|
2354
2403
|
|
|
2355
2404
|
/**
|
|
2356
|
-
* The
|
|
2357
|
-
* was not made with a card.
|
|
2405
|
+
* The line 2 of the address.
|
|
2358
2406
|
*/
|
|
2359
|
-
|
|
2407
|
+
line2: string | null;
|
|
2360
2408
|
|
|
2361
2409
|
/**
|
|
2362
|
-
* The
|
|
2410
|
+
* The postal code of the address.
|
|
2363
2411
|
*/
|
|
2364
|
-
|
|
2412
|
+
postal_code: string | null;
|
|
2365
2413
|
|
|
2366
2414
|
/**
|
|
2367
|
-
* The
|
|
2415
|
+
* The state of the address.
|
|
2368
2416
|
*/
|
|
2369
|
-
|
|
2417
|
+
state: string | null;
|
|
2418
|
+
}
|
|
2370
2419
|
|
|
2420
|
+
/**
|
|
2421
|
+
* The business representative for this payout account
|
|
2422
|
+
*/
|
|
2423
|
+
export interface BusinessRepresentative {
|
|
2371
2424
|
/**
|
|
2372
|
-
*
|
|
2425
|
+
* The date of birth of the business representative in ISO 8601 format
|
|
2426
|
+
* (YYYY-MM-DD).
|
|
2373
2427
|
*/
|
|
2374
|
-
|
|
2428
|
+
date_of_birth: string | null;
|
|
2375
2429
|
|
|
2376
2430
|
/**
|
|
2377
|
-
* The
|
|
2431
|
+
* The first name of the business representative.
|
|
2378
2432
|
*/
|
|
2379
|
-
|
|
2433
|
+
first_name: string | null;
|
|
2380
2434
|
|
|
2381
2435
|
/**
|
|
2382
|
-
* The
|
|
2436
|
+
* The last name of the business representative.
|
|
2383
2437
|
*/
|
|
2384
|
-
|
|
2438
|
+
last_name: string | null;
|
|
2385
2439
|
|
|
2386
2440
|
/**
|
|
2387
|
-
* The
|
|
2388
|
-
* has not yet succeeded. As a Unix timestamp.
|
|
2441
|
+
* The middle name of the business representative.
|
|
2389
2442
|
*/
|
|
2390
|
-
|
|
2391
|
-
|
|
2392
|
-
/**
|
|
2393
|
-
* The different types of payment methods that can be used.
|
|
2394
|
-
*/
|
|
2395
|
-
payment_method_type: PaymentsAPI.PaymentMethodTypes | null;
|
|
2443
|
+
middle_name: string | null;
|
|
2444
|
+
}
|
|
2396
2445
|
|
|
2446
|
+
/**
|
|
2447
|
+
* The latest verification for the connected account.
|
|
2448
|
+
*/
|
|
2449
|
+
export interface LatestVerification {
|
|
2397
2450
|
/**
|
|
2398
|
-
* The
|
|
2451
|
+
* The numeric id of the verification record.
|
|
2399
2452
|
*/
|
|
2400
|
-
|
|
2453
|
+
id: string;
|
|
2401
2454
|
|
|
2402
2455
|
/**
|
|
2403
|
-
*
|
|
2456
|
+
* An error code for a verification attempt.
|
|
2404
2457
|
*/
|
|
2405
|
-
|
|
2458
|
+
last_error_code: VerificationsAPI.VerificationErrorCode | null;
|
|
2406
2459
|
|
|
2407
2460
|
/**
|
|
2408
|
-
*
|
|
2409
|
-
*
|
|
2461
|
+
* A human-readable explanation of the most recent verification error. Null if no
|
|
2462
|
+
* error has occurred.
|
|
2410
2463
|
*/
|
|
2411
|
-
|
|
2464
|
+
last_error_reason: string | null;
|
|
2412
2465
|
|
|
2413
2466
|
/**
|
|
2414
|
-
* The
|
|
2467
|
+
* The current status of this verification session.
|
|
2415
2468
|
*/
|
|
2416
|
-
|
|
2469
|
+
status: VerificationsAPI.VerificationStatus;
|
|
2470
|
+
}
|
|
2471
|
+
}
|
|
2472
|
+
}
|
|
2417
2473
|
|
|
2418
|
-
|
|
2419
|
-
|
|
2420
|
-
|
|
2421
|
-
|
|
2474
|
+
export interface PayoutMethodCreatedWebhookEvent {
|
|
2475
|
+
/**
|
|
2476
|
+
* A unique ID for every single webhook request
|
|
2477
|
+
*/
|
|
2478
|
+
id: string;
|
|
2422
2479
|
|
|
2423
|
-
|
|
2424
|
-
|
|
2425
|
-
|
|
2426
|
-
|
|
2480
|
+
/**
|
|
2481
|
+
* The API version for this webhook
|
|
2482
|
+
*/
|
|
2483
|
+
api_version: 'v1';
|
|
2484
|
+
|
|
2485
|
+
/**
|
|
2486
|
+
* A configured payout destination where a user receives earned funds, such as a
|
|
2487
|
+
* bank account or digital wallet.
|
|
2488
|
+
*/
|
|
2489
|
+
data: PayoutMethodCreatedWebhookEvent.Data;
|
|
2490
|
+
|
|
2491
|
+
/**
|
|
2492
|
+
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
2493
|
+
*/
|
|
2494
|
+
timestamp: string;
|
|
2495
|
+
|
|
2496
|
+
/**
|
|
2497
|
+
* The webhook event type
|
|
2498
|
+
*/
|
|
2499
|
+
type: 'payout_method.created';
|
|
2500
|
+
|
|
2501
|
+
/**
|
|
2502
|
+
* The company ID that this webhook event is associated with
|
|
2503
|
+
*/
|
|
2504
|
+
company_id?: string | null;
|
|
2505
|
+
}
|
|
2506
|
+
|
|
2507
|
+
export namespace PayoutMethodCreatedWebhookEvent {
|
|
2508
|
+
/**
|
|
2509
|
+
* A configured payout destination where a user receives earned funds, such as a
|
|
2510
|
+
* bank account or digital wallet.
|
|
2511
|
+
*/
|
|
2512
|
+
export interface Data {
|
|
2513
|
+
/**
|
|
2514
|
+
* The unique identifier for the payout token.
|
|
2515
|
+
*/
|
|
2516
|
+
id: string;
|
|
2517
|
+
|
|
2518
|
+
/**
|
|
2519
|
+
* A masked identifier for the payout destination, such as the last four digits of
|
|
2520
|
+
* a bank account or an email address. Null if no reference is available.
|
|
2521
|
+
*/
|
|
2522
|
+
account_reference: string | null;
|
|
2523
|
+
|
|
2524
|
+
/**
|
|
2525
|
+
* The company associated with this payout destination. Null if not linked to a
|
|
2526
|
+
* specific company.
|
|
2527
|
+
*/
|
|
2528
|
+
company: Data.Company | null;
|
|
2529
|
+
|
|
2530
|
+
/**
|
|
2531
|
+
* The datetime the payout token was created.
|
|
2532
|
+
*/
|
|
2533
|
+
created_at: string;
|
|
2534
|
+
|
|
2535
|
+
/**
|
|
2536
|
+
* The three-letter ISO currency code that payouts are delivered in for this
|
|
2537
|
+
* destination.
|
|
2538
|
+
*/
|
|
2539
|
+
currency: string;
|
|
2540
|
+
|
|
2541
|
+
/**
|
|
2542
|
+
* The payout destination configuration linked to this token. Null if not yet
|
|
2543
|
+
* configured.
|
|
2544
|
+
*/
|
|
2545
|
+
destination: Data.Destination | null;
|
|
2546
|
+
|
|
2547
|
+
/**
|
|
2548
|
+
* The name of the bank or financial institution receiving payouts. Null if not
|
|
2549
|
+
* applicable or not provided.
|
|
2550
|
+
*/
|
|
2551
|
+
institution_name: string | null;
|
|
2552
|
+
|
|
2553
|
+
/**
|
|
2554
|
+
* Whether this is the default payout destination for the associated payout
|
|
2555
|
+
* account.
|
|
2556
|
+
*/
|
|
2557
|
+
is_default: boolean;
|
|
2558
|
+
|
|
2559
|
+
/**
|
|
2560
|
+
* A user-defined label to help identify this payout destination. Not sent to the
|
|
2561
|
+
* provider. Null if no nickname has been set.
|
|
2562
|
+
*/
|
|
2563
|
+
nickname: string | null;
|
|
2564
|
+
}
|
|
2427
2565
|
|
|
2566
|
+
export namespace Data {
|
|
2567
|
+
/**
|
|
2568
|
+
* The company associated with this payout destination. Null if not linked to a
|
|
2569
|
+
* specific company.
|
|
2570
|
+
*/
|
|
2571
|
+
export interface Company {
|
|
2428
2572
|
/**
|
|
2429
|
-
* The
|
|
2573
|
+
* The unique identifier for the company.
|
|
2430
2574
|
*/
|
|
2431
|
-
|
|
2575
|
+
id: string;
|
|
2432
2576
|
}
|
|
2433
2577
|
|
|
2434
|
-
|
|
2578
|
+
/**
|
|
2579
|
+
* The payout destination configuration linked to this token. Null if not yet
|
|
2580
|
+
* configured.
|
|
2581
|
+
*/
|
|
2582
|
+
export interface Destination {
|
|
2435
2583
|
/**
|
|
2436
|
-
* The
|
|
2584
|
+
* The category of the payout destination
|
|
2437
2585
|
*/
|
|
2438
|
-
|
|
2439
|
-
/**
|
|
2440
|
-
* The unique identifier for the company member.
|
|
2441
|
-
*/
|
|
2442
|
-
id: string;
|
|
2443
|
-
|
|
2444
|
-
/**
|
|
2445
|
-
* The phone number for the member, if available.
|
|
2446
|
-
*/
|
|
2447
|
-
phone: string | null;
|
|
2448
|
-
}
|
|
2586
|
+
category: PayoutMethodsAPI.PayoutDestinationCategory;
|
|
2449
2587
|
|
|
2450
2588
|
/**
|
|
2451
|
-
* The
|
|
2589
|
+
* The country code of the payout destination
|
|
2452
2590
|
*/
|
|
2453
|
-
|
|
2454
|
-
/**
|
|
2455
|
-
* The unique identifier for the membership.
|
|
2456
|
-
*/
|
|
2457
|
-
id: string;
|
|
2458
|
-
|
|
2459
|
-
/**
|
|
2460
|
-
* The state of the membership.
|
|
2461
|
-
*/
|
|
2462
|
-
status: Shared.MembershipStatus;
|
|
2463
|
-
}
|
|
2591
|
+
country_code: string;
|
|
2464
2592
|
|
|
2465
2593
|
/**
|
|
2466
|
-
* The
|
|
2594
|
+
* The name of the payer associated with the payout destination
|
|
2467
2595
|
*/
|
|
2468
|
-
|
|
2469
|
-
/**
|
|
2470
|
-
* The unique identifier for the user.
|
|
2471
|
-
*/
|
|
2472
|
-
id: string;
|
|
2473
|
-
|
|
2474
|
-
/**
|
|
2475
|
-
* The user's email address. Requires the member:email:read permission to access.
|
|
2476
|
-
* Null if not authorized.
|
|
2477
|
-
*/
|
|
2478
|
-
email: string | null;
|
|
2479
|
-
|
|
2480
|
-
/**
|
|
2481
|
-
* The user's display name shown on their public profile.
|
|
2482
|
-
*/
|
|
2483
|
-
name: string | null;
|
|
2484
|
-
|
|
2485
|
-
/**
|
|
2486
|
-
* The user's unique username shown on their public profile.
|
|
2487
|
-
*/
|
|
2488
|
-
username: string;
|
|
2489
|
-
}
|
|
2596
|
+
name: string;
|
|
2490
2597
|
}
|
|
2491
2598
|
}
|
|
2492
2599
|
}
|
|
2493
2600
|
|
|
2494
|
-
export interface
|
|
2601
|
+
export interface RefundCreatedWebhookEvent {
|
|
2495
2602
|
/**
|
|
2496
2603
|
* A unique ID for every single webhook request
|
|
2497
2604
|
*/
|
|
@@ -2506,7 +2613,7 @@ export interface RefundUpdatedWebhookEvent {
|
|
|
2506
2613
|
* A refund represents a full or partial reversal of a payment, including the
|
|
2507
2614
|
* amount, status, and payment provider.
|
|
2508
2615
|
*/
|
|
2509
|
-
data:
|
|
2616
|
+
data: RefundCreatedWebhookEvent.Data;
|
|
2510
2617
|
|
|
2511
2618
|
/**
|
|
2512
2619
|
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
@@ -2516,7 +2623,7 @@ export interface RefundUpdatedWebhookEvent {
|
|
|
2516
2623
|
/**
|
|
2517
2624
|
* The webhook event type
|
|
2518
2625
|
*/
|
|
2519
|
-
type: 'refund.
|
|
2626
|
+
type: 'refund.created';
|
|
2520
2627
|
|
|
2521
2628
|
/**
|
|
2522
2629
|
* The company ID that this webhook event is associated with
|
|
@@ -2524,7 +2631,7 @@ export interface RefundUpdatedWebhookEvent {
|
|
|
2524
2631
|
company_id?: string | null;
|
|
2525
2632
|
}
|
|
2526
2633
|
|
|
2527
|
-
export namespace
|
|
2634
|
+
export namespace RefundCreatedWebhookEvent {
|
|
2528
2635
|
/**
|
|
2529
2636
|
* A refund represents a full or partial reversal of a payment, including the
|
|
2530
2637
|
* amount, status, and payment provider.
|
|
@@ -2624,9 +2731,9 @@ export namespace RefundUpdatedWebhookEvent {
|
|
|
2624
2731
|
created_at: string;
|
|
2625
2732
|
|
|
2626
2733
|
/**
|
|
2627
|
-
* The
|
|
2734
|
+
* The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
|
|
2628
2735
|
*/
|
|
2629
|
-
currency: Shared.Currency
|
|
2736
|
+
currency: Shared.Currency;
|
|
2630
2737
|
|
|
2631
2738
|
/**
|
|
2632
2739
|
* When an alert came in that this transaction will be disputed
|
|
@@ -2643,6 +2750,12 @@ export namespace RefundUpdatedWebhookEvent {
|
|
|
2643
2750
|
*/
|
|
2644
2751
|
membership: Payment.Membership | null;
|
|
2645
2752
|
|
|
2753
|
+
/**
|
|
2754
|
+
* The custom metadata stored on this payment. This will be copied over to the
|
|
2755
|
+
* checkout configuration for which this payment was made
|
|
2756
|
+
*/
|
|
2757
|
+
metadata: { [key: string]: unknown } | null;
|
|
2758
|
+
|
|
2646
2759
|
/**
|
|
2647
2760
|
* The time at which this payment was successfully collected. Null if the payment
|
|
2648
2761
|
* has not yet succeeded. As a Unix timestamp.
|
|
@@ -2654,6 +2767,16 @@ export namespace RefundUpdatedWebhookEvent {
|
|
|
2654
2767
|
*/
|
|
2655
2768
|
payment_method_type: PaymentsAPI.PaymentMethodTypes | null;
|
|
2656
2769
|
|
|
2770
|
+
/**
|
|
2771
|
+
* The plan attached to this payment.
|
|
2772
|
+
*/
|
|
2773
|
+
plan: Payment.Plan | null;
|
|
2774
|
+
|
|
2775
|
+
/**
|
|
2776
|
+
* The product this payment was made for
|
|
2777
|
+
*/
|
|
2778
|
+
product: Payment.Product | null;
|
|
2779
|
+
|
|
2657
2780
|
/**
|
|
2658
2781
|
* The subtotal to show to the creator (excluding buyer fees).
|
|
2659
2782
|
*/
|
|
@@ -2722,6 +2845,38 @@ export namespace RefundUpdatedWebhookEvent {
|
|
|
2722
2845
|
status: Shared.MembershipStatus;
|
|
2723
2846
|
}
|
|
2724
2847
|
|
|
2848
|
+
/**
|
|
2849
|
+
* The plan attached to this payment.
|
|
2850
|
+
*/
|
|
2851
|
+
export interface Plan {
|
|
2852
|
+
/**
|
|
2853
|
+
* The unique identifier for the plan.
|
|
2854
|
+
*/
|
|
2855
|
+
id: string;
|
|
2856
|
+
|
|
2857
|
+
/**
|
|
2858
|
+
* Custom key-value pairs stored on the plan. Included in webhook payloads for
|
|
2859
|
+
* payment and membership events.
|
|
2860
|
+
*/
|
|
2861
|
+
metadata: { [key: string]: unknown } | null;
|
|
2862
|
+
}
|
|
2863
|
+
|
|
2864
|
+
/**
|
|
2865
|
+
* The product this payment was made for
|
|
2866
|
+
*/
|
|
2867
|
+
export interface Product {
|
|
2868
|
+
/**
|
|
2869
|
+
* The unique identifier for the product.
|
|
2870
|
+
*/
|
|
2871
|
+
id: string;
|
|
2872
|
+
|
|
2873
|
+
/**
|
|
2874
|
+
* Custom key-value pairs stored on the product. Included in webhook payloads for
|
|
2875
|
+
* payment and membership events.
|
|
2876
|
+
*/
|
|
2877
|
+
metadata: { [key: string]: unknown } | null;
|
|
2878
|
+
}
|
|
2879
|
+
|
|
2725
2880
|
/**
|
|
2726
2881
|
* The user that made this payment.
|
|
2727
2882
|
*/
|
|
@@ -2751,7 +2906,7 @@ export namespace RefundUpdatedWebhookEvent {
|
|
|
2751
2906
|
}
|
|
2752
2907
|
}
|
|
2753
2908
|
|
|
2754
|
-
export interface
|
|
2909
|
+
export interface RefundUpdatedWebhookEvent {
|
|
2755
2910
|
/**
|
|
2756
2911
|
* A unique ID for every single webhook request
|
|
2757
2912
|
*/
|
|
@@ -2763,10 +2918,10 @@ export interface DisputeAlertCreatedWebhookEvent {
|
|
|
2763
2918
|
api_version: 'v1';
|
|
2764
2919
|
|
|
2765
2920
|
/**
|
|
2766
|
-
* A
|
|
2767
|
-
*
|
|
2921
|
+
* A refund represents a full or partial reversal of a payment, including the
|
|
2922
|
+
* amount, status, and payment provider.
|
|
2768
2923
|
*/
|
|
2769
|
-
data:
|
|
2924
|
+
data: RefundUpdatedWebhookEvent.Data;
|
|
2770
2925
|
|
|
2771
2926
|
/**
|
|
2772
2927
|
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
@@ -2776,7 +2931,7 @@ export interface DisputeAlertCreatedWebhookEvent {
|
|
|
2776
2931
|
/**
|
|
2777
2932
|
* The webhook event type
|
|
2778
2933
|
*/
|
|
2779
|
-
type: '
|
|
2934
|
+
type: 'refund.updated';
|
|
2780
2935
|
|
|
2781
2936
|
/**
|
|
2782
2937
|
* The company ID that this webhook event is associated with
|
|
@@ -2784,97 +2939,77 @@ export interface DisputeAlertCreatedWebhookEvent {
|
|
|
2784
2939
|
company_id?: string | null;
|
|
2785
2940
|
}
|
|
2786
2941
|
|
|
2787
|
-
export namespace
|
|
2942
|
+
export namespace RefundUpdatedWebhookEvent {
|
|
2788
2943
|
/**
|
|
2789
|
-
* A
|
|
2790
|
-
*
|
|
2944
|
+
* A refund represents a full or partial reversal of a payment, including the
|
|
2945
|
+
* amount, status, and payment provider.
|
|
2791
2946
|
*/
|
|
2792
2947
|
export interface Data {
|
|
2793
2948
|
/**
|
|
2794
|
-
* The unique identifier
|
|
2949
|
+
* The unique identifier for the refund.
|
|
2795
2950
|
*/
|
|
2796
2951
|
id: string;
|
|
2797
2952
|
|
|
2798
2953
|
/**
|
|
2799
|
-
* The
|
|
2954
|
+
* The refunded amount as a decimal in the specified currency, such as 10.43 for
|
|
2955
|
+
* $10.43 USD.
|
|
2800
2956
|
*/
|
|
2801
|
-
|
|
2957
|
+
amount: number;
|
|
2802
2958
|
|
|
2803
2959
|
/**
|
|
2804
|
-
* The
|
|
2960
|
+
* The datetime the refund was created.
|
|
2805
2961
|
*/
|
|
2806
|
-
|
|
2962
|
+
created_at: string;
|
|
2807
2963
|
|
|
2808
2964
|
/**
|
|
2809
|
-
*
|
|
2965
|
+
* The three-letter ISO currency code for the refunded amount.
|
|
2810
2966
|
*/
|
|
2811
|
-
|
|
2967
|
+
currency: Shared.Currency;
|
|
2812
2968
|
|
|
2813
2969
|
/**
|
|
2814
|
-
* The
|
|
2970
|
+
* The original payment that this refund was issued against. Null if the payment is
|
|
2971
|
+
* no longer available.
|
|
2815
2972
|
*/
|
|
2816
|
-
|
|
2973
|
+
payment: Data.Payment | null;
|
|
2817
2974
|
|
|
2818
2975
|
/**
|
|
2819
|
-
* The
|
|
2976
|
+
* The payment provider that processed the refund.
|
|
2820
2977
|
*/
|
|
2821
|
-
|
|
2978
|
+
provider: RefundsAPI.PaymentProvider;
|
|
2822
2979
|
|
|
2823
2980
|
/**
|
|
2824
|
-
* The
|
|
2981
|
+
* The timestamp when the refund was created in the payment provider's system. Null
|
|
2982
|
+
* if not available from the provider.
|
|
2825
2983
|
*/
|
|
2826
|
-
|
|
2984
|
+
provider_created_at: string | null;
|
|
2827
2985
|
|
|
2828
2986
|
/**
|
|
2829
|
-
* The
|
|
2987
|
+
* The status of the refund reference.
|
|
2830
2988
|
*/
|
|
2831
|
-
|
|
2989
|
+
reference_status: RefundsAPI.RefundReferenceStatus | null;
|
|
2832
2990
|
|
|
2833
2991
|
/**
|
|
2834
|
-
* The
|
|
2992
|
+
* The type of refund reference that was made available by the payment provider.
|
|
2835
2993
|
*/
|
|
2836
|
-
|
|
2837
|
-
}
|
|
2994
|
+
reference_type: RefundsAPI.RefundReferenceType | null;
|
|
2838
2995
|
|
|
2839
|
-
export namespace Data {
|
|
2840
2996
|
/**
|
|
2841
|
-
* The
|
|
2997
|
+
* The tracking reference value from the payment processor, used to trace the
|
|
2998
|
+
* refund through banking networks. Null if no reference was provided.
|
|
2842
2999
|
*/
|
|
2843
|
-
|
|
2844
|
-
/**
|
|
2845
|
-
* The unique identifier for the dispute.
|
|
2846
|
-
*/
|
|
2847
|
-
id: string;
|
|
2848
|
-
|
|
2849
|
-
/**
|
|
2850
|
-
* The disputed amount in the specified currency, formatted as a decimal.
|
|
2851
|
-
*/
|
|
2852
|
-
amount: number;
|
|
2853
|
-
|
|
2854
|
-
/**
|
|
2855
|
-
* The datetime the dispute was created.
|
|
2856
|
-
*/
|
|
2857
|
-
created_at: string | null;
|
|
2858
|
-
|
|
2859
|
-
/**
|
|
2860
|
-
* The three-letter ISO currency code for the disputed amount.
|
|
2861
|
-
*/
|
|
2862
|
-
currency: Shared.Currency;
|
|
2863
|
-
|
|
2864
|
-
/**
|
|
2865
|
-
* A human-readable reason for the dispute.
|
|
2866
|
-
*/
|
|
2867
|
-
reason: string | null;
|
|
3000
|
+
reference_value: string | null;
|
|
2868
3001
|
|
|
2869
|
-
|
|
2870
|
-
|
|
2871
|
-
|
|
2872
|
-
|
|
2873
|
-
|
|
2874
|
-
|
|
3002
|
+
/**
|
|
3003
|
+
* The current processing status of the refund, such as pending, succeeded, or
|
|
3004
|
+
* failed.
|
|
3005
|
+
*/
|
|
3006
|
+
status: RefundsAPI.RefundStatus;
|
|
3007
|
+
}
|
|
2875
3008
|
|
|
3009
|
+
export namespace Data {
|
|
2876
3010
|
/**
|
|
2877
|
-
* The payment
|
|
3011
|
+
* The original payment that this refund was issued against. Null if the payment is
|
|
3012
|
+
* no longer available.
|
|
2878
3013
|
*/
|
|
2879
3014
|
export interface Payment {
|
|
2880
3015
|
/**
|
|
@@ -2904,9 +3039,9 @@ export namespace DisputeAlertCreatedWebhookEvent {
|
|
|
2904
3039
|
created_at: string;
|
|
2905
3040
|
|
|
2906
3041
|
/**
|
|
2907
|
-
* The
|
|
3042
|
+
* The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
|
|
2908
3043
|
*/
|
|
2909
|
-
currency: Shared.Currency
|
|
3044
|
+
currency: Shared.Currency;
|
|
2910
3045
|
|
|
2911
3046
|
/**
|
|
2912
3047
|
* When an alert came in that this transaction will be disputed
|
|
@@ -2923,6 +3058,12 @@ export namespace DisputeAlertCreatedWebhookEvent {
|
|
|
2923
3058
|
*/
|
|
2924
3059
|
membership: Payment.Membership | null;
|
|
2925
3060
|
|
|
3061
|
+
/**
|
|
3062
|
+
* The custom metadata stored on this payment. This will be copied over to the
|
|
3063
|
+
* checkout configuration for which this payment was made
|
|
3064
|
+
*/
|
|
3065
|
+
metadata: { [key: string]: unknown } | null;
|
|
3066
|
+
|
|
2926
3067
|
/**
|
|
2927
3068
|
* The time at which this payment was successfully collected. Null if the payment
|
|
2928
3069
|
* has not yet succeeded. As a Unix timestamp.
|
|
@@ -2934,88 +3075,1111 @@ export namespace DisputeAlertCreatedWebhookEvent {
|
|
|
2934
3075
|
*/
|
|
2935
3076
|
payment_method_type: PaymentsAPI.PaymentMethodTypes | null;
|
|
2936
3077
|
|
|
3078
|
+
/**
|
|
3079
|
+
* The plan attached to this payment.
|
|
3080
|
+
*/
|
|
3081
|
+
plan: Payment.Plan | null;
|
|
3082
|
+
|
|
3083
|
+
/**
|
|
3084
|
+
* The product this payment was made for
|
|
3085
|
+
*/
|
|
3086
|
+
product: Payment.Product | null;
|
|
3087
|
+
|
|
2937
3088
|
/**
|
|
2938
3089
|
* The subtotal to show to the creator (excluding buyer fees).
|
|
2939
3090
|
*/
|
|
2940
3091
|
subtotal: number | null;
|
|
2941
3092
|
|
|
2942
|
-
/**
|
|
2943
|
-
* The
|
|
2944
|
-
*/
|
|
2945
|
-
|
|
3093
|
+
/**
|
|
3094
|
+
* The calculated amount of the sales/VAT tax (if applicable).
|
|
3095
|
+
*/
|
|
3096
|
+
tax_amount: number | null;
|
|
3097
|
+
|
|
3098
|
+
/**
|
|
3099
|
+
* The type of tax inclusivity applied to the receipt, for determining whether the
|
|
3100
|
+
* tax is included in the final price, or paid on top.
|
|
3101
|
+
*/
|
|
3102
|
+
tax_behavior: PaymentsAPI.ReceiptTaxBehavior | null;
|
|
3103
|
+
|
|
3104
|
+
/**
|
|
3105
|
+
* The amount of tax that has been refunded (if applicable).
|
|
3106
|
+
*/
|
|
3107
|
+
tax_refunded_amount: number | null;
|
|
3108
|
+
|
|
3109
|
+
/**
|
|
3110
|
+
* The total to show to the creator (excluding buyer fees).
|
|
3111
|
+
*/
|
|
3112
|
+
total: number | null;
|
|
3113
|
+
|
|
3114
|
+
/**
|
|
3115
|
+
* The total in USD to show to the creator (excluding buyer fees).
|
|
3116
|
+
*/
|
|
3117
|
+
usd_total: number | null;
|
|
3118
|
+
|
|
3119
|
+
/**
|
|
3120
|
+
* The user that made this payment.
|
|
3121
|
+
*/
|
|
3122
|
+
user: Payment.User | null;
|
|
3123
|
+
}
|
|
3124
|
+
|
|
3125
|
+
export namespace Payment {
|
|
3126
|
+
/**
|
|
3127
|
+
* The member attached to this payment.
|
|
3128
|
+
*/
|
|
3129
|
+
export interface Member {
|
|
3130
|
+
/**
|
|
3131
|
+
* The unique identifier for the company member.
|
|
3132
|
+
*/
|
|
3133
|
+
id: string;
|
|
3134
|
+
|
|
3135
|
+
/**
|
|
3136
|
+
* The phone number for the member, if available.
|
|
3137
|
+
*/
|
|
3138
|
+
phone: string | null;
|
|
3139
|
+
}
|
|
3140
|
+
|
|
3141
|
+
/**
|
|
3142
|
+
* The membership attached to this payment.
|
|
3143
|
+
*/
|
|
3144
|
+
export interface Membership {
|
|
3145
|
+
/**
|
|
3146
|
+
* The unique identifier for the membership.
|
|
3147
|
+
*/
|
|
3148
|
+
id: string;
|
|
3149
|
+
|
|
3150
|
+
/**
|
|
3151
|
+
* The state of the membership.
|
|
3152
|
+
*/
|
|
3153
|
+
status: Shared.MembershipStatus;
|
|
3154
|
+
}
|
|
3155
|
+
|
|
3156
|
+
/**
|
|
3157
|
+
* The plan attached to this payment.
|
|
3158
|
+
*/
|
|
3159
|
+
export interface Plan {
|
|
3160
|
+
/**
|
|
3161
|
+
* The unique identifier for the plan.
|
|
3162
|
+
*/
|
|
3163
|
+
id: string;
|
|
3164
|
+
|
|
3165
|
+
/**
|
|
3166
|
+
* Custom key-value pairs stored on the plan. Included in webhook payloads for
|
|
3167
|
+
* payment and membership events.
|
|
3168
|
+
*/
|
|
3169
|
+
metadata: { [key: string]: unknown } | null;
|
|
3170
|
+
}
|
|
3171
|
+
|
|
3172
|
+
/**
|
|
3173
|
+
* The product this payment was made for
|
|
3174
|
+
*/
|
|
3175
|
+
export interface Product {
|
|
3176
|
+
/**
|
|
3177
|
+
* The unique identifier for the product.
|
|
3178
|
+
*/
|
|
3179
|
+
id: string;
|
|
3180
|
+
|
|
3181
|
+
/**
|
|
3182
|
+
* Custom key-value pairs stored on the product. Included in webhook payloads for
|
|
3183
|
+
* payment and membership events.
|
|
3184
|
+
*/
|
|
3185
|
+
metadata: { [key: string]: unknown } | null;
|
|
3186
|
+
}
|
|
3187
|
+
|
|
3188
|
+
/**
|
|
3189
|
+
* The user that made this payment.
|
|
3190
|
+
*/
|
|
3191
|
+
export interface User {
|
|
3192
|
+
/**
|
|
3193
|
+
* The unique identifier for the user.
|
|
3194
|
+
*/
|
|
3195
|
+
id: string;
|
|
3196
|
+
|
|
3197
|
+
/**
|
|
3198
|
+
* The user's email address. Requires the member:email:read permission to access.
|
|
3199
|
+
* Null if not authorized.
|
|
3200
|
+
*/
|
|
3201
|
+
email: string | null;
|
|
3202
|
+
|
|
3203
|
+
/**
|
|
3204
|
+
* The user's display name shown on their public profile.
|
|
3205
|
+
*/
|
|
3206
|
+
name: string | null;
|
|
3207
|
+
|
|
3208
|
+
/**
|
|
3209
|
+
* The user's unique username shown on their public profile.
|
|
3210
|
+
*/
|
|
3211
|
+
username: string;
|
|
3212
|
+
}
|
|
3213
|
+
}
|
|
3214
|
+
}
|
|
3215
|
+
}
|
|
3216
|
+
|
|
3217
|
+
export interface ResolutionCenterCaseCreatedWebhookEvent {
|
|
3218
|
+
/**
|
|
3219
|
+
* A unique ID for every single webhook request
|
|
3220
|
+
*/
|
|
3221
|
+
id: string;
|
|
3222
|
+
|
|
3223
|
+
/**
|
|
3224
|
+
* The API version for this webhook
|
|
3225
|
+
*/
|
|
3226
|
+
api_version: 'v1';
|
|
3227
|
+
|
|
3228
|
+
/**
|
|
3229
|
+
* A resolution center case is a dispute or support case between a user and a
|
|
3230
|
+
* company, tracking the issue, status, and outcome.
|
|
3231
|
+
*/
|
|
3232
|
+
data: ResolutionCenterCaseCreatedWebhookEvent.Data;
|
|
3233
|
+
|
|
3234
|
+
/**
|
|
3235
|
+
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
3236
|
+
*/
|
|
3237
|
+
timestamp: string;
|
|
3238
|
+
|
|
3239
|
+
/**
|
|
3240
|
+
* The webhook event type
|
|
3241
|
+
*/
|
|
3242
|
+
type: 'resolution_center_case.created';
|
|
3243
|
+
|
|
3244
|
+
/**
|
|
3245
|
+
* The company ID that this webhook event is associated with
|
|
3246
|
+
*/
|
|
3247
|
+
company_id?: string | null;
|
|
3248
|
+
}
|
|
3249
|
+
|
|
3250
|
+
export namespace ResolutionCenterCaseCreatedWebhookEvent {
|
|
3251
|
+
/**
|
|
3252
|
+
* A resolution center case is a dispute or support case between a user and a
|
|
3253
|
+
* company, tracking the issue, status, and outcome.
|
|
3254
|
+
*/
|
|
3255
|
+
export interface Data {
|
|
3256
|
+
/**
|
|
3257
|
+
* The unique identifier for the resolution.
|
|
3258
|
+
*/
|
|
3259
|
+
id: string;
|
|
3260
|
+
|
|
3261
|
+
/**
|
|
3262
|
+
* The company involved in this resolution case. Null if the company no longer
|
|
3263
|
+
* exists.
|
|
3264
|
+
*/
|
|
3265
|
+
company: Data.Company | null;
|
|
3266
|
+
|
|
3267
|
+
/**
|
|
3268
|
+
* The datetime the resolution was created.
|
|
3269
|
+
*/
|
|
3270
|
+
created_at: string;
|
|
3271
|
+
|
|
3272
|
+
/**
|
|
3273
|
+
* Whether the customer has filed an appeal after the initial resolution decision.
|
|
3274
|
+
*/
|
|
3275
|
+
customer_appealed: boolean;
|
|
3276
|
+
|
|
3277
|
+
/**
|
|
3278
|
+
* The list of actions currently available to the customer.
|
|
3279
|
+
*/
|
|
3280
|
+
customer_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCaseCustomerResponse>;
|
|
3281
|
+
|
|
3282
|
+
/**
|
|
3283
|
+
* The deadline by which the next response is required. Null if no deadline is
|
|
3284
|
+
* currently active. As a Unix timestamp.
|
|
3285
|
+
*/
|
|
3286
|
+
due_date: string | null;
|
|
3287
|
+
|
|
3288
|
+
/**
|
|
3289
|
+
* The category of the dispute.
|
|
3290
|
+
*/
|
|
3291
|
+
issue: ResolutionCenterCasesAPI.ResolutionCenterCaseIssueType;
|
|
3292
|
+
|
|
3293
|
+
/**
|
|
3294
|
+
* The membership record associated with the disputed payment. Null if the
|
|
3295
|
+
* membership no longer exists.
|
|
3296
|
+
*/
|
|
3297
|
+
member: Data.Member | null;
|
|
3298
|
+
|
|
3299
|
+
/**
|
|
3300
|
+
* Whether the merchant has filed an appeal after the initial resolution decision.
|
|
3301
|
+
*/
|
|
3302
|
+
merchant_appealed: boolean;
|
|
3303
|
+
|
|
3304
|
+
/**
|
|
3305
|
+
* The list of actions currently available to the merchant.
|
|
3306
|
+
*/
|
|
3307
|
+
merchant_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCaseMerchantResponse>;
|
|
3308
|
+
|
|
3309
|
+
/**
|
|
3310
|
+
* The payment record that is the subject of this resolution case.
|
|
3311
|
+
*/
|
|
3312
|
+
payment: Data.Payment;
|
|
3313
|
+
|
|
3314
|
+
/**
|
|
3315
|
+
* The list of actions currently available to the Whop platform for moderating this
|
|
3316
|
+
* resolution.
|
|
3317
|
+
*/
|
|
3318
|
+
platform_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCasePlatformResponse>;
|
|
3319
|
+
|
|
3320
|
+
/**
|
|
3321
|
+
* The most recent 50 messages, actions, and status changes that have occurred
|
|
3322
|
+
* during this resolution case.
|
|
3323
|
+
*/
|
|
3324
|
+
resolution_events: Array<Data.ResolutionEvent>;
|
|
3325
|
+
|
|
3326
|
+
/**
|
|
3327
|
+
* The current status of the resolution case, indicating which party needs to
|
|
3328
|
+
* respond or if the case is closed.
|
|
3329
|
+
*/
|
|
3330
|
+
status: ResolutionCenterCasesAPI.ResolutionCenterCaseStatus;
|
|
3331
|
+
|
|
3332
|
+
/**
|
|
3333
|
+
* The datetime the resolution was last updated.
|
|
3334
|
+
*/
|
|
3335
|
+
updated_at: string;
|
|
3336
|
+
|
|
3337
|
+
/**
|
|
3338
|
+
* The customer (buyer) who filed this resolution case.
|
|
3339
|
+
*/
|
|
3340
|
+
user: Data.User;
|
|
3341
|
+
}
|
|
3342
|
+
|
|
3343
|
+
export namespace Data {
|
|
3344
|
+
/**
|
|
3345
|
+
* The company involved in this resolution case. Null if the company no longer
|
|
3346
|
+
* exists.
|
|
3347
|
+
*/
|
|
3348
|
+
export interface Company {
|
|
3349
|
+
/**
|
|
3350
|
+
* The unique identifier for the company.
|
|
3351
|
+
*/
|
|
3352
|
+
id: string;
|
|
3353
|
+
|
|
3354
|
+
/**
|
|
3355
|
+
* The display name of the company shown to customers.
|
|
3356
|
+
*/
|
|
3357
|
+
title: string;
|
|
3358
|
+
}
|
|
3359
|
+
|
|
3360
|
+
/**
|
|
3361
|
+
* The membership record associated with the disputed payment. Null if the
|
|
3362
|
+
* membership no longer exists.
|
|
3363
|
+
*/
|
|
3364
|
+
export interface Member {
|
|
3365
|
+
/**
|
|
3366
|
+
* The unique identifier for the extra public member.
|
|
3367
|
+
*/
|
|
3368
|
+
id: string;
|
|
3369
|
+
}
|
|
3370
|
+
|
|
3371
|
+
/**
|
|
3372
|
+
* The payment record that is the subject of this resolution case.
|
|
3373
|
+
*/
|
|
3374
|
+
export interface Payment {
|
|
3375
|
+
/**
|
|
3376
|
+
* The unique identifier for the payment.
|
|
3377
|
+
*/
|
|
3378
|
+
id: string;
|
|
3379
|
+
|
|
3380
|
+
/**
|
|
3381
|
+
* The datetime the payment was created.
|
|
3382
|
+
*/
|
|
3383
|
+
created_at: string;
|
|
3384
|
+
|
|
3385
|
+
/**
|
|
3386
|
+
* The available currencies on the platform
|
|
3387
|
+
*/
|
|
3388
|
+
currency: Shared.Currency | null;
|
|
3389
|
+
|
|
3390
|
+
/**
|
|
3391
|
+
* The time at which this payment was successfully collected. Null if the payment
|
|
3392
|
+
* has not yet succeeded. As a Unix timestamp.
|
|
3393
|
+
*/
|
|
3394
|
+
paid_at: string | null;
|
|
3395
|
+
|
|
3396
|
+
/**
|
|
3397
|
+
* The payment amount before taxes and discounts are applied. In the currency
|
|
3398
|
+
* specified by the currency field.
|
|
3399
|
+
*/
|
|
3400
|
+
subtotal: number | null;
|
|
3401
|
+
|
|
3402
|
+
/**
|
|
3403
|
+
* The total amount charged to the customer for this payment, including taxes and
|
|
3404
|
+
* after any discounts. In the currency specified by the currency field.
|
|
3405
|
+
*/
|
|
3406
|
+
total: number;
|
|
3407
|
+
}
|
|
3408
|
+
|
|
3409
|
+
/**
|
|
3410
|
+
* A resolution event is a message or action within a resolution case, such as a
|
|
3411
|
+
* response, escalation, or status change.
|
|
3412
|
+
*/
|
|
3413
|
+
export interface ResolutionEvent {
|
|
3414
|
+
/**
|
|
3415
|
+
* The unique identifier for the resolution event.
|
|
3416
|
+
*/
|
|
3417
|
+
id: string;
|
|
3418
|
+
|
|
3419
|
+
/**
|
|
3420
|
+
* The type of action recorded in this event.
|
|
3421
|
+
*/
|
|
3422
|
+
action:
|
|
3423
|
+
| 'created'
|
|
3424
|
+
| 'responded'
|
|
3425
|
+
| 'accepted'
|
|
3426
|
+
| 'denied'
|
|
3427
|
+
| 'appealed'
|
|
3428
|
+
| 'withdrew'
|
|
3429
|
+
| 'requested_more_info'
|
|
3430
|
+
| 'escalated'
|
|
3431
|
+
| 'dispute_opened'
|
|
3432
|
+
| 'dispute_customer_won'
|
|
3433
|
+
| 'dispute_merchant_won';
|
|
3434
|
+
|
|
3435
|
+
/**
|
|
3436
|
+
* The datetime the resolution event was created.
|
|
3437
|
+
*/
|
|
3438
|
+
created_at: string;
|
|
3439
|
+
|
|
3440
|
+
/**
|
|
3441
|
+
* The message body or additional context provided with this resolution event. Null
|
|
3442
|
+
* if no details were included.
|
|
3443
|
+
*/
|
|
3444
|
+
details: string | null;
|
|
3445
|
+
|
|
3446
|
+
/**
|
|
3447
|
+
* The party who performed this action.
|
|
3448
|
+
*/
|
|
3449
|
+
reporter_type: 'merchant' | 'customer' | 'platform' | 'system';
|
|
3450
|
+
}
|
|
3451
|
+
|
|
3452
|
+
/**
|
|
3453
|
+
* The customer (buyer) who filed this resolution case.
|
|
3454
|
+
*/
|
|
3455
|
+
export interface User {
|
|
3456
|
+
/**
|
|
3457
|
+
* The unique identifier for the user.
|
|
3458
|
+
*/
|
|
3459
|
+
id: string;
|
|
3460
|
+
|
|
3461
|
+
/**
|
|
3462
|
+
* The user's display name shown on their public profile.
|
|
3463
|
+
*/
|
|
3464
|
+
name: string | null;
|
|
3465
|
+
|
|
3466
|
+
/**
|
|
3467
|
+
* The user's unique username shown on their public profile.
|
|
3468
|
+
*/
|
|
3469
|
+
username: string;
|
|
3470
|
+
}
|
|
3471
|
+
}
|
|
3472
|
+
}
|
|
3473
|
+
|
|
3474
|
+
export interface ResolutionCenterCaseDecidedWebhookEvent {
|
|
3475
|
+
/**
|
|
3476
|
+
* A unique ID for every single webhook request
|
|
3477
|
+
*/
|
|
3478
|
+
id: string;
|
|
3479
|
+
|
|
3480
|
+
/**
|
|
3481
|
+
* The API version for this webhook
|
|
3482
|
+
*/
|
|
3483
|
+
api_version: 'v1';
|
|
3484
|
+
|
|
3485
|
+
/**
|
|
3486
|
+
* A resolution center case is a dispute or support case between a user and a
|
|
3487
|
+
* company, tracking the issue, status, and outcome.
|
|
3488
|
+
*/
|
|
3489
|
+
data: ResolutionCenterCaseDecidedWebhookEvent.Data;
|
|
3490
|
+
|
|
3491
|
+
/**
|
|
3492
|
+
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
3493
|
+
*/
|
|
3494
|
+
timestamp: string;
|
|
3495
|
+
|
|
3496
|
+
/**
|
|
3497
|
+
* The webhook event type
|
|
3498
|
+
*/
|
|
3499
|
+
type: 'resolution_center_case.decided';
|
|
3500
|
+
|
|
3501
|
+
/**
|
|
3502
|
+
* The company ID that this webhook event is associated with
|
|
3503
|
+
*/
|
|
3504
|
+
company_id?: string | null;
|
|
3505
|
+
}
|
|
3506
|
+
|
|
3507
|
+
export namespace ResolutionCenterCaseDecidedWebhookEvent {
|
|
3508
|
+
/**
|
|
3509
|
+
* A resolution center case is a dispute or support case between a user and a
|
|
3510
|
+
* company, tracking the issue, status, and outcome.
|
|
3511
|
+
*/
|
|
3512
|
+
export interface Data {
|
|
3513
|
+
/**
|
|
3514
|
+
* The unique identifier for the resolution.
|
|
3515
|
+
*/
|
|
3516
|
+
id: string;
|
|
3517
|
+
|
|
3518
|
+
/**
|
|
3519
|
+
* The company involved in this resolution case. Null if the company no longer
|
|
3520
|
+
* exists.
|
|
3521
|
+
*/
|
|
3522
|
+
company: Data.Company | null;
|
|
3523
|
+
|
|
3524
|
+
/**
|
|
3525
|
+
* The datetime the resolution was created.
|
|
3526
|
+
*/
|
|
3527
|
+
created_at: string;
|
|
3528
|
+
|
|
3529
|
+
/**
|
|
3530
|
+
* Whether the customer has filed an appeal after the initial resolution decision.
|
|
3531
|
+
*/
|
|
3532
|
+
customer_appealed: boolean;
|
|
3533
|
+
|
|
3534
|
+
/**
|
|
3535
|
+
* The list of actions currently available to the customer.
|
|
3536
|
+
*/
|
|
3537
|
+
customer_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCaseCustomerResponse>;
|
|
3538
|
+
|
|
3539
|
+
/**
|
|
3540
|
+
* The deadline by which the next response is required. Null if no deadline is
|
|
3541
|
+
* currently active. As a Unix timestamp.
|
|
3542
|
+
*/
|
|
3543
|
+
due_date: string | null;
|
|
3544
|
+
|
|
3545
|
+
/**
|
|
3546
|
+
* The category of the dispute.
|
|
3547
|
+
*/
|
|
3548
|
+
issue: ResolutionCenterCasesAPI.ResolutionCenterCaseIssueType;
|
|
3549
|
+
|
|
3550
|
+
/**
|
|
3551
|
+
* The membership record associated with the disputed payment. Null if the
|
|
3552
|
+
* membership no longer exists.
|
|
3553
|
+
*/
|
|
3554
|
+
member: Data.Member | null;
|
|
3555
|
+
|
|
3556
|
+
/**
|
|
3557
|
+
* Whether the merchant has filed an appeal after the initial resolution decision.
|
|
3558
|
+
*/
|
|
3559
|
+
merchant_appealed: boolean;
|
|
3560
|
+
|
|
3561
|
+
/**
|
|
3562
|
+
* The list of actions currently available to the merchant.
|
|
3563
|
+
*/
|
|
3564
|
+
merchant_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCaseMerchantResponse>;
|
|
3565
|
+
|
|
3566
|
+
/**
|
|
3567
|
+
* The payment record that is the subject of this resolution case.
|
|
3568
|
+
*/
|
|
3569
|
+
payment: Data.Payment;
|
|
3570
|
+
|
|
3571
|
+
/**
|
|
3572
|
+
* The list of actions currently available to the Whop platform for moderating this
|
|
3573
|
+
* resolution.
|
|
3574
|
+
*/
|
|
3575
|
+
platform_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCasePlatformResponse>;
|
|
3576
|
+
|
|
3577
|
+
/**
|
|
3578
|
+
* The most recent 50 messages, actions, and status changes that have occurred
|
|
3579
|
+
* during this resolution case.
|
|
3580
|
+
*/
|
|
3581
|
+
resolution_events: Array<Data.ResolutionEvent>;
|
|
3582
|
+
|
|
3583
|
+
/**
|
|
3584
|
+
* The current status of the resolution case, indicating which party needs to
|
|
3585
|
+
* respond or if the case is closed.
|
|
3586
|
+
*/
|
|
3587
|
+
status: ResolutionCenterCasesAPI.ResolutionCenterCaseStatus;
|
|
3588
|
+
|
|
3589
|
+
/**
|
|
3590
|
+
* The datetime the resolution was last updated.
|
|
3591
|
+
*/
|
|
3592
|
+
updated_at: string;
|
|
3593
|
+
|
|
3594
|
+
/**
|
|
3595
|
+
* The customer (buyer) who filed this resolution case.
|
|
3596
|
+
*/
|
|
3597
|
+
user: Data.User;
|
|
3598
|
+
}
|
|
3599
|
+
|
|
3600
|
+
export namespace Data {
|
|
3601
|
+
/**
|
|
3602
|
+
* The company involved in this resolution case. Null if the company no longer
|
|
3603
|
+
* exists.
|
|
3604
|
+
*/
|
|
3605
|
+
export interface Company {
|
|
3606
|
+
/**
|
|
3607
|
+
* The unique identifier for the company.
|
|
3608
|
+
*/
|
|
3609
|
+
id: string;
|
|
3610
|
+
|
|
3611
|
+
/**
|
|
3612
|
+
* The display name of the company shown to customers.
|
|
3613
|
+
*/
|
|
3614
|
+
title: string;
|
|
3615
|
+
}
|
|
3616
|
+
|
|
3617
|
+
/**
|
|
3618
|
+
* The membership record associated with the disputed payment. Null if the
|
|
3619
|
+
* membership no longer exists.
|
|
3620
|
+
*/
|
|
3621
|
+
export interface Member {
|
|
3622
|
+
/**
|
|
3623
|
+
* The unique identifier for the extra public member.
|
|
3624
|
+
*/
|
|
3625
|
+
id: string;
|
|
3626
|
+
}
|
|
3627
|
+
|
|
3628
|
+
/**
|
|
3629
|
+
* The payment record that is the subject of this resolution case.
|
|
3630
|
+
*/
|
|
3631
|
+
export interface Payment {
|
|
3632
|
+
/**
|
|
3633
|
+
* The unique identifier for the payment.
|
|
3634
|
+
*/
|
|
3635
|
+
id: string;
|
|
3636
|
+
|
|
3637
|
+
/**
|
|
3638
|
+
* The datetime the payment was created.
|
|
3639
|
+
*/
|
|
3640
|
+
created_at: string;
|
|
3641
|
+
|
|
3642
|
+
/**
|
|
3643
|
+
* The available currencies on the platform
|
|
3644
|
+
*/
|
|
3645
|
+
currency: Shared.Currency | null;
|
|
3646
|
+
|
|
3647
|
+
/**
|
|
3648
|
+
* The time at which this payment was successfully collected. Null if the payment
|
|
3649
|
+
* has not yet succeeded. As a Unix timestamp.
|
|
3650
|
+
*/
|
|
3651
|
+
paid_at: string | null;
|
|
3652
|
+
|
|
3653
|
+
/**
|
|
3654
|
+
* The payment amount before taxes and discounts are applied. In the currency
|
|
3655
|
+
* specified by the currency field.
|
|
3656
|
+
*/
|
|
3657
|
+
subtotal: number | null;
|
|
3658
|
+
|
|
3659
|
+
/**
|
|
3660
|
+
* The total amount charged to the customer for this payment, including taxes and
|
|
3661
|
+
* after any discounts. In the currency specified by the currency field.
|
|
3662
|
+
*/
|
|
3663
|
+
total: number;
|
|
3664
|
+
}
|
|
3665
|
+
|
|
3666
|
+
/**
|
|
3667
|
+
* A resolution event is a message or action within a resolution case, such as a
|
|
3668
|
+
* response, escalation, or status change.
|
|
3669
|
+
*/
|
|
3670
|
+
export interface ResolutionEvent {
|
|
3671
|
+
/**
|
|
3672
|
+
* The unique identifier for the resolution event.
|
|
3673
|
+
*/
|
|
3674
|
+
id: string;
|
|
3675
|
+
|
|
3676
|
+
/**
|
|
3677
|
+
* The type of action recorded in this event.
|
|
3678
|
+
*/
|
|
3679
|
+
action:
|
|
3680
|
+
| 'created'
|
|
3681
|
+
| 'responded'
|
|
3682
|
+
| 'accepted'
|
|
3683
|
+
| 'denied'
|
|
3684
|
+
| 'appealed'
|
|
3685
|
+
| 'withdrew'
|
|
3686
|
+
| 'requested_more_info'
|
|
3687
|
+
| 'escalated'
|
|
3688
|
+
| 'dispute_opened'
|
|
3689
|
+
| 'dispute_customer_won'
|
|
3690
|
+
| 'dispute_merchant_won';
|
|
3691
|
+
|
|
3692
|
+
/**
|
|
3693
|
+
* The datetime the resolution event was created.
|
|
3694
|
+
*/
|
|
3695
|
+
created_at: string;
|
|
3696
|
+
|
|
3697
|
+
/**
|
|
3698
|
+
* The message body or additional context provided with this resolution event. Null
|
|
3699
|
+
* if no details were included.
|
|
3700
|
+
*/
|
|
3701
|
+
details: string | null;
|
|
3702
|
+
|
|
3703
|
+
/**
|
|
3704
|
+
* The party who performed this action.
|
|
3705
|
+
*/
|
|
3706
|
+
reporter_type: 'merchant' | 'customer' | 'platform' | 'system';
|
|
3707
|
+
}
|
|
3708
|
+
|
|
3709
|
+
/**
|
|
3710
|
+
* The customer (buyer) who filed this resolution case.
|
|
3711
|
+
*/
|
|
3712
|
+
export interface User {
|
|
3713
|
+
/**
|
|
3714
|
+
* The unique identifier for the user.
|
|
3715
|
+
*/
|
|
3716
|
+
id: string;
|
|
3717
|
+
|
|
3718
|
+
/**
|
|
3719
|
+
* The user's display name shown on their public profile.
|
|
3720
|
+
*/
|
|
3721
|
+
name: string | null;
|
|
3722
|
+
|
|
3723
|
+
/**
|
|
3724
|
+
* The user's unique username shown on their public profile.
|
|
3725
|
+
*/
|
|
3726
|
+
username: string;
|
|
3727
|
+
}
|
|
3728
|
+
}
|
|
3729
|
+
}
|
|
3730
|
+
|
|
3731
|
+
export interface ResolutionCenterCaseUpdatedWebhookEvent {
|
|
3732
|
+
/**
|
|
3733
|
+
* A unique ID for every single webhook request
|
|
3734
|
+
*/
|
|
3735
|
+
id: string;
|
|
3736
|
+
|
|
3737
|
+
/**
|
|
3738
|
+
* The API version for this webhook
|
|
3739
|
+
*/
|
|
3740
|
+
api_version: 'v1';
|
|
3741
|
+
|
|
3742
|
+
/**
|
|
3743
|
+
* A resolution center case is a dispute or support case between a user and a
|
|
3744
|
+
* company, tracking the issue, status, and outcome.
|
|
3745
|
+
*/
|
|
3746
|
+
data: ResolutionCenterCaseUpdatedWebhookEvent.Data;
|
|
3747
|
+
|
|
3748
|
+
/**
|
|
3749
|
+
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
3750
|
+
*/
|
|
3751
|
+
timestamp: string;
|
|
3752
|
+
|
|
3753
|
+
/**
|
|
3754
|
+
* The webhook event type
|
|
3755
|
+
*/
|
|
3756
|
+
type: 'resolution_center_case.updated';
|
|
3757
|
+
|
|
3758
|
+
/**
|
|
3759
|
+
* The company ID that this webhook event is associated with
|
|
3760
|
+
*/
|
|
3761
|
+
company_id?: string | null;
|
|
3762
|
+
}
|
|
3763
|
+
|
|
3764
|
+
export namespace ResolutionCenterCaseUpdatedWebhookEvent {
|
|
3765
|
+
/**
|
|
3766
|
+
* A resolution center case is a dispute or support case between a user and a
|
|
3767
|
+
* company, tracking the issue, status, and outcome.
|
|
3768
|
+
*/
|
|
3769
|
+
export interface Data {
|
|
3770
|
+
/**
|
|
3771
|
+
* The unique identifier for the resolution.
|
|
3772
|
+
*/
|
|
3773
|
+
id: string;
|
|
3774
|
+
|
|
3775
|
+
/**
|
|
3776
|
+
* The company involved in this resolution case. Null if the company no longer
|
|
3777
|
+
* exists.
|
|
3778
|
+
*/
|
|
3779
|
+
company: Data.Company | null;
|
|
3780
|
+
|
|
3781
|
+
/**
|
|
3782
|
+
* The datetime the resolution was created.
|
|
3783
|
+
*/
|
|
3784
|
+
created_at: string;
|
|
3785
|
+
|
|
3786
|
+
/**
|
|
3787
|
+
* Whether the customer has filed an appeal after the initial resolution decision.
|
|
3788
|
+
*/
|
|
3789
|
+
customer_appealed: boolean;
|
|
3790
|
+
|
|
3791
|
+
/**
|
|
3792
|
+
* The list of actions currently available to the customer.
|
|
3793
|
+
*/
|
|
3794
|
+
customer_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCaseCustomerResponse>;
|
|
3795
|
+
|
|
3796
|
+
/**
|
|
3797
|
+
* The deadline by which the next response is required. Null if no deadline is
|
|
3798
|
+
* currently active. As a Unix timestamp.
|
|
3799
|
+
*/
|
|
3800
|
+
due_date: string | null;
|
|
3801
|
+
|
|
3802
|
+
/**
|
|
3803
|
+
* The category of the dispute.
|
|
3804
|
+
*/
|
|
3805
|
+
issue: ResolutionCenterCasesAPI.ResolutionCenterCaseIssueType;
|
|
3806
|
+
|
|
3807
|
+
/**
|
|
3808
|
+
* The membership record associated with the disputed payment. Null if the
|
|
3809
|
+
* membership no longer exists.
|
|
3810
|
+
*/
|
|
3811
|
+
member: Data.Member | null;
|
|
3812
|
+
|
|
3813
|
+
/**
|
|
3814
|
+
* Whether the merchant has filed an appeal after the initial resolution decision.
|
|
3815
|
+
*/
|
|
3816
|
+
merchant_appealed: boolean;
|
|
3817
|
+
|
|
3818
|
+
/**
|
|
3819
|
+
* The list of actions currently available to the merchant.
|
|
3820
|
+
*/
|
|
3821
|
+
merchant_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCaseMerchantResponse>;
|
|
3822
|
+
|
|
3823
|
+
/**
|
|
3824
|
+
* The payment record that is the subject of this resolution case.
|
|
3825
|
+
*/
|
|
3826
|
+
payment: Data.Payment;
|
|
3827
|
+
|
|
3828
|
+
/**
|
|
3829
|
+
* The list of actions currently available to the Whop platform for moderating this
|
|
3830
|
+
* resolution.
|
|
3831
|
+
*/
|
|
3832
|
+
platform_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCasePlatformResponse>;
|
|
3833
|
+
|
|
3834
|
+
/**
|
|
3835
|
+
* The most recent 50 messages, actions, and status changes that have occurred
|
|
3836
|
+
* during this resolution case.
|
|
3837
|
+
*/
|
|
3838
|
+
resolution_events: Array<Data.ResolutionEvent>;
|
|
3839
|
+
|
|
3840
|
+
/**
|
|
3841
|
+
* The current status of the resolution case, indicating which party needs to
|
|
3842
|
+
* respond or if the case is closed.
|
|
3843
|
+
*/
|
|
3844
|
+
status: ResolutionCenterCasesAPI.ResolutionCenterCaseStatus;
|
|
3845
|
+
|
|
3846
|
+
/**
|
|
3847
|
+
* The datetime the resolution was last updated.
|
|
3848
|
+
*/
|
|
3849
|
+
updated_at: string;
|
|
3850
|
+
|
|
3851
|
+
/**
|
|
3852
|
+
* The customer (buyer) who filed this resolution case.
|
|
3853
|
+
*/
|
|
3854
|
+
user: Data.User;
|
|
3855
|
+
}
|
|
3856
|
+
|
|
3857
|
+
export namespace Data {
|
|
3858
|
+
/**
|
|
3859
|
+
* The company involved in this resolution case. Null if the company no longer
|
|
3860
|
+
* exists.
|
|
3861
|
+
*/
|
|
3862
|
+
export interface Company {
|
|
3863
|
+
/**
|
|
3864
|
+
* The unique identifier for the company.
|
|
3865
|
+
*/
|
|
3866
|
+
id: string;
|
|
3867
|
+
|
|
3868
|
+
/**
|
|
3869
|
+
* The display name of the company shown to customers.
|
|
3870
|
+
*/
|
|
3871
|
+
title: string;
|
|
3872
|
+
}
|
|
3873
|
+
|
|
3874
|
+
/**
|
|
3875
|
+
* The membership record associated with the disputed payment. Null if the
|
|
3876
|
+
* membership no longer exists.
|
|
3877
|
+
*/
|
|
3878
|
+
export interface Member {
|
|
3879
|
+
/**
|
|
3880
|
+
* The unique identifier for the extra public member.
|
|
3881
|
+
*/
|
|
3882
|
+
id: string;
|
|
3883
|
+
}
|
|
3884
|
+
|
|
3885
|
+
/**
|
|
3886
|
+
* The payment record that is the subject of this resolution case.
|
|
3887
|
+
*/
|
|
3888
|
+
export interface Payment {
|
|
3889
|
+
/**
|
|
3890
|
+
* The unique identifier for the payment.
|
|
3891
|
+
*/
|
|
3892
|
+
id: string;
|
|
3893
|
+
|
|
3894
|
+
/**
|
|
3895
|
+
* The datetime the payment was created.
|
|
3896
|
+
*/
|
|
3897
|
+
created_at: string;
|
|
3898
|
+
|
|
3899
|
+
/**
|
|
3900
|
+
* The available currencies on the platform
|
|
3901
|
+
*/
|
|
3902
|
+
currency: Shared.Currency | null;
|
|
3903
|
+
|
|
3904
|
+
/**
|
|
3905
|
+
* The time at which this payment was successfully collected. Null if the payment
|
|
3906
|
+
* has not yet succeeded. As a Unix timestamp.
|
|
3907
|
+
*/
|
|
3908
|
+
paid_at: string | null;
|
|
3909
|
+
|
|
3910
|
+
/**
|
|
3911
|
+
* The payment amount before taxes and discounts are applied. In the currency
|
|
3912
|
+
* specified by the currency field.
|
|
3913
|
+
*/
|
|
3914
|
+
subtotal: number | null;
|
|
3915
|
+
|
|
3916
|
+
/**
|
|
3917
|
+
* The total amount charged to the customer for this payment, including taxes and
|
|
3918
|
+
* after any discounts. In the currency specified by the currency field.
|
|
3919
|
+
*/
|
|
3920
|
+
total: number;
|
|
3921
|
+
}
|
|
3922
|
+
|
|
3923
|
+
/**
|
|
3924
|
+
* A resolution event is a message or action within a resolution case, such as a
|
|
3925
|
+
* response, escalation, or status change.
|
|
3926
|
+
*/
|
|
3927
|
+
export interface ResolutionEvent {
|
|
3928
|
+
/**
|
|
3929
|
+
* The unique identifier for the resolution event.
|
|
3930
|
+
*/
|
|
3931
|
+
id: string;
|
|
3932
|
+
|
|
3933
|
+
/**
|
|
3934
|
+
* The type of action recorded in this event.
|
|
3935
|
+
*/
|
|
3936
|
+
action:
|
|
3937
|
+
| 'created'
|
|
3938
|
+
| 'responded'
|
|
3939
|
+
| 'accepted'
|
|
3940
|
+
| 'denied'
|
|
3941
|
+
| 'appealed'
|
|
3942
|
+
| 'withdrew'
|
|
3943
|
+
| 'requested_more_info'
|
|
3944
|
+
| 'escalated'
|
|
3945
|
+
| 'dispute_opened'
|
|
3946
|
+
| 'dispute_customer_won'
|
|
3947
|
+
| 'dispute_merchant_won';
|
|
3948
|
+
|
|
3949
|
+
/**
|
|
3950
|
+
* The datetime the resolution event was created.
|
|
3951
|
+
*/
|
|
3952
|
+
created_at: string;
|
|
3953
|
+
|
|
3954
|
+
/**
|
|
3955
|
+
* The message body or additional context provided with this resolution event. Null
|
|
3956
|
+
* if no details were included.
|
|
3957
|
+
*/
|
|
3958
|
+
details: string | null;
|
|
3959
|
+
|
|
3960
|
+
/**
|
|
3961
|
+
* The party who performed this action.
|
|
3962
|
+
*/
|
|
3963
|
+
reporter_type: 'merchant' | 'customer' | 'platform' | 'system';
|
|
3964
|
+
}
|
|
3965
|
+
|
|
3966
|
+
/**
|
|
3967
|
+
* The customer (buyer) who filed this resolution case.
|
|
3968
|
+
*/
|
|
3969
|
+
export interface User {
|
|
3970
|
+
/**
|
|
3971
|
+
* The unique identifier for the user.
|
|
3972
|
+
*/
|
|
3973
|
+
id: string;
|
|
3974
|
+
|
|
3975
|
+
/**
|
|
3976
|
+
* The user's display name shown on their public profile.
|
|
3977
|
+
*/
|
|
3978
|
+
name: string | null;
|
|
3979
|
+
|
|
3980
|
+
/**
|
|
3981
|
+
* The user's unique username shown on their public profile.
|
|
3982
|
+
*/
|
|
3983
|
+
username: string;
|
|
3984
|
+
}
|
|
3985
|
+
}
|
|
3986
|
+
}
|
|
3987
|
+
|
|
3988
|
+
export interface SetupIntentCanceledWebhookEvent {
|
|
3989
|
+
/**
|
|
3990
|
+
* A unique ID for every single webhook request
|
|
3991
|
+
*/
|
|
3992
|
+
id: string;
|
|
3993
|
+
|
|
3994
|
+
/**
|
|
3995
|
+
* The API version for this webhook
|
|
3996
|
+
*/
|
|
3997
|
+
api_version: 'v1';
|
|
3998
|
+
|
|
3999
|
+
/**
|
|
4000
|
+
* A setup intent allows a user to save a payment method for future use without
|
|
4001
|
+
* making an immediate purchase.
|
|
4002
|
+
*/
|
|
4003
|
+
data: SetupIntentsAPI.SetupIntent;
|
|
4004
|
+
|
|
4005
|
+
/**
|
|
4006
|
+
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
4007
|
+
*/
|
|
4008
|
+
timestamp: string;
|
|
4009
|
+
|
|
4010
|
+
/**
|
|
4011
|
+
* The webhook event type
|
|
4012
|
+
*/
|
|
4013
|
+
type: 'setup_intent.canceled';
|
|
4014
|
+
|
|
4015
|
+
/**
|
|
4016
|
+
* The company ID that this webhook event is associated with
|
|
4017
|
+
*/
|
|
4018
|
+
company_id?: string | null;
|
|
4019
|
+
}
|
|
4020
|
+
|
|
4021
|
+
export interface SetupIntentRequiresActionWebhookEvent {
|
|
4022
|
+
/**
|
|
4023
|
+
* A unique ID for every single webhook request
|
|
4024
|
+
*/
|
|
4025
|
+
id: string;
|
|
4026
|
+
|
|
4027
|
+
/**
|
|
4028
|
+
* The API version for this webhook
|
|
4029
|
+
*/
|
|
4030
|
+
api_version: 'v1';
|
|
4031
|
+
|
|
4032
|
+
/**
|
|
4033
|
+
* A setup intent allows a user to save a payment method for future use without
|
|
4034
|
+
* making an immediate purchase.
|
|
4035
|
+
*/
|
|
4036
|
+
data: SetupIntentsAPI.SetupIntent;
|
|
4037
|
+
|
|
4038
|
+
/**
|
|
4039
|
+
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
4040
|
+
*/
|
|
4041
|
+
timestamp: string;
|
|
4042
|
+
|
|
4043
|
+
/**
|
|
4044
|
+
* The webhook event type
|
|
4045
|
+
*/
|
|
4046
|
+
type: 'setup_intent.requires_action';
|
|
4047
|
+
|
|
4048
|
+
/**
|
|
4049
|
+
* The company ID that this webhook event is associated with
|
|
4050
|
+
*/
|
|
4051
|
+
company_id?: string | null;
|
|
4052
|
+
}
|
|
4053
|
+
|
|
4054
|
+
export interface SetupIntentSucceededWebhookEvent {
|
|
4055
|
+
/**
|
|
4056
|
+
* A unique ID for every single webhook request
|
|
4057
|
+
*/
|
|
4058
|
+
id: string;
|
|
4059
|
+
|
|
4060
|
+
/**
|
|
4061
|
+
* The API version for this webhook
|
|
4062
|
+
*/
|
|
4063
|
+
api_version: 'v1';
|
|
4064
|
+
|
|
4065
|
+
/**
|
|
4066
|
+
* A setup intent allows a user to save a payment method for future use without
|
|
4067
|
+
* making an immediate purchase.
|
|
4068
|
+
*/
|
|
4069
|
+
data: SetupIntentsAPI.SetupIntent;
|
|
4070
|
+
|
|
4071
|
+
/**
|
|
4072
|
+
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
4073
|
+
*/
|
|
4074
|
+
timestamp: string;
|
|
4075
|
+
|
|
4076
|
+
/**
|
|
4077
|
+
* The webhook event type
|
|
4078
|
+
*/
|
|
4079
|
+
type: 'setup_intent.succeeded';
|
|
4080
|
+
|
|
4081
|
+
/**
|
|
4082
|
+
* The company ID that this webhook event is associated with
|
|
4083
|
+
*/
|
|
4084
|
+
company_id?: string | null;
|
|
4085
|
+
}
|
|
4086
|
+
|
|
4087
|
+
export interface VerificationSucceededWebhookEvent {
|
|
4088
|
+
/**
|
|
4089
|
+
* A unique ID for every single webhook request
|
|
4090
|
+
*/
|
|
4091
|
+
id: string;
|
|
4092
|
+
|
|
4093
|
+
/**
|
|
4094
|
+
* The API version for this webhook
|
|
4095
|
+
*/
|
|
4096
|
+
api_version: 'v1';
|
|
4097
|
+
|
|
4098
|
+
/**
|
|
4099
|
+
* An identity verification session used to confirm a person or entity's identity
|
|
4100
|
+
* for payout account eligibility.
|
|
4101
|
+
*/
|
|
4102
|
+
data: VerificationSucceededWebhookEvent.Data;
|
|
4103
|
+
|
|
4104
|
+
/**
|
|
4105
|
+
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
4106
|
+
*/
|
|
4107
|
+
timestamp: string;
|
|
4108
|
+
|
|
4109
|
+
/**
|
|
4110
|
+
* The webhook event type
|
|
4111
|
+
*/
|
|
4112
|
+
type: 'verification.succeeded';
|
|
4113
|
+
|
|
4114
|
+
/**
|
|
4115
|
+
* The company ID that this webhook event is associated with
|
|
4116
|
+
*/
|
|
4117
|
+
company_id?: string | null;
|
|
4118
|
+
}
|
|
2946
4119
|
|
|
2947
|
-
|
|
2948
|
-
|
|
2949
|
-
|
|
2950
|
-
|
|
4120
|
+
export namespace VerificationSucceededWebhookEvent {
|
|
4121
|
+
/**
|
|
4122
|
+
* An identity verification session used to confirm a person or entity's identity
|
|
4123
|
+
* for payout account eligibility.
|
|
4124
|
+
*/
|
|
4125
|
+
export interface Data {
|
|
4126
|
+
/**
|
|
4127
|
+
* The numeric id of the verification record.
|
|
4128
|
+
*/
|
|
4129
|
+
id: string;
|
|
2951
4130
|
|
|
2952
|
-
|
|
2953
|
-
|
|
2954
|
-
|
|
2955
|
-
|
|
2956
|
-
}
|
|
4131
|
+
/**
|
|
4132
|
+
* An error code for a verification attempt.
|
|
4133
|
+
*/
|
|
4134
|
+
last_error_code: VerificationsAPI.VerificationErrorCode | null;
|
|
2957
4135
|
|
|
2958
|
-
|
|
2959
|
-
|
|
2960
|
-
|
|
2961
|
-
|
|
2962
|
-
|
|
2963
|
-
/**
|
|
2964
|
-
* The unique identifier for the company member.
|
|
2965
|
-
*/
|
|
2966
|
-
id: string;
|
|
4136
|
+
/**
|
|
4137
|
+
* A human-readable explanation of the most recent verification error. Null if no
|
|
4138
|
+
* error has occurred.
|
|
4139
|
+
*/
|
|
4140
|
+
last_error_reason: string | null;
|
|
2967
4141
|
|
|
2968
|
-
|
|
2969
|
-
|
|
2970
|
-
|
|
2971
|
-
|
|
2972
|
-
|
|
4142
|
+
/**
|
|
4143
|
+
* The current status of this verification session.
|
|
4144
|
+
*/
|
|
4145
|
+
status: VerificationsAPI.VerificationStatus;
|
|
4146
|
+
}
|
|
4147
|
+
}
|
|
2973
4148
|
|
|
2974
|
-
|
|
2975
|
-
|
|
2976
|
-
|
|
2977
|
-
|
|
2978
|
-
|
|
2979
|
-
* The unique identifier for the membership.
|
|
2980
|
-
*/
|
|
2981
|
-
id: string;
|
|
4149
|
+
export interface WithdrawalCreatedWebhookEvent {
|
|
4150
|
+
/**
|
|
4151
|
+
* A unique ID for every single webhook request
|
|
4152
|
+
*/
|
|
4153
|
+
id: string;
|
|
2982
4154
|
|
|
2983
|
-
|
|
2984
|
-
|
|
2985
|
-
|
|
2986
|
-
|
|
2987
|
-
}
|
|
4155
|
+
/**
|
|
4156
|
+
* The API version for this webhook
|
|
4157
|
+
*/
|
|
4158
|
+
api_version: 'v1';
|
|
2988
4159
|
|
|
2989
|
-
|
|
2990
|
-
|
|
2991
|
-
|
|
2992
|
-
|
|
2993
|
-
|
|
2994
|
-
* The unique identifier for the user.
|
|
2995
|
-
*/
|
|
2996
|
-
id: string;
|
|
4160
|
+
/**
|
|
4161
|
+
* A withdrawal represents a request to transfer funds from a ledger account to an
|
|
4162
|
+
* external payout method.
|
|
4163
|
+
*/
|
|
4164
|
+
data: WithdrawalsAPI.Withdrawal;
|
|
2997
4165
|
|
|
2998
|
-
|
|
2999
|
-
|
|
3000
|
-
|
|
3001
|
-
|
|
3002
|
-
email: string | null;
|
|
4166
|
+
/**
|
|
4167
|
+
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
4168
|
+
*/
|
|
4169
|
+
timestamp: string;
|
|
3003
4170
|
|
|
3004
|
-
|
|
3005
|
-
|
|
3006
|
-
|
|
3007
|
-
|
|
4171
|
+
/**
|
|
4172
|
+
* The webhook event type
|
|
4173
|
+
*/
|
|
4174
|
+
type: 'withdrawal.created';
|
|
3008
4175
|
|
|
3009
|
-
|
|
3010
|
-
|
|
3011
|
-
|
|
3012
|
-
|
|
3013
|
-
}
|
|
3014
|
-
}
|
|
3015
|
-
}
|
|
4176
|
+
/**
|
|
4177
|
+
* The company ID that this webhook event is associated with
|
|
4178
|
+
*/
|
|
4179
|
+
company_id?: string | null;
|
|
3016
4180
|
}
|
|
3017
4181
|
|
|
3018
|
-
export interface
|
|
4182
|
+
export interface WithdrawalUpdatedWebhookEvent {
|
|
3019
4183
|
/**
|
|
3020
4184
|
* A unique ID for every single webhook request
|
|
3021
4185
|
*/
|
|
@@ -3027,10 +4191,10 @@ export interface MembershipCancelAtPeriodEndChangedWebhookEvent {
|
|
|
3027
4191
|
api_version: 'v1';
|
|
3028
4192
|
|
|
3029
4193
|
/**
|
|
3030
|
-
* A
|
|
3031
|
-
*
|
|
4194
|
+
* A withdrawal represents a request to transfer funds from a ledger account to an
|
|
4195
|
+
* external payout method.
|
|
3032
4196
|
*/
|
|
3033
|
-
data:
|
|
4197
|
+
data: WithdrawalsAPI.Withdrawal;
|
|
3034
4198
|
|
|
3035
4199
|
/**
|
|
3036
4200
|
* The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
@@ -3040,7 +4204,7 @@ export interface MembershipCancelAtPeriodEndChangedWebhookEvent {
|
|
|
3040
4204
|
/**
|
|
3041
4205
|
* The webhook event type
|
|
3042
4206
|
*/
|
|
3043
|
-
type: '
|
|
4207
|
+
type: 'withdrawal.updated';
|
|
3044
4208
|
|
|
3045
4209
|
/**
|
|
3046
4210
|
* The company ID that this webhook event is associated with
|
|
@@ -3049,39 +4213,65 @@ export interface MembershipCancelAtPeriodEndChangedWebhookEvent {
|
|
|
3049
4213
|
}
|
|
3050
4214
|
|
|
3051
4215
|
export type UnwrapWebhookEvent =
|
|
4216
|
+
| CourseLessonInteractionCompletedWebhookEvent
|
|
4217
|
+
| DisputeCreatedWebhookEvent
|
|
4218
|
+
| DisputeUpdatedWebhookEvent
|
|
4219
|
+
| DisputeAlertCreatedWebhookEvent
|
|
4220
|
+
| EntryApprovedWebhookEvent
|
|
4221
|
+
| EntryCreatedWebhookEvent
|
|
4222
|
+
| EntryDeletedWebhookEvent
|
|
4223
|
+
| EntryDeniedWebhookEvent
|
|
4224
|
+
| IdentityProfileApprovedWebhookEvent
|
|
4225
|
+
| IdentityProfileNeedsActionWebhookEvent
|
|
4226
|
+
| IdentityProfileRejectedWebhookEvent
|
|
4227
|
+
| IdentityProfileUpdatedWebhookEvent
|
|
3052
4228
|
| InvoiceCreatedWebhookEvent
|
|
3053
4229
|
| InvoiceMarkedUncollectibleWebhookEvent
|
|
3054
4230
|
| InvoicePaidWebhookEvent
|
|
3055
4231
|
| InvoicePastDueWebhookEvent
|
|
3056
4232
|
| InvoiceVoidedWebhookEvent
|
|
3057
4233
|
| MembershipActivatedWebhookEvent
|
|
4234
|
+
| MembershipCancelAtPeriodEndChangedWebhookEvent
|
|
3058
4235
|
| MembershipDeactivatedWebhookEvent
|
|
3059
|
-
| EntryCreatedWebhookEvent
|
|
3060
|
-
| EntryApprovedWebhookEvent
|
|
3061
|
-
| EntryDeniedWebhookEvent
|
|
3062
|
-
| EntryDeletedWebhookEvent
|
|
3063
|
-
| SetupIntentRequiresActionWebhookEvent
|
|
3064
|
-
| SetupIntentSucceededWebhookEvent
|
|
3065
|
-
| SetupIntentCanceledWebhookEvent
|
|
3066
|
-
| WithdrawalCreatedWebhookEvent
|
|
3067
|
-
| WithdrawalUpdatedWebhookEvent
|
|
3068
|
-
| CourseLessonInteractionCompletedWebhookEvent
|
|
3069
|
-
| PayoutMethodCreatedWebhookEvent
|
|
3070
|
-
| VerificationSucceededWebhookEvent
|
|
3071
|
-
| PayoutAccountStatusUpdatedWebhookEvent
|
|
3072
|
-
| ResolutionCenterCaseCreatedWebhookEvent
|
|
3073
|
-
| ResolutionCenterCaseUpdatedWebhookEvent
|
|
3074
|
-
| ResolutionCenterCaseDecidedWebhookEvent
|
|
3075
4236
|
| PaymentCreatedWebhookEvent
|
|
3076
|
-
| PaymentSucceededWebhookEvent
|
|
3077
4237
|
| PaymentFailedWebhookEvent
|
|
3078
4238
|
| PaymentPendingWebhookEvent
|
|
3079
|
-
|
|
|
3080
|
-
|
|
|
4239
|
+
| PaymentSucceededWebhookEvent
|
|
4240
|
+
| PayoutAccountStatusUpdatedWebhookEvent
|
|
4241
|
+
| PayoutMethodCreatedWebhookEvent
|
|
3081
4242
|
| RefundCreatedWebhookEvent
|
|
3082
4243
|
| RefundUpdatedWebhookEvent
|
|
3083
|
-
|
|
|
3084
|
-
|
|
|
4244
|
+
| ResolutionCenterCaseCreatedWebhookEvent
|
|
4245
|
+
| ResolutionCenterCaseDecidedWebhookEvent
|
|
4246
|
+
| ResolutionCenterCaseUpdatedWebhookEvent
|
|
4247
|
+
| SetupIntentCanceledWebhookEvent
|
|
4248
|
+
| SetupIntentRequiresActionWebhookEvent
|
|
4249
|
+
| SetupIntentSucceededWebhookEvent
|
|
4250
|
+
| VerificationSucceededWebhookEvent
|
|
4251
|
+
| WithdrawalCreatedWebhookEvent
|
|
4252
|
+
| WithdrawalUpdatedWebhookEvent;
|
|
4253
|
+
|
|
4254
|
+
export interface WebhookListParams extends CursorPageParams {
|
|
4255
|
+
/**
|
|
4256
|
+
* The unique identifier of the company to list webhooks for.
|
|
4257
|
+
*/
|
|
4258
|
+
company_id: string;
|
|
4259
|
+
|
|
4260
|
+
/**
|
|
4261
|
+
* Returns the elements in the list that come before the specified cursor.
|
|
4262
|
+
*/
|
|
4263
|
+
before?: string | null;
|
|
4264
|
+
|
|
4265
|
+
/**
|
|
4266
|
+
* Returns the first _n_ elements from the list.
|
|
4267
|
+
*/
|
|
4268
|
+
first?: number | null;
|
|
4269
|
+
|
|
4270
|
+
/**
|
|
4271
|
+
* Returns the last _n_ elements from the list.
|
|
4272
|
+
*/
|
|
4273
|
+
last?: number | null;
|
|
4274
|
+
}
|
|
3085
4275
|
|
|
3086
4276
|
export interface WebhookCreateParams {
|
|
3087
4277
|
/**
|
|
@@ -3144,28 +4334,6 @@ export interface WebhookUpdateParams {
|
|
|
3144
4334
|
url?: string | null;
|
|
3145
4335
|
}
|
|
3146
4336
|
|
|
3147
|
-
export interface WebhookListParams extends CursorPageParams {
|
|
3148
|
-
/**
|
|
3149
|
-
* The unique identifier of the company to list webhooks for.
|
|
3150
|
-
*/
|
|
3151
|
-
company_id: string;
|
|
3152
|
-
|
|
3153
|
-
/**
|
|
3154
|
-
* Returns the elements in the list that come before the specified cursor.
|
|
3155
|
-
*/
|
|
3156
|
-
before?: string | null;
|
|
3157
|
-
|
|
3158
|
-
/**
|
|
3159
|
-
* Returns the first _n_ elements from the list.
|
|
3160
|
-
*/
|
|
3161
|
-
first?: number | null;
|
|
3162
|
-
|
|
3163
|
-
/**
|
|
3164
|
-
* Returns the last _n_ elements from the list.
|
|
3165
|
-
*/
|
|
3166
|
-
last?: number | null;
|
|
3167
|
-
}
|
|
3168
|
-
|
|
3169
4337
|
export declare namespace Webhooks {
|
|
3170
4338
|
export {
|
|
3171
4339
|
type APIVersion as APIVersion,
|
|
@@ -3174,43 +4342,47 @@ export declare namespace Webhooks {
|
|
|
3174
4342
|
type WebhookCreateResponse as WebhookCreateResponse,
|
|
3175
4343
|
type WebhookListResponse as WebhookListResponse,
|
|
3176
4344
|
type WebhookDeleteResponse as WebhookDeleteResponse,
|
|
4345
|
+
type CourseLessonInteractionCompletedWebhookEvent as CourseLessonInteractionCompletedWebhookEvent,
|
|
4346
|
+
type DisputeCreatedWebhookEvent as DisputeCreatedWebhookEvent,
|
|
4347
|
+
type DisputeUpdatedWebhookEvent as DisputeUpdatedWebhookEvent,
|
|
4348
|
+
type DisputeAlertCreatedWebhookEvent as DisputeAlertCreatedWebhookEvent,
|
|
4349
|
+
type EntryApprovedWebhookEvent as EntryApprovedWebhookEvent,
|
|
4350
|
+
type EntryCreatedWebhookEvent as EntryCreatedWebhookEvent,
|
|
4351
|
+
type EntryDeletedWebhookEvent as EntryDeletedWebhookEvent,
|
|
4352
|
+
type EntryDeniedWebhookEvent as EntryDeniedWebhookEvent,
|
|
4353
|
+
type IdentityProfileApprovedWebhookEvent as IdentityProfileApprovedWebhookEvent,
|
|
4354
|
+
type IdentityProfileNeedsActionWebhookEvent as IdentityProfileNeedsActionWebhookEvent,
|
|
4355
|
+
type IdentityProfileRejectedWebhookEvent as IdentityProfileRejectedWebhookEvent,
|
|
4356
|
+
type IdentityProfileUpdatedWebhookEvent as IdentityProfileUpdatedWebhookEvent,
|
|
3177
4357
|
type InvoiceCreatedWebhookEvent as InvoiceCreatedWebhookEvent,
|
|
3178
4358
|
type InvoiceMarkedUncollectibleWebhookEvent as InvoiceMarkedUncollectibleWebhookEvent,
|
|
3179
4359
|
type InvoicePaidWebhookEvent as InvoicePaidWebhookEvent,
|
|
3180
4360
|
type InvoicePastDueWebhookEvent as InvoicePastDueWebhookEvent,
|
|
3181
4361
|
type InvoiceVoidedWebhookEvent as InvoiceVoidedWebhookEvent,
|
|
3182
4362
|
type MembershipActivatedWebhookEvent as MembershipActivatedWebhookEvent,
|
|
4363
|
+
type MembershipCancelAtPeriodEndChangedWebhookEvent as MembershipCancelAtPeriodEndChangedWebhookEvent,
|
|
3183
4364
|
type MembershipDeactivatedWebhookEvent as MembershipDeactivatedWebhookEvent,
|
|
3184
|
-
type EntryCreatedWebhookEvent as EntryCreatedWebhookEvent,
|
|
3185
|
-
type EntryApprovedWebhookEvent as EntryApprovedWebhookEvent,
|
|
3186
|
-
type EntryDeniedWebhookEvent as EntryDeniedWebhookEvent,
|
|
3187
|
-
type EntryDeletedWebhookEvent as EntryDeletedWebhookEvent,
|
|
3188
|
-
type SetupIntentRequiresActionWebhookEvent as SetupIntentRequiresActionWebhookEvent,
|
|
3189
|
-
type SetupIntentSucceededWebhookEvent as SetupIntentSucceededWebhookEvent,
|
|
3190
|
-
type SetupIntentCanceledWebhookEvent as SetupIntentCanceledWebhookEvent,
|
|
3191
|
-
type WithdrawalCreatedWebhookEvent as WithdrawalCreatedWebhookEvent,
|
|
3192
|
-
type WithdrawalUpdatedWebhookEvent as WithdrawalUpdatedWebhookEvent,
|
|
3193
|
-
type CourseLessonInteractionCompletedWebhookEvent as CourseLessonInteractionCompletedWebhookEvent,
|
|
3194
|
-
type PayoutMethodCreatedWebhookEvent as PayoutMethodCreatedWebhookEvent,
|
|
3195
|
-
type VerificationSucceededWebhookEvent as VerificationSucceededWebhookEvent,
|
|
3196
|
-
type PayoutAccountStatusUpdatedWebhookEvent as PayoutAccountStatusUpdatedWebhookEvent,
|
|
3197
|
-
type ResolutionCenterCaseCreatedWebhookEvent as ResolutionCenterCaseCreatedWebhookEvent,
|
|
3198
|
-
type ResolutionCenterCaseUpdatedWebhookEvent as ResolutionCenterCaseUpdatedWebhookEvent,
|
|
3199
|
-
type ResolutionCenterCaseDecidedWebhookEvent as ResolutionCenterCaseDecidedWebhookEvent,
|
|
3200
4365
|
type PaymentCreatedWebhookEvent as PaymentCreatedWebhookEvent,
|
|
3201
|
-
type PaymentSucceededWebhookEvent as PaymentSucceededWebhookEvent,
|
|
3202
4366
|
type PaymentFailedWebhookEvent as PaymentFailedWebhookEvent,
|
|
3203
4367
|
type PaymentPendingWebhookEvent as PaymentPendingWebhookEvent,
|
|
3204
|
-
type
|
|
3205
|
-
type
|
|
4368
|
+
type PaymentSucceededWebhookEvent as PaymentSucceededWebhookEvent,
|
|
4369
|
+
type PayoutAccountStatusUpdatedWebhookEvent as PayoutAccountStatusUpdatedWebhookEvent,
|
|
4370
|
+
type PayoutMethodCreatedWebhookEvent as PayoutMethodCreatedWebhookEvent,
|
|
3206
4371
|
type RefundCreatedWebhookEvent as RefundCreatedWebhookEvent,
|
|
3207
4372
|
type RefundUpdatedWebhookEvent as RefundUpdatedWebhookEvent,
|
|
3208
|
-
type
|
|
3209
|
-
type
|
|
4373
|
+
type ResolutionCenterCaseCreatedWebhookEvent as ResolutionCenterCaseCreatedWebhookEvent,
|
|
4374
|
+
type ResolutionCenterCaseDecidedWebhookEvent as ResolutionCenterCaseDecidedWebhookEvent,
|
|
4375
|
+
type ResolutionCenterCaseUpdatedWebhookEvent as ResolutionCenterCaseUpdatedWebhookEvent,
|
|
4376
|
+
type SetupIntentCanceledWebhookEvent as SetupIntentCanceledWebhookEvent,
|
|
4377
|
+
type SetupIntentRequiresActionWebhookEvent as SetupIntentRequiresActionWebhookEvent,
|
|
4378
|
+
type SetupIntentSucceededWebhookEvent as SetupIntentSucceededWebhookEvent,
|
|
4379
|
+
type VerificationSucceededWebhookEvent as VerificationSucceededWebhookEvent,
|
|
4380
|
+
type WithdrawalCreatedWebhookEvent as WithdrawalCreatedWebhookEvent,
|
|
4381
|
+
type WithdrawalUpdatedWebhookEvent as WithdrawalUpdatedWebhookEvent,
|
|
3210
4382
|
type UnwrapWebhookEvent as UnwrapWebhookEvent,
|
|
3211
4383
|
type WebhookListResponsesCursorPage as WebhookListResponsesCursorPage,
|
|
4384
|
+
type WebhookListParams as WebhookListParams,
|
|
3212
4385
|
type WebhookCreateParams as WebhookCreateParams,
|
|
3213
4386
|
type WebhookUpdateParams as WebhookUpdateParams,
|
|
3214
|
-
type WebhookListParams as WebhookListParams,
|
|
3215
4387
|
};
|
|
3216
4388
|
}
|