@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/entries.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
|
|
|
5
5
|
import { RequestOptions } from "../internal/request-options.js";
|
|
6
6
|
export declare class Entries extends APIResource {
|
|
7
7
|
/**
|
|
8
|
-
* Retrieves an
|
|
8
|
+
* Retrieves the details of an existing waitlist entry.
|
|
9
9
|
*
|
|
10
10
|
* Required permissions:
|
|
11
11
|
*
|
|
@@ -14,7 +14,8 @@ export declare class Entries extends APIResource {
|
|
|
14
14
|
*/
|
|
15
15
|
retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Entry>;
|
|
16
16
|
/**
|
|
17
|
-
*
|
|
17
|
+
* Returns a paginated list of waitlist entries for a company, with optional
|
|
18
|
+
* filtering by product, plan, status, and creation date.
|
|
18
19
|
*
|
|
19
20
|
* Required permissions:
|
|
20
21
|
*
|
|
@@ -23,7 +24,8 @@ export declare class Entries extends APIResource {
|
|
|
23
24
|
*/
|
|
24
25
|
list(query: EntryListParams, options?: RequestOptions): PagePromise<EntryListResponsesCursorPage, EntryListResponse>;
|
|
25
26
|
/**
|
|
26
|
-
* Approve
|
|
27
|
+
* Approve a pending waitlist entry, triggering the checkout process to grant the
|
|
28
|
+
* user access to the plan.
|
|
27
29
|
*
|
|
28
30
|
* Required permissions:
|
|
29
31
|
*
|
|
@@ -31,7 +33,8 @@ export declare class Entries extends APIResource {
|
|
|
31
33
|
*/
|
|
32
34
|
approve(id: string, options?: RequestOptions): APIPromise<EntryApproveResponse>;
|
|
33
35
|
/**
|
|
34
|
-
* Deny
|
|
36
|
+
* Deny a pending waitlist entry, preventing the user from gaining access to the
|
|
37
|
+
* plan.
|
|
35
38
|
*
|
|
36
39
|
* Required permissions:
|
|
37
40
|
*
|
|
@@ -43,75 +46,80 @@ export declare class Entries extends APIResource {
|
|
|
43
46
|
}
|
|
44
47
|
export type EntryListResponsesCursorPage = CursorPage<EntryListResponse>;
|
|
45
48
|
/**
|
|
46
|
-
* An
|
|
49
|
+
* An entry represents a user's signup for a waitlisted plan.
|
|
47
50
|
*/
|
|
48
51
|
export interface EntryListResponse {
|
|
49
52
|
/**
|
|
50
|
-
* The
|
|
53
|
+
* The unique identifier for the entry.
|
|
51
54
|
*/
|
|
52
55
|
id: string;
|
|
53
56
|
/**
|
|
54
|
-
*
|
|
57
|
+
* The datetime the entry was created.
|
|
55
58
|
*/
|
|
56
59
|
created_at: string | null;
|
|
57
60
|
/**
|
|
58
|
-
* The
|
|
61
|
+
* The waitlisted plan that this entry is a signup for.
|
|
59
62
|
*/
|
|
60
63
|
plan: EntryListResponse.Plan | null;
|
|
61
64
|
/**
|
|
62
|
-
* The product
|
|
65
|
+
* The product associated with this entry's waitlisted plan. Null if the plan is
|
|
66
|
+
* not tied to a product.
|
|
63
67
|
*/
|
|
64
68
|
product: EntryListResponse.Product | null;
|
|
65
69
|
/**
|
|
66
|
-
* The status of the entry.
|
|
70
|
+
* The current status of the waitlist entry (e.g., drafted, pending, approved,
|
|
71
|
+
* denied).
|
|
67
72
|
*/
|
|
68
73
|
status: Shared.EntryStatus;
|
|
69
74
|
/**
|
|
70
|
-
* The user who
|
|
75
|
+
* The user who submitted this waitlist entry.
|
|
71
76
|
*/
|
|
72
77
|
user: EntryListResponse.User;
|
|
73
78
|
}
|
|
74
79
|
export declare namespace EntryListResponse {
|
|
75
80
|
/**
|
|
76
|
-
* The
|
|
81
|
+
* The waitlisted plan that this entry is a signup for.
|
|
77
82
|
*/
|
|
78
83
|
interface Plan {
|
|
79
84
|
/**
|
|
80
|
-
* The
|
|
85
|
+
* The unique identifier for the plan.
|
|
81
86
|
*/
|
|
82
87
|
id: string;
|
|
83
88
|
}
|
|
84
89
|
/**
|
|
85
|
-
* The product
|
|
90
|
+
* The product associated with this entry's waitlisted plan. Null if the plan is
|
|
91
|
+
* not tied to a product.
|
|
86
92
|
*/
|
|
87
93
|
interface Product {
|
|
88
94
|
/**
|
|
89
|
-
* The
|
|
95
|
+
* The unique identifier for the product.
|
|
90
96
|
*/
|
|
91
97
|
id: string;
|
|
92
98
|
/**
|
|
93
|
-
* The
|
|
99
|
+
* The display name of the product shown to customers on the product page and in
|
|
100
|
+
* search results.
|
|
94
101
|
*/
|
|
95
102
|
title: string;
|
|
96
103
|
}
|
|
97
104
|
/**
|
|
98
|
-
* The user who
|
|
105
|
+
* The user who submitted this waitlist entry.
|
|
99
106
|
*/
|
|
100
107
|
interface User {
|
|
101
108
|
/**
|
|
102
|
-
* The
|
|
109
|
+
* The unique identifier for the user.
|
|
103
110
|
*/
|
|
104
111
|
id: string;
|
|
105
112
|
/**
|
|
106
|
-
* The email
|
|
113
|
+
* The user's email address. Requires the member:email:read permission to access.
|
|
114
|
+
* Null if not authorized.
|
|
107
115
|
*/
|
|
108
116
|
email: string | null;
|
|
109
117
|
/**
|
|
110
|
-
* The
|
|
118
|
+
* The user's display name shown on their public profile.
|
|
111
119
|
*/
|
|
112
120
|
name: string | null;
|
|
113
121
|
/**
|
|
114
|
-
* The
|
|
122
|
+
* The user's unique username shown on their public profile.
|
|
115
123
|
*/
|
|
116
124
|
username: string;
|
|
117
125
|
}
|
|
@@ -127,7 +135,7 @@ export interface EntryApproveResponse {
|
|
|
127
135
|
}
|
|
128
136
|
export interface EntryListParams extends CursorPageParams {
|
|
129
137
|
/**
|
|
130
|
-
* The
|
|
138
|
+
* The unique identifier of the company to list waitlist entries for.
|
|
131
139
|
*/
|
|
132
140
|
company_id: string;
|
|
133
141
|
/**
|
|
@@ -135,11 +143,11 @@ export interface EntryListParams extends CursorPageParams {
|
|
|
135
143
|
*/
|
|
136
144
|
before?: string | null;
|
|
137
145
|
/**
|
|
138
|
-
*
|
|
146
|
+
* Only return entries created after this timestamp.
|
|
139
147
|
*/
|
|
140
148
|
created_after?: string | null;
|
|
141
149
|
/**
|
|
142
|
-
*
|
|
150
|
+
* Only return entries created before this timestamp.
|
|
143
151
|
*/
|
|
144
152
|
created_before?: string | null;
|
|
145
153
|
/**
|
|
@@ -159,15 +167,15 @@ export interface EntryListParams extends CursorPageParams {
|
|
|
159
167
|
*/
|
|
160
168
|
order?: 'id' | 'created_at' | null;
|
|
161
169
|
/**
|
|
162
|
-
*
|
|
170
|
+
* Filter entries to only those for specific plans.
|
|
163
171
|
*/
|
|
164
172
|
plan_ids?: Array<string> | null;
|
|
165
173
|
/**
|
|
166
|
-
*
|
|
174
|
+
* Filter entries to only those for specific products.
|
|
167
175
|
*/
|
|
168
176
|
product_ids?: Array<string> | null;
|
|
169
177
|
/**
|
|
170
|
-
*
|
|
178
|
+
* Filter entries by their current status.
|
|
171
179
|
*/
|
|
172
180
|
statuses?: Array<Shared.EntryStatus> | null;
|
|
173
181
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entries.d.ts","sourceRoot":"","sources":["../src/resources/entries.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,OAAQ,SAAQ,WAAW;IACtC;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC;IAIxE
|
|
1
|
+
{"version":3,"file":"entries.d.ts","sourceRoot":"","sources":["../src/resources/entries.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,OAAQ,SAAQ,WAAW;IACtC;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC;IAIxE;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,EAAE,eAAe,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,4BAA4B,EAAE,iBAAiB,CAAC;IAI/D;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAI/E;;;;;;;;;OASG;IACH,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC;CAGrE;AAED,MAAM,MAAM,4BAA4B,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAC;AAEzE;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,iBAAiB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,OAAO,EAAE,iBAAiB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE1C;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,WAAW,CAAC;IAE3B;;OAEG;IACH,IAAI,EAAE,iBAAiB,CAAC,IAAI,CAAC;CAC9B;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;;OAGG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;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;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,eAAgB,SAAQ,gBAAgB;IACvD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;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,EAAE,IAAI,GAAG,YAAY,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;CAC7C;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;CACH"}
|
package/resources/entries.js
CHANGED
|
@@ -7,7 +7,7 @@ const pagination_1 = require("../core/pagination.js");
|
|
|
7
7
|
const path_1 = require("../internal/utils/path.js");
|
|
8
8
|
class Entries extends resource_1.APIResource {
|
|
9
9
|
/**
|
|
10
|
-
* Retrieves an
|
|
10
|
+
* Retrieves the details of an existing waitlist entry.
|
|
11
11
|
*
|
|
12
12
|
* Required permissions:
|
|
13
13
|
*
|
|
@@ -18,7 +18,8 @@ class Entries extends resource_1.APIResource {
|
|
|
18
18
|
return this._client.get((0, path_1.path) `/entries/${id}`, options);
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
|
-
*
|
|
21
|
+
* Returns a paginated list of waitlist entries for a company, with optional
|
|
22
|
+
* filtering by product, plan, status, and creation date.
|
|
22
23
|
*
|
|
23
24
|
* Required permissions:
|
|
24
25
|
*
|
|
@@ -29,7 +30,8 @@ class Entries extends resource_1.APIResource {
|
|
|
29
30
|
return this._client.getAPIList('/entries', (pagination_1.CursorPage), { query, ...options });
|
|
30
31
|
}
|
|
31
32
|
/**
|
|
32
|
-
* Approve
|
|
33
|
+
* Approve a pending waitlist entry, triggering the checkout process to grant the
|
|
34
|
+
* user access to the plan.
|
|
33
35
|
*
|
|
34
36
|
* Required permissions:
|
|
35
37
|
*
|
|
@@ -39,7 +41,8 @@ class Entries extends resource_1.APIResource {
|
|
|
39
41
|
return this._client.post((0, path_1.path) `/entries/${id}/approve`, options);
|
|
40
42
|
}
|
|
41
43
|
/**
|
|
42
|
-
* Deny
|
|
44
|
+
* Deny a pending waitlist entry, preventing the user from gaining access to the
|
|
45
|
+
* plan.
|
|
43
46
|
*
|
|
44
47
|
* Required permissions:
|
|
45
48
|
*
|
package/resources/entries.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entries.js","sourceRoot":"","sources":["../src/resources/entries.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"entries.js","sourceRoot":"","sources":["../src/resources/entries.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,KAAsB,EACtB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,CAAA,uBAA6B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,EAAU,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,YAAY,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,EAAU,EAAE,OAAwB;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,YAAY,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;CACF;AAtDD,0BAsDC"}
|
package/resources/entries.mjs
CHANGED
|
@@ -4,7 +4,7 @@ import { CursorPage } from "../core/pagination.mjs";
|
|
|
4
4
|
import { path } from "../internal/utils/path.mjs";
|
|
5
5
|
export class Entries extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
* Retrieves an
|
|
7
|
+
* Retrieves the details of an existing waitlist entry.
|
|
8
8
|
*
|
|
9
9
|
* Required permissions:
|
|
10
10
|
*
|
|
@@ -15,7 +15,8 @@ export class Entries extends APIResource {
|
|
|
15
15
|
return this._client.get(path `/entries/${id}`, options);
|
|
16
16
|
}
|
|
17
17
|
/**
|
|
18
|
-
*
|
|
18
|
+
* Returns a paginated list of waitlist entries for a company, with optional
|
|
19
|
+
* filtering by product, plan, status, and creation date.
|
|
19
20
|
*
|
|
20
21
|
* Required permissions:
|
|
21
22
|
*
|
|
@@ -26,7 +27,8 @@ export class Entries extends APIResource {
|
|
|
26
27
|
return this._client.getAPIList('/entries', (CursorPage), { query, ...options });
|
|
27
28
|
}
|
|
28
29
|
/**
|
|
29
|
-
* Approve
|
|
30
|
+
* Approve a pending waitlist entry, triggering the checkout process to grant the
|
|
31
|
+
* user access to the plan.
|
|
30
32
|
*
|
|
31
33
|
* Required permissions:
|
|
32
34
|
*
|
|
@@ -36,7 +38,8 @@ export class Entries extends APIResource {
|
|
|
36
38
|
return this._client.post(path `/entries/${id}/approve`, options);
|
|
37
39
|
}
|
|
38
40
|
/**
|
|
39
|
-
* Deny
|
|
41
|
+
* Deny a pending waitlist entry, preventing the user from gaining access to the
|
|
42
|
+
* plan.
|
|
40
43
|
*
|
|
41
44
|
* Required permissions:
|
|
42
45
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entries.mjs","sourceRoot":"","sources":["../src/resources/entries.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"entries.mjs","sourceRoot":"","sources":["../src/resources/entries.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,KAAsB,EACtB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,CAAA,UAA6B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,EAAU,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,YAAY,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,EAAU,EAAE,OAAwB;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,YAAY,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;CACF"}
|
|
@@ -19,7 +19,7 @@ export declare class Experiences extends APIResource {
|
|
|
19
19
|
*/
|
|
20
20
|
create(body: ExperienceCreateParams, options?: RequestOptions): APIPromise<Shared.Experience>;
|
|
21
21
|
/**
|
|
22
|
-
* Retrieves an experience
|
|
22
|
+
* Retrieves the details of an existing experience.
|
|
23
23
|
*
|
|
24
24
|
* @example
|
|
25
25
|
* ```ts
|
|
@@ -43,7 +43,8 @@ export declare class Experiences extends APIResource {
|
|
|
43
43
|
*/
|
|
44
44
|
update(id: string, body?: ExperienceUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Shared.Experience>;
|
|
45
45
|
/**
|
|
46
|
-
*
|
|
46
|
+
* Returns a paginated list of experiences belonging to a company, with optional
|
|
47
|
+
* filtering by product and app.
|
|
47
48
|
*
|
|
48
49
|
* Required permissions:
|
|
49
50
|
*
|
|
@@ -74,7 +75,7 @@ export declare class Experiences extends APIResource {
|
|
|
74
75
|
*/
|
|
75
76
|
delete(id: string, options?: RequestOptions): APIPromise<ExperienceDeleteResponse>;
|
|
76
77
|
/**
|
|
77
|
-
*
|
|
78
|
+
* Attach an experience to a product, making it accessible to the product's
|
|
78
79
|
* customers.
|
|
79
80
|
*
|
|
80
81
|
* Required permissions:
|
|
@@ -91,8 +92,8 @@ export declare class Experiences extends APIResource {
|
|
|
91
92
|
*/
|
|
92
93
|
attach(id: string, body: ExperienceAttachParams, options?: RequestOptions): APIPromise<Shared.Experience>;
|
|
93
94
|
/**
|
|
94
|
-
*
|
|
95
|
-
*
|
|
95
|
+
* Detach an experience from a product, removing customer access to it through that
|
|
96
|
+
* product.
|
|
96
97
|
*
|
|
97
98
|
* Required permissions:
|
|
98
99
|
*
|
|
@@ -130,15 +131,16 @@ export declare class Experiences extends APIResource {
|
|
|
130
131
|
}
|
|
131
132
|
export type ExperienceListResponsesCursorPage = CursorPage<ExperienceListResponse>;
|
|
132
133
|
/**
|
|
133
|
-
* An
|
|
134
|
+
* An experience is a feature or content module within a product, such as a chat,
|
|
135
|
+
* course, or custom app.
|
|
134
136
|
*/
|
|
135
137
|
export interface ExperienceListResponse {
|
|
136
138
|
/**
|
|
137
|
-
* The unique
|
|
139
|
+
* The unique identifier for the experience.
|
|
138
140
|
*/
|
|
139
141
|
id: string;
|
|
140
142
|
/**
|
|
141
|
-
* The
|
|
143
|
+
* The app that powers this experience, defining its interface and behavior.
|
|
142
144
|
*/
|
|
143
145
|
app: ExperienceListResponse.App;
|
|
144
146
|
/**
|
|
@@ -146,54 +148,59 @@ export interface ExperienceListResponse {
|
|
|
146
148
|
*/
|
|
147
149
|
company: ExperienceListResponse.Company;
|
|
148
150
|
/**
|
|
149
|
-
* The
|
|
151
|
+
* The datetime the experience was created.
|
|
150
152
|
*/
|
|
151
153
|
created_at: string;
|
|
152
154
|
/**
|
|
153
|
-
* The logo for
|
|
155
|
+
* The custom logo image for this experience. Null if no custom logo has been
|
|
156
|
+
* uploaded.
|
|
154
157
|
*/
|
|
155
158
|
image: ExperienceListResponse.Image | null;
|
|
156
159
|
/**
|
|
157
|
-
* Whether
|
|
160
|
+
* Whether this experience is publicly visible to all users, including those
|
|
161
|
+
* without a membership.
|
|
158
162
|
*/
|
|
159
163
|
is_public: boolean;
|
|
160
164
|
/**
|
|
161
|
-
* The
|
|
165
|
+
* The display name of this experience shown to users in the product navigation.
|
|
166
|
+
* Maximum 255 characters.
|
|
162
167
|
*/
|
|
163
168
|
name: string;
|
|
164
169
|
/**
|
|
165
|
-
* The
|
|
170
|
+
* The sort position of this experience within its section. Lower values appear
|
|
171
|
+
* first. Null if no position has been set.
|
|
166
172
|
*/
|
|
167
173
|
order: string | null;
|
|
168
174
|
}
|
|
169
175
|
export declare namespace ExperienceListResponse {
|
|
170
176
|
/**
|
|
171
|
-
* The
|
|
177
|
+
* The app that powers this experience, defining its interface and behavior.
|
|
172
178
|
*/
|
|
173
179
|
interface App {
|
|
174
180
|
/**
|
|
175
|
-
* The
|
|
181
|
+
* The unique identifier for the app.
|
|
176
182
|
*/
|
|
177
183
|
id: string;
|
|
178
184
|
/**
|
|
179
|
-
* The icon for
|
|
180
|
-
* checkout, and as
|
|
185
|
+
* The icon image for this app, displayed on the app store, product pages,
|
|
186
|
+
* checkout, and as the default icon for experiences using this app.
|
|
181
187
|
*/
|
|
182
188
|
icon: App.Icon | null;
|
|
183
189
|
/**
|
|
184
|
-
* The name of the app
|
|
190
|
+
* The display name of this app shown on the app store and in experience
|
|
191
|
+
* navigation. Maximum 30 characters.
|
|
185
192
|
*/
|
|
186
193
|
name: string;
|
|
187
194
|
}
|
|
188
195
|
namespace App {
|
|
189
196
|
/**
|
|
190
|
-
* The icon for
|
|
191
|
-
* checkout, and as
|
|
197
|
+
* The icon image for this app, displayed on the app store, product pages,
|
|
198
|
+
* checkout, and as the default icon for experiences using this app.
|
|
192
199
|
*/
|
|
193
200
|
interface Icon {
|
|
194
201
|
/**
|
|
195
|
-
*
|
|
196
|
-
*
|
|
202
|
+
* A pre-optimized URL for rendering this attachment on the client. This should be
|
|
203
|
+
* used for displaying attachments in apps.
|
|
197
204
|
*/
|
|
198
205
|
url: string | null;
|
|
199
206
|
}
|
|
@@ -203,25 +210,26 @@ export declare namespace ExperienceListResponse {
|
|
|
203
210
|
*/
|
|
204
211
|
interface Company {
|
|
205
212
|
/**
|
|
206
|
-
* The
|
|
213
|
+
* The unique identifier for the company.
|
|
207
214
|
*/
|
|
208
215
|
id: string;
|
|
209
216
|
/**
|
|
210
|
-
* The slug
|
|
217
|
+
* The URL slug for the company's store page (e.g., 'pickaxe' in whop.com/pickaxe).
|
|
211
218
|
*/
|
|
212
219
|
route: string;
|
|
213
220
|
/**
|
|
214
|
-
* The
|
|
221
|
+
* The display name of the company shown to customers.
|
|
215
222
|
*/
|
|
216
223
|
title: string;
|
|
217
224
|
}
|
|
218
225
|
/**
|
|
219
|
-
* The logo for
|
|
226
|
+
* The custom logo image for this experience. Null if no custom logo has been
|
|
227
|
+
* uploaded.
|
|
220
228
|
*/
|
|
221
229
|
interface Image {
|
|
222
230
|
/**
|
|
223
|
-
*
|
|
224
|
-
*
|
|
231
|
+
* A pre-optimized URL for rendering this attachment on the client. This should be
|
|
232
|
+
* used for displaying attachments in apps.
|
|
225
233
|
*/
|
|
226
234
|
url: string | null;
|
|
227
235
|
}
|
|
@@ -232,33 +240,33 @@ export declare namespace ExperienceListResponse {
|
|
|
232
240
|
export type ExperienceDeleteResponse = boolean;
|
|
233
241
|
export interface ExperienceCreateParams {
|
|
234
242
|
/**
|
|
235
|
-
* The
|
|
243
|
+
* The unique identifier of the app that powers this experience.
|
|
236
244
|
*/
|
|
237
245
|
app_id: string;
|
|
238
246
|
/**
|
|
239
|
-
* The
|
|
247
|
+
* The unique identifier of the company to create this experience for.
|
|
240
248
|
*/
|
|
241
249
|
company_id: string;
|
|
242
250
|
/**
|
|
243
|
-
* Whether the experience is publicly accessible
|
|
251
|
+
* Whether the experience is publicly accessible without a membership.
|
|
244
252
|
*/
|
|
245
253
|
is_public?: boolean | null;
|
|
246
254
|
/**
|
|
247
|
-
*
|
|
255
|
+
* A logo image displayed alongside the experience name.
|
|
248
256
|
*/
|
|
249
257
|
logo?: ExperienceCreateParams.Logo | null;
|
|
250
258
|
/**
|
|
251
|
-
* The name of the experience
|
|
259
|
+
* The display name of the experience. Defaults to the app's name if not provided.
|
|
252
260
|
*/
|
|
253
261
|
name?: string | null;
|
|
254
262
|
/**
|
|
255
|
-
* The
|
|
263
|
+
* The unique identifier of the section to place the experience in.
|
|
256
264
|
*/
|
|
257
265
|
section_id?: string | null;
|
|
258
266
|
}
|
|
259
267
|
export declare namespace ExperienceCreateParams {
|
|
260
268
|
/**
|
|
261
|
-
*
|
|
269
|
+
* A logo image displayed alongside the experience name.
|
|
262
270
|
*/
|
|
263
271
|
interface Logo {
|
|
264
272
|
/**
|
|
@@ -273,29 +281,29 @@ export interface ExperienceUpdateParams {
|
|
|
273
281
|
*/
|
|
274
282
|
access_level?: 'public' | 'private' | null;
|
|
275
283
|
/**
|
|
276
|
-
* Whether the experience is publicly accessible.
|
|
284
|
+
* Whether the experience is publicly accessible without a membership.
|
|
277
285
|
*/
|
|
278
286
|
is_public?: boolean | null;
|
|
279
287
|
/**
|
|
280
|
-
*
|
|
288
|
+
* A logo image displayed alongside the experience name.
|
|
281
289
|
*/
|
|
282
290
|
logo?: ExperienceUpdateParams.Logo | null;
|
|
283
291
|
/**
|
|
284
|
-
* The name of the experience.
|
|
292
|
+
* The display name of the experience.
|
|
285
293
|
*/
|
|
286
294
|
name?: string | null;
|
|
287
295
|
/**
|
|
288
|
-
* The
|
|
296
|
+
* The position of the experience within its section for display ordering.
|
|
289
297
|
*/
|
|
290
298
|
order?: string | null;
|
|
291
299
|
/**
|
|
292
|
-
* The
|
|
300
|
+
* The unique identifier of the section to move the experience into.
|
|
293
301
|
*/
|
|
294
302
|
section_id?: string | null;
|
|
295
303
|
}
|
|
296
304
|
export declare namespace ExperienceUpdateParams {
|
|
297
305
|
/**
|
|
298
|
-
*
|
|
306
|
+
* A logo image displayed alongside the experience name.
|
|
299
307
|
*/
|
|
300
308
|
interface Logo {
|
|
301
309
|
/**
|
|
@@ -306,11 +314,11 @@ export declare namespace ExperienceUpdateParams {
|
|
|
306
314
|
}
|
|
307
315
|
export interface ExperienceListParams extends CursorPageParams {
|
|
308
316
|
/**
|
|
309
|
-
* The
|
|
317
|
+
* The unique identifier of the company to list experiences for.
|
|
310
318
|
*/
|
|
311
319
|
company_id: string;
|
|
312
320
|
/**
|
|
313
|
-
*
|
|
321
|
+
* Filter to only experiences powered by this app identifier.
|
|
314
322
|
*/
|
|
315
323
|
app_id?: string | null;
|
|
316
324
|
/**
|
|
@@ -318,11 +326,11 @@ export interface ExperienceListParams extends CursorPageParams {
|
|
|
318
326
|
*/
|
|
319
327
|
before?: string | null;
|
|
320
328
|
/**
|
|
321
|
-
*
|
|
329
|
+
* Only return experiences created after this timestamp.
|
|
322
330
|
*/
|
|
323
331
|
created_after?: string | null;
|
|
324
332
|
/**
|
|
325
|
-
*
|
|
333
|
+
* Only return experiences created before this timestamp.
|
|
326
334
|
*/
|
|
327
335
|
created_before?: string | null;
|
|
328
336
|
/**
|
|
@@ -334,25 +342,26 @@ export interface ExperienceListParams extends CursorPageParams {
|
|
|
334
342
|
*/
|
|
335
343
|
last?: number | null;
|
|
336
344
|
/**
|
|
337
|
-
*
|
|
345
|
+
* Filter to only experiences attached to this product identifier.
|
|
338
346
|
*/
|
|
339
347
|
product_id?: string | null;
|
|
340
348
|
}
|
|
341
349
|
export interface ExperienceAttachParams {
|
|
342
350
|
/**
|
|
343
|
-
* The
|
|
351
|
+
* The unique identifier of the product to attach the experience to.
|
|
344
352
|
*/
|
|
345
353
|
product_id: string;
|
|
346
354
|
}
|
|
347
355
|
export interface ExperienceDetachParams {
|
|
348
356
|
/**
|
|
349
|
-
* The
|
|
357
|
+
* The unique identifier of the product to detach the experience from.
|
|
350
358
|
*/
|
|
351
359
|
product_id: string;
|
|
352
360
|
}
|
|
353
361
|
export interface ExperienceDuplicateParams {
|
|
354
362
|
/**
|
|
355
|
-
* The name
|
|
363
|
+
* The display name for the duplicated experience. Defaults to the original
|
|
364
|
+
* experience's name.
|
|
356
365
|
*/
|
|
357
366
|
name?: string | null;
|
|
358
367
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"experiences.d.mts","sourceRoot":"","sources":["../src/resources/experiences.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,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI7F;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI7E;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAIhC
|
|
1
|
+
{"version":3,"file":"experiences.d.mts","sourceRoot":"","sources":["../src/resources/experiences.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,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI7F;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI7E;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAIhC;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAAK,EAAE,oBAAoB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,sBAAsB,CAAC;IAIzE;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAIlF;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAIzG;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAIzG;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,CACP,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;CAGjC;AAED,MAAM,MAAM,iCAAiC,GAAG,UAAU,CAAC,sBAAsB,CAAC,CAAC;AAEnF;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,GAAG,EAAE,sBAAsB,CAAC,GAAG,CAAC;IAEhC;;OAEG;IACH,OAAO,EAAE,sBAAsB,CAAC,OAAO,CAAC;IAExC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,KAAK,EAAE,sBAAsB,CAAC,KAAK,GAAG,IAAI,CAAC;IAE3C;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,GAAG;QAClB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,IAAI,EAAE,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC;QAEtB;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,GAAG,CAAC;QACnB;;;WAGG;QACH,UAAiB,IAAI;YACnB;;;eAGG;YACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;SACpB;KACF;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;;OAGG;IACH,UAAiB,KAAK;QACpB;;;WAGG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;CACF;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,OAAO,CAAC;AAE/C,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,sBAAsB,CAAC,IAAI,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,YAAY,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,sBAAsB,CAAC,IAAI,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;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,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}
|