@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/leads.d.ts
CHANGED
|
@@ -4,7 +4,8 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
|
|
|
4
4
|
import { RequestOptions } from "../internal/request-options.js";
|
|
5
5
|
export declare class Leads extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* Record a new lead for a company, capturing a potential customer's interest in a
|
|
8
|
+
* specific product.
|
|
8
9
|
*
|
|
9
10
|
* Required permissions:
|
|
10
11
|
*
|
|
@@ -22,7 +23,7 @@ export declare class Leads extends APIResource {
|
|
|
22
23
|
*/
|
|
23
24
|
create(body: LeadCreateParams, options?: RequestOptions): APIPromise<Lead>;
|
|
24
25
|
/**
|
|
25
|
-
* Retrieves
|
|
26
|
+
* Retrieves the details of an existing lead.
|
|
26
27
|
*
|
|
27
28
|
* Required permissions:
|
|
28
29
|
*
|
|
@@ -40,7 +41,7 @@ export declare class Leads extends APIResource {
|
|
|
40
41
|
*/
|
|
41
42
|
retrieve(id: string, options?: RequestOptions): APIPromise<Lead>;
|
|
42
43
|
/**
|
|
43
|
-
*
|
|
44
|
+
* Update the metadata or referrer information on an existing lead record.
|
|
44
45
|
*
|
|
45
46
|
* Required permissions:
|
|
46
47
|
*
|
|
@@ -58,7 +59,8 @@ export declare class Leads extends APIResource {
|
|
|
58
59
|
*/
|
|
59
60
|
update(id: string, body?: LeadUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Lead>;
|
|
60
61
|
/**
|
|
61
|
-
*
|
|
62
|
+
* Returns a paginated list of leads for a company, with optional filtering by
|
|
63
|
+
* product and creation date.
|
|
62
64
|
*
|
|
63
65
|
* Required permissions:
|
|
64
66
|
*
|
|
@@ -81,213 +83,233 @@ export declare class Leads extends APIResource {
|
|
|
81
83
|
}
|
|
82
84
|
export type LeadListResponsesCursorPage = CursorPage<LeadListResponse>;
|
|
83
85
|
/**
|
|
84
|
-
*
|
|
86
|
+
* A prospective customer who has expressed interest in a company or product but
|
|
87
|
+
* has not yet purchased.
|
|
85
88
|
*/
|
|
86
89
|
export interface Lead {
|
|
87
90
|
/**
|
|
88
|
-
* The
|
|
91
|
+
* The unique identifier for the lead.
|
|
89
92
|
*/
|
|
90
93
|
id: string;
|
|
91
94
|
/**
|
|
92
|
-
* The
|
|
95
|
+
* The datetime the lead was created.
|
|
93
96
|
*/
|
|
94
97
|
created_at: string;
|
|
95
98
|
/**
|
|
96
|
-
* The
|
|
99
|
+
* The company member record if this lead has converted into a paying customer.
|
|
100
|
+
* Null if the lead has not converted.
|
|
97
101
|
*/
|
|
98
102
|
member: Lead.Member | null;
|
|
99
103
|
/**
|
|
100
|
-
* Custom
|
|
104
|
+
* Custom key-value pairs attached to this lead. Null if no metadata was provided.
|
|
101
105
|
*/
|
|
102
106
|
metadata: {
|
|
103
107
|
[key: string]: unknown;
|
|
104
108
|
} | null;
|
|
105
109
|
/**
|
|
106
|
-
* The
|
|
110
|
+
* The product the lead expressed interest in. Null if the lead is not associated
|
|
111
|
+
* with a specific product.
|
|
107
112
|
*/
|
|
108
113
|
product: Lead.Product | null;
|
|
109
114
|
/**
|
|
110
|
-
* The
|
|
115
|
+
* The URL of the page that referred this lead to the company. Null if no referrer
|
|
116
|
+
* was captured.
|
|
111
117
|
*/
|
|
112
118
|
referrer: string | null;
|
|
113
119
|
/**
|
|
114
|
-
* The
|
|
120
|
+
* The datetime the lead was last updated.
|
|
115
121
|
*/
|
|
116
122
|
updated_at: string;
|
|
117
123
|
/**
|
|
118
|
-
* The user
|
|
124
|
+
* The user account associated with this lead.
|
|
119
125
|
*/
|
|
120
126
|
user: Lead.User;
|
|
121
127
|
}
|
|
122
128
|
export declare namespace Lead {
|
|
123
129
|
/**
|
|
124
|
-
* The
|
|
130
|
+
* The company member record if this lead has converted into a paying customer.
|
|
131
|
+
* Null if the lead has not converted.
|
|
125
132
|
*/
|
|
126
133
|
interface Member {
|
|
127
134
|
/**
|
|
128
|
-
* The
|
|
135
|
+
* The unique identifier for the company member.
|
|
129
136
|
*/
|
|
130
137
|
id: string;
|
|
131
138
|
}
|
|
132
139
|
/**
|
|
133
|
-
* The
|
|
140
|
+
* The product the lead expressed interest in. Null if the lead is not associated
|
|
141
|
+
* with a specific product.
|
|
134
142
|
*/
|
|
135
143
|
interface Product {
|
|
136
144
|
/**
|
|
137
|
-
* The
|
|
145
|
+
* The unique identifier for the product.
|
|
138
146
|
*/
|
|
139
147
|
id: string;
|
|
140
148
|
/**
|
|
141
|
-
* The
|
|
149
|
+
* The display name of the product shown to customers on the product page and in
|
|
150
|
+
* search results.
|
|
142
151
|
*/
|
|
143
152
|
title: string;
|
|
144
153
|
}
|
|
145
154
|
/**
|
|
146
|
-
* The user
|
|
155
|
+
* The user account associated with this lead.
|
|
147
156
|
*/
|
|
148
157
|
interface User {
|
|
149
158
|
/**
|
|
150
|
-
* The
|
|
159
|
+
* The unique identifier for the user.
|
|
151
160
|
*/
|
|
152
161
|
id: string;
|
|
153
162
|
/**
|
|
154
|
-
* The email
|
|
163
|
+
* The user's email address. Requires the member:email:read permission to access.
|
|
164
|
+
* Null if not authorized.
|
|
155
165
|
*/
|
|
156
166
|
email: string | null;
|
|
157
167
|
/**
|
|
158
|
-
* The
|
|
168
|
+
* The user's display name shown on their public profile.
|
|
159
169
|
*/
|
|
160
170
|
name: string | null;
|
|
161
171
|
/**
|
|
162
|
-
* The
|
|
172
|
+
* The user's unique username shown on their public profile.
|
|
163
173
|
*/
|
|
164
174
|
username: string;
|
|
165
175
|
}
|
|
166
176
|
}
|
|
167
177
|
/**
|
|
168
|
-
*
|
|
178
|
+
* A prospective customer who has expressed interest in a company or product but
|
|
179
|
+
* has not yet purchased.
|
|
169
180
|
*/
|
|
170
181
|
export interface LeadListResponse {
|
|
171
182
|
/**
|
|
172
|
-
* The
|
|
183
|
+
* The unique identifier for the lead.
|
|
173
184
|
*/
|
|
174
185
|
id: string;
|
|
175
186
|
/**
|
|
176
|
-
* The
|
|
187
|
+
* The datetime the lead was created.
|
|
177
188
|
*/
|
|
178
189
|
created_at: string;
|
|
179
190
|
/**
|
|
180
|
-
* The
|
|
191
|
+
* The company member record if this lead has converted into a paying customer.
|
|
192
|
+
* Null if the lead has not converted.
|
|
181
193
|
*/
|
|
182
194
|
member: LeadListResponse.Member | null;
|
|
183
195
|
/**
|
|
184
|
-
* Custom
|
|
196
|
+
* Custom key-value pairs attached to this lead. Null if no metadata was provided.
|
|
185
197
|
*/
|
|
186
198
|
metadata: {
|
|
187
199
|
[key: string]: unknown;
|
|
188
200
|
} | null;
|
|
189
201
|
/**
|
|
190
|
-
* The
|
|
202
|
+
* The product the lead expressed interest in. Null if the lead is not associated
|
|
203
|
+
* with a specific product.
|
|
191
204
|
*/
|
|
192
205
|
product: LeadListResponse.Product | null;
|
|
193
206
|
/**
|
|
194
|
-
* The
|
|
207
|
+
* The URL of the page that referred this lead to the company. Null if no referrer
|
|
208
|
+
* was captured.
|
|
195
209
|
*/
|
|
196
210
|
referrer: string | null;
|
|
197
211
|
/**
|
|
198
|
-
* The
|
|
212
|
+
* The datetime the lead was last updated.
|
|
199
213
|
*/
|
|
200
214
|
updated_at: string;
|
|
201
215
|
/**
|
|
202
|
-
* The user
|
|
216
|
+
* The user account associated with this lead.
|
|
203
217
|
*/
|
|
204
218
|
user: LeadListResponse.User;
|
|
205
219
|
}
|
|
206
220
|
export declare namespace LeadListResponse {
|
|
207
221
|
/**
|
|
208
|
-
* The
|
|
222
|
+
* The company member record if this lead has converted into a paying customer.
|
|
223
|
+
* Null if the lead has not converted.
|
|
209
224
|
*/
|
|
210
225
|
interface Member {
|
|
211
226
|
/**
|
|
212
|
-
* The
|
|
227
|
+
* The unique identifier for the company member.
|
|
213
228
|
*/
|
|
214
229
|
id: string;
|
|
215
230
|
}
|
|
216
231
|
/**
|
|
217
|
-
* The
|
|
232
|
+
* The product the lead expressed interest in. Null if the lead is not associated
|
|
233
|
+
* with a specific product.
|
|
218
234
|
*/
|
|
219
235
|
interface Product {
|
|
220
236
|
/**
|
|
221
|
-
* The
|
|
237
|
+
* The unique identifier for the product.
|
|
222
238
|
*/
|
|
223
239
|
id: string;
|
|
224
240
|
/**
|
|
225
|
-
* The
|
|
241
|
+
* The display name of the product shown to customers on the product page and in
|
|
242
|
+
* search results.
|
|
226
243
|
*/
|
|
227
244
|
title: string;
|
|
228
245
|
}
|
|
229
246
|
/**
|
|
230
|
-
* The user
|
|
247
|
+
* The user account associated with this lead.
|
|
231
248
|
*/
|
|
232
249
|
interface User {
|
|
233
250
|
/**
|
|
234
|
-
* The
|
|
251
|
+
* The unique identifier for the user.
|
|
235
252
|
*/
|
|
236
253
|
id: string;
|
|
237
254
|
/**
|
|
238
|
-
* The email
|
|
255
|
+
* The user's email address. Requires the member:email:read permission to access.
|
|
256
|
+
* Null if not authorized.
|
|
239
257
|
*/
|
|
240
258
|
email: string | null;
|
|
241
259
|
/**
|
|
242
|
-
* The
|
|
260
|
+
* The user's display name shown on their public profile.
|
|
243
261
|
*/
|
|
244
262
|
name: string | null;
|
|
245
263
|
/**
|
|
246
|
-
* The
|
|
264
|
+
* The user's unique username shown on their public profile.
|
|
247
265
|
*/
|
|
248
266
|
username: string;
|
|
249
267
|
}
|
|
250
268
|
}
|
|
251
269
|
export interface LeadCreateParams {
|
|
252
270
|
/**
|
|
253
|
-
* The
|
|
271
|
+
* The unique identifier of the company to create the lead for, starting with
|
|
272
|
+
* 'biz\_'.
|
|
254
273
|
*/
|
|
255
274
|
company_id: string;
|
|
256
275
|
/**
|
|
257
|
-
*
|
|
276
|
+
* A JSON object of custom metadata to attach to the lead for tracking purposes.
|
|
258
277
|
*/
|
|
259
278
|
metadata?: {
|
|
260
279
|
[key: string]: unknown;
|
|
261
280
|
} | null;
|
|
262
281
|
/**
|
|
263
|
-
* The
|
|
282
|
+
* The unique identifier of the product the lead is interested in, starting with
|
|
283
|
+
* 'prod\_'.
|
|
264
284
|
*/
|
|
265
285
|
product_id?: string | null;
|
|
266
286
|
/**
|
|
267
|
-
* The
|
|
287
|
+
* The referral URL that brought the lead to the company, such as
|
|
288
|
+
* 'https://example.com/landing'.
|
|
268
289
|
*/
|
|
269
290
|
referrer?: string | null;
|
|
270
291
|
/**
|
|
271
|
-
* The
|
|
272
|
-
* user
|
|
292
|
+
* The unique identifier of the user to record as the lead. If authenticated as a
|
|
293
|
+
* user, that user is used automatically.
|
|
273
294
|
*/
|
|
274
295
|
user_id?: string | null;
|
|
275
296
|
}
|
|
276
297
|
export interface LeadUpdateParams {
|
|
277
298
|
/**
|
|
278
|
-
*
|
|
299
|
+
* A JSON object of custom metadata to set on the lead, replacing any existing
|
|
300
|
+
* metadata.
|
|
279
301
|
*/
|
|
280
302
|
metadata?: {
|
|
281
303
|
[key: string]: unknown;
|
|
282
304
|
} | null;
|
|
283
305
|
/**
|
|
284
|
-
* The
|
|
306
|
+
* The updated referral URL for the lead, such as 'https://example.com/landing'.
|
|
285
307
|
*/
|
|
286
308
|
referrer?: string | null;
|
|
287
309
|
}
|
|
288
310
|
export interface LeadListParams extends CursorPageParams {
|
|
289
311
|
/**
|
|
290
|
-
* The
|
|
312
|
+
* The unique identifier of the company to list leads for.
|
|
291
313
|
*/
|
|
292
314
|
company_id: string;
|
|
293
315
|
/**
|
|
@@ -295,11 +317,11 @@ export interface LeadListParams extends CursorPageParams {
|
|
|
295
317
|
*/
|
|
296
318
|
before?: string | null;
|
|
297
319
|
/**
|
|
298
|
-
*
|
|
320
|
+
* Only return leads created after this timestamp.
|
|
299
321
|
*/
|
|
300
322
|
created_after?: string | null;
|
|
301
323
|
/**
|
|
302
|
-
*
|
|
324
|
+
* Only return leads created before this timestamp.
|
|
303
325
|
*/
|
|
304
326
|
created_before?: string | null;
|
|
305
327
|
/**
|
|
@@ -311,7 +333,7 @@ export interface LeadListParams extends CursorPageParams {
|
|
|
311
333
|
*/
|
|
312
334
|
last?: number | null;
|
|
313
335
|
/**
|
|
314
|
-
*
|
|
336
|
+
* Filter leads to only those associated with these specific product identifiers.
|
|
315
337
|
*/
|
|
316
338
|
product_ids?: Array<string> | null;
|
|
317
339
|
}
|
package/resources/leads.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"leads.d.ts","sourceRoot":"","sources":["../src/resources/leads.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC
|
|
1
|
+
{"version":3,"file":"leads.d.ts","sourceRoot":"","sources":["../src/resources/leads.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAI1E;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAIhE;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IAInB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,IAAI,CACF,KAAK,EAAE,cAAc,EACrB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,2BAA2B,EAAE,gBAAgB,CAAC;CAG9D;AAED,MAAM,MAAM,2BAA2B,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC;AAEvE;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,OAAO,EAAE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;CACjB;AAED,yBAAiB,IAAI,CAAC;IACpB;;;OAGG;IACH,UAAiB,MAAM;QACrB;;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;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,gBAAgB,CAAC,MAAM,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,OAAO,EAAE,gBAAgB,CAAC,OAAO,GAAG,IAAI,CAAC;IAEzC;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC;CAC7B;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;;OAGG;IACH,UAAiB,MAAM;QACrB;;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,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE7C;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACtD;;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,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;CACH"}
|
package/resources/leads.js
CHANGED
|
@@ -7,7 +7,8 @@ const pagination_1 = require("../core/pagination.js");
|
|
|
7
7
|
const path_1 = require("../internal/utils/path.js");
|
|
8
8
|
class Leads extends resource_1.APIResource {
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* Record a new lead for a company, capturing a potential customer's interest in a
|
|
11
|
+
* specific product.
|
|
11
12
|
*
|
|
12
13
|
* Required permissions:
|
|
13
14
|
*
|
|
@@ -27,7 +28,7 @@ class Leads extends resource_1.APIResource {
|
|
|
27
28
|
return this._client.post('/leads', { body, ...options });
|
|
28
29
|
}
|
|
29
30
|
/**
|
|
30
|
-
* Retrieves
|
|
31
|
+
* Retrieves the details of an existing lead.
|
|
31
32
|
*
|
|
32
33
|
* Required permissions:
|
|
33
34
|
*
|
|
@@ -47,7 +48,7 @@ class Leads extends resource_1.APIResource {
|
|
|
47
48
|
return this._client.get((0, path_1.path) `/leads/${id}`, options);
|
|
48
49
|
}
|
|
49
50
|
/**
|
|
50
|
-
*
|
|
51
|
+
* Update the metadata or referrer information on an existing lead record.
|
|
51
52
|
*
|
|
52
53
|
* Required permissions:
|
|
53
54
|
*
|
|
@@ -67,7 +68,8 @@ class Leads extends resource_1.APIResource {
|
|
|
67
68
|
return this._client.patch((0, path_1.path) `/leads/${id}`, { body, ...options });
|
|
68
69
|
}
|
|
69
70
|
/**
|
|
70
|
-
*
|
|
71
|
+
* Returns a paginated list of leads for a company, with optional filtering by
|
|
72
|
+
* product and creation date.
|
|
71
73
|
*
|
|
72
74
|
* Required permissions:
|
|
73
75
|
*
|
package/resources/leads.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"leads.js","sourceRoot":"","sources":["../src/resources/leads.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,KAAM,SAAQ,sBAAW;IACpC
|
|
1
|
+
{"version":3,"file":"leads.js","sourceRoot":"","sources":["../src/resources/leads.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CACJ,EAAU,EACV,OAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,UAAU,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,IAAI,CACF,KAAqB,EACrB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAA,uBAA4B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;CACF;AAhGD,sBAgGC"}
|
package/resources/leads.mjs
CHANGED
|
@@ -4,7 +4,8 @@ import { CursorPage } from "../core/pagination.mjs";
|
|
|
4
4
|
import { path } from "../internal/utils/path.mjs";
|
|
5
5
|
export class Leads extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* Record a new lead for a company, capturing a potential customer's interest in a
|
|
8
|
+
* specific product.
|
|
8
9
|
*
|
|
9
10
|
* Required permissions:
|
|
10
11
|
*
|
|
@@ -24,7 +25,7 @@ export class Leads extends APIResource {
|
|
|
24
25
|
return this._client.post('/leads', { body, ...options });
|
|
25
26
|
}
|
|
26
27
|
/**
|
|
27
|
-
* Retrieves
|
|
28
|
+
* Retrieves the details of an existing lead.
|
|
28
29
|
*
|
|
29
30
|
* Required permissions:
|
|
30
31
|
*
|
|
@@ -44,7 +45,7 @@ export class Leads extends APIResource {
|
|
|
44
45
|
return this._client.get(path `/leads/${id}`, options);
|
|
45
46
|
}
|
|
46
47
|
/**
|
|
47
|
-
*
|
|
48
|
+
* Update the metadata or referrer information on an existing lead record.
|
|
48
49
|
*
|
|
49
50
|
* Required permissions:
|
|
50
51
|
*
|
|
@@ -64,7 +65,8 @@ export class Leads extends APIResource {
|
|
|
64
65
|
return this._client.patch(path `/leads/${id}`, { body, ...options });
|
|
65
66
|
}
|
|
66
67
|
/**
|
|
67
|
-
*
|
|
68
|
+
* Returns a paginated list of leads for a company, with optional filtering by
|
|
69
|
+
* product and creation date.
|
|
68
70
|
*
|
|
69
71
|
* Required permissions:
|
|
70
72
|
*
|
package/resources/leads.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"leads.mjs","sourceRoot":"","sources":["../src/resources/leads.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC
|
|
1
|
+
{"version":3,"file":"leads.mjs","sourceRoot":"","sources":["../src/resources/leads.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CACJ,EAAU,EACV,OAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,UAAU,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,IAAI,CACF,KAAqB,EACrB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAA,UAA4B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;CACF"}
|
|
@@ -5,7 +5,7 @@ import { APIPromise } from "../core/api-promise.mjs";
|
|
|
5
5
|
import { RequestOptions } from "../internal/request-options.mjs";
|
|
6
6
|
export declare class LedgerAccounts extends APIResource {
|
|
7
7
|
/**
|
|
8
|
-
* Retrieves
|
|
8
|
+
* Retrieves the details of an existing ledger account.
|
|
9
9
|
*
|
|
10
10
|
* Required permissions:
|
|
11
11
|
*
|
|
@@ -15,11 +15,12 @@ export declare class LedgerAccounts extends APIResource {
|
|
|
15
15
|
retrieve(id: string, options?: RequestOptions): APIPromise<LedgerAccountRetrieveResponse>;
|
|
16
16
|
}
|
|
17
17
|
/**
|
|
18
|
-
*
|
|
18
|
+
* A ledger account represents a financial account on Whop that can hold many
|
|
19
|
+
* balances.
|
|
19
20
|
*/
|
|
20
21
|
export interface LedgerAccountRetrieveResponse {
|
|
21
22
|
/**
|
|
22
|
-
* The
|
|
23
|
+
* The unique identifier for the ledger account.
|
|
23
24
|
*/
|
|
24
25
|
id: string;
|
|
25
26
|
/**
|
|
@@ -70,15 +71,16 @@ export declare namespace LedgerAccountRetrieveResponse {
|
|
|
70
71
|
reserve_balance: number;
|
|
71
72
|
}
|
|
72
73
|
/**
|
|
73
|
-
*
|
|
74
|
+
* A user account on Whop. Contains profile information, identity details, and
|
|
75
|
+
* social connections.
|
|
74
76
|
*/
|
|
75
77
|
interface User {
|
|
76
78
|
/**
|
|
77
|
-
* The
|
|
79
|
+
* The unique identifier for the user.
|
|
78
80
|
*/
|
|
79
81
|
id: string;
|
|
80
82
|
/**
|
|
81
|
-
* The
|
|
83
|
+
* The user's display name shown on their public profile.
|
|
82
84
|
*/
|
|
83
85
|
name: string | null;
|
|
84
86
|
/**
|
|
@@ -86,24 +88,25 @@ export declare namespace LedgerAccountRetrieveResponse {
|
|
|
86
88
|
*/
|
|
87
89
|
typename: 'User';
|
|
88
90
|
/**
|
|
89
|
-
* The
|
|
91
|
+
* The user's unique username shown on their public profile.
|
|
90
92
|
*/
|
|
91
93
|
username: string;
|
|
92
94
|
}
|
|
93
95
|
/**
|
|
94
|
-
*
|
|
96
|
+
* A company is a seller on Whop. Companies own products, manage members, and
|
|
97
|
+
* receive payouts.
|
|
95
98
|
*/
|
|
96
99
|
interface Company {
|
|
97
100
|
/**
|
|
98
|
-
* The
|
|
101
|
+
* The unique identifier for the company.
|
|
99
102
|
*/
|
|
100
103
|
id: string;
|
|
101
104
|
/**
|
|
102
|
-
* The slug
|
|
105
|
+
* The URL slug for the company's store page (e.g., 'pickaxe' in whop.com/pickaxe).
|
|
103
106
|
*/
|
|
104
107
|
route: string;
|
|
105
108
|
/**
|
|
106
|
-
* The
|
|
109
|
+
* The display name of the company shown to customers.
|
|
107
110
|
*/
|
|
108
111
|
title: string;
|
|
109
112
|
/**
|
|
@@ -116,7 +119,7 @@ export declare namespace LedgerAccountRetrieveResponse {
|
|
|
116
119
|
*/
|
|
117
120
|
interface PayoutAccountDetails {
|
|
118
121
|
/**
|
|
119
|
-
*
|
|
122
|
+
* The unique identifier for the payout account.
|
|
120
123
|
*/
|
|
121
124
|
id: string;
|
|
122
125
|
/**
|
|
@@ -201,7 +204,7 @@ export declare namespace LedgerAccountRetrieveResponse {
|
|
|
201
204
|
*/
|
|
202
205
|
interface LatestVerification {
|
|
203
206
|
/**
|
|
204
|
-
*
|
|
207
|
+
* The unique identifier for the verification.
|
|
205
208
|
*/
|
|
206
209
|
id: string;
|
|
207
210
|
/**
|
|
@@ -209,11 +212,12 @@ export declare namespace LedgerAccountRetrieveResponse {
|
|
|
209
212
|
*/
|
|
210
213
|
last_error_code: VerificationsAPI.VerificationErrorCode | null;
|
|
211
214
|
/**
|
|
212
|
-
*
|
|
215
|
+
* A human-readable explanation of the most recent verification error. Null if no
|
|
216
|
+
* error has occurred.
|
|
213
217
|
*/
|
|
214
218
|
last_error_reason: string | null;
|
|
215
219
|
/**
|
|
216
|
-
* The status of
|
|
220
|
+
* The current status of this verification session.
|
|
217
221
|
*/
|
|
218
222
|
status: VerificationsAPI.VerificationStatus;
|
|
219
223
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ledger-accounts.d.mts","sourceRoot":"","sources":["../src/resources/ledger-accounts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,gBAAgB;OACrB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,6BAA6B,CAAC;CAG1F;AAED
|
|
1
|
+
{"version":3,"file":"ledger-accounts.d.mts","sourceRoot":"","sources":["../src/resources/ledger-accounts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,gBAAgB;OACrB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,6BAA6B,CAAC;CAG1F;AAED;;;GAGG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,6BAA6B,CAAC,OAAO,CAAC,CAAC;IAEvD;;OAEG;IACH,WAAW,EAAE,SAAS,GAAG,MAAM,CAAC;IAEhC;;OAEG;IACH,KAAK,EAAE,6BAA6B,CAAC,IAAI,GAAG,IAAI,GAAG,6BAA6B,CAAC,OAAO,GAAG,IAAI,CAAC;IAEhG;;OAEG;IACH,wBAAwB,EAAE,SAAS,GAAG,UAAU,GAAG,YAAY,GAAG,UAAU,GAAG,IAAI,CAAC;IAEpF;;OAEG;IACH,sBAAsB,EAAE,6BAA6B,CAAC,oBAAoB,GAAG,IAAI,CAAC;IAElF;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,yBAAiB,6BAA6B,CAAC;IAC7C;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;QAE1B;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;KACzB;IAED;;;OAGG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;IAED;;;OAGG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,QAAQ,EAAE,SAAS,CAAC;KACrB;IAED;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,OAAO,EAAE,oBAAoB,CAAC,OAAO,GAAG,IAAI,CAAC;QAE7C;;WAEG;QACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,uBAAuB,EAAE,oBAAoB,CAAC,sBAAsB,GAAG,IAAI,CAAC;QAE5E;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,mBAAmB,EAAE,oBAAoB,CAAC,kBAAkB,GAAG,IAAI,CAAC;QAEpE;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;IAED,UAAiB,oBAAoB,CAAC;QACpC;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;YAEpB;;eAEG;YACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;YAEvB;;eAEG;YACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B;;eAEG;YACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;SACtB;QAED;;WAEG;QACH,UAAiB,sBAAsB;YACrC;;;eAGG;YACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;YAE7B;;eAEG;YACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;YAE1B;;eAEG;YACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;SAC5B;QAED;;WAEG;QACH,UAAiB,kBAAkB;YACjC;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,eAAe,EAAE,gBAAgB,CAAC,qBAAqB,GAAG,IAAI,CAAC;YAE/D;;;eAGG;YACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;YAEjC;;eAEG;YACH,MAAM,EAAE,gBAAgB,CAAC,kBAAkB,CAAC;SAC7C;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EAAE,KAAK,6BAA6B,IAAI,6BAA6B,EAAE,CAAC;CAChF"}
|