@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,7 +5,8 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
|
|
|
5
5
|
import { RequestOptions } from "../internal/request-options.mjs";
|
|
6
6
|
export declare class Transfers extends APIResource {
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
8
|
+
* Transfer funds between two ledger accounts, such as from a company balance to a
|
|
9
|
+
* user balance.
|
|
9
10
|
*
|
|
10
11
|
* Required permissions:
|
|
11
12
|
*
|
|
@@ -23,7 +24,7 @@ export declare class Transfers extends APIResource {
|
|
|
23
24
|
*/
|
|
24
25
|
create(body: TransferCreateParams, options?: RequestOptions): APIPromise<Shared.Transfer>;
|
|
25
26
|
/**
|
|
26
|
-
* Retrieves
|
|
27
|
+
* Retrieves the details of an existing transfer.
|
|
27
28
|
*
|
|
28
29
|
* Required permissions:
|
|
29
30
|
*
|
|
@@ -38,7 +39,8 @@ export declare class Transfers extends APIResource {
|
|
|
38
39
|
*/
|
|
39
40
|
retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Transfer>;
|
|
40
41
|
/**
|
|
41
|
-
*
|
|
42
|
+
* Returns a paginated list of fund transfers, filtered by origin or destination
|
|
43
|
+
* account, with optional sorting and date filtering.
|
|
42
44
|
*
|
|
43
45
|
* Required permissions:
|
|
44
46
|
*
|
|
@@ -56,79 +58,86 @@ export declare class Transfers extends APIResource {
|
|
|
56
58
|
}
|
|
57
59
|
export type TransferListResponsesCursorPage = CursorPage<TransferListResponse>;
|
|
58
60
|
/**
|
|
59
|
-
*
|
|
61
|
+
* A transfer of credit between two ledger accounts.
|
|
60
62
|
*/
|
|
61
63
|
export interface TransferListResponse {
|
|
62
64
|
/**
|
|
63
|
-
* The unique identifier
|
|
65
|
+
* The unique identifier for the credit transaction transfer.
|
|
64
66
|
*/
|
|
65
67
|
id: string;
|
|
66
68
|
/**
|
|
67
|
-
* The amount
|
|
69
|
+
* The transfer amount in the currency specified by the currency field. For
|
|
70
|
+
* example, 10.43 represents $10.43 USD.
|
|
68
71
|
*/
|
|
69
72
|
amount: number;
|
|
70
73
|
/**
|
|
71
|
-
* The
|
|
74
|
+
* The datetime the credit transaction transfer was created.
|
|
72
75
|
*/
|
|
73
76
|
created_at: string;
|
|
74
77
|
/**
|
|
75
|
-
* The currency
|
|
78
|
+
* The currency in which this transfer amount is denominated.
|
|
76
79
|
*/
|
|
77
80
|
currency: Shared.Currency;
|
|
78
81
|
/**
|
|
79
|
-
* The
|
|
82
|
+
* The unique identifier of the ledger account receiving the funds.
|
|
80
83
|
*/
|
|
81
84
|
destination_ledger_account_id: string;
|
|
82
85
|
/**
|
|
83
|
-
* The
|
|
86
|
+
* The flat fee amount deducted from this transfer, in the transfer's currency.
|
|
87
|
+
* Null if no flat fee was applied.
|
|
84
88
|
*/
|
|
85
89
|
fee_amount: number | null;
|
|
86
90
|
/**
|
|
87
|
-
*
|
|
91
|
+
* Custom key-value pairs attached to this transfer. Maximum 50 keys, 500
|
|
92
|
+
* characters per key, 5000 characters per value.
|
|
88
93
|
*/
|
|
89
94
|
metadata: {
|
|
90
95
|
[key: string]: unknown;
|
|
91
96
|
} | null;
|
|
92
97
|
/**
|
|
93
|
-
*
|
|
98
|
+
* A free-text note attached to this transfer by the sender. Null if no note was
|
|
99
|
+
* provided.
|
|
94
100
|
*/
|
|
95
101
|
notes: string | null;
|
|
96
102
|
/**
|
|
97
|
-
* The
|
|
103
|
+
* The unique identifier of the ledger account that sent the funds.
|
|
98
104
|
*/
|
|
99
105
|
origin_ledger_account_id: string;
|
|
100
106
|
}
|
|
101
107
|
export interface TransferCreateParams {
|
|
102
108
|
/**
|
|
103
|
-
* The amount to
|
|
109
|
+
* The amount to transfer in the specified currency. For example, 25.00 for $25.00
|
|
110
|
+
* USD.
|
|
104
111
|
*/
|
|
105
112
|
amount: number;
|
|
106
113
|
/**
|
|
107
|
-
* The currency
|
|
114
|
+
* The currency of the transfer amount, such as 'usd'.
|
|
108
115
|
*/
|
|
109
116
|
currency: Shared.Currency;
|
|
110
117
|
/**
|
|
111
|
-
* The
|
|
112
|
-
*
|
|
118
|
+
* The identifier of the account receiving the funds. Accepts a user ID
|
|
119
|
+
* ('user_xxx'), company ID ('biz_xxx'), or ledger account ID ('ldgr_xxx').
|
|
113
120
|
*/
|
|
114
121
|
destination_id: string;
|
|
115
122
|
/**
|
|
116
|
-
* The
|
|
117
|
-
*
|
|
123
|
+
* The identifier of the account sending the funds. Accepts a user ID ('user_xxx'),
|
|
124
|
+
* company ID ('biz_xxx'), or ledger account ID ('ldgr_xxx').
|
|
118
125
|
*/
|
|
119
126
|
origin_id: string;
|
|
120
127
|
/**
|
|
121
|
-
* A unique key to
|
|
128
|
+
* A unique key to prevent duplicate transfers. Use a UUID or similar unique
|
|
129
|
+
* string.
|
|
122
130
|
*/
|
|
123
131
|
idempotence_key?: string | null;
|
|
124
132
|
/**
|
|
125
|
-
* A
|
|
133
|
+
* A JSON object of custom metadata to attach to the transfer for tracking
|
|
134
|
+
* purposes.
|
|
126
135
|
*/
|
|
127
136
|
metadata?: {
|
|
128
137
|
[key: string]: unknown;
|
|
129
138
|
} | null;
|
|
130
139
|
/**
|
|
131
|
-
*
|
|
140
|
+
* A short note describing the transfer, up to 50 characters.
|
|
132
141
|
*/
|
|
133
142
|
notes?: string | null;
|
|
134
143
|
}
|
|
@@ -138,16 +147,16 @@ export interface TransferListParams extends CursorPageParams {
|
|
|
138
147
|
*/
|
|
139
148
|
before?: string | null;
|
|
140
149
|
/**
|
|
141
|
-
*
|
|
150
|
+
* Only return transfers created after this timestamp.
|
|
142
151
|
*/
|
|
143
152
|
created_after?: string | null;
|
|
144
153
|
/**
|
|
145
|
-
*
|
|
154
|
+
* Only return transfers created before this timestamp.
|
|
146
155
|
*/
|
|
147
156
|
created_before?: string | null;
|
|
148
157
|
/**
|
|
149
|
-
* Filter transfers
|
|
150
|
-
*
|
|
158
|
+
* Filter to transfers received by this account. Accepts a user, company, or ledger
|
|
159
|
+
* account ID.
|
|
151
160
|
*/
|
|
152
161
|
destination_id?: string | null;
|
|
153
162
|
/**
|
|
@@ -167,8 +176,8 @@ export interface TransferListParams extends CursorPageParams {
|
|
|
167
176
|
*/
|
|
168
177
|
order?: 'amount' | 'created_at' | null;
|
|
169
178
|
/**
|
|
170
|
-
* Filter transfers
|
|
171
|
-
*
|
|
179
|
+
* Filter to transfers sent from this account. Accepts a user, company, or ledger
|
|
180
|
+
* account ID.
|
|
172
181
|
*/
|
|
173
182
|
origin_id?: string | null;
|
|
174
183
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"transfers.d.mts","sourceRoot":"","sources":["../src/resources/transfers.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,SAAU,SAAQ,WAAW;IACxC
|
|
1
|
+
{"version":3,"file":"transfers.d.mts","sourceRoot":"","sources":["../src/resources/transfers.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,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC;IAIzF;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC;IAI3E;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,+BAA+B,EAAE,oBAAoB,CAAC;CAGtE;AAED,MAAM,MAAM,+BAA+B,GAAG,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAE/E;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;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,6BAA6B,EAAE,MAAM,CAAC;IAEtC;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,wBAAwB,EAAE,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,QAAQ,GAAG,YAAY,GAAG,IAAI,CAAC;IAEvC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
|
package/resources/transfers.d.ts
CHANGED
|
@@ -5,7 +5,8 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
|
|
|
5
5
|
import { RequestOptions } from "../internal/request-options.js";
|
|
6
6
|
export declare class Transfers extends APIResource {
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
8
|
+
* Transfer funds between two ledger accounts, such as from a company balance to a
|
|
9
|
+
* user balance.
|
|
9
10
|
*
|
|
10
11
|
* Required permissions:
|
|
11
12
|
*
|
|
@@ -23,7 +24,7 @@ export declare class Transfers extends APIResource {
|
|
|
23
24
|
*/
|
|
24
25
|
create(body: TransferCreateParams, options?: RequestOptions): APIPromise<Shared.Transfer>;
|
|
25
26
|
/**
|
|
26
|
-
* Retrieves
|
|
27
|
+
* Retrieves the details of an existing transfer.
|
|
27
28
|
*
|
|
28
29
|
* Required permissions:
|
|
29
30
|
*
|
|
@@ -38,7 +39,8 @@ export declare class Transfers extends APIResource {
|
|
|
38
39
|
*/
|
|
39
40
|
retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Transfer>;
|
|
40
41
|
/**
|
|
41
|
-
*
|
|
42
|
+
* Returns a paginated list of fund transfers, filtered by origin or destination
|
|
43
|
+
* account, with optional sorting and date filtering.
|
|
42
44
|
*
|
|
43
45
|
* Required permissions:
|
|
44
46
|
*
|
|
@@ -56,79 +58,86 @@ export declare class Transfers extends APIResource {
|
|
|
56
58
|
}
|
|
57
59
|
export type TransferListResponsesCursorPage = CursorPage<TransferListResponse>;
|
|
58
60
|
/**
|
|
59
|
-
*
|
|
61
|
+
* A transfer of credit between two ledger accounts.
|
|
60
62
|
*/
|
|
61
63
|
export interface TransferListResponse {
|
|
62
64
|
/**
|
|
63
|
-
* The unique identifier
|
|
65
|
+
* The unique identifier for the credit transaction transfer.
|
|
64
66
|
*/
|
|
65
67
|
id: string;
|
|
66
68
|
/**
|
|
67
|
-
* The amount
|
|
69
|
+
* The transfer amount in the currency specified by the currency field. For
|
|
70
|
+
* example, 10.43 represents $10.43 USD.
|
|
68
71
|
*/
|
|
69
72
|
amount: number;
|
|
70
73
|
/**
|
|
71
|
-
* The
|
|
74
|
+
* The datetime the credit transaction transfer was created.
|
|
72
75
|
*/
|
|
73
76
|
created_at: string;
|
|
74
77
|
/**
|
|
75
|
-
* The currency
|
|
78
|
+
* The currency in which this transfer amount is denominated.
|
|
76
79
|
*/
|
|
77
80
|
currency: Shared.Currency;
|
|
78
81
|
/**
|
|
79
|
-
* The
|
|
82
|
+
* The unique identifier of the ledger account receiving the funds.
|
|
80
83
|
*/
|
|
81
84
|
destination_ledger_account_id: string;
|
|
82
85
|
/**
|
|
83
|
-
* The
|
|
86
|
+
* The flat fee amount deducted from this transfer, in the transfer's currency.
|
|
87
|
+
* Null if no flat fee was applied.
|
|
84
88
|
*/
|
|
85
89
|
fee_amount: number | null;
|
|
86
90
|
/**
|
|
87
|
-
*
|
|
91
|
+
* Custom key-value pairs attached to this transfer. Maximum 50 keys, 500
|
|
92
|
+
* characters per key, 5000 characters per value.
|
|
88
93
|
*/
|
|
89
94
|
metadata: {
|
|
90
95
|
[key: string]: unknown;
|
|
91
96
|
} | null;
|
|
92
97
|
/**
|
|
93
|
-
*
|
|
98
|
+
* A free-text note attached to this transfer by the sender. Null if no note was
|
|
99
|
+
* provided.
|
|
94
100
|
*/
|
|
95
101
|
notes: string | null;
|
|
96
102
|
/**
|
|
97
|
-
* The
|
|
103
|
+
* The unique identifier of the ledger account that sent the funds.
|
|
98
104
|
*/
|
|
99
105
|
origin_ledger_account_id: string;
|
|
100
106
|
}
|
|
101
107
|
export interface TransferCreateParams {
|
|
102
108
|
/**
|
|
103
|
-
* The amount to
|
|
109
|
+
* The amount to transfer in the specified currency. For example, 25.00 for $25.00
|
|
110
|
+
* USD.
|
|
104
111
|
*/
|
|
105
112
|
amount: number;
|
|
106
113
|
/**
|
|
107
|
-
* The currency
|
|
114
|
+
* The currency of the transfer amount, such as 'usd'.
|
|
108
115
|
*/
|
|
109
116
|
currency: Shared.Currency;
|
|
110
117
|
/**
|
|
111
|
-
* The
|
|
112
|
-
*
|
|
118
|
+
* The identifier of the account receiving the funds. Accepts a user ID
|
|
119
|
+
* ('user_xxx'), company ID ('biz_xxx'), or ledger account ID ('ldgr_xxx').
|
|
113
120
|
*/
|
|
114
121
|
destination_id: string;
|
|
115
122
|
/**
|
|
116
|
-
* The
|
|
117
|
-
*
|
|
123
|
+
* The identifier of the account sending the funds. Accepts a user ID ('user_xxx'),
|
|
124
|
+
* company ID ('biz_xxx'), or ledger account ID ('ldgr_xxx').
|
|
118
125
|
*/
|
|
119
126
|
origin_id: string;
|
|
120
127
|
/**
|
|
121
|
-
* A unique key to
|
|
128
|
+
* A unique key to prevent duplicate transfers. Use a UUID or similar unique
|
|
129
|
+
* string.
|
|
122
130
|
*/
|
|
123
131
|
idempotence_key?: string | null;
|
|
124
132
|
/**
|
|
125
|
-
* A
|
|
133
|
+
* A JSON object of custom metadata to attach to the transfer for tracking
|
|
134
|
+
* purposes.
|
|
126
135
|
*/
|
|
127
136
|
metadata?: {
|
|
128
137
|
[key: string]: unknown;
|
|
129
138
|
} | null;
|
|
130
139
|
/**
|
|
131
|
-
*
|
|
140
|
+
* A short note describing the transfer, up to 50 characters.
|
|
132
141
|
*/
|
|
133
142
|
notes?: string | null;
|
|
134
143
|
}
|
|
@@ -138,16 +147,16 @@ export interface TransferListParams extends CursorPageParams {
|
|
|
138
147
|
*/
|
|
139
148
|
before?: string | null;
|
|
140
149
|
/**
|
|
141
|
-
*
|
|
150
|
+
* Only return transfers created after this timestamp.
|
|
142
151
|
*/
|
|
143
152
|
created_after?: string | null;
|
|
144
153
|
/**
|
|
145
|
-
*
|
|
154
|
+
* Only return transfers created before this timestamp.
|
|
146
155
|
*/
|
|
147
156
|
created_before?: string | null;
|
|
148
157
|
/**
|
|
149
|
-
* Filter transfers
|
|
150
|
-
*
|
|
158
|
+
* Filter to transfers received by this account. Accepts a user, company, or ledger
|
|
159
|
+
* account ID.
|
|
151
160
|
*/
|
|
152
161
|
destination_id?: string | null;
|
|
153
162
|
/**
|
|
@@ -167,8 +176,8 @@ export interface TransferListParams extends CursorPageParams {
|
|
|
167
176
|
*/
|
|
168
177
|
order?: 'amount' | 'created_at' | null;
|
|
169
178
|
/**
|
|
170
|
-
* Filter transfers
|
|
171
|
-
*
|
|
179
|
+
* Filter to transfers sent from this account. Accepts a user, company, or ledger
|
|
180
|
+
* account ID.
|
|
172
181
|
*/
|
|
173
182
|
origin_id?: string | null;
|
|
174
183
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"transfers.d.ts","sourceRoot":"","sources":["../src/resources/transfers.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,SAAU,SAAQ,WAAW;IACxC
|
|
1
|
+
{"version":3,"file":"transfers.d.ts","sourceRoot":"","sources":["../src/resources/transfers.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,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC;IAIzF;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC;IAI3E;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,+BAA+B,EAAE,oBAAoB,CAAC;CAGtE;AAED,MAAM,MAAM,+BAA+B,GAAG,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAE/E;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;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,6BAA6B,EAAE,MAAM,CAAC;IAEtC;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,wBAAwB,EAAE,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,QAAQ,GAAG,YAAY,GAAG,IAAI,CAAC;IAEvC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
|
package/resources/transfers.js
CHANGED
|
@@ -7,7 +7,8 @@ const pagination_1 = require("../core/pagination.js");
|
|
|
7
7
|
const path_1 = require("../internal/utils/path.js");
|
|
8
8
|
class Transfers extends resource_1.APIResource {
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* Transfer funds between two ledger accounts, such as from a company balance to a
|
|
11
|
+
* user balance.
|
|
11
12
|
*
|
|
12
13
|
* Required permissions:
|
|
13
14
|
*
|
|
@@ -27,7 +28,7 @@ class Transfers extends resource_1.APIResource {
|
|
|
27
28
|
return this._client.post('/transfers', { body, ...options });
|
|
28
29
|
}
|
|
29
30
|
/**
|
|
30
|
-
* Retrieves
|
|
31
|
+
* Retrieves the details of an existing transfer.
|
|
31
32
|
*
|
|
32
33
|
* Required permissions:
|
|
33
34
|
*
|
|
@@ -44,7 +45,8 @@ class Transfers extends resource_1.APIResource {
|
|
|
44
45
|
return this._client.get((0, path_1.path) `/transfers/${id}`, options);
|
|
45
46
|
}
|
|
46
47
|
/**
|
|
47
|
-
*
|
|
48
|
+
* Returns a paginated list of fund transfers, filtered by origin or destination
|
|
49
|
+
* account, with optional sorting and date filtering.
|
|
48
50
|
*
|
|
49
51
|
* Required permissions:
|
|
50
52
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"transfers.js","sourceRoot":"","sources":["../src/resources/transfers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,SAAU,SAAQ,sBAAW;IACxC
|
|
1
|
+
{"version":3,"file":"transfers.js","sourceRoot":"","sources":["../src/resources/transfers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,CAAA,uBAAgC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;CACF;AA/DD,8BA+DC"}
|
package/resources/transfers.mjs
CHANGED
|
@@ -4,7 +4,8 @@ import { CursorPage } from "../core/pagination.mjs";
|
|
|
4
4
|
import { path } from "../internal/utils/path.mjs";
|
|
5
5
|
export class Transfers extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* Transfer funds between two ledger accounts, such as from a company balance to a
|
|
8
|
+
* user balance.
|
|
8
9
|
*
|
|
9
10
|
* Required permissions:
|
|
10
11
|
*
|
|
@@ -24,7 +25,7 @@ export class Transfers extends APIResource {
|
|
|
24
25
|
return this._client.post('/transfers', { body, ...options });
|
|
25
26
|
}
|
|
26
27
|
/**
|
|
27
|
-
* Retrieves
|
|
28
|
+
* Retrieves the details of an existing transfer.
|
|
28
29
|
*
|
|
29
30
|
* Required permissions:
|
|
30
31
|
*
|
|
@@ -41,7 +42,8 @@ export class Transfers extends APIResource {
|
|
|
41
42
|
return this._client.get(path `/transfers/${id}`, options);
|
|
42
43
|
}
|
|
43
44
|
/**
|
|
44
|
-
*
|
|
45
|
+
* Returns a paginated list of fund transfers, filtered by origin or destination
|
|
46
|
+
* account, with optional sorting and date filtering.
|
|
45
47
|
*
|
|
46
48
|
* Required permissions:
|
|
47
49
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"transfers.mjs","sourceRoot":"","sources":["../src/resources/transfers.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC
|
|
1
|
+
{"version":3,"file":"transfers.mjs","sourceRoot":"","sources":["../src/resources/transfers.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,CAAA,UAAgC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;CACF"}
|
package/resources/users.d.mts
CHANGED
|
@@ -4,51 +4,63 @@ import { APIPromise } from "../core/api-promise.mjs";
|
|
|
4
4
|
import { RequestOptions } from "../internal/request-options.mjs";
|
|
5
5
|
export declare class Users extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
* Retrieves
|
|
7
|
+
* Retrieves the details of an existing user.
|
|
8
8
|
*/
|
|
9
|
-
retrieve(id: string, options?: RequestOptions): APIPromise<
|
|
9
|
+
retrieve(id: string, options?: RequestOptions): APIPromise<User>;
|
|
10
10
|
/**
|
|
11
|
-
* Check
|
|
11
|
+
* Check whether a user has access to a specific resource, and return their access
|
|
12
|
+
* level.
|
|
12
13
|
*/
|
|
13
14
|
checkAccess(resourceID: string, params: UserCheckAccessParams, options?: RequestOptions): APIPromise<UserCheckAccessResponse>;
|
|
15
|
+
/**
|
|
16
|
+
* Update the currently authenticated user's profile.
|
|
17
|
+
*
|
|
18
|
+
* Required permissions:
|
|
19
|
+
*
|
|
20
|
+
* - `user:profile:update`
|
|
21
|
+
*/
|
|
22
|
+
updateProfile(body?: UserUpdateProfileParams | null | undefined, options?: RequestOptions): APIPromise<User>;
|
|
14
23
|
}
|
|
15
24
|
/**
|
|
16
|
-
*
|
|
25
|
+
* A user account on Whop. Contains profile information, identity details, and
|
|
26
|
+
* social connections.
|
|
17
27
|
*/
|
|
18
|
-
export interface
|
|
28
|
+
export interface User {
|
|
19
29
|
/**
|
|
20
|
-
* The
|
|
30
|
+
* The unique identifier for the user.
|
|
21
31
|
*/
|
|
22
32
|
id: string;
|
|
23
33
|
/**
|
|
24
|
-
*
|
|
34
|
+
* A short biography written by the user, displayed on their public profile.
|
|
25
35
|
*/
|
|
26
36
|
bio: string | null;
|
|
27
37
|
/**
|
|
28
|
-
*
|
|
38
|
+
* The datetime the user was created.
|
|
29
39
|
*/
|
|
30
40
|
created_at: string;
|
|
31
41
|
/**
|
|
32
|
-
* The
|
|
42
|
+
* The user's display name shown on their public profile.
|
|
33
43
|
*/
|
|
34
44
|
name: string | null;
|
|
35
45
|
/**
|
|
36
|
-
* The user's profile picture
|
|
46
|
+
* The user's profile picture attachment with URL, content type, and file metadata.
|
|
47
|
+
* Null if using a legacy profile picture.
|
|
37
48
|
*/
|
|
38
|
-
profile_picture:
|
|
49
|
+
profile_picture: User.ProfilePicture | null;
|
|
39
50
|
/**
|
|
40
|
-
* The
|
|
51
|
+
* The user's unique username shown on their public profile.
|
|
41
52
|
*/
|
|
42
53
|
username: string;
|
|
43
54
|
}
|
|
44
|
-
export declare namespace
|
|
55
|
+
export declare namespace User {
|
|
45
56
|
/**
|
|
46
|
-
* The user's profile picture
|
|
57
|
+
* The user's profile picture attachment with URL, content type, and file metadata.
|
|
58
|
+
* Null if using a legacy profile picture.
|
|
47
59
|
*/
|
|
48
60
|
interface ProfilePicture {
|
|
49
61
|
/**
|
|
50
|
-
*
|
|
51
|
-
*
|
|
62
|
+
* A pre-optimized URL for rendering this attachment on the client. This should be
|
|
63
|
+
* used for displaying attachments in apps.
|
|
52
64
|
*/
|
|
53
65
|
url: string | null;
|
|
54
66
|
}
|
|
@@ -68,11 +80,41 @@ export interface UserCheckAccessResponse {
|
|
|
68
80
|
}
|
|
69
81
|
export interface UserCheckAccessParams {
|
|
70
82
|
/**
|
|
71
|
-
* The
|
|
83
|
+
* The unique identifier or username of the user.
|
|
72
84
|
*/
|
|
73
85
|
id: string;
|
|
74
86
|
}
|
|
87
|
+
export interface UserUpdateProfileParams {
|
|
88
|
+
/**
|
|
89
|
+
* A short biography displayed on the user's public profile.
|
|
90
|
+
*/
|
|
91
|
+
bio?: string | null;
|
|
92
|
+
/**
|
|
93
|
+
* The user's display name shown on their public profile. Maximum 100 characters.
|
|
94
|
+
*/
|
|
95
|
+
name?: string | null;
|
|
96
|
+
/**
|
|
97
|
+
* The user's profile picture image attachment.
|
|
98
|
+
*/
|
|
99
|
+
profile_picture?: UserUpdateProfileParams.ProfilePicture | null;
|
|
100
|
+
/**
|
|
101
|
+
* The user's unique username. Alphanumeric characters and hyphens only. Maximum 42
|
|
102
|
+
* characters.
|
|
103
|
+
*/
|
|
104
|
+
username?: string | null;
|
|
105
|
+
}
|
|
106
|
+
export declare namespace UserUpdateProfileParams {
|
|
107
|
+
/**
|
|
108
|
+
* The user's profile picture image attachment.
|
|
109
|
+
*/
|
|
110
|
+
interface ProfilePicture {
|
|
111
|
+
/**
|
|
112
|
+
* The ID of an existing file object.
|
|
113
|
+
*/
|
|
114
|
+
id: string;
|
|
115
|
+
}
|
|
116
|
+
}
|
|
75
117
|
export declare namespace Users {
|
|
76
|
-
export { type
|
|
118
|
+
export { type User as User, type UserCheckAccessResponse as UserCheckAccessResponse, type UserCheckAccessParams as UserCheckAccessParams, type UserUpdateProfileParams as UserUpdateProfileParams, };
|
|
77
119
|
}
|
|
78
120
|
//# sourceMappingURL=users.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"users.d.mts","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,
|
|
1
|
+
{"version":3,"file":"users.d.mts","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAIhE;;;OAGG;IACH,WAAW,CACT,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAKtC;;;;;;OAMG;IACH,aAAa,CACX,IAAI,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;CAGpB;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;OAGG;IACH,eAAe,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,IAAI,CAAC;IACpB;;;OAGG;IACH,UAAiB,cAAc;QAC7B;;;WAGG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,WAAW,CAAC;IAEjC;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,uBAAuB,CAAC,cAAc,GAAG,IAAI,CAAC;IAEhE;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
|