@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
|
@@ -4,7 +4,8 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
|
|
|
4
4
|
import { RequestOptions } from "../internal/request-options.js";
|
|
5
5
|
export declare class CompanyTokenTransactions extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
* Create a token transaction
|
|
7
|
+
* Create a token transaction to add, subtract, or transfer tokens for a member
|
|
8
|
+
* within a company.
|
|
8
9
|
*
|
|
9
10
|
* Required permissions:
|
|
10
11
|
*
|
|
@@ -26,7 +27,7 @@ export declare class CompanyTokenTransactions extends APIResource {
|
|
|
26
27
|
*/
|
|
27
28
|
create(body: CompanyTokenTransactionCreateParams, options?: RequestOptions): APIPromise<CompanyTokenTransaction>;
|
|
28
29
|
/**
|
|
29
|
-
* Retrieves
|
|
30
|
+
* Retrieves the details of an existing company token transaction.
|
|
30
31
|
*
|
|
31
32
|
* Required permissions:
|
|
32
33
|
*
|
|
@@ -36,7 +37,9 @@ export declare class CompanyTokenTransactions extends APIResource {
|
|
|
36
37
|
*/
|
|
37
38
|
retrieve(id: string, options?: RequestOptions): APIPromise<CompanyTokenTransaction>;
|
|
38
39
|
/**
|
|
39
|
-
*
|
|
40
|
+
* Returns a paginated list of token transactions for a user or company, depending
|
|
41
|
+
* on the authenticated actor, with optional filtering by user and transaction
|
|
42
|
+
* type.
|
|
40
43
|
*
|
|
41
44
|
* Required permissions:
|
|
42
45
|
*
|
|
@@ -48,61 +51,62 @@ export declare class CompanyTokenTransactions extends APIResource {
|
|
|
48
51
|
}
|
|
49
52
|
export type CompanyTokenTransactionListResponsesCursorPage = CursorPage<CompanyTokenTransactionListResponse>;
|
|
50
53
|
/**
|
|
51
|
-
*
|
|
52
|
-
|
|
53
|
-
export type BotTokenTransactionTypes = 'add' | 'subtract' | 'transfer';
|
|
54
|
-
/**
|
|
55
|
-
* A token transaction within a company
|
|
54
|
+
* A token transaction records a credit or debit to a member's token balance within
|
|
55
|
+
* a company, including transfers between members.
|
|
56
56
|
*/
|
|
57
57
|
export interface CompanyTokenTransaction {
|
|
58
58
|
/**
|
|
59
|
-
* The
|
|
59
|
+
* The unique identifier for the company token transaction.
|
|
60
60
|
*/
|
|
61
61
|
id: string;
|
|
62
62
|
/**
|
|
63
|
-
* The
|
|
63
|
+
* The token amount for this transaction. Always a positive value regardless of
|
|
64
|
+
* transaction type.
|
|
64
65
|
*/
|
|
65
66
|
amount: number;
|
|
66
67
|
/**
|
|
67
|
-
* The company
|
|
68
|
+
* The company whose token balance this transaction affects.
|
|
68
69
|
*/
|
|
69
70
|
company: CompanyTokenTransaction.Company;
|
|
70
71
|
/**
|
|
71
|
-
*
|
|
72
|
+
* The datetime the company token transaction was created.
|
|
72
73
|
*/
|
|
73
74
|
created_at: string;
|
|
74
75
|
/**
|
|
75
|
-
*
|
|
76
|
+
* Free-text description explaining the reason for this token transaction. Null if
|
|
77
|
+
* no description was provided.
|
|
76
78
|
*/
|
|
77
79
|
description: string | null;
|
|
78
80
|
/**
|
|
79
|
-
*
|
|
81
|
+
* A unique key used to prevent duplicate transactions when retrying API requests.
|
|
82
|
+
* Null if no idempotency key was provided.
|
|
80
83
|
*/
|
|
81
84
|
idempotency_key: string | null;
|
|
82
85
|
/**
|
|
83
|
-
*
|
|
86
|
+
* The ID of the corresponding transaction on the other side of a transfer. Null if
|
|
87
|
+
* this is not a transfer transaction.
|
|
84
88
|
*/
|
|
85
89
|
linked_transaction_id: string | null;
|
|
86
90
|
/**
|
|
87
|
-
* The member
|
|
91
|
+
* The member whose token balance was affected by this transaction.
|
|
88
92
|
*/
|
|
89
93
|
member: CompanyTokenTransaction.Member;
|
|
90
94
|
/**
|
|
91
|
-
* The
|
|
95
|
+
* The direction of this token transaction (add, subtract, or transfer).
|
|
92
96
|
*/
|
|
93
|
-
transaction_type:
|
|
97
|
+
transaction_type: CompanyTokenTransactionType;
|
|
94
98
|
/**
|
|
95
|
-
* The user whose balance
|
|
99
|
+
* The user whose token balance was affected by this transaction.
|
|
96
100
|
*/
|
|
97
101
|
user: CompanyTokenTransaction.User;
|
|
98
102
|
}
|
|
99
103
|
export declare namespace CompanyTokenTransaction {
|
|
100
104
|
/**
|
|
101
|
-
* The company
|
|
105
|
+
* The company whose token balance this transaction affects.
|
|
102
106
|
*/
|
|
103
107
|
interface Company {
|
|
104
108
|
/**
|
|
105
|
-
* The
|
|
109
|
+
* The unique identifier for the company.
|
|
106
110
|
*/
|
|
107
111
|
id: string;
|
|
108
112
|
/**
|
|
@@ -115,84 +119,93 @@ export declare namespace CompanyTokenTransaction {
|
|
|
115
119
|
title: string;
|
|
116
120
|
}
|
|
117
121
|
/**
|
|
118
|
-
* The member
|
|
122
|
+
* The member whose token balance was affected by this transaction.
|
|
119
123
|
*/
|
|
120
124
|
interface Member {
|
|
121
125
|
/**
|
|
122
|
-
* The
|
|
126
|
+
* The unique identifier for the company member.
|
|
123
127
|
*/
|
|
124
128
|
id: string;
|
|
125
129
|
}
|
|
126
130
|
/**
|
|
127
|
-
* The user whose balance
|
|
131
|
+
* The user whose token balance was affected by this transaction.
|
|
128
132
|
*/
|
|
129
133
|
interface User {
|
|
130
134
|
/**
|
|
131
|
-
* The
|
|
135
|
+
* The unique identifier for the user.
|
|
132
136
|
*/
|
|
133
137
|
id: string;
|
|
134
138
|
/**
|
|
135
|
-
* The
|
|
139
|
+
* The user's display name shown on their public profile.
|
|
136
140
|
*/
|
|
137
141
|
name: string | null;
|
|
138
142
|
/**
|
|
139
|
-
* The
|
|
143
|
+
* The user's unique username shown on their public profile.
|
|
140
144
|
*/
|
|
141
145
|
username: string;
|
|
142
146
|
}
|
|
143
147
|
}
|
|
144
148
|
/**
|
|
145
|
-
*
|
|
149
|
+
* The type of token transaction
|
|
150
|
+
*/
|
|
151
|
+
export type CompanyTokenTransactionType = 'add' | 'subtract' | 'transfer';
|
|
152
|
+
/**
|
|
153
|
+
* A token transaction records a credit or debit to a member's token balance within
|
|
154
|
+
* a company, including transfers between members.
|
|
146
155
|
*/
|
|
147
156
|
export interface CompanyTokenTransactionListResponse {
|
|
148
157
|
/**
|
|
149
|
-
* The
|
|
158
|
+
* The unique identifier for the company token transaction.
|
|
150
159
|
*/
|
|
151
160
|
id: string;
|
|
152
161
|
/**
|
|
153
|
-
* The
|
|
162
|
+
* The token amount for this transaction. Always a positive value regardless of
|
|
163
|
+
* transaction type.
|
|
154
164
|
*/
|
|
155
165
|
amount: number;
|
|
156
166
|
/**
|
|
157
|
-
* The company
|
|
167
|
+
* The company whose token balance this transaction affects.
|
|
158
168
|
*/
|
|
159
169
|
company: CompanyTokenTransactionListResponse.Company;
|
|
160
170
|
/**
|
|
161
|
-
*
|
|
171
|
+
* The datetime the company token transaction was created.
|
|
162
172
|
*/
|
|
163
173
|
created_at: string;
|
|
164
174
|
/**
|
|
165
|
-
*
|
|
175
|
+
* Free-text description explaining the reason for this token transaction. Null if
|
|
176
|
+
* no description was provided.
|
|
166
177
|
*/
|
|
167
178
|
description: string | null;
|
|
168
179
|
/**
|
|
169
|
-
*
|
|
180
|
+
* A unique key used to prevent duplicate transactions when retrying API requests.
|
|
181
|
+
* Null if no idempotency key was provided.
|
|
170
182
|
*/
|
|
171
183
|
idempotency_key: string | null;
|
|
172
184
|
/**
|
|
173
|
-
*
|
|
185
|
+
* The ID of the corresponding transaction on the other side of a transfer. Null if
|
|
186
|
+
* this is not a transfer transaction.
|
|
174
187
|
*/
|
|
175
188
|
linked_transaction_id: string | null;
|
|
176
189
|
/**
|
|
177
|
-
* The member
|
|
190
|
+
* The member whose token balance was affected by this transaction.
|
|
178
191
|
*/
|
|
179
192
|
member: CompanyTokenTransactionListResponse.Member;
|
|
180
193
|
/**
|
|
181
|
-
* The
|
|
194
|
+
* The direction of this token transaction (add, subtract, or transfer).
|
|
182
195
|
*/
|
|
183
|
-
transaction_type:
|
|
196
|
+
transaction_type: CompanyTokenTransactionType;
|
|
184
197
|
/**
|
|
185
|
-
* The user whose balance
|
|
198
|
+
* The user whose token balance was affected by this transaction.
|
|
186
199
|
*/
|
|
187
200
|
user: CompanyTokenTransactionListResponse.User;
|
|
188
201
|
}
|
|
189
202
|
export declare namespace CompanyTokenTransactionListResponse {
|
|
190
203
|
/**
|
|
191
|
-
* The company
|
|
204
|
+
* The company whose token balance this transaction affects.
|
|
192
205
|
*/
|
|
193
206
|
interface Company {
|
|
194
207
|
/**
|
|
195
|
-
* The
|
|
208
|
+
* The unique identifier for the company.
|
|
196
209
|
*/
|
|
197
210
|
id: string;
|
|
198
211
|
/**
|
|
@@ -205,28 +218,28 @@ export declare namespace CompanyTokenTransactionListResponse {
|
|
|
205
218
|
title: string;
|
|
206
219
|
}
|
|
207
220
|
/**
|
|
208
|
-
* The member
|
|
221
|
+
* The member whose token balance was affected by this transaction.
|
|
209
222
|
*/
|
|
210
223
|
interface Member {
|
|
211
224
|
/**
|
|
212
|
-
* The
|
|
225
|
+
* The unique identifier for the company member.
|
|
213
226
|
*/
|
|
214
227
|
id: string;
|
|
215
228
|
}
|
|
216
229
|
/**
|
|
217
|
-
* The user whose balance
|
|
230
|
+
* The user whose token balance was affected by this transaction.
|
|
218
231
|
*/
|
|
219
232
|
interface User {
|
|
220
233
|
/**
|
|
221
|
-
* The
|
|
234
|
+
* The unique identifier for the user.
|
|
222
235
|
*/
|
|
223
236
|
id: string;
|
|
224
237
|
/**
|
|
225
|
-
* The
|
|
238
|
+
* The user's display name shown on their public profile.
|
|
226
239
|
*/
|
|
227
240
|
name: string | null;
|
|
228
241
|
/**
|
|
229
|
-
* The
|
|
242
|
+
* The user's unique username shown on their public profile.
|
|
230
243
|
*/
|
|
231
244
|
username: string;
|
|
232
245
|
}
|
|
@@ -235,81 +248,91 @@ export type CompanyTokenTransactionCreateParams = CompanyTokenTransactionCreateP
|
|
|
235
248
|
export declare namespace CompanyTokenTransactionCreateParams {
|
|
236
249
|
interface CreateCompanyTokenTransactionInputTransactionTypeTransfer {
|
|
237
250
|
/**
|
|
238
|
-
* The positive
|
|
251
|
+
* The positive number of tokens to transact. For example, 100.0 for 100 tokens.
|
|
239
252
|
*/
|
|
240
253
|
amount: number;
|
|
241
254
|
/**
|
|
242
|
-
* The company
|
|
255
|
+
* The unique identifier of the company to create the transaction in, starting with
|
|
256
|
+
* 'biz\_'.
|
|
243
257
|
*/
|
|
244
258
|
company_id: string;
|
|
245
259
|
/**
|
|
246
|
-
*
|
|
260
|
+
* The unique identifier of the user receiving the tokens. Required when the
|
|
261
|
+
* transaction type is 'transfer'.
|
|
247
262
|
*/
|
|
248
263
|
destination_user_id: string;
|
|
249
264
|
transaction_type: 'transfer';
|
|
250
265
|
/**
|
|
251
|
-
* The user
|
|
266
|
+
* The unique identifier of the user whose token balance will be affected, starting
|
|
267
|
+
* with 'user\_'.
|
|
252
268
|
*/
|
|
253
269
|
user_id: string;
|
|
254
270
|
/**
|
|
255
|
-
*
|
|
271
|
+
* A human-readable description of why the transaction was created.
|
|
256
272
|
*/
|
|
257
273
|
description?: string | null;
|
|
258
274
|
/**
|
|
259
|
-
*
|
|
275
|
+
* A unique key to prevent duplicate transactions. Use a UUID or similar unique
|
|
276
|
+
* string.
|
|
260
277
|
*/
|
|
261
278
|
idempotency_key?: string | null;
|
|
262
279
|
}
|
|
263
280
|
interface CreateCompanyTokenTransactionInputTransactionTypeAdd {
|
|
264
281
|
/**
|
|
265
|
-
* The positive
|
|
282
|
+
* The positive number of tokens to transact. For example, 100.0 for 100 tokens.
|
|
266
283
|
*/
|
|
267
284
|
amount: number;
|
|
268
285
|
/**
|
|
269
|
-
* The company
|
|
286
|
+
* The unique identifier of the company to create the transaction in, starting with
|
|
287
|
+
* 'biz\_'.
|
|
270
288
|
*/
|
|
271
289
|
company_id: string;
|
|
272
290
|
transaction_type: 'add';
|
|
273
291
|
/**
|
|
274
|
-
* The user
|
|
292
|
+
* The unique identifier of the user whose token balance will be affected, starting
|
|
293
|
+
* with 'user\_'.
|
|
275
294
|
*/
|
|
276
295
|
user_id: string;
|
|
277
296
|
/**
|
|
278
|
-
*
|
|
297
|
+
* A human-readable description of why the transaction was created.
|
|
279
298
|
*/
|
|
280
299
|
description?: string | null;
|
|
281
300
|
/**
|
|
282
|
-
*
|
|
301
|
+
* A unique key to prevent duplicate transactions. Use a UUID or similar unique
|
|
302
|
+
* string.
|
|
283
303
|
*/
|
|
284
304
|
idempotency_key?: string | null;
|
|
285
305
|
}
|
|
286
306
|
interface CreateCompanyTokenTransactionInputTransactionTypeSubtract {
|
|
287
307
|
/**
|
|
288
|
-
* The positive
|
|
308
|
+
* The positive number of tokens to transact. For example, 100.0 for 100 tokens.
|
|
289
309
|
*/
|
|
290
310
|
amount: number;
|
|
291
311
|
/**
|
|
292
|
-
* The company
|
|
312
|
+
* The unique identifier of the company to create the transaction in, starting with
|
|
313
|
+
* 'biz\_'.
|
|
293
314
|
*/
|
|
294
315
|
company_id: string;
|
|
295
316
|
transaction_type: 'subtract';
|
|
296
317
|
/**
|
|
297
|
-
* The user
|
|
318
|
+
* The unique identifier of the user whose token balance will be affected, starting
|
|
319
|
+
* with 'user\_'.
|
|
298
320
|
*/
|
|
299
321
|
user_id: string;
|
|
300
322
|
/**
|
|
301
|
-
*
|
|
323
|
+
* A human-readable description of why the transaction was created.
|
|
302
324
|
*/
|
|
303
325
|
description?: string | null;
|
|
304
326
|
/**
|
|
305
|
-
*
|
|
327
|
+
* A unique key to prevent duplicate transactions. Use a UUID or similar unique
|
|
328
|
+
* string.
|
|
306
329
|
*/
|
|
307
330
|
idempotency_key?: string | null;
|
|
308
331
|
}
|
|
309
332
|
}
|
|
310
333
|
export interface CompanyTokenTransactionListParams extends CursorPageParams {
|
|
311
334
|
/**
|
|
312
|
-
* The
|
|
335
|
+
* The unique identifier of the company to list token transactions for.
|
|
313
336
|
*/
|
|
314
337
|
company_id: string;
|
|
315
338
|
/**
|
|
@@ -327,13 +350,13 @@ export interface CompanyTokenTransactionListParams extends CursorPageParams {
|
|
|
327
350
|
/**
|
|
328
351
|
* The type of token transaction
|
|
329
352
|
*/
|
|
330
|
-
transaction_type?:
|
|
353
|
+
transaction_type?: CompanyTokenTransactionType | null;
|
|
331
354
|
/**
|
|
332
|
-
* Filter
|
|
355
|
+
* Filter transactions to only those involving this specific user.
|
|
333
356
|
*/
|
|
334
357
|
user_id?: string | null;
|
|
335
358
|
}
|
|
336
359
|
export declare namespace CompanyTokenTransactions {
|
|
337
|
-
export { type
|
|
360
|
+
export { type CompanyTokenTransaction as CompanyTokenTransaction, type CompanyTokenTransactionType as CompanyTokenTransactionType, type CompanyTokenTransactionListResponse as CompanyTokenTransactionListResponse, type CompanyTokenTransactionListResponsesCursorPage as CompanyTokenTransactionListResponsesCursorPage, type CompanyTokenTransactionCreateParams as CompanyTokenTransactionCreateParams, type CompanyTokenTransactionListParams as CompanyTokenTransactionListParams, };
|
|
338
361
|
}
|
|
339
362
|
//# sourceMappingURL=company-token-transactions.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"company-token-transactions.d.ts","sourceRoot":"","sources":["../src/resources/company-token-transactions.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,wBAAyB,SAAQ,WAAW;IACvD
|
|
1
|
+
{"version":3,"file":"company-token-transactions.d.ts","sourceRoot":"","sources":["../src/resources/company-token-transactions.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,wBAAyB,SAAQ,WAAW;IACvD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CACJ,IAAI,EAAE,mCAAmC,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAItC;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAInF;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,EAAE,iCAAiC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,8CAA8C,EAAE,mCAAmC,CAAC;CAOpG;AAED,MAAM,MAAM,8CAA8C,GAAG,UAAU,CAAC,mCAAmC,CAAC,CAAC;AAE7G;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,uBAAuB,CAAC,OAAO,CAAC;IAEzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,MAAM,EAAE,uBAAuB,CAAC,MAAM,CAAC;IAEvC;;OAEG;IACH,gBAAgB,EAAE,2BAA2B,CAAC;IAE9C;;OAEG;IACH,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;CACpC;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,KAAK,GAAG,UAAU,GAAG,UAAU,CAAC;AAE1E;;;GAGG;AACH,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,mCAAmC,CAAC,OAAO,CAAC;IAErD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,MAAM,EAAE,mCAAmC,CAAC,MAAM,CAAC;IAEnD;;OAEG;IACH,gBAAgB,EAAE,2BAA2B,CAAC;IAE9C;;OAEG;IACH,IAAI,EAAE,mCAAmC,CAAC,IAAI,CAAC;CAChD;AAED,yBAAiB,mCAAmC,CAAC;IACnD;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,MAAM,mCAAmC,GAC3C,mCAAmC,CAAC,yDAAyD,GAC7F,mCAAmC,CAAC,oDAAoD,GACxF,mCAAmC,CAAC,yDAAyD,CAAC;AAElG,MAAM,CAAC,OAAO,WAAW,mCAAmC,CAAC;IAC3D,UAAiB,yDAAyD;QACxE;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B,gBAAgB,EAAE,UAAU,CAAC;QAE7B;;;WAGG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;;WAGG;QACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACjC;IAED,UAAiB,oDAAoD;QACnE;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB,gBAAgB,EAAE,KAAK,CAAC;QAExB;;;WAGG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;;WAGG;QACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACjC;IAED,UAAiB,yDAAyD;QACxE;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB,gBAAgB,EAAE,UAAU,CAAC;QAE7B;;;WAGG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;;WAGG;QACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACjC;CACF;AAED,MAAM,WAAW,iCAAkC,SAAQ,gBAAgB;IACzE;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;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;IAErB;;OAEG;IACH,gBAAgB,CAAC,EAAE,2BAA2B,GAAG,IAAI,CAAC;IAEtD;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,wBAAwB,CAAC;IAChD,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,8CAA8C,IAAI,8CAA8C,EACrG,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;CACH"}
|
|
@@ -7,7 +7,8 @@ const pagination_1 = require("../core/pagination.js");
|
|
|
7
7
|
const path_1 = require("../internal/utils/path.js");
|
|
8
8
|
class CompanyTokenTransactions extends resource_1.APIResource {
|
|
9
9
|
/**
|
|
10
|
-
* Create a token transaction
|
|
10
|
+
* Create a token transaction to add, subtract, or transfer tokens for a member
|
|
11
|
+
* within a company.
|
|
11
12
|
*
|
|
12
13
|
* Required permissions:
|
|
13
14
|
*
|
|
@@ -31,7 +32,7 @@ class CompanyTokenTransactions extends resource_1.APIResource {
|
|
|
31
32
|
return this._client.post('/company_token_transactions', { body, ...options });
|
|
32
33
|
}
|
|
33
34
|
/**
|
|
34
|
-
* Retrieves
|
|
35
|
+
* Retrieves the details of an existing company token transaction.
|
|
35
36
|
*
|
|
36
37
|
* Required permissions:
|
|
37
38
|
*
|
|
@@ -43,7 +44,9 @@ class CompanyTokenTransactions extends resource_1.APIResource {
|
|
|
43
44
|
return this._client.get((0, path_1.path) `/company_token_transactions/${id}`, options);
|
|
44
45
|
}
|
|
45
46
|
/**
|
|
46
|
-
*
|
|
47
|
+
* Returns a paginated list of token transactions for a user or company, depending
|
|
48
|
+
* on the authenticated actor, with optional filtering by user and transaction
|
|
49
|
+
* type.
|
|
47
50
|
*
|
|
48
51
|
* Required permissions:
|
|
49
52
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"company-token-transactions.js","sourceRoot":"","sources":["../src/resources/company-token-transactions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,wBAAyB,SAAQ,sBAAW;IACvD
|
|
1
|
+
{"version":3,"file":"company-token-transactions.js","sourceRoot":"","sources":["../src/resources/company-token-transactions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,wBAAyB,SAAQ,sBAAW;IACvD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CACJ,IAAyC,EACzC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,+BAA+B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,6BAA6B,EAC7B,CAAA,uBAA+C,CAAA,EAC/C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AAhED,4DAgEC"}
|
|
@@ -4,7 +4,8 @@ import { CursorPage } from "../core/pagination.mjs";
|
|
|
4
4
|
import { path } from "../internal/utils/path.mjs";
|
|
5
5
|
export class CompanyTokenTransactions extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
* Create a token transaction
|
|
7
|
+
* Create a token transaction to add, subtract, or transfer tokens for a member
|
|
8
|
+
* within a company.
|
|
8
9
|
*
|
|
9
10
|
* Required permissions:
|
|
10
11
|
*
|
|
@@ -28,7 +29,7 @@ export class CompanyTokenTransactions extends APIResource {
|
|
|
28
29
|
return this._client.post('/company_token_transactions', { body, ...options });
|
|
29
30
|
}
|
|
30
31
|
/**
|
|
31
|
-
* Retrieves
|
|
32
|
+
* Retrieves the details of an existing company token transaction.
|
|
32
33
|
*
|
|
33
34
|
* Required permissions:
|
|
34
35
|
*
|
|
@@ -40,7 +41,9 @@ export class CompanyTokenTransactions extends APIResource {
|
|
|
40
41
|
return this._client.get(path `/company_token_transactions/${id}`, options);
|
|
41
42
|
}
|
|
42
43
|
/**
|
|
43
|
-
*
|
|
44
|
+
* Returns a paginated list of token transactions for a user or company, depending
|
|
45
|
+
* on the authenticated actor, with optional filtering by user and transaction
|
|
46
|
+
* type.
|
|
44
47
|
*
|
|
45
48
|
* Required permissions:
|
|
46
49
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"company-token-transactions.mjs","sourceRoot":"","sources":["../src/resources/company-token-transactions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,wBAAyB,SAAQ,WAAW;IACvD
|
|
1
|
+
{"version":3,"file":"company-token-transactions.mjs","sourceRoot":"","sources":["../src/resources/company-token-transactions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,wBAAyB,SAAQ,WAAW;IACvD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CACJ,IAAyC,EACzC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,+BAA+B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,6BAA6B,EAC7B,CAAA,UAA+C,CAAA,EAC/C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF"}
|
|
@@ -4,7 +4,7 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
|
|
|
4
4
|
import { RequestOptions } from "../internal/request-options.mjs";
|
|
5
5
|
export declare class CourseChapters extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* Create a new chapter within a course to organize lessons into sections.
|
|
8
8
|
*
|
|
9
9
|
* Required permissions:
|
|
10
10
|
*
|
|
@@ -19,7 +19,7 @@ export declare class CourseChapters extends APIResource {
|
|
|
19
19
|
*/
|
|
20
20
|
create(body: CourseChapterCreateParams, options?: RequestOptions): APIPromise<CourseChapter>;
|
|
21
21
|
/**
|
|
22
|
-
* Retrieves
|
|
22
|
+
* Retrieves the details of an existing course chapter.
|
|
23
23
|
*
|
|
24
24
|
* Required permissions:
|
|
25
25
|
*
|
|
@@ -34,7 +34,7 @@ export declare class CourseChapters extends APIResource {
|
|
|
34
34
|
*/
|
|
35
35
|
retrieve(id: string, options?: RequestOptions): APIPromise<CourseChapter>;
|
|
36
36
|
/**
|
|
37
|
-
*
|
|
37
|
+
* Update a chapter's title within a course.
|
|
38
38
|
*
|
|
39
39
|
* Required permissions:
|
|
40
40
|
*
|
|
@@ -50,7 +50,7 @@ export declare class CourseChapters extends APIResource {
|
|
|
50
50
|
*/
|
|
51
51
|
update(id: string, body: CourseChapterUpdateParams, options?: RequestOptions): APIPromise<CourseChapter>;
|
|
52
52
|
/**
|
|
53
|
-
*
|
|
53
|
+
* Returns a paginated list of chapters within a course, ordered by position.
|
|
54
54
|
*
|
|
55
55
|
* Required permissions:
|
|
56
56
|
*
|
|
@@ -68,7 +68,7 @@ export declare class CourseChapters extends APIResource {
|
|
|
68
68
|
*/
|
|
69
69
|
list(query: CourseChapterListParams, options?: RequestOptions): PagePromise<CourseChapterListResponsesCursorPage, CourseChapterListResponse>;
|
|
70
70
|
/**
|
|
71
|
-
*
|
|
71
|
+
* Permanently delete a chapter and all of its lessons from a course.
|
|
72
72
|
*
|
|
73
73
|
* Required permissions:
|
|
74
74
|
*
|
|
@@ -85,59 +85,63 @@ export declare class CourseChapters extends APIResource {
|
|
|
85
85
|
}
|
|
86
86
|
export type CourseChapterListResponsesCursorPage = CursorPage<CourseChapterListResponse>;
|
|
87
87
|
/**
|
|
88
|
-
* A
|
|
88
|
+
* A grouping of related lessons within a course, used to organize content into
|
|
89
|
+
* sections.
|
|
89
90
|
*/
|
|
90
91
|
export interface CourseChapter {
|
|
91
92
|
/**
|
|
92
|
-
* The
|
|
93
|
+
* The unique identifier for the chapter.
|
|
93
94
|
*/
|
|
94
95
|
id: string;
|
|
95
96
|
/**
|
|
96
|
-
*
|
|
97
|
+
* An ordered list of lessons in this chapter, sorted by display position. Hidden
|
|
98
|
+
* lessons are excluded for non-admin users.
|
|
97
99
|
*/
|
|
98
100
|
lessons: Array<CourseChapter.Lesson>;
|
|
99
101
|
/**
|
|
100
|
-
* The
|
|
102
|
+
* The sort position of this chapter within its parent course, starting from zero.
|
|
101
103
|
*/
|
|
102
104
|
order: number;
|
|
103
105
|
/**
|
|
104
|
-
* The
|
|
106
|
+
* The display name of the chapter shown to students. Maximum 150 characters.
|
|
105
107
|
*/
|
|
106
108
|
title: string;
|
|
107
109
|
}
|
|
108
110
|
export declare namespace CourseChapter {
|
|
109
111
|
/**
|
|
110
|
-
*
|
|
112
|
+
* An individual learning unit within a chapter, which can contain text, video,
|
|
113
|
+
* PDF, or assessment content.
|
|
111
114
|
*/
|
|
112
115
|
interface Lesson {
|
|
113
116
|
/**
|
|
114
|
-
* The
|
|
117
|
+
* The unique identifier for the lesson.
|
|
115
118
|
*/
|
|
116
119
|
id: string;
|
|
117
120
|
/**
|
|
118
|
-
* The
|
|
121
|
+
* The sort position of this lesson within its parent chapter, starting from zero.
|
|
119
122
|
*/
|
|
120
123
|
order: number;
|
|
121
124
|
/**
|
|
122
|
-
* The
|
|
125
|
+
* The display name of the lesson shown to students. Maximum 120 characters.
|
|
123
126
|
*/
|
|
124
127
|
title: string;
|
|
125
128
|
}
|
|
126
129
|
}
|
|
127
130
|
/**
|
|
128
|
-
* A
|
|
131
|
+
* A grouping of related lessons within a course, used to organize content into
|
|
132
|
+
* sections.
|
|
129
133
|
*/
|
|
130
134
|
export interface CourseChapterListResponse {
|
|
131
135
|
/**
|
|
132
|
-
* The
|
|
136
|
+
* The unique identifier for the chapter.
|
|
133
137
|
*/
|
|
134
138
|
id: string;
|
|
135
139
|
/**
|
|
136
|
-
* The
|
|
140
|
+
* The sort position of this chapter within its parent course, starting from zero.
|
|
137
141
|
*/
|
|
138
142
|
order: number;
|
|
139
143
|
/**
|
|
140
|
-
* The
|
|
144
|
+
* The display name of the chapter shown to students. Maximum 150 characters.
|
|
141
145
|
*/
|
|
142
146
|
title: string;
|
|
143
147
|
}
|
|
@@ -147,23 +151,24 @@ export interface CourseChapterListResponse {
|
|
|
147
151
|
export type CourseChapterDeleteResponse = boolean;
|
|
148
152
|
export interface CourseChapterCreateParams {
|
|
149
153
|
/**
|
|
150
|
-
* The
|
|
154
|
+
* The unique identifier of the course to create the chapter in (e.g.,
|
|
155
|
+
* "course_XXXXX").
|
|
151
156
|
*/
|
|
152
157
|
course_id: string;
|
|
153
158
|
/**
|
|
154
|
-
* The title of the chapter
|
|
159
|
+
* The display title of the chapter (e.g., "Module 1: Introduction").
|
|
155
160
|
*/
|
|
156
161
|
title?: string | null;
|
|
157
162
|
}
|
|
158
163
|
export interface CourseChapterUpdateParams {
|
|
159
164
|
/**
|
|
160
|
-
* The title of the chapter
|
|
165
|
+
* The new display title of the chapter (e.g., "Module 1: Introduction").
|
|
161
166
|
*/
|
|
162
167
|
title: string;
|
|
163
168
|
}
|
|
164
169
|
export interface CourseChapterListParams extends CursorPageParams {
|
|
165
170
|
/**
|
|
166
|
-
* The
|
|
171
|
+
* The unique identifier of the course to list chapters for.
|
|
167
172
|
*/
|
|
168
173
|
course_id: string;
|
|
169
174
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"course-chapters.d.mts","sourceRoot":"","sources":["../src/resources/course-chapters.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,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IAI5F;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IAIzE;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IAIxG;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,EAAE,uBAAuB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,yBAAyB,CAAC;IAO/E;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;CAGtF;AAED,MAAM,MAAM,oCAAoC,GAAG,UAAU,CAAC,yBAAyB,CAAC,CAAC;AAEzF
|
|
1
|
+
{"version":3,"file":"course-chapters.d.mts","sourceRoot":"","sources":["../src/resources/course-chapters.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,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IAI5F;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IAIzE;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IAIxG;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,EAAE,uBAAuB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,yBAAyB,CAAC;IAO/E;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;CAGtF;AAED,MAAM,MAAM,oCAAoC,GAAG,UAAU,CAAC,yBAAyB,CAAC,CAAC;AAEzF;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAErC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,aAAa,CAAC;IAC7B;;;OAGG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,OAAO,CAAC;AAElD,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB;IAC/D;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;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,cAAc,CAAC;IACtC,OAAO,EACL,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
|