@whop/sdk 0.0.27 → 0.0.29
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 +75 -0
- package/client.d.mts +9 -6
- package/client.d.mts.map +1 -1
- package/client.d.ts +9 -6
- package/client.d.ts.map +1 -1
- package/client.js +10 -0
- package/client.js.map +1 -1
- package/client.mjs +10 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/access-tokens.d.mts +19 -20
- package/resources/access-tokens.d.mts.map +1 -1
- package/resources/access-tokens.d.ts +19 -20
- package/resources/access-tokens.d.ts.map +1 -1
- package/resources/access-tokens.js +4 -4
- package/resources/access-tokens.mjs +4 -4
- 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 +38 -26
- package/resources/ai-chats.d.mts.map +1 -1
- package/resources/ai-chats.d.ts +38 -26
- package/resources/ai-chats.d.ts.map +1 -1
- package/resources/ai-chats.js +5 -5
- package/resources/ai-chats.mjs +5 -5
- package/resources/app-builds.d.mts +35 -33
- package/resources/app-builds.d.mts.map +1 -1
- package/resources/app-builds.d.ts +35 -33
- 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 +81 -56
- package/resources/apps.d.mts.map +1 -1
- package/resources/apps.d.ts +81 -56
- 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 +32 -26
- package/resources/authorized-users.d.mts.map +1 -1
- package/resources/authorized-users.d.ts +32 -26
- 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 +27 -19
- package/resources/chat-channels.d.mts.map +1 -1
- package/resources/chat-channels.d.ts +27 -19
- 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 +55 -46
- package/resources/checkout-configurations.d.mts.map +1 -1
- package/resources/checkout-configurations.d.ts +55 -46
- 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 +71 -46
- package/resources/companies.d.mts.map +1 -1
- package/resources/companies.d.ts +71 -46
- package/resources/companies.d.ts.map +1 -1
- package/resources/companies.js +7 -8
- package/resources/companies.js.map +1 -1
- package/resources/companies.mjs +7 -8
- package/resources/companies.mjs.map +1 -1
- package/resources/company-token-transactions.d.mts +80 -57
- package/resources/company-token-transactions.d.mts.map +1 -1
- package/resources/company-token-transactions.d.ts +80 -57
- 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 +24 -19
- package/resources/course-chapters.d.mts.map +1 -1
- package/resources/course-chapters.d.ts +24 -19
- 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 +126 -84
- package/resources/course-lessons.d.mts.map +1 -1
- package/resources/course-lessons.d.ts +126 -84
- 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 +38 -29
- package/resources/course-students.d.mts.map +1 -1
- package/resources/course-students.d.ts +38 -29
- 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 +132 -91
- package/resources/courses.d.mts.map +1 -1
- package/resources/courses.d.ts +132 -91
- 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/dispute-alerts.d.mts +325 -0
- package/resources/dispute-alerts.d.mts.map +1 -0
- package/resources/dispute-alerts.d.ts +325 -0
- package/resources/dispute-alerts.d.ts.map +1 -0
- package/resources/dispute-alerts.js +42 -0
- package/resources/dispute-alerts.js.map +1 -0
- package/resources/dispute-alerts.mjs +38 -0
- package/resources/dispute-alerts.mjs.map +1 -0
- package/resources/disputes.d.mts +156 -102
- package/resources/disputes.d.mts.map +1 -1
- package/resources/disputes.d.ts +156 -102
- 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 +29 -21
- package/resources/entries.d.mts.map +1 -1
- package/resources/entries.d.ts +29 -21
- 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 +53 -49
- package/resources/experiences.d.mts.map +1 -1
- package/resources/experiences.d.ts +53 -49
- package/resources/experiences.d.ts.map +1 -1
- package/resources/experiences.js +6 -9
- package/resources/experiences.js.map +1 -1
- package/resources/experiences.mjs +6 -9
- package/resources/experiences.mjs.map +1 -1
- package/resources/fee-markups.d.mts +32 -21
- package/resources/fee-markups.d.mts.map +1 -1
- package/resources/fee-markups.d.ts +32 -21
- 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 +21 -17
- package/resources/files.d.mts.map +1 -1
- package/resources/files.d.ts +21 -17
- 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 +62 -43
- package/resources/forum-posts.d.mts.map +1 -1
- package/resources/forum-posts.d.ts +62 -43
- 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 +20 -12
- package/resources/forums.d.mts.map +1 -1
- package/resources/forums.d.ts +20 -12
- 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 +4 -3
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +4 -3
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/invoices.d.mts +108 -80
- package/resources/invoices.d.mts.map +1 -1
- package/resources/invoices.d.ts +108 -80
- 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 +64 -42
- package/resources/leads.d.mts.map +1 -1
- package/resources/leads.d.ts +64 -42
- 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 +10 -8
- package/resources/ledger-accounts.d.mts.map +1 -1
- package/resources/ledger-accounts.d.ts +10 -8
- 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 +18 -19
- package/resources/members.d.mts.map +1 -1
- package/resources/members.d.ts +18 -19
- 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 +69 -51
- package/resources/memberships.d.mts.map +1 -1
- package/resources/memberships.d.ts +69 -51
- 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 +50 -32
- package/resources/messages.d.mts.map +1 -1
- package/resources/messages.d.ts +50 -32
- 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 +73 -40
- package/resources/payments.d.mts.map +1 -1
- package/resources/payments.d.ts +73 -40
- 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 +44 -29
- package/resources/payout-methods.d.mts.map +1 -1
- package/resources/payout-methods.d.ts +44 -29
- 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 +121 -90
- package/resources/plans.d.mts.map +1 -1
- package/resources/plans.d.ts +121 -90
- 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 +76 -65
- package/resources/products.d.mts.map +1 -1
- package/resources/products.d.ts +76 -65
- 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 +41 -31
- package/resources/promo-codes.d.mts.map +1 -1
- package/resources/promo-codes.d.ts +41 -31
- 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 +24 -18
- package/resources/reactions.d.mts.map +1 -1
- package/resources/reactions.d.ts +24 -18
- 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 +43 -29
- package/resources/refunds.d.mts.map +1 -1
- package/resources/refunds.d.ts +43 -29
- 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 +66 -50
- package/resources/reviews.d.mts.map +1 -1
- package/resources/reviews.d.ts +66 -50
- 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 +61 -43
- package/resources/setup-intents.d.mts.map +1 -1
- package/resources/setup-intents.d.ts +61 -43
- 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 +696 -389
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +696 -389
- package/resources/shared.d.ts.map +1 -1
- package/resources/shipments.d.mts +26 -17
- package/resources/shipments.d.mts.map +1 -1
- package/resources/shipments.d.ts +26 -17
- 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 +31 -19
- package/resources/support-channels.d.mts.map +1 -1
- package/resources/support-channels.d.ts +31 -19
- 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 +11 -9
- package/resources/topups.d.mts.map +1 -1
- package/resources/topups.d.ts +11 -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 +35 -29
- package/resources/transfers.d.mts.map +1 -1
- package/resources/transfers.d.ts +35 -29
- 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 +20 -16
- package/resources/users.d.mts.map +1 -1
- package/resources/users.d.ts +20 -16
- package/resources/users.d.ts.map +1 -1
- package/resources/users.js +4 -3
- package/resources/users.js.map +1 -1
- package/resources/users.mjs +4 -3
- package/resources/users.mjs.map +1 -1
- package/resources/verifications.d.mts +6 -4
- package/resources/verifications.d.mts.map +1 -1
- package/resources/verifications.d.ts +6 -4
- 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 +360 -98
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +360 -98
- 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 +53 -44
- package/resources/withdrawals.d.mts.map +1 -1
- package/resources/withdrawals.d.ts +53 -44
- 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 +34 -3
- package/src/resources/access-tokens.ts +19 -20
- package/src/resources/account-links.ts +15 -13
- package/src/resources/ai-chats.ts +39 -26
- package/src/resources/app-builds.ts +35 -33
- package/src/resources/apps.ts +84 -56
- package/src/resources/authorized-users.ts +32 -26
- package/src/resources/chat-channels.ts +27 -19
- package/src/resources/checkout-configurations.ts +56 -46
- package/src/resources/companies.ts +75 -46
- package/src/resources/company-token-transactions.ts +81 -58
- package/src/resources/course-chapters.ts +24 -19
- package/src/resources/course-lesson-interactions.ts +7 -6
- package/src/resources/course-lessons.ts +126 -84
- package/src/resources/course-students.ts +38 -29
- package/src/resources/courses.ts +132 -91
- package/src/resources/dispute-alerts.ts +404 -0
- package/src/resources/disputes.ts +156 -102
- package/src/resources/dm-channels.ts +29 -16
- package/src/resources/dm-members.ts +30 -21
- package/src/resources/entries.ts +29 -21
- package/src/resources/experiences.ts +53 -49
- package/src/resources/fee-markups.ts +32 -21
- package/src/resources/files.ts +21 -17
- package/src/resources/forum-posts.ts +63 -43
- package/src/resources/forums.ts +20 -12
- package/src/resources/index.ts +11 -1
- package/src/resources/invoices.ts +112 -80
- package/src/resources/leads.ts +64 -42
- package/src/resources/ledger-accounts.ts +10 -8
- package/src/resources/members.ts +18 -19
- package/src/resources/memberships.ts +69 -51
- package/src/resources/messages.ts +51 -32
- package/src/resources/notifications.ts +33 -25
- package/src/resources/payment-methods.ts +212 -114
- package/src/resources/payments.ts +78 -39
- package/src/resources/payout-methods.ts +44 -29
- package/src/resources/plans.ts +121 -90
- package/src/resources/products.ts +219 -68
- package/src/resources/promo-codes.ts +41 -31
- package/src/resources/reactions.ts +24 -18
- package/src/resources/refunds.ts +45 -29
- package/src/resources/reviews.ts +66 -50
- package/src/resources/setup-intents.ts +61 -43
- package/src/resources/shared.ts +2649 -388
- package/src/resources/shipments.ts +26 -17
- package/src/resources/support-channels.ts +32 -19
- package/src/resources/topups.ts +11 -9
- package/src/resources/transfers.ts +35 -29
- package/src/resources/users.ts +20 -16
- package/src/resources/verifications.ts +6 -4
- package/src/resources/webhooks.ts +404 -95
- package/src/resources/withdrawals.ts +53 -43
- 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
package/resources/invoices.d.ts
CHANGED
|
@@ -6,7 +6,8 @@ import { type CursorPageParams, PagePromise } from "../core/pagination.js";
|
|
|
6
6
|
import { RequestOptions } from "../internal/request-options.js";
|
|
7
7
|
export declare class Invoices extends APIResource {
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Create an invoice for a customer. The invoice can be charged automatically using
|
|
10
|
+
* a stored payment method, or sent to the customer for manual payment.
|
|
10
11
|
*
|
|
11
12
|
* Required permissions:
|
|
12
13
|
*
|
|
@@ -27,7 +28,7 @@ export declare class Invoices extends APIResource {
|
|
|
27
28
|
*/
|
|
28
29
|
create(body: InvoiceCreateParams, options?: RequestOptions): APIPromise<Shared.Invoice>;
|
|
29
30
|
/**
|
|
30
|
-
* Retrieves
|
|
31
|
+
* Retrieves the details of an existing invoice.
|
|
31
32
|
*
|
|
32
33
|
* Required permissions:
|
|
33
34
|
*
|
|
@@ -36,7 +37,8 @@ export declare class Invoices extends APIResource {
|
|
|
36
37
|
*/
|
|
37
38
|
retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Invoice>;
|
|
38
39
|
/**
|
|
39
|
-
*
|
|
40
|
+
* Returns a paginated list of invoices for a company, with optional filtering by
|
|
41
|
+
* product, status, collection method, and creation date.
|
|
40
42
|
*
|
|
41
43
|
* Required permissions:
|
|
42
44
|
*
|
|
@@ -45,7 +47,8 @@ export declare class Invoices extends APIResource {
|
|
|
45
47
|
*/
|
|
46
48
|
list(query: InvoiceListParams, options?: RequestOptions): PagePromise<InvoiceListItemsCursorPage, Shared.InvoiceListItem>;
|
|
47
49
|
/**
|
|
48
|
-
* Void an invoice
|
|
50
|
+
* Void an open invoice so it can no longer be paid. Voiding is permanent and
|
|
51
|
+
* cannot be undone.
|
|
49
52
|
*
|
|
50
53
|
* Required permissions:
|
|
51
54
|
*
|
|
@@ -61,46 +64,51 @@ export type InvoiceCreateParams = InvoiceCreateParams.CreateInvoiceInputWithProd
|
|
|
61
64
|
export declare namespace InvoiceCreateParams {
|
|
62
65
|
interface CreateInvoiceInputWithProductAndMemberID {
|
|
63
66
|
/**
|
|
64
|
-
*
|
|
65
|
-
*
|
|
67
|
+
* How the invoice should be collected. Use charge_automatically to charge a stored
|
|
68
|
+
* payment method, or send_invoice to email the customer.
|
|
66
69
|
*/
|
|
67
70
|
collection_method: Shared.CollectionMethod;
|
|
68
71
|
/**
|
|
69
|
-
* The company
|
|
72
|
+
* The unique identifier of the company to create this invoice for.
|
|
70
73
|
*/
|
|
71
74
|
company_id: string;
|
|
72
75
|
/**
|
|
73
|
-
* The date the invoice
|
|
76
|
+
* The date by which the invoice must be paid.
|
|
74
77
|
*/
|
|
75
78
|
due_date: string;
|
|
76
79
|
/**
|
|
77
|
-
* The member
|
|
78
|
-
*
|
|
79
|
-
* an email_address and customer_name.
|
|
80
|
+
* The unique identifier of an existing member to create this invoice for. If not
|
|
81
|
+
* provided, you must supply an email_address and customer_name.
|
|
80
82
|
*/
|
|
81
83
|
member_id: string;
|
|
82
84
|
/**
|
|
83
|
-
* The
|
|
85
|
+
* The plan attributes defining the price, currency, and billing interval for this
|
|
86
|
+
* invoice.
|
|
84
87
|
*/
|
|
85
88
|
plan: CreateInvoiceInputWithProductAndMemberID.Plan;
|
|
86
89
|
/**
|
|
87
|
-
* The properties of the product to create for this invoice.
|
|
88
|
-
*
|
|
90
|
+
* The properties of the product to create for this invoice. Provide this to create
|
|
91
|
+
* a new product inline.
|
|
89
92
|
*/
|
|
90
93
|
product: CreateInvoiceInputWithProductAndMemberID.Product;
|
|
91
94
|
/**
|
|
92
|
-
*
|
|
95
|
+
* The date and time when the invoice will be automatically finalized and charged.
|
|
96
|
+
* Only valid when collection_method is charge_automatically. If not provided, the
|
|
97
|
+
* charge will be processed immediately.
|
|
98
|
+
*/
|
|
99
|
+
automatically_finalizes_at?: string | null;
|
|
100
|
+
/**
|
|
101
|
+
* Whether to charge the customer a buyer fee on this invoice.
|
|
93
102
|
*/
|
|
94
103
|
charge_buyer_fee?: boolean | null;
|
|
95
104
|
/**
|
|
96
|
-
* The name of the customer
|
|
97
|
-
*
|
|
98
|
-
* company yet.
|
|
105
|
+
* The name of the customer. Required when creating an invoice for a customer who
|
|
106
|
+
* is not yet a member of the company.
|
|
99
107
|
*/
|
|
100
108
|
customer_name?: string | null;
|
|
101
109
|
/**
|
|
102
|
-
* The
|
|
103
|
-
*
|
|
110
|
+
* The unique identifier of the payment method to charge. Required when
|
|
111
|
+
* collection_method is charge_automatically.
|
|
104
112
|
*/
|
|
105
113
|
payment_method_id?: string | null;
|
|
106
114
|
/**
|
|
@@ -111,7 +119,8 @@ export declare namespace InvoiceCreateParams {
|
|
|
111
119
|
}
|
|
112
120
|
namespace CreateInvoiceInputWithProductAndMemberID {
|
|
113
121
|
/**
|
|
114
|
-
* The
|
|
122
|
+
* The plan attributes defining the price, currency, and billing interval for this
|
|
123
|
+
* invoice.
|
|
115
124
|
*/
|
|
116
125
|
interface Plan {
|
|
117
126
|
/**
|
|
@@ -201,8 +210,8 @@ export declare namespace InvoiceCreateParams {
|
|
|
201
210
|
}
|
|
202
211
|
}
|
|
203
212
|
/**
|
|
204
|
-
* The properties of the product to create for this invoice.
|
|
205
|
-
*
|
|
213
|
+
* The properties of the product to create for this invoice. Provide this to create
|
|
214
|
+
* a new product inline.
|
|
206
215
|
*/
|
|
207
216
|
interface Product {
|
|
208
217
|
/**
|
|
@@ -217,45 +226,51 @@ export declare namespace InvoiceCreateParams {
|
|
|
217
226
|
}
|
|
218
227
|
interface CreateInvoiceInputWithProductAndEmailAddress {
|
|
219
228
|
/**
|
|
220
|
-
*
|
|
221
|
-
*
|
|
229
|
+
* How the invoice should be collected. Use charge_automatically to charge a stored
|
|
230
|
+
* payment method, or send_invoice to email the customer.
|
|
222
231
|
*/
|
|
223
232
|
collection_method: Shared.CollectionMethod;
|
|
224
233
|
/**
|
|
225
|
-
* The company
|
|
234
|
+
* The unique identifier of the company to create this invoice for.
|
|
226
235
|
*/
|
|
227
236
|
company_id: string;
|
|
228
237
|
/**
|
|
229
|
-
* The date the invoice
|
|
238
|
+
* The date by which the invoice must be paid.
|
|
230
239
|
*/
|
|
231
240
|
due_date: string;
|
|
232
241
|
/**
|
|
233
|
-
* The email address
|
|
234
|
-
*
|
|
242
|
+
* The email address of the customer. Required when creating an invoice for a
|
|
243
|
+
* customer who is not yet a member of the company.
|
|
235
244
|
*/
|
|
236
245
|
email_address: string;
|
|
237
246
|
/**
|
|
238
|
-
* The
|
|
247
|
+
* The plan attributes defining the price, currency, and billing interval for this
|
|
248
|
+
* invoice.
|
|
239
249
|
*/
|
|
240
250
|
plan: CreateInvoiceInputWithProductAndEmailAddress.Plan;
|
|
241
251
|
/**
|
|
242
|
-
* The properties of the product to create for this invoice.
|
|
243
|
-
*
|
|
252
|
+
* The properties of the product to create for this invoice. Provide this to create
|
|
253
|
+
* a new product inline.
|
|
244
254
|
*/
|
|
245
255
|
product: CreateInvoiceInputWithProductAndEmailAddress.Product;
|
|
246
256
|
/**
|
|
247
|
-
*
|
|
257
|
+
* The date and time when the invoice will be automatically finalized and charged.
|
|
258
|
+
* Only valid when collection_method is charge_automatically. If not provided, the
|
|
259
|
+
* charge will be processed immediately.
|
|
260
|
+
*/
|
|
261
|
+
automatically_finalizes_at?: string | null;
|
|
262
|
+
/**
|
|
263
|
+
* Whether to charge the customer a buyer fee on this invoice.
|
|
248
264
|
*/
|
|
249
265
|
charge_buyer_fee?: boolean | null;
|
|
250
266
|
/**
|
|
251
|
-
* The name of the customer
|
|
252
|
-
*
|
|
253
|
-
* company yet.
|
|
267
|
+
* The name of the customer. Required when creating an invoice for a customer who
|
|
268
|
+
* is not yet a member of the company.
|
|
254
269
|
*/
|
|
255
270
|
customer_name?: string | null;
|
|
256
271
|
/**
|
|
257
|
-
* The
|
|
258
|
-
*
|
|
272
|
+
* The unique identifier of the payment method to charge. Required when
|
|
273
|
+
* collection_method is charge_automatically.
|
|
259
274
|
*/
|
|
260
275
|
payment_method_id?: string | null;
|
|
261
276
|
/**
|
|
@@ -266,7 +281,8 @@ export declare namespace InvoiceCreateParams {
|
|
|
266
281
|
}
|
|
267
282
|
namespace CreateInvoiceInputWithProductAndEmailAddress {
|
|
268
283
|
/**
|
|
269
|
-
* The
|
|
284
|
+
* The plan attributes defining the price, currency, and billing interval for this
|
|
285
|
+
* invoice.
|
|
270
286
|
*/
|
|
271
287
|
interface Plan {
|
|
272
288
|
/**
|
|
@@ -356,8 +372,8 @@ export declare namespace InvoiceCreateParams {
|
|
|
356
372
|
}
|
|
357
373
|
}
|
|
358
374
|
/**
|
|
359
|
-
* The properties of the product to create for this invoice.
|
|
360
|
-
*
|
|
375
|
+
* The properties of the product to create for this invoice. Provide this to create
|
|
376
|
+
* a new product inline.
|
|
361
377
|
*/
|
|
362
378
|
interface Product {
|
|
363
379
|
/**
|
|
@@ -372,46 +388,50 @@ export declare namespace InvoiceCreateParams {
|
|
|
372
388
|
}
|
|
373
389
|
interface CreateInvoiceInputWithProductIDAndMemberID {
|
|
374
390
|
/**
|
|
375
|
-
*
|
|
376
|
-
*
|
|
391
|
+
* How the invoice should be collected. Use charge_automatically to charge a stored
|
|
392
|
+
* payment method, or send_invoice to email the customer.
|
|
377
393
|
*/
|
|
378
394
|
collection_method: Shared.CollectionMethod;
|
|
379
395
|
/**
|
|
380
|
-
* The company
|
|
396
|
+
* The unique identifier of the company to create this invoice for.
|
|
381
397
|
*/
|
|
382
398
|
company_id: string;
|
|
383
399
|
/**
|
|
384
|
-
* The date the invoice
|
|
400
|
+
* The date by which the invoice must be paid.
|
|
385
401
|
*/
|
|
386
402
|
due_date: string;
|
|
387
403
|
/**
|
|
388
|
-
* The member
|
|
389
|
-
*
|
|
390
|
-
* an email_address and customer_name.
|
|
404
|
+
* The unique identifier of an existing member to create this invoice for. If not
|
|
405
|
+
* provided, you must supply an email_address and customer_name.
|
|
391
406
|
*/
|
|
392
407
|
member_id: string;
|
|
393
408
|
/**
|
|
394
|
-
* The
|
|
409
|
+
* The plan attributes defining the price, currency, and billing interval for this
|
|
410
|
+
* invoice.
|
|
395
411
|
*/
|
|
396
412
|
plan: CreateInvoiceInputWithProductIDAndMemberID.Plan;
|
|
397
413
|
/**
|
|
398
|
-
* The product
|
|
399
|
-
* invoice for an existing product.
|
|
414
|
+
* The unique identifier of an existing product to create this invoice for.
|
|
400
415
|
*/
|
|
401
416
|
product_id: string;
|
|
402
417
|
/**
|
|
403
|
-
*
|
|
418
|
+
* The date and time when the invoice will be automatically finalized and charged.
|
|
419
|
+
* Only valid when collection_method is charge_automatically. If not provided, the
|
|
420
|
+
* charge will be processed immediately.
|
|
421
|
+
*/
|
|
422
|
+
automatically_finalizes_at?: string | null;
|
|
423
|
+
/**
|
|
424
|
+
* Whether to charge the customer a buyer fee on this invoice.
|
|
404
425
|
*/
|
|
405
426
|
charge_buyer_fee?: boolean | null;
|
|
406
427
|
/**
|
|
407
|
-
* The name of the customer
|
|
408
|
-
*
|
|
409
|
-
* company yet.
|
|
428
|
+
* The name of the customer. Required when creating an invoice for a customer who
|
|
429
|
+
* is not yet a member of the company.
|
|
410
430
|
*/
|
|
411
431
|
customer_name?: string | null;
|
|
412
432
|
/**
|
|
413
|
-
* The
|
|
414
|
-
*
|
|
433
|
+
* The unique identifier of the payment method to charge. Required when
|
|
434
|
+
* collection_method is charge_automatically.
|
|
415
435
|
*/
|
|
416
436
|
payment_method_id?: string | null;
|
|
417
437
|
/**
|
|
@@ -422,7 +442,8 @@ export declare namespace InvoiceCreateParams {
|
|
|
422
442
|
}
|
|
423
443
|
namespace CreateInvoiceInputWithProductIDAndMemberID {
|
|
424
444
|
/**
|
|
425
|
-
* The
|
|
445
|
+
* The plan attributes defining the price, currency, and billing interval for this
|
|
446
|
+
* invoice.
|
|
426
447
|
*/
|
|
427
448
|
interface Plan {
|
|
428
449
|
/**
|
|
@@ -514,45 +535,50 @@ export declare namespace InvoiceCreateParams {
|
|
|
514
535
|
}
|
|
515
536
|
interface CreateInvoiceInputWithProductIDAndEmailAddress {
|
|
516
537
|
/**
|
|
517
|
-
*
|
|
518
|
-
*
|
|
538
|
+
* How the invoice should be collected. Use charge_automatically to charge a stored
|
|
539
|
+
* payment method, or send_invoice to email the customer.
|
|
519
540
|
*/
|
|
520
541
|
collection_method: Shared.CollectionMethod;
|
|
521
542
|
/**
|
|
522
|
-
* The company
|
|
543
|
+
* The unique identifier of the company to create this invoice for.
|
|
523
544
|
*/
|
|
524
545
|
company_id: string;
|
|
525
546
|
/**
|
|
526
|
-
* The date the invoice
|
|
547
|
+
* The date by which the invoice must be paid.
|
|
527
548
|
*/
|
|
528
549
|
due_date: string;
|
|
529
550
|
/**
|
|
530
|
-
* The email address
|
|
531
|
-
*
|
|
551
|
+
* The email address of the customer. Required when creating an invoice for a
|
|
552
|
+
* customer who is not yet a member of the company.
|
|
532
553
|
*/
|
|
533
554
|
email_address: string;
|
|
534
555
|
/**
|
|
535
|
-
* The
|
|
556
|
+
* The plan attributes defining the price, currency, and billing interval for this
|
|
557
|
+
* invoice.
|
|
536
558
|
*/
|
|
537
559
|
plan: CreateInvoiceInputWithProductIDAndEmailAddress.Plan;
|
|
538
560
|
/**
|
|
539
|
-
* The product
|
|
540
|
-
* invoice for an existing product.
|
|
561
|
+
* The unique identifier of an existing product to create this invoice for.
|
|
541
562
|
*/
|
|
542
563
|
product_id: string;
|
|
543
564
|
/**
|
|
544
|
-
*
|
|
565
|
+
* The date and time when the invoice will be automatically finalized and charged.
|
|
566
|
+
* Only valid when collection_method is charge_automatically. If not provided, the
|
|
567
|
+
* charge will be processed immediately.
|
|
568
|
+
*/
|
|
569
|
+
automatically_finalizes_at?: string | null;
|
|
570
|
+
/**
|
|
571
|
+
* Whether to charge the customer a buyer fee on this invoice.
|
|
545
572
|
*/
|
|
546
573
|
charge_buyer_fee?: boolean | null;
|
|
547
574
|
/**
|
|
548
|
-
* The name of the customer
|
|
549
|
-
*
|
|
550
|
-
* company yet.
|
|
575
|
+
* The name of the customer. Required when creating an invoice for a customer who
|
|
576
|
+
* is not yet a member of the company.
|
|
551
577
|
*/
|
|
552
578
|
customer_name?: string | null;
|
|
553
579
|
/**
|
|
554
|
-
* The
|
|
555
|
-
*
|
|
580
|
+
* The unique identifier of the payment method to charge. Required when
|
|
581
|
+
* collection_method is charge_automatically.
|
|
556
582
|
*/
|
|
557
583
|
payment_method_id?: string | null;
|
|
558
584
|
/**
|
|
@@ -563,7 +589,8 @@ export declare namespace InvoiceCreateParams {
|
|
|
563
589
|
}
|
|
564
590
|
namespace CreateInvoiceInputWithProductIDAndEmailAddress {
|
|
565
591
|
/**
|
|
566
|
-
* The
|
|
592
|
+
* The plan attributes defining the price, currency, and billing interval for this
|
|
593
|
+
* invoice.
|
|
567
594
|
*/
|
|
568
595
|
interface Plan {
|
|
569
596
|
/**
|
|
@@ -656,7 +683,7 @@ export declare namespace InvoiceCreateParams {
|
|
|
656
683
|
}
|
|
657
684
|
export interface InvoiceListParams extends CursorPageParams {
|
|
658
685
|
/**
|
|
659
|
-
* The
|
|
686
|
+
* The unique identifier of the company to list invoices for.
|
|
660
687
|
*/
|
|
661
688
|
company_id: string;
|
|
662
689
|
/**
|
|
@@ -664,15 +691,15 @@ export interface InvoiceListParams extends CursorPageParams {
|
|
|
664
691
|
*/
|
|
665
692
|
before?: string | null;
|
|
666
693
|
/**
|
|
667
|
-
* Filter invoices by their collection method
|
|
694
|
+
* Filter invoices by their collection method.
|
|
668
695
|
*/
|
|
669
696
|
collection_methods?: Array<Shared.CollectionMethod> | null;
|
|
670
697
|
/**
|
|
671
|
-
*
|
|
698
|
+
* Only return invoices created after this timestamp.
|
|
672
699
|
*/
|
|
673
700
|
created_after?: string | null;
|
|
674
701
|
/**
|
|
675
|
-
*
|
|
702
|
+
* Only return invoices created before this timestamp.
|
|
676
703
|
*/
|
|
677
704
|
created_before?: string | null;
|
|
678
705
|
/**
|
|
@@ -692,11 +719,12 @@ export interface InvoiceListParams extends CursorPageParams {
|
|
|
692
719
|
*/
|
|
693
720
|
order?: 'id' | 'created_at' | 'due_date' | null;
|
|
694
721
|
/**
|
|
695
|
-
*
|
|
722
|
+
* Filter invoices to only those associated with these specific product
|
|
723
|
+
* identifiers.
|
|
696
724
|
*/
|
|
697
725
|
product_ids?: Array<string> | null;
|
|
698
726
|
/**
|
|
699
|
-
*
|
|
727
|
+
* Filter invoices by their current status.
|
|
700
728
|
*/
|
|
701
729
|
statuses?: Array<Shared.InvoiceStatus> | null;
|
|
702
730
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"invoices.d.ts","sourceRoot":"","sources":["../src/resources/invoices.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,0BAA0B,EAAE;OAC9B,EAAE,UAAU,EAAE;OACd,EAAc,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC
|
|
1
|
+
{"version":3,"file":"invoices.d.ts","sourceRoot":"","sources":["../src/resources/invoices.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,0BAA0B,EAAE;OAC9B,EAAE,UAAU,EAAE;OACd,EAAc,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAIvF;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAI1E;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,EAAE,iBAAiB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0BAA0B,EAAE,MAAM,CAAC,eAAe,CAAC;IAIlE;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAG5E;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAC;AAE1C,MAAM,MAAM,mBAAmB,GAC3B,mBAAmB,CAAC,wCAAwC,GAC5D,mBAAmB,CAAC,4CAA4C,GAChE,mBAAmB,CAAC,0CAA0C,GAC9D,mBAAmB,CAAC,8CAA8C,CAAC;AAEvE,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,UAAiB,wCAAwC;QACvD;;;WAGG;QACH,iBAAiB,EAAE,MAAM,CAAC,gBAAgB,CAAC;QAE3C;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,IAAI,EAAE,wCAAwC,CAAC,IAAI,CAAC;QAEpD;;;WAGG;QACH,OAAO,EAAE,wCAAwC,CAAC,OAAO,CAAC;QAE1D;;;;WAIG;QACH,0BAA0B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3C;;WAEG;QACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAElC;;;WAGG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;;WAGG;QACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAElC;;;WAGG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;IAED,UAAiB,wCAAwC,CAAC;QACxD;;;WAGG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE/B;;eAEG;YACH,aAAa,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;YAE/C;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;;eAGG;YACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEhC;;;;eAIG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE/B;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;YAEnC;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;YAE7C;;;eAGG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAElC;;;eAGG;YACH,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;YAEjC;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;SACvC;QAED,UAAiB,IAAI,CAAC;YACpB,UAAiB,WAAW;gBAC1B;;mBAEG;gBACH,UAAU,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEnB;;mBAEG;gBACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEtB;;mBAEG;gBACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE5B;;mBAEG;gBACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;aAC3B;SACF;QAED;;;WAGG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACrC;KACF;IAED,UAAiB,4CAA4C;QAC3D;;;WAGG;QACH,iBAAiB,EAAE,MAAM,CAAC,gBAAgB,CAAC;QAE3C;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,IAAI,EAAE,4CAA4C,CAAC,IAAI,CAAC;QAExD;;;WAGG;QACH,OAAO,EAAE,4CAA4C,CAAC,OAAO,CAAC;QAE9D;;;;WAIG;QACH,0BAA0B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3C;;WAEG;QACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAElC;;;WAGG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;;WAGG;QACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAElC;;;WAGG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;IAED,UAAiB,4CAA4C,CAAC;QAC5D;;;WAGG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE/B;;eAEG;YACH,aAAa,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;YAE/C;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;;eAGG;YACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEhC;;;;eAIG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE/B;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;YAEnC;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;YAE7C;;;eAGG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAElC;;;eAGG;YACH,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;YAEjC;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;SACvC;QAED,UAAiB,IAAI,CAAC;YACpB,UAAiB,WAAW;gBAC1B;;mBAEG;gBACH,UAAU,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEnB;;mBAEG;gBACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEtB;;mBAEG;gBACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE5B;;mBAEG;gBACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;aAC3B;SACF;QAED;;;WAGG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACrC;KACF;IAED,UAAiB,0CAA0C;QACzD;;;WAGG;QACH,iBAAiB,EAAE,MAAM,CAAC,gBAAgB,CAAC;QAE3C;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,IAAI,EAAE,0CAA0C,CAAC,IAAI,CAAC;QAEtD;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,0BAA0B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3C;;WAEG;QACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAElC;;;WAGG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;;WAGG;QACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAElC;;;WAGG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;IAED,UAAiB,0CAA0C,CAAC;QAC1D;;;WAGG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE/B;;eAEG;YACH,aAAa,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;YAE/C;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;;eAGG;YACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEhC;;;;eAIG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE/B;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;YAEnC;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;YAE7C;;;eAGG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAElC;;;eAGG;YACH,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;YAEjC;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;SACvC;QAED,UAAiB,IAAI,CAAC;YACpB,UAAiB,WAAW;gBAC1B;;mBAEG;gBACH,UAAU,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEnB;;mBAEG;gBACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEtB;;mBAEG;gBACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE5B;;mBAEG;gBACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;aAC3B;SACF;KACF;IAED,UAAiB,8CAA8C;QAC7D;;;WAGG;QACH,iBAAiB,EAAE,MAAM,CAAC,gBAAgB,CAAC;QAE3C;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,IAAI,EAAE,8CAA8C,CAAC,IAAI,CAAC;QAE1D;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,0BAA0B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3C;;WAEG;QACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAElC;;;WAGG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;;WAGG;QACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAElC;;;WAGG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;IAED,UAAiB,8CAA8C,CAAC;QAC9D;;;WAGG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE/B;;eAEG;YACH,aAAa,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;YAE/C;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;;eAGG;YACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEhC;;;;eAIG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE/B;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;YAEnC;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;YAE7C;;;eAGG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAElC;;;eAGG;YACH,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;YAEjC;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;SACvC;QAED,UAAiB,IAAI,CAAC;YACpB,UAAiB,WAAW;gBAC1B;;mBAEG;gBACH,UAAU,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEnB;;mBAEG;gBACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEtB;;mBAEG;gBACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE5B;;mBAEG;gBACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;aAC3B;SACF;KACF;CACF;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;IAE3D;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;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,IAAI,GAAG,YAAY,GAAG,UAAU,GAAG,IAAI,CAAC;IAEhD;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC;CAC/C;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH;AAED,OAAO,EAAE,KAAK,0BAA0B,EAAE,CAAC"}
|
package/resources/invoices.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 Invoices extends resource_1.APIResource {
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* Create an invoice for a customer. The invoice can be charged automatically using
|
|
11
|
+
* a stored payment method, or sent to the customer for manual payment.
|
|
11
12
|
*
|
|
12
13
|
* Required permissions:
|
|
13
14
|
*
|
|
@@ -30,7 +31,7 @@ class Invoices extends resource_1.APIResource {
|
|
|
30
31
|
return this._client.post('/invoices', { body, ...options });
|
|
31
32
|
}
|
|
32
33
|
/**
|
|
33
|
-
* Retrieves
|
|
34
|
+
* Retrieves the details of an existing invoice.
|
|
34
35
|
*
|
|
35
36
|
* Required permissions:
|
|
36
37
|
*
|
|
@@ -41,7 +42,8 @@ class Invoices extends resource_1.APIResource {
|
|
|
41
42
|
return this._client.get((0, path_1.path) `/invoices/${id}`, options);
|
|
42
43
|
}
|
|
43
44
|
/**
|
|
44
|
-
*
|
|
45
|
+
* Returns a paginated list of invoices for a company, with optional filtering by
|
|
46
|
+
* product, status, collection method, and creation date.
|
|
45
47
|
*
|
|
46
48
|
* Required permissions:
|
|
47
49
|
*
|
|
@@ -52,7 +54,8 @@ class Invoices extends resource_1.APIResource {
|
|
|
52
54
|
return this._client.getAPIList('/invoices', (pagination_1.CursorPage), { query, ...options });
|
|
53
55
|
}
|
|
54
56
|
/**
|
|
55
|
-
* Void an invoice
|
|
57
|
+
* Void an open invoice so it can no longer be paid. Voiding is permanent and
|
|
58
|
+
* cannot be undone.
|
|
56
59
|
*
|
|
57
60
|
* Required permissions:
|
|
58
61
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"invoices.js","sourceRoot":"","sources":["../src/resources/invoices.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,QAAS,SAAQ,sBAAW;IACvC
|
|
1
|
+
{"version":3,"file":"invoices.js","sourceRoot":"","sources":["../src/resources/invoices.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,KAAwB,EACxB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA,uBAAkC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,EAAU,EAAE,OAAwB;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;CACF;AAjED,4BAiEC"}
|
package/resources/invoices.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 Invoices extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* Create an invoice for a customer. The invoice can be charged automatically using
|
|
8
|
+
* a stored payment method, or sent to the customer for manual payment.
|
|
8
9
|
*
|
|
9
10
|
* Required permissions:
|
|
10
11
|
*
|
|
@@ -27,7 +28,7 @@ export class Invoices extends APIResource {
|
|
|
27
28
|
return this._client.post('/invoices', { body, ...options });
|
|
28
29
|
}
|
|
29
30
|
/**
|
|
30
|
-
* Retrieves
|
|
31
|
+
* Retrieves the details of an existing invoice.
|
|
31
32
|
*
|
|
32
33
|
* Required permissions:
|
|
33
34
|
*
|
|
@@ -38,7 +39,8 @@ export class Invoices extends APIResource {
|
|
|
38
39
|
return this._client.get(path `/invoices/${id}`, options);
|
|
39
40
|
}
|
|
40
41
|
/**
|
|
41
|
-
*
|
|
42
|
+
* Returns a paginated list of invoices for a company, with optional filtering by
|
|
43
|
+
* product, status, collection method, and creation date.
|
|
42
44
|
*
|
|
43
45
|
* Required permissions:
|
|
44
46
|
*
|
|
@@ -49,7 +51,8 @@ export class Invoices extends APIResource {
|
|
|
49
51
|
return this._client.getAPIList('/invoices', (CursorPage), { query, ...options });
|
|
50
52
|
}
|
|
51
53
|
/**
|
|
52
|
-
* Void an invoice
|
|
54
|
+
* Void an open invoice so it can no longer be paid. Voiding is permanent and
|
|
55
|
+
* cannot be undone.
|
|
53
56
|
*
|
|
54
57
|
* Required permissions:
|
|
55
58
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"invoices.mjs","sourceRoot":"","sources":["../src/resources/invoices.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC
|
|
1
|
+
{"version":3,"file":"invoices.mjs","sourceRoot":"","sources":["../src/resources/invoices.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,KAAwB,EACxB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA,UAAkC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,EAAU,EAAE,OAAwB;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;CACF"}
|