@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 FeeMarkups extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* Create or update a fee markup for a company. If a markup for the specified fee
|
|
8
|
+
* type already exists, it will be updated with the new values.
|
|
8
9
|
*
|
|
9
10
|
* Required permissions:
|
|
10
11
|
*
|
|
@@ -20,7 +21,8 @@ export declare class FeeMarkups extends APIResource {
|
|
|
20
21
|
*/
|
|
21
22
|
create(body: FeeMarkupCreateParams, options?: RequestOptions): APIPromise<FeeMarkupCreateResponse>;
|
|
22
23
|
/**
|
|
23
|
-
*
|
|
24
|
+
* Returns a paginated list of fee markups configured for a company. If the company
|
|
25
|
+
* is a platform account, returns the platform default markups.
|
|
24
26
|
*
|
|
25
27
|
* Required permissions:
|
|
26
28
|
*
|
|
@@ -38,7 +40,8 @@ export declare class FeeMarkups extends APIResource {
|
|
|
38
40
|
*/
|
|
39
41
|
list(query: FeeMarkupListParams, options?: RequestOptions): PagePromise<FeeMarkupListResponsesCursorPage, FeeMarkupListResponse>;
|
|
40
42
|
/**
|
|
41
|
-
*
|
|
43
|
+
* Delete a fee markup configuration for a company. This removes the custom fee
|
|
44
|
+
* override and reverts to the parent company's default fees.
|
|
42
45
|
*
|
|
43
46
|
* Required permissions:
|
|
44
47
|
*
|
|
@@ -57,68 +60,76 @@ export type FeeMarkupListResponsesCursorPage = CursorPage<FeeMarkupListResponse>
|
|
|
57
60
|
*/
|
|
58
61
|
export type FeeMarkupType = 'crypto_withdrawal_markup' | 'rtp_withdrawal_markup' | 'next_day_bank_withdrawal_markup' | 'bank_wire_withdrawal_markup' | 'digital_wallet_withdrawal_markup';
|
|
59
62
|
/**
|
|
60
|
-
*
|
|
63
|
+
* A fee markup configuration that defines additional charges applied to
|
|
64
|
+
* transactions for a platform's connected accounts.
|
|
61
65
|
*/
|
|
62
66
|
export interface FeeMarkupCreateResponse {
|
|
63
67
|
/**
|
|
64
|
-
* The unique identifier
|
|
68
|
+
* The unique identifier for the fee markup.
|
|
65
69
|
*/
|
|
66
70
|
id: string;
|
|
67
71
|
/**
|
|
68
|
-
*
|
|
72
|
+
* The datetime the fee markup was created.
|
|
69
73
|
*/
|
|
70
74
|
created_at: string;
|
|
71
75
|
/**
|
|
72
|
-
* The
|
|
76
|
+
* The category of fee this markup applies to.
|
|
73
77
|
*/
|
|
74
78
|
fee_type: FeeMarkupType;
|
|
75
79
|
/**
|
|
76
|
-
*
|
|
80
|
+
* A flat fee charged per transaction, in USD. Ranges from 0 to 50. Null if no
|
|
81
|
+
* fixed fee is configured.
|
|
77
82
|
*/
|
|
78
83
|
fixed_fee_usd: number | null;
|
|
79
84
|
/**
|
|
80
|
-
* Internal notes about this fee markup.
|
|
85
|
+
* Internal notes about this fee markup, visible only to administrators. Null if no
|
|
86
|
+
* notes have been added.
|
|
81
87
|
*/
|
|
82
88
|
notes: string | null;
|
|
83
89
|
/**
|
|
84
|
-
*
|
|
90
|
+
* A percentage-based fee charged per transaction. Ranges from 0 to 25. Null if no
|
|
91
|
+
* percentage fee is configured.
|
|
85
92
|
*/
|
|
86
93
|
percentage_fee: number | null;
|
|
87
94
|
/**
|
|
88
|
-
*
|
|
95
|
+
* The datetime the fee markup was last updated.
|
|
89
96
|
*/
|
|
90
97
|
updated_at: string;
|
|
91
98
|
}
|
|
92
99
|
/**
|
|
93
|
-
*
|
|
100
|
+
* A fee markup configuration that defines additional charges applied to
|
|
101
|
+
* transactions for a platform's connected accounts.
|
|
94
102
|
*/
|
|
95
103
|
export interface FeeMarkupListResponse {
|
|
96
104
|
/**
|
|
97
|
-
* The unique identifier
|
|
105
|
+
* The unique identifier for the fee markup.
|
|
98
106
|
*/
|
|
99
107
|
id: string;
|
|
100
108
|
/**
|
|
101
|
-
*
|
|
109
|
+
* The datetime the fee markup was created.
|
|
102
110
|
*/
|
|
103
111
|
created_at: string;
|
|
104
112
|
/**
|
|
105
|
-
* The
|
|
113
|
+
* The category of fee this markup applies to.
|
|
106
114
|
*/
|
|
107
115
|
fee_type: FeeMarkupType;
|
|
108
116
|
/**
|
|
109
|
-
*
|
|
117
|
+
* A flat fee charged per transaction, in USD. Ranges from 0 to 50. Null if no
|
|
118
|
+
* fixed fee is configured.
|
|
110
119
|
*/
|
|
111
120
|
fixed_fee_usd: number | null;
|
|
112
121
|
/**
|
|
113
|
-
* Internal notes about this fee markup.
|
|
122
|
+
* Internal notes about this fee markup, visible only to administrators. Null if no
|
|
123
|
+
* notes have been added.
|
|
114
124
|
*/
|
|
115
125
|
notes: string | null;
|
|
116
126
|
/**
|
|
117
|
-
*
|
|
127
|
+
* A percentage-based fee charged per transaction. Ranges from 0 to 25. Null if no
|
|
128
|
+
* percentage fee is configured.
|
|
118
129
|
*/
|
|
119
130
|
percentage_fee: number | null;
|
|
120
131
|
/**
|
|
121
|
-
*
|
|
132
|
+
* The datetime the fee markup was last updated.
|
|
122
133
|
*/
|
|
123
134
|
updated_at: string;
|
|
124
135
|
}
|
|
@@ -128,36 +139,36 @@ export interface FeeMarkupListResponse {
|
|
|
128
139
|
export type FeeMarkupDeleteResponse = boolean;
|
|
129
140
|
export interface FeeMarkupCreateParams {
|
|
130
141
|
/**
|
|
131
|
-
* The
|
|
142
|
+
* The unique identifier of the company to create or update the fee markup for.
|
|
132
143
|
*/
|
|
133
144
|
company_id: string;
|
|
134
145
|
/**
|
|
135
|
-
* The type of fee this markup applies to.
|
|
146
|
+
* The type of fee this markup applies to, such as processing or platform fees.
|
|
136
147
|
*/
|
|
137
148
|
fee_type: FeeMarkupType;
|
|
138
149
|
/**
|
|
139
|
-
* The fixed fee in USD to charge
|
|
150
|
+
* The fixed fee amount in USD to charge per transaction. Must be between 0 and 50.
|
|
140
151
|
*/
|
|
141
152
|
fixed_fee_usd?: number | null;
|
|
142
153
|
/**
|
|
143
|
-
* Custom metadata to attach to this fee markup.
|
|
154
|
+
* Custom key-value metadata to attach to this fee markup.
|
|
144
155
|
*/
|
|
145
156
|
metadata?: {
|
|
146
157
|
[key: string]: unknown;
|
|
147
158
|
} | null;
|
|
148
159
|
/**
|
|
149
|
-
* Internal notes about this fee markup.
|
|
160
|
+
* Internal notes about this fee markup for record-keeping purposes.
|
|
150
161
|
*/
|
|
151
162
|
notes?: string | null;
|
|
152
163
|
/**
|
|
153
|
-
* The percentage fee to charge
|
|
164
|
+
* The percentage fee to charge per transaction. Must be between 0 and 25.
|
|
154
165
|
*/
|
|
155
166
|
percentage_fee?: number | null;
|
|
156
167
|
}
|
|
157
168
|
export interface FeeMarkupListParams extends CursorPageParams {
|
|
158
169
|
/**
|
|
159
|
-
* The
|
|
160
|
-
*
|
|
170
|
+
* The unique identifier of the company to list fee markups for. Pass a platform
|
|
171
|
+
* account identifier to retrieve platform default markups.
|
|
161
172
|
*/
|
|
162
173
|
company_id: string;
|
|
163
174
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fee-markups.d.ts","sourceRoot":"","sources":["../src/resources/fee-markups.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,UAAW,SAAQ,WAAW;IACzC
|
|
1
|
+
{"version":3,"file":"fee-markups.d.ts","sourceRoot":"","sources":["../src/resources/fee-markups.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,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIlG;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAAK,EAAE,mBAAmB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,gCAAgC,EAAE,qBAAqB,CAAC;IAIvE;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;CAGlF;AAED,MAAM,MAAM,gCAAgC,GAAG,UAAU,CAAC,qBAAqB,CAAC,CAAC;AAEjF;;GAEG;AACH,MAAM,MAAM,aAAa,GACrB,0BAA0B,GAC1B,uBAAuB,GACvB,iCAAiC,GACjC,6BAA6B,GAC7B,kCAAkC,CAAC;AAEvC;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAC;IAExB;;;OAGG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAC;IAExB;;;OAGG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,OAAO,CAAC;AAE9C,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAC;IAExB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;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;IAEtB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D;;;OAGG;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;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|
package/resources/fee-markups.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 FeeMarkups extends resource_1.APIResource {
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* Create or update a fee markup for a company. If a markup for the specified fee
|
|
11
|
+
* type already exists, it will be updated with the new values.
|
|
11
12
|
*
|
|
12
13
|
* Required permissions:
|
|
13
14
|
*
|
|
@@ -25,7 +26,8 @@ class FeeMarkups extends resource_1.APIResource {
|
|
|
25
26
|
return this._client.post('/fee_markups', { body, ...options });
|
|
26
27
|
}
|
|
27
28
|
/**
|
|
28
|
-
*
|
|
29
|
+
* Returns a paginated list of fee markups configured for a company. If the company
|
|
30
|
+
* is a platform account, returns the platform default markups.
|
|
29
31
|
*
|
|
30
32
|
* Required permissions:
|
|
31
33
|
*
|
|
@@ -45,7 +47,8 @@ class FeeMarkups extends resource_1.APIResource {
|
|
|
45
47
|
return this._client.getAPIList('/fee_markups', (pagination_1.CursorPage), { query, ...options });
|
|
46
48
|
}
|
|
47
49
|
/**
|
|
48
|
-
*
|
|
50
|
+
* Delete a fee markup configuration for a company. This removes the custom fee
|
|
51
|
+
* override and reverts to the parent company's default fees.
|
|
49
52
|
*
|
|
50
53
|
* Required permissions:
|
|
51
54
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fee-markups.js","sourceRoot":"","sources":["../src/resources/fee-markups.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,UAAW,SAAQ,sBAAW;IACzC
|
|
1
|
+
{"version":3,"file":"fee-markups.js","sourceRoot":"","sources":["../src/resources/fee-markups.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAA2B,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,uBAAiC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;CACF;AA9DD,gCA8DC"}
|
|
@@ -4,7 +4,8 @@ import { CursorPage } from "../core/pagination.mjs";
|
|
|
4
4
|
import { path } from "../internal/utils/path.mjs";
|
|
5
5
|
export class FeeMarkups extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* Create or update a fee markup for a company. If a markup for the specified fee
|
|
8
|
+
* type already exists, it will be updated with the new values.
|
|
8
9
|
*
|
|
9
10
|
* Required permissions:
|
|
10
11
|
*
|
|
@@ -22,7 +23,8 @@ export class FeeMarkups extends APIResource {
|
|
|
22
23
|
return this._client.post('/fee_markups', { body, ...options });
|
|
23
24
|
}
|
|
24
25
|
/**
|
|
25
|
-
*
|
|
26
|
+
* Returns a paginated list of fee markups configured for a company. If the company
|
|
27
|
+
* is a platform account, returns the platform default markups.
|
|
26
28
|
*
|
|
27
29
|
* Required permissions:
|
|
28
30
|
*
|
|
@@ -42,7 +44,8 @@ export class FeeMarkups extends APIResource {
|
|
|
42
44
|
return this._client.getAPIList('/fee_markups', (CursorPage), { query, ...options });
|
|
43
45
|
}
|
|
44
46
|
/**
|
|
45
|
-
*
|
|
47
|
+
* Delete a fee markup configuration for a company. This removes the custom fee
|
|
48
|
+
* override and reverts to the parent company's default fees.
|
|
46
49
|
*
|
|
47
50
|
* Required permissions:
|
|
48
51
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fee-markups.mjs","sourceRoot":"","sources":["../src/resources/fee-markups.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC
|
|
1
|
+
{"version":3,"file":"fee-markups.mjs","sourceRoot":"","sources":["../src/resources/fee-markups.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAA2B,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,UAAiC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;CACF"}
|
package/resources/files.d.mts
CHANGED
|
@@ -4,11 +4,12 @@ import { RequestOptions } from "../internal/request-options.mjs";
|
|
|
4
4
|
import type { ToFileInput, Uploadable } from "../core/uploads.mjs";
|
|
5
5
|
export declare class Files extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* Create a new file record and receive a presigned URL for uploading content to
|
|
8
|
+
* S3.
|
|
8
9
|
*/
|
|
9
10
|
create(body: FileCreateParams, options?: RequestOptions): APIPromise<FileCreateResponse>;
|
|
10
11
|
/**
|
|
11
|
-
* Retrieves
|
|
12
|
+
* Retrieves the details of an existing file.
|
|
12
13
|
*/
|
|
13
14
|
retrieve(id: string, options?: RequestOptions): APIPromise<FileRetrieveResponse>;
|
|
14
15
|
/**
|
|
@@ -23,76 +24,79 @@ export declare class Files extends APIResource {
|
|
|
23
24
|
*/
|
|
24
25
|
export type UploadStatus = 'pending' | 'processing' | 'ready' | 'failed';
|
|
25
26
|
/**
|
|
26
|
-
* A file that has been uploaded or is pending upload
|
|
27
|
+
* A file that has been uploaded or is pending upload.
|
|
27
28
|
*/
|
|
28
29
|
export interface FileCreateResponse {
|
|
29
30
|
/**
|
|
30
|
-
* The
|
|
31
|
+
* The unique identifier for the file.
|
|
31
32
|
*/
|
|
32
33
|
id: string;
|
|
33
34
|
/**
|
|
34
|
-
* The MIME type of the file (e.g., image/jpeg, video/mp4)
|
|
35
|
+
* The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).
|
|
35
36
|
*/
|
|
36
37
|
content_type: string | null;
|
|
37
38
|
/**
|
|
38
|
-
* The
|
|
39
|
+
* The original filename of the uploaded file, including its file extension.
|
|
39
40
|
*/
|
|
40
41
|
filename: string | null;
|
|
41
42
|
/**
|
|
42
|
-
* The size
|
|
43
|
+
* The file size in bytes. Null if the file has not finished uploading.
|
|
43
44
|
*/
|
|
44
45
|
size: string | null;
|
|
45
46
|
/**
|
|
46
|
-
* Headers to include in the upload request
|
|
47
|
+
* Headers to include in the upload request. Only present in the response from the
|
|
48
|
+
* create mutation.
|
|
47
49
|
*/
|
|
48
50
|
upload_headers: {
|
|
49
51
|
[key: string]: unknown;
|
|
50
52
|
} | null;
|
|
51
53
|
/**
|
|
52
|
-
* The upload status of the file
|
|
54
|
+
* The current upload status of the file (e.g., pending, ready).
|
|
53
55
|
*/
|
|
54
56
|
upload_status: UploadStatus;
|
|
55
57
|
/**
|
|
56
|
-
* The presigned URL to upload the file to
|
|
58
|
+
* The presigned URL to upload the file contents to. Only present in the response
|
|
59
|
+
* from the create mutation.
|
|
57
60
|
*/
|
|
58
61
|
upload_url: string | null;
|
|
59
62
|
/**
|
|
60
|
-
* The URL
|
|
63
|
+
* The CDN URL for accessing the file. Null if the file has not finished uploading.
|
|
61
64
|
*/
|
|
62
65
|
url: string | null;
|
|
63
66
|
}
|
|
64
67
|
/**
|
|
65
|
-
* A file that has been uploaded or is pending upload
|
|
68
|
+
* A file that has been uploaded or is pending upload.
|
|
66
69
|
*/
|
|
67
70
|
export interface FileRetrieveResponse {
|
|
68
71
|
/**
|
|
69
|
-
* The
|
|
72
|
+
* The unique identifier for the file.
|
|
70
73
|
*/
|
|
71
74
|
id: string;
|
|
72
75
|
/**
|
|
73
|
-
* The MIME type of the file (e.g., image/jpeg, video/mp4)
|
|
76
|
+
* The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).
|
|
74
77
|
*/
|
|
75
78
|
content_type: string | null;
|
|
76
79
|
/**
|
|
77
|
-
* The
|
|
80
|
+
* The original filename of the uploaded file, including its file extension.
|
|
78
81
|
*/
|
|
79
82
|
filename: string | null;
|
|
80
83
|
/**
|
|
81
|
-
* The size
|
|
84
|
+
* The file size in bytes. Null if the file has not finished uploading.
|
|
82
85
|
*/
|
|
83
86
|
size: string | null;
|
|
84
87
|
/**
|
|
85
|
-
* The upload status of the file
|
|
88
|
+
* The current upload status of the file (e.g., pending, ready).
|
|
86
89
|
*/
|
|
87
90
|
upload_status: UploadStatus;
|
|
88
91
|
/**
|
|
89
|
-
* The URL
|
|
92
|
+
* The CDN URL for accessing the file. Null if the file has not finished uploading.
|
|
90
93
|
*/
|
|
91
94
|
url: string | null;
|
|
92
95
|
}
|
|
93
96
|
export interface FileCreateParams {
|
|
94
97
|
/**
|
|
95
|
-
* The
|
|
98
|
+
* The name of the file including its extension (e.g., "photo.png" or
|
|
99
|
+
* "document.pdf").
|
|
96
100
|
*/
|
|
97
101
|
filename: string;
|
|
98
102
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"files.d.mts","sourceRoot":"","sources":["../src/resources/files.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;OAElB,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE;AAGvC,qBAAa,KAAM,SAAQ,WAAW;IACpC
|
|
1
|
+
{"version":3,"file":"files.d.mts","sourceRoot":"","sources":["../src/resources/files.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;OAElB,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE;AAGvC,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAIxF;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAIhF;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,UAAU,GAAG,WAAW,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAOnG;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,YAAY,GAAG,OAAO,GAAG,QAAQ,CAAC;AAEzE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;OAGG;IACH,cAAc,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAElD;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CACpB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,iBAAkB,SAAQ,cAAc;IACvD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACtC;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
|
package/resources/files.d.ts
CHANGED
|
@@ -4,11 +4,12 @@ import { RequestOptions } from "../internal/request-options.js";
|
|
|
4
4
|
import type { ToFileInput, Uploadable } from "../core/uploads.js";
|
|
5
5
|
export declare class Files extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* Create a new file record and receive a presigned URL for uploading content to
|
|
8
|
+
* S3.
|
|
8
9
|
*/
|
|
9
10
|
create(body: FileCreateParams, options?: RequestOptions): APIPromise<FileCreateResponse>;
|
|
10
11
|
/**
|
|
11
|
-
* Retrieves
|
|
12
|
+
* Retrieves the details of an existing file.
|
|
12
13
|
*/
|
|
13
14
|
retrieve(id: string, options?: RequestOptions): APIPromise<FileRetrieveResponse>;
|
|
14
15
|
/**
|
|
@@ -23,76 +24,79 @@ export declare class Files extends APIResource {
|
|
|
23
24
|
*/
|
|
24
25
|
export type UploadStatus = 'pending' | 'processing' | 'ready' | 'failed';
|
|
25
26
|
/**
|
|
26
|
-
* A file that has been uploaded or is pending upload
|
|
27
|
+
* A file that has been uploaded or is pending upload.
|
|
27
28
|
*/
|
|
28
29
|
export interface FileCreateResponse {
|
|
29
30
|
/**
|
|
30
|
-
* The
|
|
31
|
+
* The unique identifier for the file.
|
|
31
32
|
*/
|
|
32
33
|
id: string;
|
|
33
34
|
/**
|
|
34
|
-
* The MIME type of the file (e.g., image/jpeg, video/mp4)
|
|
35
|
+
* The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).
|
|
35
36
|
*/
|
|
36
37
|
content_type: string | null;
|
|
37
38
|
/**
|
|
38
|
-
* The
|
|
39
|
+
* The original filename of the uploaded file, including its file extension.
|
|
39
40
|
*/
|
|
40
41
|
filename: string | null;
|
|
41
42
|
/**
|
|
42
|
-
* The size
|
|
43
|
+
* The file size in bytes. Null if the file has not finished uploading.
|
|
43
44
|
*/
|
|
44
45
|
size: string | null;
|
|
45
46
|
/**
|
|
46
|
-
* Headers to include in the upload request
|
|
47
|
+
* Headers to include in the upload request. Only present in the response from the
|
|
48
|
+
* create mutation.
|
|
47
49
|
*/
|
|
48
50
|
upload_headers: {
|
|
49
51
|
[key: string]: unknown;
|
|
50
52
|
} | null;
|
|
51
53
|
/**
|
|
52
|
-
* The upload status of the file
|
|
54
|
+
* The current upload status of the file (e.g., pending, ready).
|
|
53
55
|
*/
|
|
54
56
|
upload_status: UploadStatus;
|
|
55
57
|
/**
|
|
56
|
-
* The presigned URL to upload the file to
|
|
58
|
+
* The presigned URL to upload the file contents to. Only present in the response
|
|
59
|
+
* from the create mutation.
|
|
57
60
|
*/
|
|
58
61
|
upload_url: string | null;
|
|
59
62
|
/**
|
|
60
|
-
* The URL
|
|
63
|
+
* The CDN URL for accessing the file. Null if the file has not finished uploading.
|
|
61
64
|
*/
|
|
62
65
|
url: string | null;
|
|
63
66
|
}
|
|
64
67
|
/**
|
|
65
|
-
* A file that has been uploaded or is pending upload
|
|
68
|
+
* A file that has been uploaded or is pending upload.
|
|
66
69
|
*/
|
|
67
70
|
export interface FileRetrieveResponse {
|
|
68
71
|
/**
|
|
69
|
-
* The
|
|
72
|
+
* The unique identifier for the file.
|
|
70
73
|
*/
|
|
71
74
|
id: string;
|
|
72
75
|
/**
|
|
73
|
-
* The MIME type of the file (e.g., image/jpeg, video/mp4)
|
|
76
|
+
* The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).
|
|
74
77
|
*/
|
|
75
78
|
content_type: string | null;
|
|
76
79
|
/**
|
|
77
|
-
* The
|
|
80
|
+
* The original filename of the uploaded file, including its file extension.
|
|
78
81
|
*/
|
|
79
82
|
filename: string | null;
|
|
80
83
|
/**
|
|
81
|
-
* The size
|
|
84
|
+
* The file size in bytes. Null if the file has not finished uploading.
|
|
82
85
|
*/
|
|
83
86
|
size: string | null;
|
|
84
87
|
/**
|
|
85
|
-
* The upload status of the file
|
|
88
|
+
* The current upload status of the file (e.g., pending, ready).
|
|
86
89
|
*/
|
|
87
90
|
upload_status: UploadStatus;
|
|
88
91
|
/**
|
|
89
|
-
* The URL
|
|
92
|
+
* The CDN URL for accessing the file. Null if the file has not finished uploading.
|
|
90
93
|
*/
|
|
91
94
|
url: string | null;
|
|
92
95
|
}
|
|
93
96
|
export interface FileCreateParams {
|
|
94
97
|
/**
|
|
95
|
-
* The
|
|
98
|
+
* The name of the file including its extension (e.g., "photo.png" or
|
|
99
|
+
* "document.pdf").
|
|
96
100
|
*/
|
|
97
101
|
filename: string;
|
|
98
102
|
}
|
package/resources/files.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../src/resources/files.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;OAElB,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE;AAGvC,qBAAa,KAAM,SAAQ,WAAW;IACpC
|
|
1
|
+
{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../src/resources/files.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;OAElB,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE;AAGvC,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAIxF;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAIhF;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,UAAU,GAAG,WAAW,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAOnG;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,YAAY,GAAG,OAAO,GAAG,QAAQ,CAAC;AAEzE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;OAGG;IACH,cAAc,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAElD;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CACpB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,iBAAkB,SAAQ,cAAc;IACvD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACtC;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
|
package/resources/files.js
CHANGED
|
@@ -7,13 +7,14 @@ const path_1 = require("../internal/utils/path.js");
|
|
|
7
7
|
const upload_file_1 = require("../lib/upload-file.js");
|
|
8
8
|
class Files extends resource_1.APIResource {
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* Create a new file record and receive a presigned URL for uploading content to
|
|
11
|
+
* S3.
|
|
11
12
|
*/
|
|
12
13
|
create(body, options) {
|
|
13
14
|
return this._client.post('/files', { body, ...options });
|
|
14
15
|
}
|
|
15
16
|
/**
|
|
16
|
-
* Retrieves
|
|
17
|
+
* Retrieves the details of an existing file.
|
|
17
18
|
*/
|
|
18
19
|
retrieve(id, options) {
|
|
19
20
|
return this._client.get((0, path_1.path) `/files/${id}`, options);
|
package/resources/files.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"files.js","sourceRoot":"","sources":["../src/resources/files.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,uDAAgD;AAEhD,MAAa,KAAM,SAAQ,sBAAW;IACpC
|
|
1
|
+
{"version":3,"file":"files.js","sourceRoot":"","sources":["../src/resources/files.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,uDAAgD;AAEhD,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;OAGG;IACH,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,IAA8B,EAAE,OAA2B;QAChE,MAAM,EAAE,QAAQ,EAAE,GAAG,cAAc,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;QACtD,OAAO,IAAA,wBAAU,EAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE;YACpC,QAAQ;YACR,cAAc;SACf,CAAC,CAAC;IACL,CAAC;CACF;AA5BD,sBA4BC"}
|
package/resources/files.mjs
CHANGED
|
@@ -4,13 +4,14 @@ import { path } from "../internal/utils/path.mjs";
|
|
|
4
4
|
import { uploadFile } from "../lib/upload-file.mjs";
|
|
5
5
|
export class Files extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* Create a new file record and receive a presigned URL for uploading content to
|
|
8
|
+
* S3.
|
|
8
9
|
*/
|
|
9
10
|
create(body, options) {
|
|
10
11
|
return this._client.post('/files', { body, ...options });
|
|
11
12
|
}
|
|
12
13
|
/**
|
|
13
|
-
* Retrieves
|
|
14
|
+
* Retrieves the details of an existing file.
|
|
14
15
|
*/
|
|
15
16
|
retrieve(id, options) {
|
|
16
17
|
return this._client.get(path `/files/${id}`, options);
|
package/resources/files.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"files.mjs","sourceRoot":"","sources":["../src/resources/files.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;OAER,EAAE,UAAU,EAAE;AAErB,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC
|
|
1
|
+
{"version":3,"file":"files.mjs","sourceRoot":"","sources":["../src/resources/files.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;OAER,EAAE,UAAU,EAAE;AAErB,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;OAGG;IACH,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,IAA8B,EAAE,OAA2B;QAChE,MAAM,EAAE,QAAQ,EAAE,GAAG,cAAc,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;QACtD,OAAO,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE;YACpC,QAAQ;YACR,cAAc;SACf,CAAC,CAAC;IACL,CAAC;CACF"}
|