@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
|
@@ -3,9 +3,8 @@ import { APIPromise } from "../core/api-promise.mjs";
|
|
|
3
3
|
import { RequestOptions } from "../internal/request-options.mjs";
|
|
4
4
|
export declare class AccountLinks extends APIResource {
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
* the hosted KYC onboarding flow.
|
|
6
|
+
* Generate a URL that directs a sub-merchant to their account portal, such as the
|
|
7
|
+
* hosted payouts dashboard or the KYC onboarding flow.
|
|
9
8
|
*
|
|
10
9
|
* @example
|
|
11
10
|
* ```ts
|
|
@@ -20,36 +19,39 @@ export declare class AccountLinks extends APIResource {
|
|
|
20
19
|
create(body: AccountLinkCreateParams, options?: RequestOptions): APIPromise<AccountLinkCreateResponse>;
|
|
21
20
|
}
|
|
22
21
|
/**
|
|
23
|
-
*
|
|
24
|
-
*
|
|
22
|
+
* A temporary, time-limited URL that grants a user access to an external account
|
|
23
|
+
* management page.
|
|
25
24
|
*/
|
|
26
25
|
export interface AccountLinkCreateResponse {
|
|
27
26
|
/**
|
|
28
|
-
* The
|
|
27
|
+
* The timestamp after which this account link URL is no longer valid.
|
|
29
28
|
*/
|
|
30
29
|
expires_at: string;
|
|
31
30
|
/**
|
|
32
|
-
* The URL to
|
|
31
|
+
* The temporary URL to redirect the user to for account access. Expires at the
|
|
32
|
+
* time specified by expires_at.
|
|
33
33
|
*/
|
|
34
34
|
url: string;
|
|
35
35
|
}
|
|
36
36
|
export interface AccountLinkCreateParams {
|
|
37
37
|
/**
|
|
38
|
-
* The
|
|
39
|
-
* sub-merchant of the API key's company.
|
|
38
|
+
* The unique identifier of the company to generate the link for, starting with
|
|
39
|
+
* 'biz\_'. Must be a sub-merchant of the API key's company.
|
|
40
40
|
*/
|
|
41
41
|
company_id: string;
|
|
42
42
|
/**
|
|
43
|
-
* The URL to redirect to if the session expires and needs to be
|
|
44
|
-
*
|
|
43
|
+
* The URL to redirect the user to if the session expires and needs to be
|
|
44
|
+
* re-authenticated, such as 'https://example.com/refresh'.
|
|
45
45
|
*/
|
|
46
46
|
refresh_url: string;
|
|
47
47
|
/**
|
|
48
|
-
* The URL to redirect to when
|
|
48
|
+
* The URL to redirect the user to when they want to return to your site, such as
|
|
49
|
+
* 'https://example.com/return'.
|
|
49
50
|
*/
|
|
50
51
|
return_url: string;
|
|
51
52
|
/**
|
|
52
|
-
* The
|
|
53
|
+
* The purpose of the account link, such as hosted payouts portal or hosted KYC
|
|
54
|
+
* onboarding.
|
|
53
55
|
*/
|
|
54
56
|
use_case: 'account_onboarding' | 'payouts_portal';
|
|
55
57
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"account-links.d.mts","sourceRoot":"","sources":["../src/resources/account-links.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C
|
|
1
|
+
{"version":3,"file":"account-links.d.mts","sourceRoot":"","sources":["../src/resources/account-links.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAGvG;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,EAAE,oBAAoB,GAAG,gBAAgB,CAAC;CACnD;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
|
|
@@ -3,9 +3,8 @@ import { APIPromise } from "../core/api-promise.js";
|
|
|
3
3
|
import { RequestOptions } from "../internal/request-options.js";
|
|
4
4
|
export declare class AccountLinks extends APIResource {
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
* the hosted KYC onboarding flow.
|
|
6
|
+
* Generate a URL that directs a sub-merchant to their account portal, such as the
|
|
7
|
+
* hosted payouts dashboard or the KYC onboarding flow.
|
|
9
8
|
*
|
|
10
9
|
* @example
|
|
11
10
|
* ```ts
|
|
@@ -20,36 +19,39 @@ export declare class AccountLinks extends APIResource {
|
|
|
20
19
|
create(body: AccountLinkCreateParams, options?: RequestOptions): APIPromise<AccountLinkCreateResponse>;
|
|
21
20
|
}
|
|
22
21
|
/**
|
|
23
|
-
*
|
|
24
|
-
*
|
|
22
|
+
* A temporary, time-limited URL that grants a user access to an external account
|
|
23
|
+
* management page.
|
|
25
24
|
*/
|
|
26
25
|
export interface AccountLinkCreateResponse {
|
|
27
26
|
/**
|
|
28
|
-
* The
|
|
27
|
+
* The timestamp after which this account link URL is no longer valid.
|
|
29
28
|
*/
|
|
30
29
|
expires_at: string;
|
|
31
30
|
/**
|
|
32
|
-
* The URL to
|
|
31
|
+
* The temporary URL to redirect the user to for account access. Expires at the
|
|
32
|
+
* time specified by expires_at.
|
|
33
33
|
*/
|
|
34
34
|
url: string;
|
|
35
35
|
}
|
|
36
36
|
export interface AccountLinkCreateParams {
|
|
37
37
|
/**
|
|
38
|
-
* The
|
|
39
|
-
* sub-merchant of the API key's company.
|
|
38
|
+
* The unique identifier of the company to generate the link for, starting with
|
|
39
|
+
* 'biz\_'. Must be a sub-merchant of the API key's company.
|
|
40
40
|
*/
|
|
41
41
|
company_id: string;
|
|
42
42
|
/**
|
|
43
|
-
* The URL to redirect to if the session expires and needs to be
|
|
44
|
-
*
|
|
43
|
+
* The URL to redirect the user to if the session expires and needs to be
|
|
44
|
+
* re-authenticated, such as 'https://example.com/refresh'.
|
|
45
45
|
*/
|
|
46
46
|
refresh_url: string;
|
|
47
47
|
/**
|
|
48
|
-
* The URL to redirect to when
|
|
48
|
+
* The URL to redirect the user to when they want to return to your site, such as
|
|
49
|
+
* 'https://example.com/return'.
|
|
49
50
|
*/
|
|
50
51
|
return_url: string;
|
|
51
52
|
/**
|
|
52
|
-
* The
|
|
53
|
+
* The purpose of the account link, such as hosted payouts portal or hosted KYC
|
|
54
|
+
* onboarding.
|
|
53
55
|
*/
|
|
54
56
|
use_case: 'account_onboarding' | 'payouts_portal';
|
|
55
57
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"account-links.d.ts","sourceRoot":"","sources":["../src/resources/account-links.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C
|
|
1
|
+
{"version":3,"file":"account-links.d.ts","sourceRoot":"","sources":["../src/resources/account-links.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAGvG;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,EAAE,oBAAoB,GAAG,gBAAgB,CAAC;CACnD;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
|
|
@@ -5,9 +5,8 @@ exports.AccountLinks = void 0;
|
|
|
5
5
|
const resource_1 = require("../core/resource.js");
|
|
6
6
|
class AccountLinks extends resource_1.APIResource {
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
* the hosted KYC onboarding flow.
|
|
8
|
+
* Generate a URL that directs a sub-merchant to their account portal, such as the
|
|
9
|
+
* hosted payouts dashboard or the KYC onboarding flow.
|
|
11
10
|
*
|
|
12
11
|
* @example
|
|
13
12
|
* ```ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"account-links.js","sourceRoot":"","sources":["../src/resources/account-links.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,YAAa,SAAQ,sBAAW;IAC3C
|
|
1
|
+
{"version":3,"file":"account-links.js","sourceRoot":"","sources":["../src/resources/account-links.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAA6B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF;AAlBD,oCAkBC"}
|
|
@@ -2,9 +2,8 @@
|
|
|
2
2
|
import { APIResource } from "../core/resource.mjs";
|
|
3
3
|
export class AccountLinks extends APIResource {
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
* the hosted KYC onboarding flow.
|
|
5
|
+
* Generate a URL that directs a sub-merchant to their account portal, such as the
|
|
6
|
+
* hosted payouts dashboard or the KYC onboarding flow.
|
|
8
7
|
*
|
|
9
8
|
* @example
|
|
10
9
|
* ```ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"account-links.mjs","sourceRoot":"","sources":["../src/resources/account-links.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C
|
|
1
|
+
{"version":3,"file":"account-links.mjs","sourceRoot":"","sources":["../src/resources/account-links.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAA6B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF"}
|
package/resources/ai-chats.d.mts
CHANGED
|
@@ -4,19 +4,19 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
|
|
|
4
4
|
import { RequestOptions } from "../internal/request-options.mjs";
|
|
5
5
|
export declare class AIChats extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* Create a new AI chat thread and send the first message to the AI agent.
|
|
8
8
|
*
|
|
9
9
|
* Required permissions:
|
|
10
10
|
*
|
|
11
11
|
* - `ai_chat:create`
|
|
12
12
|
*/
|
|
13
|
-
create(body
|
|
13
|
+
create(body: AIChatCreateParams, options?: RequestOptions): APIPromise<AIChat>;
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
15
|
+
* Retrieves the details of an existing AI chat.
|
|
16
16
|
*/
|
|
17
17
|
retrieve(id: string, options?: RequestOptions): APIPromise<AIChat>;
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
19
|
+
* Update an AI chat's title or associated company context.
|
|
20
20
|
*
|
|
21
21
|
* Required permissions:
|
|
22
22
|
*
|
|
@@ -24,11 +24,11 @@ export declare class AIChats extends APIResource {
|
|
|
24
24
|
*/
|
|
25
25
|
update(id: string, body?: AIChatUpdateParams | null | undefined, options?: RequestOptions): APIPromise<AIChat>;
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
27
|
+
* Returns a paginated list of AI chat threads for the current authenticated user.
|
|
28
28
|
*/
|
|
29
29
|
list(query?: AIChatListParams | null | undefined, options?: RequestOptions): PagePromise<AIChatListResponsesCursorPage, AIChatListResponse>;
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
31
|
+
* Delete an AI chat thread so it no longer appears in the user's chat list.
|
|
32
32
|
*
|
|
33
33
|
* Required permissions:
|
|
34
34
|
*
|
|
@@ -38,97 +38,103 @@ export declare class AIChats extends APIResource {
|
|
|
38
38
|
}
|
|
39
39
|
export type AIChatListResponsesCursorPage = CursorPage<AIChatListResponse>;
|
|
40
40
|
/**
|
|
41
|
-
* An AI chat conversation belonging to a user
|
|
41
|
+
* An AI-powered chat conversation belonging to a user, with optional scheduled
|
|
42
|
+
* automation.
|
|
42
43
|
*/
|
|
43
44
|
export interface AIChat {
|
|
44
45
|
/**
|
|
45
|
-
* The unique identifier for the
|
|
46
|
+
* The unique identifier for the ai chat.
|
|
46
47
|
*/
|
|
47
48
|
id: string;
|
|
48
49
|
/**
|
|
49
|
-
* The total number of tokens
|
|
50
|
+
* The total number of tokens consumed across all messages in this conversation.
|
|
50
51
|
*/
|
|
51
52
|
blended_token_usage: string;
|
|
52
53
|
/**
|
|
53
|
-
*
|
|
54
|
+
* The datetime the ai chat was created.
|
|
54
55
|
*/
|
|
55
56
|
created_at: string;
|
|
56
57
|
/**
|
|
57
|
-
*
|
|
58
|
+
* The timestamp of the most recent message in this conversation. Null if no
|
|
59
|
+
* messages have been sent yet.
|
|
58
60
|
*/
|
|
59
61
|
last_message_at: string | null;
|
|
60
62
|
/**
|
|
61
|
-
* The number of messages in
|
|
63
|
+
* The total number of messages exchanged in this conversation.
|
|
62
64
|
*/
|
|
63
65
|
message_count: number;
|
|
64
66
|
/**
|
|
65
|
-
*
|
|
67
|
+
* A short descriptive title for this AI chat conversation. Null if no title has
|
|
68
|
+
* been set.
|
|
66
69
|
*/
|
|
67
70
|
title: string | null;
|
|
68
71
|
/**
|
|
69
|
-
*
|
|
72
|
+
* The datetime the ai chat was last updated.
|
|
70
73
|
*/
|
|
71
74
|
updated_at: string;
|
|
72
75
|
/**
|
|
73
|
-
* The user who owns
|
|
76
|
+
* The user who owns this AI chat conversation.
|
|
74
77
|
*/
|
|
75
78
|
user: AIChat.User;
|
|
76
79
|
}
|
|
77
80
|
export declare namespace AIChat {
|
|
78
81
|
/**
|
|
79
|
-
* The user who owns
|
|
82
|
+
* The user who owns this AI chat conversation.
|
|
80
83
|
*/
|
|
81
84
|
interface User {
|
|
82
85
|
/**
|
|
83
|
-
* The
|
|
86
|
+
* The unique identifier for the user.
|
|
84
87
|
*/
|
|
85
88
|
id: string;
|
|
86
89
|
}
|
|
87
90
|
}
|
|
88
91
|
/**
|
|
89
|
-
* An AI chat conversation belonging to a user
|
|
92
|
+
* An AI-powered chat conversation belonging to a user, with optional scheduled
|
|
93
|
+
* automation.
|
|
90
94
|
*/
|
|
91
95
|
export interface AIChatListResponse {
|
|
92
96
|
/**
|
|
93
|
-
* The unique identifier for the
|
|
97
|
+
* The unique identifier for the ai chat.
|
|
94
98
|
*/
|
|
95
99
|
id: string;
|
|
96
100
|
/**
|
|
97
|
-
* The total number of tokens
|
|
101
|
+
* The total number of tokens consumed across all messages in this conversation.
|
|
98
102
|
*/
|
|
99
103
|
blended_token_usage: string;
|
|
100
104
|
/**
|
|
101
|
-
*
|
|
105
|
+
* The datetime the ai chat was created.
|
|
102
106
|
*/
|
|
103
107
|
created_at: string;
|
|
104
108
|
/**
|
|
105
|
-
*
|
|
109
|
+
* The timestamp of the most recent message in this conversation. Null if no
|
|
110
|
+
* messages have been sent yet.
|
|
106
111
|
*/
|
|
107
112
|
last_message_at: string | null;
|
|
108
113
|
/**
|
|
109
|
-
* The number of messages in
|
|
114
|
+
* The total number of messages exchanged in this conversation.
|
|
110
115
|
*/
|
|
111
116
|
message_count: number;
|
|
112
117
|
/**
|
|
113
|
-
*
|
|
118
|
+
* A short descriptive title for this AI chat conversation. Null if no title has
|
|
119
|
+
* been set.
|
|
114
120
|
*/
|
|
115
121
|
title: string | null;
|
|
116
122
|
/**
|
|
117
|
-
*
|
|
123
|
+
* The datetime the ai chat was last updated.
|
|
118
124
|
*/
|
|
119
125
|
updated_at: string;
|
|
120
126
|
/**
|
|
121
|
-
* The user who owns
|
|
127
|
+
* The user who owns this AI chat conversation.
|
|
122
128
|
*/
|
|
123
129
|
user: AIChatListResponse.User;
|
|
124
130
|
}
|
|
125
131
|
export declare namespace AIChatListResponse {
|
|
126
132
|
/**
|
|
127
|
-
* The user who owns
|
|
133
|
+
* The user who owns this AI chat conversation.
|
|
128
134
|
*/
|
|
129
135
|
interface User {
|
|
130
136
|
/**
|
|
131
|
-
* The
|
|
137
|
+
* The unique identifier for the user.
|
|
132
138
|
*/
|
|
133
139
|
id: string;
|
|
134
140
|
}
|
|
@@ -139,13 +145,47 @@ export declare namespace AIChatListResponse {
|
|
|
139
145
|
export type AIChatDeleteResponse = boolean;
|
|
140
146
|
export interface AIChatCreateParams {
|
|
141
147
|
/**
|
|
142
|
-
* The
|
|
148
|
+
* The text content of the first message to send to the AI agent.
|
|
149
|
+
*/
|
|
150
|
+
message_text: string;
|
|
151
|
+
/**
|
|
152
|
+
* The unique identifier of the company to set as context for the AI chat (e.g.,
|
|
153
|
+
* "biz_XXXXX").
|
|
154
|
+
*/
|
|
155
|
+
current_company_id?: string | null;
|
|
156
|
+
/**
|
|
157
|
+
* A list of previously uploaded file attachments to include with the first
|
|
158
|
+
* message.
|
|
159
|
+
*/
|
|
160
|
+
message_attachments?: Array<AIChatCreateParams.MessageAttachment> | null;
|
|
161
|
+
/**
|
|
162
|
+
* The source of an AI chat message
|
|
163
|
+
*/
|
|
164
|
+
message_source?: 'manual' | 'suggestion' | 'link' | null;
|
|
165
|
+
/**
|
|
166
|
+
* An optional display title for the AI chat thread (e.g., "Help with billing").
|
|
143
167
|
*/
|
|
144
168
|
title?: string | null;
|
|
145
169
|
}
|
|
170
|
+
export declare namespace AIChatCreateParams {
|
|
171
|
+
/**
|
|
172
|
+
* Input for an attachment
|
|
173
|
+
*/
|
|
174
|
+
interface MessageAttachment {
|
|
175
|
+
/**
|
|
176
|
+
* The ID of an existing file object.
|
|
177
|
+
*/
|
|
178
|
+
id: string;
|
|
179
|
+
}
|
|
180
|
+
}
|
|
146
181
|
export interface AIChatUpdateParams {
|
|
147
182
|
/**
|
|
148
|
-
* The
|
|
183
|
+
* The unique identifier of the company to set as context for the AI chat (e.g.,
|
|
184
|
+
* "biz_XXXXX").
|
|
185
|
+
*/
|
|
186
|
+
current_company_id?: string | null;
|
|
187
|
+
/**
|
|
188
|
+
* The new display title for the AI chat thread (e.g., "Help with billing").
|
|
149
189
|
*/
|
|
150
190
|
title?: string | null;
|
|
151
191
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ai-chats.d.mts","sourceRoot":"","sources":["../src/resources/ai-chats.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,OAAQ,SAAQ,WAAW;IACtC;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,
|
|
1
|
+
{"version":3,"file":"ai-chats.d.mts","sourceRoot":"","sources":["../src/resources/ai-chats.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,OAAQ,SAAQ,WAAW;IACtC;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI9E;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIlE;;;;;;OAMG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC;IAIrB;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6BAA6B,EAAE,kBAAkB,CAAC;IAIjE;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;CAG/E;AAED,MAAM,MAAM,6BAA6B,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC;AAE3E;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;CACnB;AAED,yBAAiB,MAAM,CAAC;IACtB;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;CAC/B;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC;AAE3C,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;IAEzE;;OAEG;IACH,cAAc,CAAC,EAAE,QAAQ,GAAG,YAAY,GAAG,MAAM,GAAG,IAAI,CAAC;IAEzD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,iBAAiB;QAChC;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
|
package/resources/ai-chats.d.ts
CHANGED
|
@@ -4,19 +4,19 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
|
|
|
4
4
|
import { RequestOptions } from "../internal/request-options.js";
|
|
5
5
|
export declare class AIChats extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* Create a new AI chat thread and send the first message to the AI agent.
|
|
8
8
|
*
|
|
9
9
|
* Required permissions:
|
|
10
10
|
*
|
|
11
11
|
* - `ai_chat:create`
|
|
12
12
|
*/
|
|
13
|
-
create(body
|
|
13
|
+
create(body: AIChatCreateParams, options?: RequestOptions): APIPromise<AIChat>;
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
15
|
+
* Retrieves the details of an existing AI chat.
|
|
16
16
|
*/
|
|
17
17
|
retrieve(id: string, options?: RequestOptions): APIPromise<AIChat>;
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
19
|
+
* Update an AI chat's title or associated company context.
|
|
20
20
|
*
|
|
21
21
|
* Required permissions:
|
|
22
22
|
*
|
|
@@ -24,11 +24,11 @@ export declare class AIChats extends APIResource {
|
|
|
24
24
|
*/
|
|
25
25
|
update(id: string, body?: AIChatUpdateParams | null | undefined, options?: RequestOptions): APIPromise<AIChat>;
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
27
|
+
* Returns a paginated list of AI chat threads for the current authenticated user.
|
|
28
28
|
*/
|
|
29
29
|
list(query?: AIChatListParams | null | undefined, options?: RequestOptions): PagePromise<AIChatListResponsesCursorPage, AIChatListResponse>;
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
31
|
+
* Delete an AI chat thread so it no longer appears in the user's chat list.
|
|
32
32
|
*
|
|
33
33
|
* Required permissions:
|
|
34
34
|
*
|
|
@@ -38,97 +38,103 @@ export declare class AIChats extends APIResource {
|
|
|
38
38
|
}
|
|
39
39
|
export type AIChatListResponsesCursorPage = CursorPage<AIChatListResponse>;
|
|
40
40
|
/**
|
|
41
|
-
* An AI chat conversation belonging to a user
|
|
41
|
+
* An AI-powered chat conversation belonging to a user, with optional scheduled
|
|
42
|
+
* automation.
|
|
42
43
|
*/
|
|
43
44
|
export interface AIChat {
|
|
44
45
|
/**
|
|
45
|
-
* The unique identifier for the
|
|
46
|
+
* The unique identifier for the ai chat.
|
|
46
47
|
*/
|
|
47
48
|
id: string;
|
|
48
49
|
/**
|
|
49
|
-
* The total number of tokens
|
|
50
|
+
* The total number of tokens consumed across all messages in this conversation.
|
|
50
51
|
*/
|
|
51
52
|
blended_token_usage: string;
|
|
52
53
|
/**
|
|
53
|
-
*
|
|
54
|
+
* The datetime the ai chat was created.
|
|
54
55
|
*/
|
|
55
56
|
created_at: string;
|
|
56
57
|
/**
|
|
57
|
-
*
|
|
58
|
+
* The timestamp of the most recent message in this conversation. Null if no
|
|
59
|
+
* messages have been sent yet.
|
|
58
60
|
*/
|
|
59
61
|
last_message_at: string | null;
|
|
60
62
|
/**
|
|
61
|
-
* The number of messages in
|
|
63
|
+
* The total number of messages exchanged in this conversation.
|
|
62
64
|
*/
|
|
63
65
|
message_count: number;
|
|
64
66
|
/**
|
|
65
|
-
*
|
|
67
|
+
* A short descriptive title for this AI chat conversation. Null if no title has
|
|
68
|
+
* been set.
|
|
66
69
|
*/
|
|
67
70
|
title: string | null;
|
|
68
71
|
/**
|
|
69
|
-
*
|
|
72
|
+
* The datetime the ai chat was last updated.
|
|
70
73
|
*/
|
|
71
74
|
updated_at: string;
|
|
72
75
|
/**
|
|
73
|
-
* The user who owns
|
|
76
|
+
* The user who owns this AI chat conversation.
|
|
74
77
|
*/
|
|
75
78
|
user: AIChat.User;
|
|
76
79
|
}
|
|
77
80
|
export declare namespace AIChat {
|
|
78
81
|
/**
|
|
79
|
-
* The user who owns
|
|
82
|
+
* The user who owns this AI chat conversation.
|
|
80
83
|
*/
|
|
81
84
|
interface User {
|
|
82
85
|
/**
|
|
83
|
-
* The
|
|
86
|
+
* The unique identifier for the user.
|
|
84
87
|
*/
|
|
85
88
|
id: string;
|
|
86
89
|
}
|
|
87
90
|
}
|
|
88
91
|
/**
|
|
89
|
-
* An AI chat conversation belonging to a user
|
|
92
|
+
* An AI-powered chat conversation belonging to a user, with optional scheduled
|
|
93
|
+
* automation.
|
|
90
94
|
*/
|
|
91
95
|
export interface AIChatListResponse {
|
|
92
96
|
/**
|
|
93
|
-
* The unique identifier for the
|
|
97
|
+
* The unique identifier for the ai chat.
|
|
94
98
|
*/
|
|
95
99
|
id: string;
|
|
96
100
|
/**
|
|
97
|
-
* The total number of tokens
|
|
101
|
+
* The total number of tokens consumed across all messages in this conversation.
|
|
98
102
|
*/
|
|
99
103
|
blended_token_usage: string;
|
|
100
104
|
/**
|
|
101
|
-
*
|
|
105
|
+
* The datetime the ai chat was created.
|
|
102
106
|
*/
|
|
103
107
|
created_at: string;
|
|
104
108
|
/**
|
|
105
|
-
*
|
|
109
|
+
* The timestamp of the most recent message in this conversation. Null if no
|
|
110
|
+
* messages have been sent yet.
|
|
106
111
|
*/
|
|
107
112
|
last_message_at: string | null;
|
|
108
113
|
/**
|
|
109
|
-
* The number of messages in
|
|
114
|
+
* The total number of messages exchanged in this conversation.
|
|
110
115
|
*/
|
|
111
116
|
message_count: number;
|
|
112
117
|
/**
|
|
113
|
-
*
|
|
118
|
+
* A short descriptive title for this AI chat conversation. Null if no title has
|
|
119
|
+
* been set.
|
|
114
120
|
*/
|
|
115
121
|
title: string | null;
|
|
116
122
|
/**
|
|
117
|
-
*
|
|
123
|
+
* The datetime the ai chat was last updated.
|
|
118
124
|
*/
|
|
119
125
|
updated_at: string;
|
|
120
126
|
/**
|
|
121
|
-
* The user who owns
|
|
127
|
+
* The user who owns this AI chat conversation.
|
|
122
128
|
*/
|
|
123
129
|
user: AIChatListResponse.User;
|
|
124
130
|
}
|
|
125
131
|
export declare namespace AIChatListResponse {
|
|
126
132
|
/**
|
|
127
|
-
* The user who owns
|
|
133
|
+
* The user who owns this AI chat conversation.
|
|
128
134
|
*/
|
|
129
135
|
interface User {
|
|
130
136
|
/**
|
|
131
|
-
* The
|
|
137
|
+
* The unique identifier for the user.
|
|
132
138
|
*/
|
|
133
139
|
id: string;
|
|
134
140
|
}
|
|
@@ -139,13 +145,47 @@ export declare namespace AIChatListResponse {
|
|
|
139
145
|
export type AIChatDeleteResponse = boolean;
|
|
140
146
|
export interface AIChatCreateParams {
|
|
141
147
|
/**
|
|
142
|
-
* The
|
|
148
|
+
* The text content of the first message to send to the AI agent.
|
|
149
|
+
*/
|
|
150
|
+
message_text: string;
|
|
151
|
+
/**
|
|
152
|
+
* The unique identifier of the company to set as context for the AI chat (e.g.,
|
|
153
|
+
* "biz_XXXXX").
|
|
154
|
+
*/
|
|
155
|
+
current_company_id?: string | null;
|
|
156
|
+
/**
|
|
157
|
+
* A list of previously uploaded file attachments to include with the first
|
|
158
|
+
* message.
|
|
159
|
+
*/
|
|
160
|
+
message_attachments?: Array<AIChatCreateParams.MessageAttachment> | null;
|
|
161
|
+
/**
|
|
162
|
+
* The source of an AI chat message
|
|
163
|
+
*/
|
|
164
|
+
message_source?: 'manual' | 'suggestion' | 'link' | null;
|
|
165
|
+
/**
|
|
166
|
+
* An optional display title for the AI chat thread (e.g., "Help with billing").
|
|
143
167
|
*/
|
|
144
168
|
title?: string | null;
|
|
145
169
|
}
|
|
170
|
+
export declare namespace AIChatCreateParams {
|
|
171
|
+
/**
|
|
172
|
+
* Input for an attachment
|
|
173
|
+
*/
|
|
174
|
+
interface MessageAttachment {
|
|
175
|
+
/**
|
|
176
|
+
* The ID of an existing file object.
|
|
177
|
+
*/
|
|
178
|
+
id: string;
|
|
179
|
+
}
|
|
180
|
+
}
|
|
146
181
|
export interface AIChatUpdateParams {
|
|
147
182
|
/**
|
|
148
|
-
* The
|
|
183
|
+
* The unique identifier of the company to set as context for the AI chat (e.g.,
|
|
184
|
+
* "biz_XXXXX").
|
|
185
|
+
*/
|
|
186
|
+
current_company_id?: string | null;
|
|
187
|
+
/**
|
|
188
|
+
* The new display title for the AI chat thread (e.g., "Help with billing").
|
|
149
189
|
*/
|
|
150
190
|
title?: string | null;
|
|
151
191
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ai-chats.d.ts","sourceRoot":"","sources":["../src/resources/ai-chats.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,OAAQ,SAAQ,WAAW;IACtC;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,
|
|
1
|
+
{"version":3,"file":"ai-chats.d.ts","sourceRoot":"","sources":["../src/resources/ai-chats.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,OAAQ,SAAQ,WAAW;IACtC;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI9E;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIlE;;;;;;OAMG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC;IAIrB;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6BAA6B,EAAE,kBAAkB,CAAC;IAIjE;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;CAG/E;AAED,MAAM,MAAM,6BAA6B,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC;AAE3E;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;CACnB;AAED,yBAAiB,MAAM,CAAC;IACtB;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;CAC/B;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC;AAE3C,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;IAEzE;;OAEG;IACH,cAAc,CAAC,EAAE,QAAQ,GAAG,YAAY,GAAG,MAAM,GAAG,IAAI,CAAC;IAEzD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,iBAAiB;QAChC;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
|