@whop/sdk 0.0.26 → 0.0.28
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +78 -0
- package/client.d.mts +10 -9
- package/client.d.mts.map +1 -1
- package/client.d.ts +10 -9
- package/client.d.ts.map +1 -1
- package/client.js +16 -2
- package/client.js.map +1 -1
- package/client.mjs +16 -2
- package/client.mjs.map +1 -1
- package/package.json +3 -3
- package/resources/access-tokens.d.mts +34 -54
- package/resources/access-tokens.d.mts.map +1 -1
- package/resources/access-tokens.d.ts +34 -54
- package/resources/access-tokens.d.ts.map +1 -1
- package/resources/access-tokens.js +6 -8
- package/resources/access-tokens.js.map +1 -1
- package/resources/access-tokens.mjs +6 -8
- package/resources/access-tokens.mjs.map +1 -1
- package/resources/account-links.d.mts +15 -13
- package/resources/account-links.d.mts.map +1 -1
- package/resources/account-links.d.ts +15 -13
- package/resources/account-links.d.ts.map +1 -1
- package/resources/account-links.js +2 -3
- package/resources/account-links.js.map +1 -1
- package/resources/account-links.mjs +2 -3
- package/resources/account-links.mjs.map +1 -1
- package/resources/ai-chats.d.mts +70 -30
- package/resources/ai-chats.d.mts.map +1 -1
- package/resources/ai-chats.d.ts +70 -30
- package/resources/ai-chats.d.ts.map +1 -1
- package/resources/ai-chats.js +6 -6
- package/resources/ai-chats.js.map +1 -1
- package/resources/ai-chats.mjs +6 -6
- package/resources/ai-chats.mjs.map +1 -1
- package/resources/app-builds.d.mts +37 -35
- package/resources/app-builds.d.mts.map +1 -1
- package/resources/app-builds.d.ts +37 -35
- package/resources/app-builds.d.ts.map +1 -1
- package/resources/app-builds.js +7 -4
- package/resources/app-builds.js.map +1 -1
- package/resources/app-builds.mjs +7 -4
- package/resources/app-builds.mjs.map +1 -1
- package/resources/apps.d.mts +86 -60
- package/resources/apps.d.mts.map +1 -1
- package/resources/apps.d.ts +86 -60
- package/resources/apps.d.ts.map +1 -1
- package/resources/apps.js +7 -4
- package/resources/apps.js.map +1 -1
- package/resources/apps.mjs +7 -4
- package/resources/apps.mjs.map +1 -1
- package/resources/authorized-users.d.mts +38 -32
- package/resources/authorized-users.d.mts.map +1 -1
- package/resources/authorized-users.d.ts +38 -32
- package/resources/authorized-users.d.ts.map +1 -1
- package/resources/authorized-users.js +3 -2
- package/resources/authorized-users.js.map +1 -1
- package/resources/authorized-users.mjs +3 -2
- package/resources/authorized-users.mjs.map +1 -1
- package/resources/chat-channels.d.mts +28 -20
- package/resources/chat-channels.d.mts.map +1 -1
- package/resources/chat-channels.d.ts +28 -20
- package/resources/chat-channels.d.ts.map +1 -1
- package/resources/chat-channels.js +5 -3
- package/resources/chat-channels.js.map +1 -1
- package/resources/chat-channels.mjs +5 -3
- package/resources/chat-channels.mjs.map +1 -1
- package/resources/checkout-configurations.d.mts +75 -58
- package/resources/checkout-configurations.d.mts.map +1 -1
- package/resources/checkout-configurations.d.ts +75 -58
- package/resources/checkout-configurations.d.ts.map +1 -1
- package/resources/checkout-configurations.js +3 -2
- package/resources/checkout-configurations.js.map +1 -1
- package/resources/checkout-configurations.mjs +3 -2
- package/resources/checkout-configurations.mjs.map +1 -1
- package/resources/companies.d.mts +88 -56
- package/resources/companies.d.mts.map +1 -1
- package/resources/companies.d.ts +88 -56
- package/resources/companies.d.ts.map +1 -1
- package/resources/companies.js +9 -7
- package/resources/companies.js.map +1 -1
- package/resources/companies.mjs +9 -7
- package/resources/companies.mjs.map +1 -1
- package/resources/company-token-transactions.d.mts +90 -67
- package/resources/company-token-transactions.d.mts.map +1 -1
- package/resources/company-token-transactions.d.ts +90 -67
- package/resources/company-token-transactions.d.ts.map +1 -1
- package/resources/company-token-transactions.js +6 -3
- package/resources/company-token-transactions.js.map +1 -1
- package/resources/company-token-transactions.mjs +6 -3
- package/resources/company-token-transactions.mjs.map +1 -1
- package/resources/course-chapters.d.mts +27 -22
- package/resources/course-chapters.d.mts.map +1 -1
- package/resources/course-chapters.d.ts +27 -22
- package/resources/course-chapters.d.ts.map +1 -1
- package/resources/course-chapters.js +5 -5
- package/resources/course-chapters.mjs +5 -5
- package/resources/course-lesson-interactions.d.mts +7 -6
- package/resources/course-lesson-interactions.d.mts.map +1 -1
- package/resources/course-lesson-interactions.d.ts +7 -6
- package/resources/course-lesson-interactions.d.ts.map +1 -1
- package/resources/course-lesson-interactions.js +3 -2
- package/resources/course-lesson-interactions.js.map +1 -1
- package/resources/course-lesson-interactions.mjs +3 -2
- package/resources/course-lesson-interactions.mjs.map +1 -1
- package/resources/course-lessons.d.mts +141 -99
- package/resources/course-lessons.d.mts.map +1 -1
- package/resources/course-lessons.d.ts +141 -99
- package/resources/course-lessons.d.ts.map +1 -1
- package/resources/course-lessons.js +12 -8
- package/resources/course-lessons.js.map +1 -1
- package/resources/course-lessons.mjs +12 -8
- package/resources/course-lessons.mjs.map +1 -1
- package/resources/course-students.d.mts +44 -35
- package/resources/course-students.d.mts.map +1 -1
- package/resources/course-students.d.ts +44 -35
- package/resources/course-students.d.ts.map +1 -1
- package/resources/course-students.js +3 -2
- package/resources/course-students.js.map +1 -1
- package/resources/course-students.mjs +3 -2
- package/resources/course-students.mjs.map +1 -1
- package/resources/courses.d.mts +140 -99
- package/resources/courses.d.mts.map +1 -1
- package/resources/courses.d.ts +140 -99
- package/resources/courses.d.ts.map +1 -1
- package/resources/courses.js +9 -5
- package/resources/courses.js.map +1 -1
- package/resources/courses.mjs +9 -5
- package/resources/courses.mjs.map +1 -1
- package/resources/disputes.d.mts +176 -120
- package/resources/disputes.d.mts.map +1 -1
- package/resources/disputes.d.ts +176 -120
- package/resources/disputes.d.ts.map +1 -1
- package/resources/disputes.js +4 -2
- package/resources/disputes.js.map +1 -1
- package/resources/disputes.mjs +4 -2
- package/resources/disputes.mjs.map +1 -1
- package/resources/dm-channels.d.mts +29 -16
- package/resources/dm-channels.d.mts.map +1 -1
- package/resources/dm-channels.d.ts +29 -16
- package/resources/dm-channels.d.ts.map +1 -1
- package/resources/dm-channels.js +9 -5
- package/resources/dm-channels.js.map +1 -1
- package/resources/dm-channels.mjs +9 -5
- package/resources/dm-channels.mjs.map +1 -1
- package/resources/dm-members.d.mts +30 -21
- package/resources/dm-members.d.mts.map +1 -1
- package/resources/dm-members.d.ts +30 -21
- package/resources/dm-members.d.ts.map +1 -1
- package/resources/dm-members.js +9 -5
- package/resources/dm-members.js.map +1 -1
- package/resources/dm-members.mjs +9 -5
- package/resources/dm-members.mjs.map +1 -1
- package/resources/entries.d.mts +35 -27
- package/resources/entries.d.mts.map +1 -1
- package/resources/entries.d.ts +35 -27
- package/resources/entries.d.ts.map +1 -1
- package/resources/entries.js +7 -4
- package/resources/entries.js.map +1 -1
- package/resources/entries.mjs +7 -4
- package/resources/entries.mjs.map +1 -1
- package/resources/experiences.d.mts +58 -49
- package/resources/experiences.d.mts.map +1 -1
- package/resources/experiences.d.ts +58 -49
- package/resources/experiences.d.ts.map +1 -1
- package/resources/experiences.js +6 -5
- package/resources/experiences.js.map +1 -1
- package/resources/experiences.mjs +6 -5
- package/resources/experiences.mjs.map +1 -1
- package/resources/fee-markups.d.mts +38 -27
- package/resources/fee-markups.d.mts.map +1 -1
- package/resources/fee-markups.d.ts +38 -27
- package/resources/fee-markups.d.ts.map +1 -1
- package/resources/fee-markups.js +6 -3
- package/resources/fee-markups.js.map +1 -1
- package/resources/fee-markups.mjs +6 -3
- package/resources/fee-markups.mjs.map +1 -1
- package/resources/files.d.mts +23 -19
- package/resources/files.d.mts.map +1 -1
- package/resources/files.d.ts +23 -19
- package/resources/files.d.ts.map +1 -1
- package/resources/files.js +3 -2
- package/resources/files.js.map +1 -1
- package/resources/files.mjs +3 -2
- package/resources/files.mjs.map +1 -1
- package/resources/forum-posts.d.mts +68 -45
- package/resources/forum-posts.d.mts.map +1 -1
- package/resources/forum-posts.d.ts +68 -45
- package/resources/forum-posts.d.ts.map +1 -1
- package/resources/forum-posts.js +8 -4
- package/resources/forum-posts.js.map +1 -1
- package/resources/forum-posts.mjs +8 -4
- package/resources/forum-posts.mjs.map +1 -1
- package/resources/forums.d.mts +21 -13
- package/resources/forums.d.mts.map +1 -1
- package/resources/forums.d.ts +21 -13
- package/resources/forums.d.ts.map +1 -1
- package/resources/forums.js +5 -3
- package/resources/forums.js.map +1 -1
- package/resources/forums.mjs +5 -3
- package/resources/forums.mjs.map +1 -1
- package/resources/index.d.mts +3 -3
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +3 -3
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/invoices.d.mts +136 -100
- package/resources/invoices.d.mts.map +1 -1
- package/resources/invoices.d.ts +136 -100
- package/resources/invoices.d.ts.map +1 -1
- package/resources/invoices.js +7 -4
- package/resources/invoices.js.map +1 -1
- package/resources/invoices.mjs +7 -4
- package/resources/invoices.mjs.map +1 -1
- package/resources/leads.d.mts +76 -54
- package/resources/leads.d.mts.map +1 -1
- package/resources/leads.d.ts +76 -54
- package/resources/leads.d.ts.map +1 -1
- package/resources/leads.js +6 -4
- package/resources/leads.js.map +1 -1
- package/resources/leads.mjs +6 -4
- package/resources/leads.mjs.map +1 -1
- package/resources/ledger-accounts.d.mts +19 -15
- package/resources/ledger-accounts.d.mts.map +1 -1
- package/resources/ledger-accounts.d.ts +19 -15
- package/resources/ledger-accounts.d.ts.map +1 -1
- package/resources/ledger-accounts.js +1 -1
- package/resources/ledger-accounts.mjs +1 -1
- package/resources/members.d.mts +27 -28
- package/resources/members.d.mts.map +1 -1
- package/resources/members.d.ts +27 -28
- package/resources/members.d.ts.map +1 -1
- package/resources/members.js +3 -2
- package/resources/members.js.map +1 -1
- package/resources/members.mjs +3 -2
- package/resources/members.mjs.map +1 -1
- package/resources/memberships.d.mts +85 -62
- package/resources/memberships.d.mts.map +1 -1
- package/resources/memberships.d.ts +85 -62
- package/resources/memberships.d.ts.map +1 -1
- package/resources/memberships.js +12 -8
- package/resources/memberships.js.map +1 -1
- package/resources/memberships.mjs +12 -8
- package/resources/memberships.mjs.map +1 -1
- package/resources/messages.d.mts +53 -35
- package/resources/messages.d.mts.map +1 -1
- package/resources/messages.d.ts +53 -35
- package/resources/messages.d.ts.map +1 -1
- package/resources/messages.js +9 -5
- package/resources/messages.js.map +1 -1
- package/resources/messages.mjs +9 -5
- package/resources/messages.mjs.map +1 -1
- package/resources/notifications.d.mts +33 -25
- package/resources/notifications.d.mts.map +1 -1
- package/resources/notifications.d.ts +33 -25
- package/resources/notifications.d.ts.map +1 -1
- package/resources/notifications.js +2 -1
- package/resources/notifications.js.map +1 -1
- package/resources/notifications.mjs +2 -1
- package/resources/notifications.mjs.map +1 -1
- package/resources/payment-methods.d.mts +212 -114
- package/resources/payment-methods.d.mts.map +1 -1
- package/resources/payment-methods.d.ts +212 -114
- package/resources/payment-methods.d.ts.map +1 -1
- package/resources/payment-methods.js +5 -10
- package/resources/payment-methods.js.map +1 -1
- package/resources/payment-methods.mjs +5 -10
- package/resources/payment-methods.mjs.map +1 -1
- package/resources/payments.d.mts +96 -56
- package/resources/payments.d.mts.map +1 -1
- package/resources/payments.d.ts +96 -56
- package/resources/payments.d.ts.map +1 -1
- package/resources/payments.js +23 -10
- package/resources/payments.js.map +1 -1
- package/resources/payments.mjs +23 -10
- package/resources/payments.mjs.map +1 -1
- package/resources/payout-methods.d.mts +50 -35
- package/resources/payout-methods.d.mts.map +1 -1
- package/resources/payout-methods.d.ts +50 -35
- package/resources/payout-methods.d.ts.map +1 -1
- package/resources/payout-methods.js +3 -2
- package/resources/payout-methods.js.map +1 -1
- package/resources/payout-methods.mjs +3 -2
- package/resources/payout-methods.mjs.map +1 -1
- package/resources/plans.d.mts +136 -95
- package/resources/plans.d.mts.map +1 -1
- package/resources/plans.d.ts +136 -95
- package/resources/plans.d.ts.map +1 -1
- package/resources/plans.js +9 -5
- package/resources/plans.js.map +1 -1
- package/resources/plans.mjs +9 -5
- package/resources/plans.mjs.map +1 -1
- package/resources/products.d.mts +80 -67
- package/resources/products.d.mts.map +1 -1
- package/resources/products.d.ts +80 -67
- package/resources/products.d.ts.map +1 -1
- package/resources/products.js +7 -5
- package/resources/products.js.map +1 -1
- package/resources/products.mjs +7 -5
- package/resources/products.mjs.map +1 -1
- package/resources/promo-codes.d.mts +60 -40
- package/resources/promo-codes.d.mts.map +1 -1
- package/resources/promo-codes.d.ts +60 -40
- package/resources/promo-codes.d.ts.map +1 -1
- package/resources/promo-codes.js +7 -4
- package/resources/promo-codes.js.map +1 -1
- package/resources/promo-codes.mjs +7 -4
- package/resources/promo-codes.mjs.map +1 -1
- package/resources/reactions.d.mts +25 -19
- package/resources/reactions.d.mts.map +1 -1
- package/resources/reactions.d.ts +25 -19
- package/resources/reactions.d.ts.map +1 -1
- package/resources/reactions.js +7 -4
- package/resources/reactions.js.map +1 -1
- package/resources/reactions.mjs +7 -4
- package/resources/reactions.mjs.map +1 -1
- package/resources/refunds.d.mts +57 -39
- package/resources/refunds.d.mts.map +1 -1
- package/resources/refunds.d.ts +57 -39
- package/resources/refunds.d.ts.map +1 -1
- package/resources/refunds.js +3 -2
- package/resources/refunds.js.map +1 -1
- package/resources/refunds.mjs +3 -2
- package/resources/refunds.mjs.map +1 -1
- package/resources/reviews.d.mts +76 -60
- package/resources/reviews.d.mts.map +1 -1
- package/resources/reviews.d.ts +76 -60
- package/resources/reviews.d.ts.map +1 -1
- package/resources/reviews.js +3 -2
- package/resources/reviews.js.map +1 -1
- package/resources/reviews.mjs +3 -2
- package/resources/reviews.mjs.map +1 -1
- package/resources/setup-intents.d.mts +77 -61
- package/resources/setup-intents.d.mts.map +1 -1
- package/resources/setup-intents.d.ts +77 -61
- package/resources/setup-intents.d.ts.map +1 -1
- package/resources/setup-intents.js +4 -10
- package/resources/setup-intents.js.map +1 -1
- package/resources/setup-intents.mjs +4 -10
- package/resources/setup-intents.mjs.map +1 -1
- package/resources/shared.d.mts +854 -509
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +854 -509
- package/resources/shared.d.ts.map +1 -1
- package/resources/shipments.d.mts +30 -21
- package/resources/shipments.d.mts.map +1 -1
- package/resources/shipments.d.ts +30 -21
- package/resources/shipments.d.ts.map +1 -1
- package/resources/shipments.js +5 -3
- package/resources/shipments.js.map +1 -1
- package/resources/shipments.mjs +5 -3
- package/resources/shipments.mjs.map +1 -1
- package/resources/support-channels.d.mts +28 -20
- package/resources/support-channels.d.mts.map +1 -1
- package/resources/support-channels.d.ts +28 -20
- package/resources/support-channels.d.ts.map +1 -1
- package/resources/support-channels.js +5 -4
- package/resources/support-channels.js.map +1 -1
- package/resources/support-channels.mjs +5 -4
- package/resources/support-channels.mjs.map +1 -1
- package/resources/topups.d.mts +13 -9
- package/resources/topups.d.mts.map +1 -1
- package/resources/topups.d.ts +13 -9
- package/resources/topups.d.ts.map +1 -1
- package/resources/topups.js +2 -1
- package/resources/topups.js.map +1 -1
- package/resources/topups.mjs +2 -1
- package/resources/topups.mjs.map +1 -1
- package/resources/transfers.d.mts +37 -28
- package/resources/transfers.d.mts.map +1 -1
- package/resources/transfers.d.ts +37 -28
- package/resources/transfers.d.ts.map +1 -1
- package/resources/transfers.js +5 -3
- package/resources/transfers.js.map +1 -1
- package/resources/transfers.mjs +5 -3
- package/resources/transfers.mjs.map +1 -1
- package/resources/users.d.mts +60 -18
- package/resources/users.d.mts.map +1 -1
- package/resources/users.d.ts +60 -18
- package/resources/users.d.ts.map +1 -1
- package/resources/users.js +13 -2
- package/resources/users.js.map +1 -1
- package/resources/users.mjs +13 -2
- package/resources/users.mjs.map +1 -1
- package/resources/verifications.d.mts +7 -5
- package/resources/verifications.d.mts.map +1 -1
- package/resources/verifications.d.ts +7 -5
- package/resources/verifications.d.ts.map +1 -1
- package/resources/verifications.js +1 -1
- package/resources/verifications.mjs +1 -1
- package/resources/webhooks.d.mts +188 -133
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +188 -133
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/webhooks.js +3 -2
- package/resources/webhooks.js.map +1 -1
- package/resources/webhooks.mjs +3 -2
- package/resources/webhooks.mjs.map +1 -1
- package/resources/withdrawals.d.mts +60 -47
- package/resources/withdrawals.d.mts.map +1 -1
- package/resources/withdrawals.d.ts +60 -47
- package/resources/withdrawals.d.ts.map +1 -1
- package/resources/withdrawals.js +3 -2
- package/resources/withdrawals.js.map +1 -1
- package/resources/withdrawals.mjs +3 -2
- package/resources/withdrawals.mjs.map +1 -1
- package/src/client.ts +33 -11
- package/src/resources/access-tokens.ts +37 -59
- package/src/resources/account-links.ts +15 -13
- package/src/resources/ai-chats.ts +76 -30
- package/src/resources/app-builds.ts +37 -35
- package/src/resources/apps.ts +89 -60
- package/src/resources/authorized-users.ts +38 -32
- package/src/resources/chat-channels.ts +28 -20
- package/src/resources/checkout-configurations.ts +76 -58
- package/src/resources/companies.ts +94 -57
- package/src/resources/company-token-transactions.ts +91 -68
- package/src/resources/course-chapters.ts +27 -22
- package/src/resources/course-lesson-interactions.ts +7 -6
- package/src/resources/course-lessons.ts +141 -99
- package/src/resources/course-students.ts +44 -35
- package/src/resources/courses.ts +140 -99
- package/src/resources/disputes.ts +176 -120
- package/src/resources/dm-channels.ts +29 -16
- package/src/resources/dm-members.ts +30 -21
- package/src/resources/entries.ts +35 -27
- package/src/resources/experiences.ts +58 -49
- package/src/resources/fee-markups.ts +38 -27
- package/src/resources/files.ts +23 -19
- package/src/resources/forum-posts.ts +69 -45
- package/src/resources/forums.ts +21 -13
- package/src/resources/index.ts +4 -2
- package/src/resources/invoices.ts +140 -100
- package/src/resources/leads.ts +76 -54
- package/src/resources/ledger-accounts.ts +19 -15
- package/src/resources/members.ts +27 -28
- package/src/resources/memberships.ts +86 -62
- package/src/resources/messages.ts +53 -35
- package/src/resources/notifications.ts +33 -25
- package/src/resources/payment-methods.ts +212 -114
- package/src/resources/payments.ts +103 -55
- package/src/resources/payout-methods.ts +50 -35
- package/src/resources/plans.ts +136 -95
- package/src/resources/products.ts +219 -70
- package/src/resources/promo-codes.ts +60 -40
- package/src/resources/reactions.ts +25 -19
- package/src/resources/refunds.ts +59 -39
- package/src/resources/reviews.ts +76 -60
- package/src/resources/setup-intents.ts +77 -61
- package/src/resources/shared.ts +2797 -508
- package/src/resources/shipments.ts +30 -21
- package/src/resources/support-channels.ts +28 -20
- package/src/resources/topups.ts +13 -9
- package/src/resources/transfers.ts +37 -28
- package/src/resources/users.ts +72 -18
- package/src/resources/verifications.ts +7 -5
- package/src/resources/webhooks.ts +188 -133
- package/src/resources/withdrawals.ts +60 -46
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/apps.d.ts
CHANGED
|
@@ -5,7 +5,8 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
|
|
|
5
5
|
import { RequestOptions } from "../internal/request-options.js";
|
|
6
6
|
export declare class Apps extends APIResource {
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
8
|
+
* Register a new app on the Whop developer platform. Apps provide custom
|
|
9
|
+
* experiences that can be added to products.
|
|
9
10
|
*
|
|
10
11
|
* Required permissions:
|
|
11
12
|
*
|
|
@@ -22,7 +23,7 @@ export declare class Apps extends APIResource {
|
|
|
22
23
|
*/
|
|
23
24
|
create(body: AppCreateParams, options?: RequestOptions): APIPromise<Shared.App>;
|
|
24
25
|
/**
|
|
25
|
-
* Retrieves an app
|
|
26
|
+
* Retrieves the details of an existing app.
|
|
26
27
|
*
|
|
27
28
|
* Required permissions:
|
|
28
29
|
*
|
|
@@ -37,7 +38,8 @@ export declare class Apps extends APIResource {
|
|
|
37
38
|
*/
|
|
38
39
|
retrieve(id: string, options?: RequestOptions): APIPromise<Shared.App>;
|
|
39
40
|
/**
|
|
40
|
-
* Update an existing
|
|
41
|
+
* Update the settings, metadata, or status of an existing app on the Whop
|
|
42
|
+
* developer platform.
|
|
41
43
|
*
|
|
42
44
|
* Required permissions:
|
|
43
45
|
*
|
|
@@ -51,7 +53,8 @@ export declare class Apps extends APIResource {
|
|
|
51
53
|
*/
|
|
52
54
|
update(id: string, body?: AppUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Shared.App>;
|
|
53
55
|
/**
|
|
54
|
-
*
|
|
56
|
+
* Returns a paginated list of apps on the Whop platform, with optional filtering
|
|
57
|
+
* by company, type, view support, and search query.
|
|
55
58
|
*
|
|
56
59
|
* @example
|
|
57
60
|
* ```ts
|
|
@@ -69,141 +72,153 @@ export type AppListResponsesCursorPage = CursorPage<AppListResponse>;
|
|
|
69
72
|
*/
|
|
70
73
|
export type AppType = 'b2b_app' | 'b2c_app' | 'company_app' | 'component';
|
|
71
74
|
/**
|
|
72
|
-
* An
|
|
75
|
+
* An app is an integration built on Whop. Apps can serve consumers as experiences
|
|
76
|
+
* within products, or serve companies as business tools.
|
|
73
77
|
*/
|
|
74
78
|
export interface AppListResponse {
|
|
75
79
|
/**
|
|
76
|
-
* The
|
|
80
|
+
* The unique identifier for the app.
|
|
77
81
|
*/
|
|
78
82
|
id: string;
|
|
79
83
|
/**
|
|
80
|
-
* The
|
|
84
|
+
* The target audience classification for this app (e.g., 'b2b_app', 'b2c_app',
|
|
85
|
+
* 'company_app', 'component').
|
|
81
86
|
*/
|
|
82
87
|
app_type: AppType;
|
|
83
88
|
/**
|
|
84
|
-
* The base
|
|
89
|
+
* The production base URL where the app is hosted. Null if no base URL is
|
|
90
|
+
* configured.
|
|
85
91
|
*/
|
|
86
92
|
base_url: string | null;
|
|
87
93
|
/**
|
|
88
|
-
* The company that owns
|
|
94
|
+
* The company that owns and publishes this app.
|
|
89
95
|
*/
|
|
90
96
|
company: AppListResponse.Company;
|
|
91
97
|
/**
|
|
92
|
-
* The
|
|
98
|
+
* The user who created and owns the company that published this app.
|
|
93
99
|
*/
|
|
94
100
|
creator: AppListResponse.Creator;
|
|
95
101
|
/**
|
|
96
|
-
* The path
|
|
97
|
-
*
|
|
102
|
+
* The URL path template for a specific view of this app, appended to the base
|
|
103
|
+
* domain (e.g., '/experiences/[experienceId]'). Null if the specified view type is
|
|
104
|
+
* not configured.
|
|
98
105
|
*/
|
|
99
106
|
dashboard_path: string | null;
|
|
100
107
|
/**
|
|
101
|
-
*
|
|
108
|
+
* A written description of what this app does, displayed on the app store listing
|
|
109
|
+
* page. Null if no description has been set.
|
|
102
110
|
*/
|
|
103
111
|
description: string | null;
|
|
104
112
|
/**
|
|
105
|
-
* The path
|
|
106
|
-
*
|
|
113
|
+
* The URL path template for a specific view of this app, appended to the base
|
|
114
|
+
* domain (e.g., '/experiences/[experienceId]'). Null if the specified view type is
|
|
115
|
+
* not configured.
|
|
107
116
|
*/
|
|
108
117
|
discover_path: string | null;
|
|
109
118
|
/**
|
|
110
|
-
* The unique
|
|
111
|
-
*
|
|
112
|
-
* the final url: https://{domain_id}.apps.whop.com
|
|
119
|
+
* The unique subdomain identifier for this app's proxied URL on the Whop platform.
|
|
120
|
+
* Forms the URL pattern https://{domain_id}.apps.whop.com.
|
|
113
121
|
*/
|
|
114
122
|
domain_id: string;
|
|
115
123
|
/**
|
|
116
|
-
* The path
|
|
117
|
-
*
|
|
124
|
+
* The URL path template for a specific view of this app, appended to the base
|
|
125
|
+
* domain (e.g., '/experiences/[experienceId]'). Null if the specified view type is
|
|
126
|
+
* not configured.
|
|
118
127
|
*/
|
|
119
128
|
experience_path: string | null;
|
|
120
129
|
/**
|
|
121
|
-
* The icon for
|
|
122
|
-
* checkout, and as
|
|
130
|
+
* The icon image for this app, displayed on the app store, product pages,
|
|
131
|
+
* checkout, and as the default icon for experiences using this app.
|
|
123
132
|
*/
|
|
124
133
|
icon: AppListResponse.Icon | null;
|
|
125
134
|
/**
|
|
126
|
-
* The name of the app
|
|
135
|
+
* The display name of this app shown on the app store and in experience
|
|
136
|
+
* navigation. Maximum 30 characters.
|
|
127
137
|
*/
|
|
128
138
|
name: string;
|
|
129
139
|
/**
|
|
130
|
-
*
|
|
131
|
-
*
|
|
132
|
-
* means
|
|
133
|
-
* link. To remove the app from whop discovery, you should set the status to
|
|
134
|
-
* unlisted.
|
|
140
|
+
* The current visibility status of this app on the Whop app store. 'live' means
|
|
141
|
+
* publicly discoverable, 'unlisted' means accessible only via direct link, and
|
|
142
|
+
* 'hidden' means not visible anywhere.
|
|
135
143
|
*/
|
|
136
144
|
status: Shared.AppStatuses;
|
|
137
145
|
/**
|
|
138
|
-
* Whether this app has been verified by Whop. Verified apps are endorsed by
|
|
139
|
-
* and
|
|
146
|
+
* Whether this app has been verified by Whop. Verified apps are endorsed by Whop
|
|
147
|
+
* and displayed in the featured apps section of the app store.
|
|
140
148
|
*/
|
|
141
149
|
verified: boolean;
|
|
142
150
|
}
|
|
143
151
|
export declare namespace AppListResponse {
|
|
144
152
|
/**
|
|
145
|
-
* The company that owns
|
|
153
|
+
* The company that owns and publishes this app.
|
|
146
154
|
*/
|
|
147
155
|
interface Company {
|
|
148
156
|
/**
|
|
149
|
-
* The
|
|
157
|
+
* The unique identifier for the company.
|
|
150
158
|
*/
|
|
151
159
|
id: string;
|
|
152
160
|
/**
|
|
153
|
-
* The
|
|
161
|
+
* The display name of the company shown to customers.
|
|
154
162
|
*/
|
|
155
163
|
title: string;
|
|
156
164
|
}
|
|
157
165
|
/**
|
|
158
|
-
* The
|
|
166
|
+
* The user who created and owns the company that published this app.
|
|
159
167
|
*/
|
|
160
168
|
interface Creator {
|
|
161
169
|
/**
|
|
162
|
-
* The
|
|
170
|
+
* The unique identifier for the user.
|
|
163
171
|
*/
|
|
164
172
|
id: string;
|
|
165
173
|
/**
|
|
166
|
-
* The
|
|
174
|
+
* The user's display name shown on their public profile.
|
|
167
175
|
*/
|
|
168
176
|
name: string | null;
|
|
169
177
|
/**
|
|
170
|
-
* The
|
|
178
|
+
* The user's unique username shown on their public profile.
|
|
171
179
|
*/
|
|
172
180
|
username: string;
|
|
173
181
|
}
|
|
174
182
|
/**
|
|
175
|
-
* The icon for
|
|
176
|
-
* checkout, and as
|
|
183
|
+
* The icon image for this app, displayed on the app store, product pages,
|
|
184
|
+
* checkout, and as the default icon for experiences using this app.
|
|
177
185
|
*/
|
|
178
186
|
interface Icon {
|
|
179
187
|
/**
|
|
180
|
-
*
|
|
181
|
-
*
|
|
188
|
+
* A pre-optimized URL for rendering this attachment on the client. This should be
|
|
189
|
+
* used for displaying attachments in apps.
|
|
182
190
|
*/
|
|
183
191
|
url: string | null;
|
|
184
192
|
}
|
|
185
193
|
}
|
|
186
194
|
export interface AppCreateParams {
|
|
187
195
|
/**
|
|
188
|
-
* The
|
|
196
|
+
* The unique identifier of the company to create the app for, starting with
|
|
197
|
+
* 'biz\_'.
|
|
189
198
|
*/
|
|
190
199
|
company_id: string;
|
|
191
200
|
/**
|
|
192
|
-
* The name
|
|
201
|
+
* The display name for the app, shown to users on the app store and product pages.
|
|
193
202
|
*/
|
|
194
203
|
name: string;
|
|
195
204
|
/**
|
|
196
|
-
* The base URL
|
|
205
|
+
* The base production URL where the app is hosted, such as
|
|
206
|
+
* 'https://myapp.example.com'.
|
|
197
207
|
*/
|
|
198
208
|
base_url?: string | null;
|
|
199
209
|
/**
|
|
200
|
-
* The icon for the app in
|
|
210
|
+
* The icon image for the app in PNG, JPEG, or GIF format.
|
|
201
211
|
*/
|
|
202
212
|
icon?: AppCreateParams.Icon | null;
|
|
213
|
+
/**
|
|
214
|
+
* The whitelisted OAuth callback URLs that users are redirected to after
|
|
215
|
+
* authorizing the app.
|
|
216
|
+
*/
|
|
217
|
+
redirect_uris?: Array<string> | null;
|
|
203
218
|
}
|
|
204
219
|
export declare namespace AppCreateParams {
|
|
205
220
|
/**
|
|
206
|
-
* The icon for the app in
|
|
221
|
+
* The icon image for the app in PNG, JPEG, or GIF format.
|
|
207
222
|
*/
|
|
208
223
|
interface Icon {
|
|
209
224
|
/**
|
|
@@ -214,7 +229,7 @@ export declare namespace AppCreateParams {
|
|
|
214
229
|
}
|
|
215
230
|
export interface AppUpdateParams {
|
|
216
231
|
/**
|
|
217
|
-
* The description
|
|
232
|
+
* The detailed description shown on the app store's in-depth app view page.
|
|
218
233
|
*/
|
|
219
234
|
app_store_description?: string | null;
|
|
220
235
|
/**
|
|
@@ -222,35 +237,46 @@ export interface AppUpdateParams {
|
|
|
222
237
|
*/
|
|
223
238
|
app_type?: AppType | null;
|
|
224
239
|
/**
|
|
225
|
-
* The base production
|
|
240
|
+
* The base production URL where the app is hosted, such as
|
|
241
|
+
* 'https://myapp.example.com'.
|
|
226
242
|
*/
|
|
227
243
|
base_url?: string | null;
|
|
228
244
|
/**
|
|
229
|
-
* The path for the dashboard view of the app
|
|
245
|
+
* The URL path for the company dashboard view of the app, such as '/dashboard'.
|
|
230
246
|
*/
|
|
231
247
|
dashboard_path?: string | null;
|
|
232
248
|
/**
|
|
233
|
-
*
|
|
249
|
+
* A short description of the app shown in listings and search results.
|
|
234
250
|
*/
|
|
235
251
|
description?: string | null;
|
|
236
252
|
/**
|
|
237
|
-
* The path for the discover view of the app
|
|
253
|
+
* The URL path for the discover view of the app, such as '/discover'.
|
|
238
254
|
*/
|
|
239
255
|
discover_path?: string | null;
|
|
240
256
|
/**
|
|
241
|
-
* The path for the hub view of the app
|
|
257
|
+
* The URL path for the member-facing hub view of the app, such as
|
|
258
|
+
* '/experiences/[experienceId]'.
|
|
242
259
|
*/
|
|
243
260
|
experience_path?: string | null;
|
|
244
261
|
/**
|
|
245
|
-
* The icon for the app
|
|
262
|
+
* The icon image for the app, used in listings and navigation.
|
|
246
263
|
*/
|
|
247
264
|
icon?: AppUpdateParams.Icon | null;
|
|
248
265
|
/**
|
|
249
|
-
* The name
|
|
266
|
+
* The display name for the app, shown to users on the app store and product pages.
|
|
250
267
|
*/
|
|
251
268
|
name?: string | null;
|
|
252
269
|
/**
|
|
253
|
-
*
|
|
270
|
+
* How this app authenticates at the OAuth token endpoint.
|
|
271
|
+
*/
|
|
272
|
+
oauth_client_type?: 'public' | 'confidential' | null;
|
|
273
|
+
/**
|
|
274
|
+
* The whitelisted OAuth callback URLs that users are redirected to after
|
|
275
|
+
* authorizing the app
|
|
276
|
+
*/
|
|
277
|
+
redirect_uris?: Array<string> | null;
|
|
278
|
+
/**
|
|
279
|
+
* The permission scopes the app will request from users when they install it.
|
|
254
280
|
*/
|
|
255
281
|
required_scopes?: Array<'read_user'> | null;
|
|
256
282
|
/**
|
|
@@ -260,7 +286,7 @@ export interface AppUpdateParams {
|
|
|
260
286
|
}
|
|
261
287
|
export declare namespace AppUpdateParams {
|
|
262
288
|
/**
|
|
263
|
-
* The icon for the app
|
|
289
|
+
* The icon image for the app, used in listings and navigation.
|
|
264
290
|
*/
|
|
265
291
|
interface Icon {
|
|
266
292
|
/**
|
|
@@ -279,7 +305,7 @@ export interface AppListParams extends CursorPageParams {
|
|
|
279
305
|
*/
|
|
280
306
|
before?: string | null;
|
|
281
307
|
/**
|
|
282
|
-
*
|
|
308
|
+
* Filter apps to only those created by this company, starting with 'biz\_'.
|
|
283
309
|
*/
|
|
284
310
|
company_id?: string | null;
|
|
285
311
|
/**
|
|
@@ -299,12 +325,12 @@ export interface AppListParams extends CursorPageParams {
|
|
|
299
325
|
*/
|
|
300
326
|
order?: 'created_at' | 'discoverable_at' | 'total_installs_last_30_days' | 'total_installs_last_7_days' | 'time_spent' | 'time_spent_last_24_hours' | 'daily_active_users' | 'ai_prompt_count' | 'total_ai_cost_usd' | 'total_ai_tokens' | 'last_ai_prompt_at' | 'ai_average_rating' | null;
|
|
301
327
|
/**
|
|
302
|
-
*
|
|
328
|
+
* A search string to filter apps by name, such as 'chat' or 'analytics'.
|
|
303
329
|
*/
|
|
304
330
|
query?: string | null;
|
|
305
331
|
/**
|
|
306
|
-
*
|
|
307
|
-
* a
|
|
332
|
+
* Whether to only return apps that have been verified by Whop. Useful for
|
|
333
|
+
* populating a featured apps section.
|
|
308
334
|
*/
|
|
309
335
|
verified_apps_only?: boolean | null;
|
|
310
336
|
/**
|
package/resources/apps.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"apps.d.ts","sourceRoot":"","sources":["../src/resources/apps.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,IAAK,SAAQ,WAAW;IACnC
|
|
1
|
+
{"version":3,"file":"apps.d.ts","sourceRoot":"","sources":["../src/resources/apps.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC;IAI/E;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC;IAItE;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC;IAIzB;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,aAAa,GAAG,IAAI,GAAG,SAAc,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0BAA0B,EAAE,eAAe,CAAC;CAG5D;AAED,MAAM,MAAM,0BAA0B,GAAG,UAAU,CAAC,eAAe,CAAC,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,aAAa,GAAG,WAAW,CAAC;AAE1E;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,EAAE,eAAe,CAAC,OAAO,CAAC;IAEjC;;OAEG;IACH,OAAO,EAAE,eAAe,CAAC,OAAO,CAAC;IAEjC;;;;OAIG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;OAIG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,IAAI,EAAE,eAAe,CAAC,IAAI,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC,WAAW,CAAC;IAE3B;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;IAED;;;OAGG;IACH,UAAiB,IAAI;QACnB;;;WAGG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,CAAC,IAAI,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CACtC;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,CAAC,IAAI,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,iBAAiB,CAAC,EAAE,QAAQ,GAAG,cAAc,GAAG,IAAI,CAAC;IAErD;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC;CACpC;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,aAAc,SAAQ,gBAAgB;IACrD;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EACF,YAAY,GACZ,iBAAiB,GACjB,6BAA6B,GAC7B,4BAA4B,GAC5B,YAAY,GACZ,0BAA0B,GAC1B,oBAAoB,GACpB,iBAAiB,GACjB,mBAAmB,GACnB,iBAAiB,GACjB,mBAAmB,GACnB,mBAAmB,GACnB,IAAI,CAAC;IAET;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC;CACvC;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;CACH"}
|
package/resources/apps.js
CHANGED
|
@@ -7,7 +7,8 @@ const pagination_1 = require("../core/pagination.js");
|
|
|
7
7
|
const path_1 = require("../internal/utils/path.js");
|
|
8
8
|
class Apps extends resource_1.APIResource {
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* Register a new app on the Whop developer platform. Apps provide custom
|
|
11
|
+
* experiences that can be added to products.
|
|
11
12
|
*
|
|
12
13
|
* Required permissions:
|
|
13
14
|
*
|
|
@@ -26,7 +27,7 @@ class Apps extends resource_1.APIResource {
|
|
|
26
27
|
return this._client.post('/apps', { body, ...options });
|
|
27
28
|
}
|
|
28
29
|
/**
|
|
29
|
-
* Retrieves an app
|
|
30
|
+
* Retrieves the details of an existing app.
|
|
30
31
|
*
|
|
31
32
|
* Required permissions:
|
|
32
33
|
*
|
|
@@ -43,7 +44,8 @@ class Apps extends resource_1.APIResource {
|
|
|
43
44
|
return this._client.get((0, path_1.path) `/apps/${id}`, options);
|
|
44
45
|
}
|
|
45
46
|
/**
|
|
46
|
-
* Update an existing
|
|
47
|
+
* Update the settings, metadata, or status of an existing app on the Whop
|
|
48
|
+
* developer platform.
|
|
47
49
|
*
|
|
48
50
|
* Required permissions:
|
|
49
51
|
*
|
|
@@ -59,7 +61,8 @@ class Apps extends resource_1.APIResource {
|
|
|
59
61
|
return this._client.patch((0, path_1.path) `/apps/${id}`, { body, ...options });
|
|
60
62
|
}
|
|
61
63
|
/**
|
|
62
|
-
*
|
|
64
|
+
* Returns a paginated list of apps on the Whop platform, with optional filtering
|
|
65
|
+
* by company, type, view support, and search query.
|
|
63
66
|
*
|
|
64
67
|
* @example
|
|
65
68
|
* ```ts
|
package/resources/apps.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"apps.js","sourceRoot":"","sources":["../src/resources/apps.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,IAAK,SAAQ,sBAAW;IACnC
|
|
1
|
+
{"version":3,"file":"apps.js","sourceRoot":"","sources":["../src/resources/apps.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAqB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,SAAS,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,EAAU,EACV,OAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,SAAS,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CACF,QAA0C,EAAE,EAC5C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE,CAAA,uBAA2B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;CACF;AAhFD,oBAgFC"}
|
package/resources/apps.mjs
CHANGED
|
@@ -4,7 +4,8 @@ import { CursorPage } from "../core/pagination.mjs";
|
|
|
4
4
|
import { path } from "../internal/utils/path.mjs";
|
|
5
5
|
export class Apps extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* Register a new app on the Whop developer platform. Apps provide custom
|
|
8
|
+
* experiences that can be added to products.
|
|
8
9
|
*
|
|
9
10
|
* Required permissions:
|
|
10
11
|
*
|
|
@@ -23,7 +24,7 @@ export class Apps extends APIResource {
|
|
|
23
24
|
return this._client.post('/apps', { body, ...options });
|
|
24
25
|
}
|
|
25
26
|
/**
|
|
26
|
-
* Retrieves an app
|
|
27
|
+
* Retrieves the details of an existing app.
|
|
27
28
|
*
|
|
28
29
|
* Required permissions:
|
|
29
30
|
*
|
|
@@ -40,7 +41,8 @@ export class Apps extends APIResource {
|
|
|
40
41
|
return this._client.get(path `/apps/${id}`, options);
|
|
41
42
|
}
|
|
42
43
|
/**
|
|
43
|
-
* Update an existing
|
|
44
|
+
* Update the settings, metadata, or status of an existing app on the Whop
|
|
45
|
+
* developer platform.
|
|
44
46
|
*
|
|
45
47
|
* Required permissions:
|
|
46
48
|
*
|
|
@@ -56,7 +58,8 @@ export class Apps extends APIResource {
|
|
|
56
58
|
return this._client.patch(path `/apps/${id}`, { body, ...options });
|
|
57
59
|
}
|
|
58
60
|
/**
|
|
59
|
-
*
|
|
61
|
+
* Returns a paginated list of apps on the Whop platform, with optional filtering
|
|
62
|
+
* by company, type, view support, and search query.
|
|
60
63
|
*
|
|
61
64
|
* @example
|
|
62
65
|
* ```ts
|
package/resources/apps.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"apps.mjs","sourceRoot":"","sources":["../src/resources/apps.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC
|
|
1
|
+
{"version":3,"file":"apps.mjs","sourceRoot":"","sources":["../src/resources/apps.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAqB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,SAAS,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,EAAU,EACV,OAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,SAAS,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CACF,QAA0C,EAAE,EAC5C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE,CAAA,UAA2B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;CACF"}
|
|
@@ -5,7 +5,7 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
|
|
|
5
5
|
import { RequestOptions } from "../internal/request-options.mjs";
|
|
6
6
|
export declare class AuthorizedUsers extends APIResource {
|
|
7
7
|
/**
|
|
8
|
-
* Retrieves
|
|
8
|
+
* Retrieves the details of an existing authorized user.
|
|
9
9
|
*
|
|
10
10
|
* Required permissions:
|
|
11
11
|
*
|
|
@@ -14,7 +14,8 @@ export declare class AuthorizedUsers extends APIResource {
|
|
|
14
14
|
*/
|
|
15
15
|
retrieve(id: string, options?: RequestOptions): APIPromise<AuthorizedUserRetrieveResponse>;
|
|
16
16
|
/**
|
|
17
|
-
*
|
|
17
|
+
* Returns a paginated list of authorized team members for a company, with optional
|
|
18
|
+
* filtering by user, role, and creation date.
|
|
18
19
|
*
|
|
19
20
|
* Required permissions:
|
|
20
21
|
*
|
|
@@ -25,115 +26,119 @@ export declare class AuthorizedUsers extends APIResource {
|
|
|
25
26
|
}
|
|
26
27
|
export type AuthorizedUserListResponsesCursorPage = CursorPage<AuthorizedUserListResponse>;
|
|
27
28
|
/**
|
|
28
|
-
* A user who has
|
|
29
|
+
* A user who has been granted administrative access to manage a company's
|
|
30
|
+
* dashboard and settings.
|
|
29
31
|
*/
|
|
30
32
|
export interface AuthorizedUserRetrieveResponse {
|
|
31
33
|
/**
|
|
32
|
-
*
|
|
34
|
+
* The unique identifier for the authorized user.
|
|
33
35
|
*/
|
|
34
36
|
id: string;
|
|
35
37
|
/**
|
|
36
|
-
* The company
|
|
38
|
+
* The company this authorized user has access to.
|
|
37
39
|
*/
|
|
38
40
|
company: AuthorizedUserRetrieveResponse.Company;
|
|
39
41
|
/**
|
|
40
|
-
* The role
|
|
42
|
+
* The permission role assigned to this authorized user within the company.
|
|
41
43
|
*/
|
|
42
44
|
role: Shared.AuthorizedUserRoles;
|
|
43
45
|
/**
|
|
44
|
-
* The user
|
|
46
|
+
* The user account linked to this authorized user record.
|
|
45
47
|
*/
|
|
46
48
|
user: AuthorizedUserRetrieveResponse.User;
|
|
47
49
|
}
|
|
48
50
|
export declare namespace AuthorizedUserRetrieveResponse {
|
|
49
51
|
/**
|
|
50
|
-
* The company
|
|
52
|
+
* The company this authorized user has access to.
|
|
51
53
|
*/
|
|
52
54
|
interface Company {
|
|
53
55
|
/**
|
|
54
|
-
* The
|
|
56
|
+
* The unique identifier for the company.
|
|
55
57
|
*/
|
|
56
58
|
id: string;
|
|
57
59
|
/**
|
|
58
|
-
* The
|
|
60
|
+
* The display name of the company shown to customers.
|
|
59
61
|
*/
|
|
60
62
|
title: string;
|
|
61
63
|
}
|
|
62
64
|
/**
|
|
63
|
-
* The user
|
|
65
|
+
* The user account linked to this authorized user record.
|
|
64
66
|
*/
|
|
65
67
|
interface User {
|
|
66
68
|
/**
|
|
67
|
-
* The
|
|
69
|
+
* The unique identifier for the user.
|
|
68
70
|
*/
|
|
69
71
|
id: string;
|
|
70
72
|
/**
|
|
71
|
-
* The email
|
|
73
|
+
* The user's email address. Requires the member:email:read permission to access.
|
|
74
|
+
* Null if not authorized.
|
|
72
75
|
*/
|
|
73
76
|
email: string | null;
|
|
74
77
|
/**
|
|
75
|
-
* The
|
|
78
|
+
* The user's display name shown on their public profile.
|
|
76
79
|
*/
|
|
77
80
|
name: string | null;
|
|
78
81
|
/**
|
|
79
|
-
* The
|
|
82
|
+
* The user's unique username shown on their public profile.
|
|
80
83
|
*/
|
|
81
84
|
username: string;
|
|
82
85
|
}
|
|
83
86
|
}
|
|
84
87
|
/**
|
|
85
|
-
* A user who has
|
|
88
|
+
* A user who has been granted administrative access to manage a company's
|
|
89
|
+
* dashboard and settings.
|
|
86
90
|
*/
|
|
87
91
|
export interface AuthorizedUserListResponse {
|
|
88
92
|
/**
|
|
89
|
-
*
|
|
93
|
+
* The unique identifier for the authorized user.
|
|
90
94
|
*/
|
|
91
95
|
id: string;
|
|
92
96
|
/**
|
|
93
|
-
* The company
|
|
97
|
+
* The company this authorized user has access to.
|
|
94
98
|
*/
|
|
95
99
|
company: AuthorizedUserListResponse.Company;
|
|
96
100
|
/**
|
|
97
|
-
* The role
|
|
101
|
+
* The permission role assigned to this authorized user within the company.
|
|
98
102
|
*/
|
|
99
103
|
role: Shared.AuthorizedUserRoles;
|
|
100
104
|
/**
|
|
101
|
-
* The user
|
|
105
|
+
* The user account linked to this authorized user record.
|
|
102
106
|
*/
|
|
103
107
|
user: AuthorizedUserListResponse.User;
|
|
104
108
|
}
|
|
105
109
|
export declare namespace AuthorizedUserListResponse {
|
|
106
110
|
/**
|
|
107
|
-
* The company
|
|
111
|
+
* The company this authorized user has access to.
|
|
108
112
|
*/
|
|
109
113
|
interface Company {
|
|
110
114
|
/**
|
|
111
|
-
* The
|
|
115
|
+
* The unique identifier for the company.
|
|
112
116
|
*/
|
|
113
117
|
id: string;
|
|
114
118
|
/**
|
|
115
|
-
* The
|
|
119
|
+
* The display name of the company shown to customers.
|
|
116
120
|
*/
|
|
117
121
|
title: string;
|
|
118
122
|
}
|
|
119
123
|
/**
|
|
120
|
-
* The user
|
|
124
|
+
* The user account linked to this authorized user record.
|
|
121
125
|
*/
|
|
122
126
|
interface User {
|
|
123
127
|
/**
|
|
124
|
-
* The
|
|
128
|
+
* The unique identifier for the user.
|
|
125
129
|
*/
|
|
126
130
|
id: string;
|
|
127
131
|
/**
|
|
128
|
-
* The email
|
|
132
|
+
* The user's email address. Requires the member:email:read permission to access.
|
|
133
|
+
* Null if not authorized.
|
|
129
134
|
*/
|
|
130
135
|
email: string | null;
|
|
131
136
|
/**
|
|
132
|
-
* The
|
|
137
|
+
* The user's display name shown on their public profile.
|
|
133
138
|
*/
|
|
134
139
|
name: string | null;
|
|
135
140
|
/**
|
|
136
|
-
* The
|
|
141
|
+
* The user's unique username shown on their public profile.
|
|
137
142
|
*/
|
|
138
143
|
username: string;
|
|
139
144
|
}
|
|
@@ -144,15 +149,15 @@ export interface AuthorizedUserListParams extends CursorPageParams {
|
|
|
144
149
|
*/
|
|
145
150
|
before?: string | null;
|
|
146
151
|
/**
|
|
147
|
-
* The
|
|
152
|
+
* The unique identifier of the company to list authorized users for.
|
|
148
153
|
*/
|
|
149
154
|
company_id?: string | null;
|
|
150
155
|
/**
|
|
151
|
-
*
|
|
156
|
+
* Only return authorized users created after this timestamp.
|
|
152
157
|
*/
|
|
153
158
|
created_after?: string | null;
|
|
154
159
|
/**
|
|
155
|
-
*
|
|
160
|
+
* Only return authorized users created before this timestamp.
|
|
156
161
|
*/
|
|
157
162
|
created_before?: string | null;
|
|
158
163
|
/**
|
|
@@ -168,7 +173,8 @@ export interface AuthorizedUserListParams extends CursorPageParams {
|
|
|
168
173
|
*/
|
|
169
174
|
role?: Shared.AuthorizedUserRoles | null;
|
|
170
175
|
/**
|
|
171
|
-
* Filter
|
|
176
|
+
* Filter results to a specific user to check if they are an authorized team
|
|
177
|
+
* member.
|
|
172
178
|
*/
|
|
173
179
|
user_id?: string | null;
|
|
174
180
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"authorized-users.d.mts","sourceRoot":"","sources":["../src/resources/authorized-users.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,8BAA8B,CAAC;IAI1F
|
|
1
|
+
{"version":3,"file":"authorized-users.d.mts","sourceRoot":"","sources":["../src/resources/authorized-users.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,8BAA8B,CAAC;IAI1F;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qCAAqC,EAAE,0BAA0B,CAAC;CAMlF;AAED,MAAM,MAAM,qCAAqC,GAAG,UAAU,CAAC,0BAA0B,CAAC,CAAC;AAE3F;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,8BAA8B,CAAC,OAAO,CAAC;IAEhD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,mBAAmB,CAAC;IAEjC;;OAEG;IACH,IAAI,EAAE,8BAA8B,CAAC,IAAI,CAAC;CAC3C;AAED,yBAAiB,8BAA8B,CAAC;IAC9C;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,0BAA0B,CAAC,OAAO,CAAC;IAE5C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,mBAAmB,CAAC;IAEjC;;OAEG;IACH,IAAI,EAAE,0BAA0B,CAAC,IAAI,CAAC;CACvC;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,wBAAyB,SAAQ,gBAAgB;IAChE;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,mBAAmB,GAAG,IAAI,CAAC;IAEzC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC;IACvC,OAAO,EACL,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
|