@whop/sdk 0.0.27 → 0.0.29
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 +75 -0
- package/client.d.mts +9 -6
- package/client.d.mts.map +1 -1
- package/client.d.ts +9 -6
- package/client.d.ts.map +1 -1
- package/client.js +10 -0
- package/client.js.map +1 -1
- package/client.mjs +10 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/access-tokens.d.mts +19 -20
- package/resources/access-tokens.d.mts.map +1 -1
- package/resources/access-tokens.d.ts +19 -20
- package/resources/access-tokens.d.ts.map +1 -1
- package/resources/access-tokens.js +4 -4
- package/resources/access-tokens.mjs +4 -4
- 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 +38 -26
- package/resources/ai-chats.d.mts.map +1 -1
- package/resources/ai-chats.d.ts +38 -26
- package/resources/ai-chats.d.ts.map +1 -1
- package/resources/ai-chats.js +5 -5
- package/resources/ai-chats.mjs +5 -5
- package/resources/app-builds.d.mts +35 -33
- package/resources/app-builds.d.mts.map +1 -1
- package/resources/app-builds.d.ts +35 -33
- 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 +81 -56
- package/resources/apps.d.mts.map +1 -1
- package/resources/apps.d.ts +81 -56
- 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 +32 -26
- package/resources/authorized-users.d.mts.map +1 -1
- package/resources/authorized-users.d.ts +32 -26
- 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 +27 -19
- package/resources/chat-channels.d.mts.map +1 -1
- package/resources/chat-channels.d.ts +27 -19
- 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 +55 -46
- package/resources/checkout-configurations.d.mts.map +1 -1
- package/resources/checkout-configurations.d.ts +55 -46
- 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 +71 -46
- package/resources/companies.d.mts.map +1 -1
- package/resources/companies.d.ts +71 -46
- package/resources/companies.d.ts.map +1 -1
- package/resources/companies.js +7 -8
- package/resources/companies.js.map +1 -1
- package/resources/companies.mjs +7 -8
- package/resources/companies.mjs.map +1 -1
- package/resources/company-token-transactions.d.mts +80 -57
- package/resources/company-token-transactions.d.mts.map +1 -1
- package/resources/company-token-transactions.d.ts +80 -57
- 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 +24 -19
- package/resources/course-chapters.d.mts.map +1 -1
- package/resources/course-chapters.d.ts +24 -19
- 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 +126 -84
- package/resources/course-lessons.d.mts.map +1 -1
- package/resources/course-lessons.d.ts +126 -84
- 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 +38 -29
- package/resources/course-students.d.mts.map +1 -1
- package/resources/course-students.d.ts +38 -29
- 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 +132 -91
- package/resources/courses.d.mts.map +1 -1
- package/resources/courses.d.ts +132 -91
- 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/dispute-alerts.d.mts +325 -0
- package/resources/dispute-alerts.d.mts.map +1 -0
- package/resources/dispute-alerts.d.ts +325 -0
- package/resources/dispute-alerts.d.ts.map +1 -0
- package/resources/dispute-alerts.js +42 -0
- package/resources/dispute-alerts.js.map +1 -0
- package/resources/dispute-alerts.mjs +38 -0
- package/resources/dispute-alerts.mjs.map +1 -0
- package/resources/disputes.d.mts +156 -102
- package/resources/disputes.d.mts.map +1 -1
- package/resources/disputes.d.ts +156 -102
- 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 +29 -21
- package/resources/entries.d.mts.map +1 -1
- package/resources/entries.d.ts +29 -21
- 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 +53 -49
- package/resources/experiences.d.mts.map +1 -1
- package/resources/experiences.d.ts +53 -49
- package/resources/experiences.d.ts.map +1 -1
- package/resources/experiences.js +6 -9
- package/resources/experiences.js.map +1 -1
- package/resources/experiences.mjs +6 -9
- package/resources/experiences.mjs.map +1 -1
- package/resources/fee-markups.d.mts +32 -21
- package/resources/fee-markups.d.mts.map +1 -1
- package/resources/fee-markups.d.ts +32 -21
- 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 +21 -17
- package/resources/files.d.mts.map +1 -1
- package/resources/files.d.ts +21 -17
- 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 +62 -43
- package/resources/forum-posts.d.mts.map +1 -1
- package/resources/forum-posts.d.ts +62 -43
- 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 +20 -12
- package/resources/forums.d.mts.map +1 -1
- package/resources/forums.d.ts +20 -12
- 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 +4 -3
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +4 -3
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/invoices.d.mts +108 -80
- package/resources/invoices.d.mts.map +1 -1
- package/resources/invoices.d.ts +108 -80
- 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 +64 -42
- package/resources/leads.d.mts.map +1 -1
- package/resources/leads.d.ts +64 -42
- 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 +10 -8
- package/resources/ledger-accounts.d.mts.map +1 -1
- package/resources/ledger-accounts.d.ts +10 -8
- 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 +18 -19
- package/resources/members.d.mts.map +1 -1
- package/resources/members.d.ts +18 -19
- 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 +69 -51
- package/resources/memberships.d.mts.map +1 -1
- package/resources/memberships.d.ts +69 -51
- 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 +50 -32
- package/resources/messages.d.mts.map +1 -1
- package/resources/messages.d.ts +50 -32
- 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 +73 -40
- package/resources/payments.d.mts.map +1 -1
- package/resources/payments.d.ts +73 -40
- 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 +44 -29
- package/resources/payout-methods.d.mts.map +1 -1
- package/resources/payout-methods.d.ts +44 -29
- 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 +121 -90
- package/resources/plans.d.mts.map +1 -1
- package/resources/plans.d.ts +121 -90
- 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 +76 -65
- package/resources/products.d.mts.map +1 -1
- package/resources/products.d.ts +76 -65
- 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 +41 -31
- package/resources/promo-codes.d.mts.map +1 -1
- package/resources/promo-codes.d.ts +41 -31
- 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 +24 -18
- package/resources/reactions.d.mts.map +1 -1
- package/resources/reactions.d.ts +24 -18
- 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 +43 -29
- package/resources/refunds.d.mts.map +1 -1
- package/resources/refunds.d.ts +43 -29
- 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 +66 -50
- package/resources/reviews.d.mts.map +1 -1
- package/resources/reviews.d.ts +66 -50
- 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 +61 -43
- package/resources/setup-intents.d.mts.map +1 -1
- package/resources/setup-intents.d.ts +61 -43
- 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 +696 -389
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +696 -389
- package/resources/shared.d.ts.map +1 -1
- package/resources/shipments.d.mts +26 -17
- package/resources/shipments.d.mts.map +1 -1
- package/resources/shipments.d.ts +26 -17
- 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 +31 -19
- package/resources/support-channels.d.mts.map +1 -1
- package/resources/support-channels.d.ts +31 -19
- 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 +11 -9
- package/resources/topups.d.mts.map +1 -1
- package/resources/topups.d.ts +11 -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 +35 -29
- package/resources/transfers.d.mts.map +1 -1
- package/resources/transfers.d.ts +35 -29
- 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 +20 -16
- package/resources/users.d.mts.map +1 -1
- package/resources/users.d.ts +20 -16
- package/resources/users.d.ts.map +1 -1
- package/resources/users.js +4 -3
- package/resources/users.js.map +1 -1
- package/resources/users.mjs +4 -3
- package/resources/users.mjs.map +1 -1
- package/resources/verifications.d.mts +6 -4
- package/resources/verifications.d.mts.map +1 -1
- package/resources/verifications.d.ts +6 -4
- 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 +360 -98
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +360 -98
- 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 +53 -44
- package/resources/withdrawals.d.mts.map +1 -1
- package/resources/withdrawals.d.ts +53 -44
- 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 +34 -3
- package/src/resources/access-tokens.ts +19 -20
- package/src/resources/account-links.ts +15 -13
- package/src/resources/ai-chats.ts +39 -26
- package/src/resources/app-builds.ts +35 -33
- package/src/resources/apps.ts +84 -56
- package/src/resources/authorized-users.ts +32 -26
- package/src/resources/chat-channels.ts +27 -19
- package/src/resources/checkout-configurations.ts +56 -46
- package/src/resources/companies.ts +75 -46
- package/src/resources/company-token-transactions.ts +81 -58
- package/src/resources/course-chapters.ts +24 -19
- package/src/resources/course-lesson-interactions.ts +7 -6
- package/src/resources/course-lessons.ts +126 -84
- package/src/resources/course-students.ts +38 -29
- package/src/resources/courses.ts +132 -91
- package/src/resources/dispute-alerts.ts +404 -0
- package/src/resources/disputes.ts +156 -102
- package/src/resources/dm-channels.ts +29 -16
- package/src/resources/dm-members.ts +30 -21
- package/src/resources/entries.ts +29 -21
- package/src/resources/experiences.ts +53 -49
- package/src/resources/fee-markups.ts +32 -21
- package/src/resources/files.ts +21 -17
- package/src/resources/forum-posts.ts +63 -43
- package/src/resources/forums.ts +20 -12
- package/src/resources/index.ts +11 -1
- package/src/resources/invoices.ts +112 -80
- package/src/resources/leads.ts +64 -42
- package/src/resources/ledger-accounts.ts +10 -8
- package/src/resources/members.ts +18 -19
- package/src/resources/memberships.ts +69 -51
- package/src/resources/messages.ts +51 -32
- package/src/resources/notifications.ts +33 -25
- package/src/resources/payment-methods.ts +212 -114
- package/src/resources/payments.ts +78 -39
- package/src/resources/payout-methods.ts +44 -29
- package/src/resources/plans.ts +121 -90
- package/src/resources/products.ts +219 -68
- package/src/resources/promo-codes.ts +41 -31
- package/src/resources/reactions.ts +24 -18
- package/src/resources/refunds.ts +45 -29
- package/src/resources/reviews.ts +66 -50
- package/src/resources/setup-intents.ts +61 -43
- package/src/resources/shared.ts +2649 -388
- package/src/resources/shipments.ts +26 -17
- package/src/resources/support-channels.ts +32 -19
- package/src/resources/topups.ts +11 -9
- package/src/resources/transfers.ts +35 -29
- package/src/resources/users.ts +20 -16
- package/src/resources/verifications.ts +6 -4
- package/src/resources/webhooks.ts +404 -95
- package/src/resources/withdrawals.ts +53 -43
- 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
|
*
|
|
@@ -55,25 +58,27 @@ export interface EntryListResponse {
|
|
|
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
|
/**
|
|
@@ -82,7 +87,8 @@ export declare namespace EntryListResponse {
|
|
|
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
|
/**
|
|
@@ -90,12 +96,13 @@ export declare namespace EntryListResponse {
|
|
|
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
|
/**
|
|
@@ -103,15 +110,16 @@ export declare namespace EntryListResponse {
|
|
|
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,11 +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
|
-
*
|
|
47
|
-
*
|
|
48
|
-
* Required permissions:
|
|
49
|
-
*
|
|
50
|
-
* - `experience:hidden_experience:read`
|
|
46
|
+
* Returns a paginated list of experiences belonging to a company, with optional
|
|
47
|
+
* filtering by product and app.
|
|
51
48
|
*
|
|
52
49
|
* @example
|
|
53
50
|
* ```ts
|
|
@@ -74,7 +71,7 @@ export declare class Experiences extends APIResource {
|
|
|
74
71
|
*/
|
|
75
72
|
delete(id: string, options?: RequestOptions): APIPromise<ExperienceDeleteResponse>;
|
|
76
73
|
/**
|
|
77
|
-
*
|
|
74
|
+
* Attach an experience to a product, making it accessible to the product's
|
|
78
75
|
* customers.
|
|
79
76
|
*
|
|
80
77
|
* Required permissions:
|
|
@@ -91,8 +88,8 @@ export declare class Experiences extends APIResource {
|
|
|
91
88
|
*/
|
|
92
89
|
attach(id: string, body: ExperienceAttachParams, options?: RequestOptions): APIPromise<Shared.Experience>;
|
|
93
90
|
/**
|
|
94
|
-
*
|
|
95
|
-
*
|
|
91
|
+
* Detach an experience from a product, removing customer access to it through that
|
|
92
|
+
* product.
|
|
96
93
|
*
|
|
97
94
|
* Required permissions:
|
|
98
95
|
*
|
|
@@ -131,7 +128,7 @@ export declare class Experiences extends APIResource {
|
|
|
131
128
|
export type ExperienceListResponsesCursorPage = CursorPage<ExperienceListResponse>;
|
|
132
129
|
/**
|
|
133
130
|
* An experience is a feature or content module within a product, such as a chat,
|
|
134
|
-
* course, or app.
|
|
131
|
+
* course, or custom app.
|
|
135
132
|
*/
|
|
136
133
|
export interface ExperienceListResponse {
|
|
137
134
|
/**
|
|
@@ -139,7 +136,7 @@ export interface ExperienceListResponse {
|
|
|
139
136
|
*/
|
|
140
137
|
id: string;
|
|
141
138
|
/**
|
|
142
|
-
* The
|
|
139
|
+
* The app that powers this experience, defining its interface and behavior.
|
|
143
140
|
*/
|
|
144
141
|
app: ExperienceListResponse.App;
|
|
145
142
|
/**
|
|
@@ -151,25 +148,29 @@ export interface ExperienceListResponse {
|
|
|
151
148
|
*/
|
|
152
149
|
created_at: string;
|
|
153
150
|
/**
|
|
154
|
-
* The logo for
|
|
151
|
+
* The custom logo image for this experience. Null if no custom logo has been
|
|
152
|
+
* uploaded.
|
|
155
153
|
*/
|
|
156
154
|
image: ExperienceListResponse.Image | null;
|
|
157
155
|
/**
|
|
158
|
-
* Whether
|
|
156
|
+
* Whether this experience is publicly visible to all users, including those
|
|
157
|
+
* without a membership.
|
|
159
158
|
*/
|
|
160
159
|
is_public: boolean;
|
|
161
160
|
/**
|
|
162
|
-
* The
|
|
161
|
+
* The display name of this experience shown to users in the product navigation.
|
|
162
|
+
* Maximum 255 characters.
|
|
163
163
|
*/
|
|
164
164
|
name: string;
|
|
165
165
|
/**
|
|
166
|
-
* The
|
|
166
|
+
* The sort position of this experience within its section. Lower values appear
|
|
167
|
+
* first. Null if no position has been set.
|
|
167
168
|
*/
|
|
168
169
|
order: string | null;
|
|
169
170
|
}
|
|
170
171
|
export declare namespace ExperienceListResponse {
|
|
171
172
|
/**
|
|
172
|
-
* The
|
|
173
|
+
* The app that powers this experience, defining its interface and behavior.
|
|
173
174
|
*/
|
|
174
175
|
interface App {
|
|
175
176
|
/**
|
|
@@ -177,24 +178,25 @@ export declare namespace ExperienceListResponse {
|
|
|
177
178
|
*/
|
|
178
179
|
id: string;
|
|
179
180
|
/**
|
|
180
|
-
* The icon for
|
|
181
|
-
* checkout, and as
|
|
181
|
+
* The icon image for this app, displayed on the app store, product pages,
|
|
182
|
+
* checkout, and as the default icon for experiences using this app.
|
|
182
183
|
*/
|
|
183
184
|
icon: App.Icon | null;
|
|
184
185
|
/**
|
|
185
|
-
* The name of the app
|
|
186
|
+
* The display name of this app shown on the app store and in experience
|
|
187
|
+
* navigation. Maximum 30 characters.
|
|
186
188
|
*/
|
|
187
189
|
name: string;
|
|
188
190
|
}
|
|
189
191
|
namespace App {
|
|
190
192
|
/**
|
|
191
|
-
* The icon for
|
|
192
|
-
* checkout, and as
|
|
193
|
+
* The icon image for this app, displayed on the app store, product pages,
|
|
194
|
+
* checkout, and as the default icon for experiences using this app.
|
|
193
195
|
*/
|
|
194
196
|
interface Icon {
|
|
195
197
|
/**
|
|
196
|
-
*
|
|
197
|
-
*
|
|
198
|
+
* A pre-optimized URL for rendering this attachment on the client. This should be
|
|
199
|
+
* used for displaying attachments in apps.
|
|
198
200
|
*/
|
|
199
201
|
url: string | null;
|
|
200
202
|
}
|
|
@@ -208,21 +210,22 @@ export declare namespace ExperienceListResponse {
|
|
|
208
210
|
*/
|
|
209
211
|
id: string;
|
|
210
212
|
/**
|
|
211
|
-
* The slug
|
|
213
|
+
* The URL slug for the company's store page (e.g., 'pickaxe' in whop.com/pickaxe).
|
|
212
214
|
*/
|
|
213
215
|
route: string;
|
|
214
216
|
/**
|
|
215
|
-
* The
|
|
217
|
+
* The display name of the company shown to customers.
|
|
216
218
|
*/
|
|
217
219
|
title: string;
|
|
218
220
|
}
|
|
219
221
|
/**
|
|
220
|
-
* The logo for
|
|
222
|
+
* The custom logo image for this experience. Null if no custom logo has been
|
|
223
|
+
* uploaded.
|
|
221
224
|
*/
|
|
222
225
|
interface Image {
|
|
223
226
|
/**
|
|
224
|
-
*
|
|
225
|
-
*
|
|
227
|
+
* A pre-optimized URL for rendering this attachment on the client. This should be
|
|
228
|
+
* used for displaying attachments in apps.
|
|
226
229
|
*/
|
|
227
230
|
url: string | null;
|
|
228
231
|
}
|
|
@@ -233,33 +236,33 @@ export declare namespace ExperienceListResponse {
|
|
|
233
236
|
export type ExperienceDeleteResponse = boolean;
|
|
234
237
|
export interface ExperienceCreateParams {
|
|
235
238
|
/**
|
|
236
|
-
* The
|
|
239
|
+
* The unique identifier of the app that powers this experience.
|
|
237
240
|
*/
|
|
238
241
|
app_id: string;
|
|
239
242
|
/**
|
|
240
|
-
* The
|
|
243
|
+
* The unique identifier of the company to create this experience for.
|
|
241
244
|
*/
|
|
242
245
|
company_id: string;
|
|
243
246
|
/**
|
|
244
|
-
* Whether the experience is publicly accessible
|
|
247
|
+
* Whether the experience is publicly accessible without a membership.
|
|
245
248
|
*/
|
|
246
249
|
is_public?: boolean | null;
|
|
247
250
|
/**
|
|
248
|
-
*
|
|
251
|
+
* A logo image displayed alongside the experience name.
|
|
249
252
|
*/
|
|
250
253
|
logo?: ExperienceCreateParams.Logo | null;
|
|
251
254
|
/**
|
|
252
|
-
* The name of the experience
|
|
255
|
+
* The display name of the experience. Defaults to the app's name if not provided.
|
|
253
256
|
*/
|
|
254
257
|
name?: string | null;
|
|
255
258
|
/**
|
|
256
|
-
* The
|
|
259
|
+
* The unique identifier of the section to place the experience in.
|
|
257
260
|
*/
|
|
258
261
|
section_id?: string | null;
|
|
259
262
|
}
|
|
260
263
|
export declare namespace ExperienceCreateParams {
|
|
261
264
|
/**
|
|
262
|
-
*
|
|
265
|
+
* A logo image displayed alongside the experience name.
|
|
263
266
|
*/
|
|
264
267
|
interface Logo {
|
|
265
268
|
/**
|
|
@@ -274,29 +277,29 @@ export interface ExperienceUpdateParams {
|
|
|
274
277
|
*/
|
|
275
278
|
access_level?: 'public' | 'private' | null;
|
|
276
279
|
/**
|
|
277
|
-
* Whether the experience is publicly accessible.
|
|
280
|
+
* Whether the experience is publicly accessible without a membership.
|
|
278
281
|
*/
|
|
279
282
|
is_public?: boolean | null;
|
|
280
283
|
/**
|
|
281
|
-
*
|
|
284
|
+
* A logo image displayed alongside the experience name.
|
|
282
285
|
*/
|
|
283
286
|
logo?: ExperienceUpdateParams.Logo | null;
|
|
284
287
|
/**
|
|
285
|
-
* The name of the experience.
|
|
288
|
+
* The display name of the experience.
|
|
286
289
|
*/
|
|
287
290
|
name?: string | null;
|
|
288
291
|
/**
|
|
289
|
-
* The
|
|
292
|
+
* The position of the experience within its section for display ordering.
|
|
290
293
|
*/
|
|
291
294
|
order?: string | null;
|
|
292
295
|
/**
|
|
293
|
-
* The
|
|
296
|
+
* The unique identifier of the section to move the experience into.
|
|
294
297
|
*/
|
|
295
298
|
section_id?: string | null;
|
|
296
299
|
}
|
|
297
300
|
export declare namespace ExperienceUpdateParams {
|
|
298
301
|
/**
|
|
299
|
-
*
|
|
302
|
+
* A logo image displayed alongside the experience name.
|
|
300
303
|
*/
|
|
301
304
|
interface Logo {
|
|
302
305
|
/**
|
|
@@ -307,11 +310,11 @@ export declare namespace ExperienceUpdateParams {
|
|
|
307
310
|
}
|
|
308
311
|
export interface ExperienceListParams extends CursorPageParams {
|
|
309
312
|
/**
|
|
310
|
-
* The
|
|
313
|
+
* The unique identifier of the company to list experiences for.
|
|
311
314
|
*/
|
|
312
315
|
company_id: string;
|
|
313
316
|
/**
|
|
314
|
-
*
|
|
317
|
+
* Filter to only experiences powered by this app identifier.
|
|
315
318
|
*/
|
|
316
319
|
app_id?: string | null;
|
|
317
320
|
/**
|
|
@@ -319,11 +322,11 @@ export interface ExperienceListParams extends CursorPageParams {
|
|
|
319
322
|
*/
|
|
320
323
|
before?: string | null;
|
|
321
324
|
/**
|
|
322
|
-
*
|
|
325
|
+
* Only return experiences created after this timestamp.
|
|
323
326
|
*/
|
|
324
327
|
created_after?: string | null;
|
|
325
328
|
/**
|
|
326
|
-
*
|
|
329
|
+
* Only return experiences created before this timestamp.
|
|
327
330
|
*/
|
|
328
331
|
created_before?: string | null;
|
|
329
332
|
/**
|
|
@@ -335,25 +338,26 @@ export interface ExperienceListParams extends CursorPageParams {
|
|
|
335
338
|
*/
|
|
336
339
|
last?: number | null;
|
|
337
340
|
/**
|
|
338
|
-
*
|
|
341
|
+
* Filter to only experiences attached to this product identifier.
|
|
339
342
|
*/
|
|
340
343
|
product_id?: string | null;
|
|
341
344
|
}
|
|
342
345
|
export interface ExperienceAttachParams {
|
|
343
346
|
/**
|
|
344
|
-
* The
|
|
347
|
+
* The unique identifier of the product to attach the experience to.
|
|
345
348
|
*/
|
|
346
349
|
product_id: string;
|
|
347
350
|
}
|
|
348
351
|
export interface ExperienceDetachParams {
|
|
349
352
|
/**
|
|
350
|
-
* The
|
|
353
|
+
* The unique identifier of the product to detach the experience from.
|
|
351
354
|
*/
|
|
352
355
|
product_id: string;
|
|
353
356
|
}
|
|
354
357
|
export interface ExperienceDuplicateParams {
|
|
355
358
|
/**
|
|
356
|
-
* The name
|
|
359
|
+
* The display name for the duplicated experience. Defaults to the original
|
|
360
|
+
* experience's name.
|
|
357
361
|
*/
|
|
358
362
|
name?: string | null;
|
|
359
363
|
}
|
|
@@ -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;;;;;;;;;;;;;OAaG;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"}
|