@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
|
@@ -5,8 +5,8 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
|
|
|
5
5
|
import { RequestOptions } from "../internal/request-options.mjs";
|
|
6
6
|
export declare class SupportChannels extends APIResource {
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
9
|
-
*
|
|
8
|
+
* Open a new support channel between a company team member and a customer. Returns
|
|
9
|
+
* the existing channel if one already exists for that user.
|
|
10
10
|
*
|
|
11
11
|
* Required permissions:
|
|
12
12
|
*
|
|
@@ -22,7 +22,7 @@ export declare class SupportChannels extends APIResource {
|
|
|
22
22
|
*/
|
|
23
23
|
create(body: SupportChannelCreateParams, options?: RequestOptions): APIPromise<Shared.SupportChannel>;
|
|
24
24
|
/**
|
|
25
|
-
* Retrieves
|
|
25
|
+
* Retrieves the details of an existing support channel.
|
|
26
26
|
*
|
|
27
27
|
* Required permissions:
|
|
28
28
|
*
|
|
@@ -36,7 +36,8 @@ export declare class SupportChannels extends APIResource {
|
|
|
36
36
|
*/
|
|
37
37
|
retrieve(id: string, options?: RequestOptions): APIPromise<Shared.SupportChannel>;
|
|
38
38
|
/**
|
|
39
|
-
*
|
|
39
|
+
* Returns a paginated list of support channels for a specific company, with
|
|
40
|
+
* optional filtering by resolution status and custom sorting.
|
|
40
41
|
*
|
|
41
42
|
* Required permissions:
|
|
42
43
|
*
|
|
@@ -56,7 +57,8 @@ export declare class SupportChannels extends APIResource {
|
|
|
56
57
|
}
|
|
57
58
|
export type SupportChannelListResponsesCursorPage = CursorPage<SupportChannelListResponse>;
|
|
58
59
|
/**
|
|
59
|
-
*
|
|
60
|
+
* A messaging channel that can be a one-on-one DM, group chat, company support
|
|
61
|
+
* conversation, or platform-level direct message.
|
|
60
62
|
*/
|
|
61
63
|
export interface SupportChannelListResponse {
|
|
62
64
|
/**
|
|
@@ -64,58 +66,65 @@ export interface SupportChannelListResponse {
|
|
|
64
66
|
*/
|
|
65
67
|
id: string;
|
|
66
68
|
/**
|
|
67
|
-
* The
|
|
69
|
+
* The unique identifier of the company associated with this channel. Null if this
|
|
70
|
+
* is not a support or company-scoped conversation.
|
|
68
71
|
*/
|
|
69
72
|
company_id: string | null;
|
|
70
73
|
/**
|
|
71
|
-
*
|
|
74
|
+
* A custom display name assigned to this channel by the user. Null if no custom
|
|
75
|
+
* name has been set.
|
|
72
76
|
*/
|
|
73
77
|
custom_name: string | null;
|
|
74
78
|
/**
|
|
75
|
-
* The customer
|
|
79
|
+
* The customer who initiated this support conversation. Null if this is not a
|
|
80
|
+
* support chat.
|
|
76
81
|
*/
|
|
77
82
|
customer_user: SupportChannelListResponse.CustomerUser | null;
|
|
78
83
|
/**
|
|
79
|
-
*
|
|
84
|
+
* The timestamp when the most recent message was sent in this channel. Null if no
|
|
85
|
+
* messages have been sent.
|
|
80
86
|
*/
|
|
81
87
|
last_message_at: string | null;
|
|
82
88
|
/**
|
|
83
|
-
*
|
|
89
|
+
* The timestamp when the linked support ticket was marked as resolved. Null if
|
|
90
|
+
* unresolved or not a support chat.
|
|
84
91
|
*/
|
|
85
92
|
resolved_at: string | null;
|
|
86
93
|
}
|
|
87
94
|
export declare namespace SupportChannelListResponse {
|
|
88
95
|
/**
|
|
89
|
-
* The customer
|
|
96
|
+
* The customer who initiated this support conversation. Null if this is not a
|
|
97
|
+
* support chat.
|
|
90
98
|
*/
|
|
91
99
|
interface CustomerUser {
|
|
92
100
|
/**
|
|
93
|
-
* The
|
|
101
|
+
* The unique identifier for the user.
|
|
94
102
|
*/
|
|
95
103
|
id: string;
|
|
96
104
|
/**
|
|
97
|
-
* The
|
|
105
|
+
* The user's display name shown on their public profile.
|
|
98
106
|
*/
|
|
99
107
|
name: string | null;
|
|
100
108
|
/**
|
|
101
|
-
* The
|
|
109
|
+
* The user's unique username shown on their public profile.
|
|
102
110
|
*/
|
|
103
111
|
username: string;
|
|
104
112
|
}
|
|
105
113
|
}
|
|
106
114
|
export interface SupportChannelCreateParams {
|
|
107
115
|
/**
|
|
108
|
-
* The
|
|
116
|
+
* The unique identifier of the company to create the support channel in.
|
|
109
117
|
*/
|
|
110
118
|
company_id: string;
|
|
111
119
|
/**
|
|
112
|
-
* The ID (
|
|
120
|
+
* The user ID (e.g. 'user_xxxxx') or username of the customer to open a support
|
|
121
|
+
* channel for.
|
|
113
122
|
*/
|
|
114
123
|
user_id: string;
|
|
115
124
|
}
|
|
116
125
|
export interface SupportChannelListParams extends CursorPageParams {
|
|
117
126
|
/**
|
|
118
|
-
* The
|
|
127
|
+
* The unique identifier of the company to list support channels for.
|
|
119
128
|
*/
|
|
120
129
|
company_id: string;
|
|
121
130
|
/**
|
|
@@ -135,9 +144,8 @@ export interface SupportChannelListParams extends CursorPageParams {
|
|
|
135
144
|
*/
|
|
136
145
|
last?: number | null;
|
|
137
146
|
/**
|
|
138
|
-
*
|
|
139
|
-
*
|
|
140
|
-
* resolved channels.
|
|
147
|
+
* Whether to filter by open or resolved support channels. Set to true to only
|
|
148
|
+
* return channels awaiting a response, or false for resolved channels.
|
|
141
149
|
*/
|
|
142
150
|
open?: boolean | null;
|
|
143
151
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"support-channels.d.mts","sourceRoot":"","sources":["../src/resources/support-channels.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAI,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC;IAIrG;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC;IAIjF
|
|
1
|
+
{"version":3,"file":"support-channels.d.mts","sourceRoot":"","sources":["../src/resources/support-channels.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAI,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC;IAIrG;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC;IAIjF;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qCAAqC,EAAE,0BAA0B,CAAC;CAMlF;AAED,MAAM,MAAM,qCAAqC,GAAG,UAAU,CAAC,0BAA0B,CAAC,CAAC;AAE3F;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,aAAa,EAAE,0BAA0B,CAAC,YAAY,GAAG,IAAI,CAAC;IAE9D;;;OAGG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,wBAAyB,SAAQ,gBAAgB;IAChE;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,YAAY,GAAG,mBAAmB,GAAG,IAAI,CAAC;CACnD;AAED,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC;IACvC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
|
|
@@ -5,8 +5,8 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
|
|
|
5
5
|
import { RequestOptions } from "../internal/request-options.js";
|
|
6
6
|
export declare class SupportChannels extends APIResource {
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
9
|
-
*
|
|
8
|
+
* Open a new support channel between a company team member and a customer. Returns
|
|
9
|
+
* the existing channel if one already exists for that user.
|
|
10
10
|
*
|
|
11
11
|
* Required permissions:
|
|
12
12
|
*
|
|
@@ -22,7 +22,7 @@ export declare class SupportChannels extends APIResource {
|
|
|
22
22
|
*/
|
|
23
23
|
create(body: SupportChannelCreateParams, options?: RequestOptions): APIPromise<Shared.SupportChannel>;
|
|
24
24
|
/**
|
|
25
|
-
* Retrieves
|
|
25
|
+
* Retrieves the details of an existing support channel.
|
|
26
26
|
*
|
|
27
27
|
* Required permissions:
|
|
28
28
|
*
|
|
@@ -36,7 +36,8 @@ export declare class SupportChannels extends APIResource {
|
|
|
36
36
|
*/
|
|
37
37
|
retrieve(id: string, options?: RequestOptions): APIPromise<Shared.SupportChannel>;
|
|
38
38
|
/**
|
|
39
|
-
*
|
|
39
|
+
* Returns a paginated list of support channels for a specific company, with
|
|
40
|
+
* optional filtering by resolution status and custom sorting.
|
|
40
41
|
*
|
|
41
42
|
* Required permissions:
|
|
42
43
|
*
|
|
@@ -56,7 +57,8 @@ export declare class SupportChannels extends APIResource {
|
|
|
56
57
|
}
|
|
57
58
|
export type SupportChannelListResponsesCursorPage = CursorPage<SupportChannelListResponse>;
|
|
58
59
|
/**
|
|
59
|
-
*
|
|
60
|
+
* A messaging channel that can be a one-on-one DM, group chat, company support
|
|
61
|
+
* conversation, or platform-level direct message.
|
|
60
62
|
*/
|
|
61
63
|
export interface SupportChannelListResponse {
|
|
62
64
|
/**
|
|
@@ -64,58 +66,65 @@ export interface SupportChannelListResponse {
|
|
|
64
66
|
*/
|
|
65
67
|
id: string;
|
|
66
68
|
/**
|
|
67
|
-
* The
|
|
69
|
+
* The unique identifier of the company associated with this channel. Null if this
|
|
70
|
+
* is not a support or company-scoped conversation.
|
|
68
71
|
*/
|
|
69
72
|
company_id: string | null;
|
|
70
73
|
/**
|
|
71
|
-
*
|
|
74
|
+
* A custom display name assigned to this channel by the user. Null if no custom
|
|
75
|
+
* name has been set.
|
|
72
76
|
*/
|
|
73
77
|
custom_name: string | null;
|
|
74
78
|
/**
|
|
75
|
-
* The customer
|
|
79
|
+
* The customer who initiated this support conversation. Null if this is not a
|
|
80
|
+
* support chat.
|
|
76
81
|
*/
|
|
77
82
|
customer_user: SupportChannelListResponse.CustomerUser | null;
|
|
78
83
|
/**
|
|
79
|
-
*
|
|
84
|
+
* The timestamp when the most recent message was sent in this channel. Null if no
|
|
85
|
+
* messages have been sent.
|
|
80
86
|
*/
|
|
81
87
|
last_message_at: string | null;
|
|
82
88
|
/**
|
|
83
|
-
*
|
|
89
|
+
* The timestamp when the linked support ticket was marked as resolved. Null if
|
|
90
|
+
* unresolved or not a support chat.
|
|
84
91
|
*/
|
|
85
92
|
resolved_at: string | null;
|
|
86
93
|
}
|
|
87
94
|
export declare namespace SupportChannelListResponse {
|
|
88
95
|
/**
|
|
89
|
-
* The customer
|
|
96
|
+
* The customer who initiated this support conversation. Null if this is not a
|
|
97
|
+
* support chat.
|
|
90
98
|
*/
|
|
91
99
|
interface CustomerUser {
|
|
92
100
|
/**
|
|
93
|
-
* The
|
|
101
|
+
* The unique identifier for the user.
|
|
94
102
|
*/
|
|
95
103
|
id: string;
|
|
96
104
|
/**
|
|
97
|
-
* The
|
|
105
|
+
* The user's display name shown on their public profile.
|
|
98
106
|
*/
|
|
99
107
|
name: string | null;
|
|
100
108
|
/**
|
|
101
|
-
* The
|
|
109
|
+
* The user's unique username shown on their public profile.
|
|
102
110
|
*/
|
|
103
111
|
username: string;
|
|
104
112
|
}
|
|
105
113
|
}
|
|
106
114
|
export interface SupportChannelCreateParams {
|
|
107
115
|
/**
|
|
108
|
-
* The
|
|
116
|
+
* The unique identifier of the company to create the support channel in.
|
|
109
117
|
*/
|
|
110
118
|
company_id: string;
|
|
111
119
|
/**
|
|
112
|
-
* The ID (
|
|
120
|
+
* The user ID (e.g. 'user_xxxxx') or username of the customer to open a support
|
|
121
|
+
* channel for.
|
|
113
122
|
*/
|
|
114
123
|
user_id: string;
|
|
115
124
|
}
|
|
116
125
|
export interface SupportChannelListParams extends CursorPageParams {
|
|
117
126
|
/**
|
|
118
|
-
* The
|
|
127
|
+
* The unique identifier of the company to list support channels for.
|
|
119
128
|
*/
|
|
120
129
|
company_id: string;
|
|
121
130
|
/**
|
|
@@ -135,9 +144,8 @@ export interface SupportChannelListParams extends CursorPageParams {
|
|
|
135
144
|
*/
|
|
136
145
|
last?: number | null;
|
|
137
146
|
/**
|
|
138
|
-
*
|
|
139
|
-
*
|
|
140
|
-
* resolved channels.
|
|
147
|
+
* Whether to filter by open or resolved support channels. Set to true to only
|
|
148
|
+
* return channels awaiting a response, or false for resolved channels.
|
|
141
149
|
*/
|
|
142
150
|
open?: boolean | null;
|
|
143
151
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"support-channels.d.ts","sourceRoot":"","sources":["../src/resources/support-channels.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAI,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC;IAIrG;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC;IAIjF
|
|
1
|
+
{"version":3,"file":"support-channels.d.ts","sourceRoot":"","sources":["../src/resources/support-channels.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAI,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC;IAIrG;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC;IAIjF;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qCAAqC,EAAE,0BAA0B,CAAC;CAMlF;AAED,MAAM,MAAM,qCAAqC,GAAG,UAAU,CAAC,0BAA0B,CAAC,CAAC;AAE3F;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,aAAa,EAAE,0BAA0B,CAAC,YAAY,GAAG,IAAI,CAAC;IAE9D;;;OAGG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,wBAAyB,SAAQ,gBAAgB;IAChE;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,YAAY,GAAG,mBAAmB,GAAG,IAAI,CAAC;CACnD;AAED,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC;IACvC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
|
|
@@ -7,8 +7,8 @@ const pagination_1 = require("../core/pagination.js");
|
|
|
7
7
|
const path_1 = require("../internal/utils/path.js");
|
|
8
8
|
class SupportChannels extends resource_1.APIResource {
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
11
|
-
*
|
|
10
|
+
* Open a new support channel between a company team member and a customer. Returns
|
|
11
|
+
* the existing channel if one already exists for that user.
|
|
12
12
|
*
|
|
13
13
|
* Required permissions:
|
|
14
14
|
*
|
|
@@ -26,7 +26,7 @@ class SupportChannels extends resource_1.APIResource {
|
|
|
26
26
|
return this._client.post('/support_channels', { body, ...options });
|
|
27
27
|
}
|
|
28
28
|
/**
|
|
29
|
-
* Retrieves
|
|
29
|
+
* Retrieves the details of an existing support channel.
|
|
30
30
|
*
|
|
31
31
|
* Required permissions:
|
|
32
32
|
*
|
|
@@ -42,7 +42,8 @@ class SupportChannels extends resource_1.APIResource {
|
|
|
42
42
|
return this._client.get((0, path_1.path) `/support_channels/${id}`, options);
|
|
43
43
|
}
|
|
44
44
|
/**
|
|
45
|
-
*
|
|
45
|
+
* Returns a paginated list of support channels for a specific company, with
|
|
46
|
+
* optional filtering by resolution status and custom sorting.
|
|
46
47
|
*
|
|
47
48
|
* Required permissions:
|
|
48
49
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"support-channels.js","sourceRoot":"","sources":["../src/resources/support-channels.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,eAAgB,SAAQ,sBAAW;IAC9C;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAgC,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"support-channels.js","sourceRoot":"","sources":["../src/resources/support-channels.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,eAAgB,SAAQ,sBAAW;IAC9C;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAgC,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAA,uBAAsC,CAAA,EAAE;YAC1F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAjED,0CAiEC"}
|
|
@@ -4,8 +4,8 @@ import { CursorPage } from "../core/pagination.mjs";
|
|
|
4
4
|
import { path } from "../internal/utils/path.mjs";
|
|
5
5
|
export class SupportChannels extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
8
|
-
*
|
|
7
|
+
* Open a new support channel between a company team member and a customer. Returns
|
|
8
|
+
* the existing channel if one already exists for that user.
|
|
9
9
|
*
|
|
10
10
|
* Required permissions:
|
|
11
11
|
*
|
|
@@ -23,7 +23,7 @@ export class SupportChannels extends APIResource {
|
|
|
23
23
|
return this._client.post('/support_channels', { body, ...options });
|
|
24
24
|
}
|
|
25
25
|
/**
|
|
26
|
-
* Retrieves
|
|
26
|
+
* Retrieves the details of an existing support channel.
|
|
27
27
|
*
|
|
28
28
|
* Required permissions:
|
|
29
29
|
*
|
|
@@ -39,7 +39,8 @@ export class SupportChannels extends APIResource {
|
|
|
39
39
|
return this._client.get(path `/support_channels/${id}`, options);
|
|
40
40
|
}
|
|
41
41
|
/**
|
|
42
|
-
*
|
|
42
|
+
* Returns a paginated list of support channels for a specific company, with
|
|
43
|
+
* optional filtering by resolution status and custom sorting.
|
|
43
44
|
*
|
|
44
45
|
* Required permissions:
|
|
45
46
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"support-channels.mjs","sourceRoot":"","sources":["../src/resources/support-channels.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAgC,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"support-channels.mjs","sourceRoot":"","sources":["../src/resources/support-channels.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAgC,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAA,UAAsC,CAAA,EAAE;YAC1F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
|
package/resources/topups.d.mts
CHANGED
|
@@ -4,7 +4,8 @@ import { APIPromise } from "../core/api-promise.mjs";
|
|
|
4
4
|
import { RequestOptions } from "../internal/request-options.mjs";
|
|
5
5
|
export declare class Topups extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
* Add funds to
|
|
7
|
+
* Add funds to a company's platform balance by charging a stored payment method.
|
|
8
|
+
* Top-ups have no fees or taxes and do not count as revenue.
|
|
8
9
|
*
|
|
9
10
|
* Required permissions:
|
|
10
11
|
*
|
|
@@ -23,15 +24,16 @@ export declare class Topups extends APIResource {
|
|
|
23
24
|
create(body: TopupCreateParams, options?: RequestOptions): APIPromise<TopupCreateResponse>;
|
|
24
25
|
}
|
|
25
26
|
/**
|
|
26
|
-
*
|
|
27
|
+
* A payment represents a completed or attempted charge. Payments track the amount,
|
|
28
|
+
* status, currency, and payment method used.
|
|
27
29
|
*/
|
|
28
30
|
export interface TopupCreateResponse {
|
|
29
31
|
/**
|
|
30
|
-
* The payment
|
|
32
|
+
* The unique identifier for the payment.
|
|
31
33
|
*/
|
|
32
34
|
id: string;
|
|
33
35
|
/**
|
|
34
|
-
* The datetime the payment was created
|
|
36
|
+
* The datetime the payment was created.
|
|
35
37
|
*/
|
|
36
38
|
created_at: string;
|
|
37
39
|
/**
|
|
@@ -43,7 +45,8 @@ export interface TopupCreateResponse {
|
|
|
43
45
|
*/
|
|
44
46
|
failure_message: string | null;
|
|
45
47
|
/**
|
|
46
|
-
* The
|
|
48
|
+
* The time at which this payment was successfully collected. Null if the payment
|
|
49
|
+
* has not yet succeeded. As a Unix timestamp.
|
|
47
50
|
*/
|
|
48
51
|
paid_at: string | null;
|
|
49
52
|
/**
|
|
@@ -57,19 +60,20 @@ export interface TopupCreateResponse {
|
|
|
57
60
|
}
|
|
58
61
|
export interface TopupCreateParams {
|
|
59
62
|
/**
|
|
60
|
-
* The amount to add to the balance.
|
|
63
|
+
* The amount to add to the balance in the specified currency. For example, 50.00
|
|
64
|
+
* for $50.00 USD.
|
|
61
65
|
*/
|
|
62
66
|
amount: number;
|
|
63
67
|
/**
|
|
64
|
-
* The
|
|
68
|
+
* The unique identifier of the company to add funds to, starting with 'biz\_'.
|
|
65
69
|
*/
|
|
66
70
|
company_id: string;
|
|
67
71
|
/**
|
|
68
|
-
* The currency
|
|
72
|
+
* The currency for the top-up amount, such as 'usd'.
|
|
69
73
|
*/
|
|
70
74
|
currency: Shared.Currency;
|
|
71
75
|
/**
|
|
72
|
-
* The
|
|
76
|
+
* The unique identifier of the stored payment method to charge for the top-up.
|
|
73
77
|
*/
|
|
74
78
|
payment_method_id: string;
|
|
75
79
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"topups.d.mts","sourceRoot":"","sources":["../src/resources/topups.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC
|
|
1
|
+
{"version":3,"file":"topups.d.mts","sourceRoot":"","sources":["../src/resources/topups.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAG3F;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,CAAC;CACzG"}
|
package/resources/topups.d.ts
CHANGED
|
@@ -4,7 +4,8 @@ import { APIPromise } from "../core/api-promise.js";
|
|
|
4
4
|
import { RequestOptions } from "../internal/request-options.js";
|
|
5
5
|
export declare class Topups extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
* Add funds to
|
|
7
|
+
* Add funds to a company's platform balance by charging a stored payment method.
|
|
8
|
+
* Top-ups have no fees or taxes and do not count as revenue.
|
|
8
9
|
*
|
|
9
10
|
* Required permissions:
|
|
10
11
|
*
|
|
@@ -23,15 +24,16 @@ export declare class Topups extends APIResource {
|
|
|
23
24
|
create(body: TopupCreateParams, options?: RequestOptions): APIPromise<TopupCreateResponse>;
|
|
24
25
|
}
|
|
25
26
|
/**
|
|
26
|
-
*
|
|
27
|
+
* A payment represents a completed or attempted charge. Payments track the amount,
|
|
28
|
+
* status, currency, and payment method used.
|
|
27
29
|
*/
|
|
28
30
|
export interface TopupCreateResponse {
|
|
29
31
|
/**
|
|
30
|
-
* The payment
|
|
32
|
+
* The unique identifier for the payment.
|
|
31
33
|
*/
|
|
32
34
|
id: string;
|
|
33
35
|
/**
|
|
34
|
-
* The datetime the payment was created
|
|
36
|
+
* The datetime the payment was created.
|
|
35
37
|
*/
|
|
36
38
|
created_at: string;
|
|
37
39
|
/**
|
|
@@ -43,7 +45,8 @@ export interface TopupCreateResponse {
|
|
|
43
45
|
*/
|
|
44
46
|
failure_message: string | null;
|
|
45
47
|
/**
|
|
46
|
-
* The
|
|
48
|
+
* The time at which this payment was successfully collected. Null if the payment
|
|
49
|
+
* has not yet succeeded. As a Unix timestamp.
|
|
47
50
|
*/
|
|
48
51
|
paid_at: string | null;
|
|
49
52
|
/**
|
|
@@ -57,19 +60,20 @@ export interface TopupCreateResponse {
|
|
|
57
60
|
}
|
|
58
61
|
export interface TopupCreateParams {
|
|
59
62
|
/**
|
|
60
|
-
* The amount to add to the balance.
|
|
63
|
+
* The amount to add to the balance in the specified currency. For example, 50.00
|
|
64
|
+
* for $50.00 USD.
|
|
61
65
|
*/
|
|
62
66
|
amount: number;
|
|
63
67
|
/**
|
|
64
|
-
* The
|
|
68
|
+
* The unique identifier of the company to add funds to, starting with 'biz\_'.
|
|
65
69
|
*/
|
|
66
70
|
company_id: string;
|
|
67
71
|
/**
|
|
68
|
-
* The currency
|
|
72
|
+
* The currency for the top-up amount, such as 'usd'.
|
|
69
73
|
*/
|
|
70
74
|
currency: Shared.Currency;
|
|
71
75
|
/**
|
|
72
|
-
* The
|
|
76
|
+
* The unique identifier of the stored payment method to charge for the top-up.
|
|
73
77
|
*/
|
|
74
78
|
payment_method_id: string;
|
|
75
79
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"topups.d.ts","sourceRoot":"","sources":["../src/resources/topups.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC
|
|
1
|
+
{"version":3,"file":"topups.d.ts","sourceRoot":"","sources":["../src/resources/topups.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAG3F;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,CAAC;CACzG"}
|
package/resources/topups.js
CHANGED
|
@@ -5,7 +5,8 @@ exports.Topups = void 0;
|
|
|
5
5
|
const resource_1 = require("../core/resource.js");
|
|
6
6
|
class Topups extends resource_1.APIResource {
|
|
7
7
|
/**
|
|
8
|
-
* Add funds to
|
|
8
|
+
* Add funds to a company's platform balance by charging a stored payment method.
|
|
9
|
+
* Top-ups have no fees or taxes and do not count as revenue.
|
|
9
10
|
*
|
|
10
11
|
* Required permissions:
|
|
11
12
|
*
|
package/resources/topups.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"topups.js","sourceRoot":"","sources":["../src/resources/topups.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAK/C,MAAa,MAAO,SAAQ,sBAAW;IACrC
|
|
1
|
+
{"version":3,"file":"topups.js","sourceRoot":"","sources":["../src/resources/topups.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAK/C,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,IAAuB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;CACF;AAtBD,wBAsBC"}
|
package/resources/topups.mjs
CHANGED
|
@@ -2,7 +2,8 @@
|
|
|
2
2
|
import { APIResource } from "../core/resource.mjs";
|
|
3
3
|
export class Topups extends APIResource {
|
|
4
4
|
/**
|
|
5
|
-
* Add funds to
|
|
5
|
+
* Add funds to a company's platform balance by charging a stored payment method.
|
|
6
|
+
* Top-ups have no fees or taxes and do not count as revenue.
|
|
6
7
|
*
|
|
7
8
|
* Required permissions:
|
|
8
9
|
*
|
package/resources/topups.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"topups.mjs","sourceRoot":"","sources":["../src/resources/topups.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAKtB,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC
|
|
1
|
+
{"version":3,"file":"topups.mjs","sourceRoot":"","sources":["../src/resources/topups.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAKtB,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,IAAuB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;CACF"}
|