@whop/sdk 0.0.27 → 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 +41 -0
- package/client.d.mts +4 -4
- package/client.d.mts.map +1 -1
- package/client.d.ts +4 -4
- package/client.d.ts.map +1 -1
- package/client.js +7 -0
- package/client.js.map +1 -1
- package/client.mjs +7 -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 +65 -46
- package/resources/companies.d.mts.map +1 -1
- package/resources/companies.d.ts +65 -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/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 -45
- package/resources/experiences.d.mts.map +1 -1
- package/resources/experiences.d.ts +53 -45
- 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 +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 +2 -2
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +2 -2
- 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 +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 +46 -32
- package/resources/messages.d.mts.map +1 -1
- package/resources/messages.d.ts +46 -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 +695 -388
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +695 -388
- 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 +27 -19
- package/resources/support-channels.d.mts.map +1 -1
- package/resources/support-channels.d.ts +27 -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 +136 -95
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +136 -95
- 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 +13 -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 +68 -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/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 -45
- 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 +2 -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 +46 -32
- package/src/resources/notifications.ts +33 -25
- package/src/resources/payment-methods.ts +212 -114
- package/src/resources/payments.ts +77 -39
- package/src/resources/payout-methods.ts +44 -29
- package/src/resources/plans.ts +121 -90
- package/src/resources/products.ts +215 -68
- package/src/resources/promo-codes.ts +41 -31
- package/src/resources/reactions.ts +24 -18
- package/src/resources/refunds.ts +44 -29
- package/src/resources/reviews.ts +66 -50
- package/src/resources/setup-intents.ts +61 -43
- package/src/resources/shared.ts +2637 -387
- package/src/resources/shipments.ts +26 -17
- package/src/resources/support-channels.ts +27 -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 +136 -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
|
@@ -5,7 +5,7 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
|
|
|
5
5
|
import { RequestOptions } from "../internal/request-options.js";
|
|
6
6
|
export declare class Memberships extends APIResource {
|
|
7
7
|
/**
|
|
8
|
-
* Retrieves
|
|
8
|
+
* Retrieves the details of an existing membership.
|
|
9
9
|
*
|
|
10
10
|
* Required permissions:
|
|
11
11
|
*
|
|
@@ -14,7 +14,7 @@ export declare class Memberships extends APIResource {
|
|
|
14
14
|
*/
|
|
15
15
|
retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Membership>;
|
|
16
16
|
/**
|
|
17
|
-
* Update a membership
|
|
17
|
+
* Update a membership's metadata or other mutable properties.
|
|
18
18
|
*
|
|
19
19
|
* Required permissions:
|
|
20
20
|
*
|
|
@@ -24,7 +24,8 @@ export declare class Memberships extends APIResource {
|
|
|
24
24
|
*/
|
|
25
25
|
update(id: string, body?: MembershipUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Shared.Membership>;
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
27
|
+
* Returns a paginated list of memberships, with optional filtering by product,
|
|
28
|
+
* plan, status, and user.
|
|
28
29
|
*
|
|
29
30
|
* Required permissions:
|
|
30
31
|
*
|
|
@@ -33,8 +34,8 @@ export declare class Memberships extends APIResource {
|
|
|
33
34
|
*/
|
|
34
35
|
list(query?: MembershipListParams | null | undefined, options?: RequestOptions): PagePromise<MembershipListResponsesCursorPage, MembershipListResponse>;
|
|
35
36
|
/**
|
|
36
|
-
*
|
|
37
|
-
* period
|
|
37
|
+
* Cancel a membership either immediately or at the end of the current billing
|
|
38
|
+
* period. Immediate cancellation revokes access right away.
|
|
38
39
|
*
|
|
39
40
|
* Required permissions:
|
|
40
41
|
*
|
|
@@ -44,7 +45,8 @@ export declare class Memberships extends APIResource {
|
|
|
44
45
|
*/
|
|
45
46
|
cancel(id: string, body?: MembershipCancelParams | null | undefined, options?: RequestOptions): APIPromise<Shared.Membership>;
|
|
46
47
|
/**
|
|
47
|
-
*
|
|
48
|
+
* Pause a membership's recurring payments. The customer retains access but will
|
|
49
|
+
* not be charged until the membership is resumed.
|
|
48
50
|
*
|
|
49
51
|
* Required permissions:
|
|
50
52
|
*
|
|
@@ -54,7 +56,8 @@ export declare class Memberships extends APIResource {
|
|
|
54
56
|
*/
|
|
55
57
|
pause(id: string, body?: MembershipPauseParams | null | undefined, options?: RequestOptions): APIPromise<Shared.Membership>;
|
|
56
58
|
/**
|
|
57
|
-
*
|
|
59
|
+
* Resume a previously paused membership's recurring payments. Billing resumes on
|
|
60
|
+
* the next cycle.
|
|
58
61
|
*
|
|
59
62
|
* Required permissions:
|
|
60
63
|
*
|
|
@@ -64,7 +67,8 @@ export declare class Memberships extends APIResource {
|
|
|
64
67
|
*/
|
|
65
68
|
resume(id: string, options?: RequestOptions): APIPromise<Shared.Membership>;
|
|
66
69
|
/**
|
|
67
|
-
*
|
|
70
|
+
* Reverse a pending cancellation for a membership that was scheduled to cancel at
|
|
71
|
+
* period end.
|
|
68
72
|
*
|
|
69
73
|
* Required permissions:
|
|
70
74
|
*
|
|
@@ -90,8 +94,8 @@ export interface MembershipListResponse {
|
|
|
90
94
|
*/
|
|
91
95
|
id: string;
|
|
92
96
|
/**
|
|
93
|
-
* Whether this
|
|
94
|
-
* cycle. Only applies
|
|
97
|
+
* Whether this membership is set to cancel at the end of the current billing
|
|
98
|
+
* cycle. Only applies to memberships with a recurring plan.
|
|
95
99
|
*/
|
|
96
100
|
cancel_at_period_end: boolean;
|
|
97
101
|
/**
|
|
@@ -100,15 +104,17 @@ export interface MembershipListResponse {
|
|
|
100
104
|
*/
|
|
101
105
|
cancel_option: CancelOptions | null;
|
|
102
106
|
/**
|
|
103
|
-
* The
|
|
107
|
+
* The time the customer initiated cancellation of this membership. As a Unix
|
|
108
|
+
* timestamp. Null if the membership has not been canceled.
|
|
104
109
|
*/
|
|
105
110
|
canceled_at: string | null;
|
|
106
111
|
/**
|
|
107
|
-
*
|
|
112
|
+
* Free-text explanation provided by the customer when canceling. Null if the
|
|
113
|
+
* customer did not provide a reason.
|
|
108
114
|
*/
|
|
109
115
|
cancellation_reason: string | null;
|
|
110
116
|
/**
|
|
111
|
-
* The
|
|
117
|
+
* The company this membership belongs to.
|
|
112
118
|
*/
|
|
113
119
|
company: MembershipListResponse.Company;
|
|
114
120
|
/**
|
|
@@ -120,20 +126,23 @@ export interface MembershipListResponse {
|
|
|
120
126
|
*/
|
|
121
127
|
currency: Shared.Currency | null;
|
|
122
128
|
/**
|
|
123
|
-
*
|
|
129
|
+
* The time the user first joined the company associated with this membership. As a
|
|
130
|
+
* Unix timestamp. Null if the member record does not exist.
|
|
124
131
|
*/
|
|
125
132
|
joined_at: string | null;
|
|
126
133
|
/**
|
|
127
|
-
* The license key
|
|
128
|
-
*
|
|
134
|
+
* The software license key associated with this membership. Only present if the
|
|
135
|
+
* product includes a Whop Software Licensing experience. Null otherwise.
|
|
129
136
|
*/
|
|
130
137
|
license_key: string | null;
|
|
131
138
|
/**
|
|
132
|
-
* The URL
|
|
139
|
+
* The URL where the customer can view and manage this membership, including
|
|
140
|
+
* cancellation and plan changes. Null if no member record exists.
|
|
133
141
|
*/
|
|
134
142
|
manage_url: string | null;
|
|
135
143
|
/**
|
|
136
|
-
* The
|
|
144
|
+
* The member record linking the user to the company for this membership. Null if
|
|
145
|
+
* the member record has not been created yet.
|
|
137
146
|
*/
|
|
138
147
|
member: MembershipListResponse.Member | null;
|
|
139
148
|
/**
|
|
@@ -144,33 +153,36 @@ export interface MembershipListResponse {
|
|
|
144
153
|
[key: string]: unknown;
|
|
145
154
|
};
|
|
146
155
|
/**
|
|
147
|
-
* Whether
|
|
156
|
+
* Whether recurring payment collection for this membership is temporarily paused
|
|
157
|
+
* by the company.
|
|
148
158
|
*/
|
|
149
159
|
payment_collection_paused: boolean;
|
|
150
160
|
/**
|
|
151
|
-
* The
|
|
161
|
+
* The plan the customer purchased to create this membership.
|
|
152
162
|
*/
|
|
153
163
|
plan: MembershipListResponse.Plan;
|
|
154
164
|
/**
|
|
155
|
-
* The
|
|
165
|
+
* The product this membership grants access to.
|
|
156
166
|
*/
|
|
157
167
|
product: MembershipListResponse.Product;
|
|
158
168
|
/**
|
|
159
|
-
* The
|
|
169
|
+
* The promotional code currently applied to this membership's billing. Null if no
|
|
170
|
+
* promo code is active.
|
|
160
171
|
*/
|
|
161
172
|
promo_code: MembershipListResponse.PromoCode | null;
|
|
162
173
|
/**
|
|
163
|
-
* The
|
|
164
|
-
*
|
|
174
|
+
* The end of the current billing period for this recurring membership. As a Unix
|
|
175
|
+
* timestamp. Null if the membership is not recurring.
|
|
165
176
|
*/
|
|
166
177
|
renewal_period_end: string | null;
|
|
167
178
|
/**
|
|
168
|
-
* The
|
|
169
|
-
*
|
|
179
|
+
* The start of the current billing period for this recurring membership. As a Unix
|
|
180
|
+
* timestamp. Null if the membership is not recurring.
|
|
170
181
|
*/
|
|
171
182
|
renewal_period_start: string | null;
|
|
172
183
|
/**
|
|
173
|
-
* The status of the membership.
|
|
184
|
+
* The current lifecycle status of the membership (e.g., active, trialing,
|
|
185
|
+
* past_due, canceled, expired, completed).
|
|
174
186
|
*/
|
|
175
187
|
status: Shared.MembershipStatus;
|
|
176
188
|
/**
|
|
@@ -178,13 +190,13 @@ export interface MembershipListResponse {
|
|
|
178
190
|
*/
|
|
179
191
|
updated_at: string;
|
|
180
192
|
/**
|
|
181
|
-
* The user this membership
|
|
193
|
+
* The user who owns this membership. Null if the user account has been deleted.
|
|
182
194
|
*/
|
|
183
195
|
user: MembershipListResponse.User | null;
|
|
184
196
|
}
|
|
185
197
|
export declare namespace MembershipListResponse {
|
|
186
198
|
/**
|
|
187
|
-
* The
|
|
199
|
+
* The company this membership belongs to.
|
|
188
200
|
*/
|
|
189
201
|
interface Company {
|
|
190
202
|
/**
|
|
@@ -192,12 +204,13 @@ export declare namespace MembershipListResponse {
|
|
|
192
204
|
*/
|
|
193
205
|
id: string;
|
|
194
206
|
/**
|
|
195
|
-
* The
|
|
207
|
+
* The display name of the company shown to customers.
|
|
196
208
|
*/
|
|
197
209
|
title: string;
|
|
198
210
|
}
|
|
199
211
|
/**
|
|
200
|
-
* The
|
|
212
|
+
* The member record linking the user to the company for this membership. Null if
|
|
213
|
+
* the member record has not been created yet.
|
|
201
214
|
*/
|
|
202
215
|
interface Member {
|
|
203
216
|
/**
|
|
@@ -206,7 +219,7 @@ export declare namespace MembershipListResponse {
|
|
|
206
219
|
id: string;
|
|
207
220
|
}
|
|
208
221
|
/**
|
|
209
|
-
* The
|
|
222
|
+
* The plan the customer purchased to create this membership.
|
|
210
223
|
*/
|
|
211
224
|
interface Plan {
|
|
212
225
|
/**
|
|
@@ -215,7 +228,7 @@ export declare namespace MembershipListResponse {
|
|
|
215
228
|
id: string;
|
|
216
229
|
}
|
|
217
230
|
/**
|
|
218
|
-
* The
|
|
231
|
+
* The product this membership grants access to.
|
|
219
232
|
*/
|
|
220
233
|
interface Product {
|
|
221
234
|
/**
|
|
@@ -223,12 +236,14 @@ export declare namespace MembershipListResponse {
|
|
|
223
236
|
*/
|
|
224
237
|
id: string;
|
|
225
238
|
/**
|
|
226
|
-
* The
|
|
239
|
+
* The display name of the product shown to customers on the product page and in
|
|
240
|
+
* search results.
|
|
227
241
|
*/
|
|
228
242
|
title: string;
|
|
229
243
|
}
|
|
230
244
|
/**
|
|
231
|
-
* The
|
|
245
|
+
* The promotional code currently applied to this membership's billing. Null if no
|
|
246
|
+
* promo code is active.
|
|
232
247
|
*/
|
|
233
248
|
interface PromoCode {
|
|
234
249
|
/**
|
|
@@ -237,7 +252,7 @@ export declare namespace MembershipListResponse {
|
|
|
237
252
|
id: string;
|
|
238
253
|
}
|
|
239
254
|
/**
|
|
240
|
-
* The user this membership
|
|
255
|
+
* The user who owns this membership. Null if the user account has been deleted.
|
|
241
256
|
*/
|
|
242
257
|
interface User {
|
|
243
258
|
/**
|
|
@@ -245,22 +260,24 @@ export declare namespace MembershipListResponse {
|
|
|
245
260
|
*/
|
|
246
261
|
id: string;
|
|
247
262
|
/**
|
|
248
|
-
* The email
|
|
263
|
+
* The user's email address. Requires the member:email:read permission to access.
|
|
264
|
+
* Null if not authorized.
|
|
249
265
|
*/
|
|
250
266
|
email: string | null;
|
|
251
267
|
/**
|
|
252
|
-
* The
|
|
268
|
+
* The user's display name shown on their public profile.
|
|
253
269
|
*/
|
|
254
270
|
name: string | null;
|
|
255
271
|
/**
|
|
256
|
-
* The
|
|
272
|
+
* The user's unique username shown on their public profile.
|
|
257
273
|
*/
|
|
258
274
|
username: string;
|
|
259
275
|
}
|
|
260
276
|
}
|
|
261
277
|
export interface MembershipUpdateParams {
|
|
262
278
|
/**
|
|
263
|
-
*
|
|
279
|
+
* A JSON object of key-value pairs to store on the membership. Replaces any
|
|
280
|
+
* existing metadata.
|
|
264
281
|
*/
|
|
265
282
|
metadata?: {
|
|
266
283
|
[key: string]: unknown;
|
|
@@ -272,19 +289,20 @@ export interface MembershipListParams extends CursorPageParams {
|
|
|
272
289
|
*/
|
|
273
290
|
before?: string | null;
|
|
274
291
|
/**
|
|
275
|
-
*
|
|
292
|
+
* Filter to only memberships matching these cancellation reasons.
|
|
276
293
|
*/
|
|
277
294
|
cancel_options?: Array<CancelOptions> | null;
|
|
278
295
|
/**
|
|
279
|
-
* The
|
|
296
|
+
* The unique identifier of the company to list memberships for. Required when
|
|
297
|
+
* using an API key.
|
|
280
298
|
*/
|
|
281
299
|
company_id?: string | null;
|
|
282
300
|
/**
|
|
283
|
-
*
|
|
301
|
+
* Only return memberships created after this timestamp.
|
|
284
302
|
*/
|
|
285
303
|
created_after?: string | null;
|
|
286
304
|
/**
|
|
287
|
-
*
|
|
305
|
+
* Only return memberships created before this timestamp.
|
|
288
306
|
*/
|
|
289
307
|
created_before?: string | null;
|
|
290
308
|
/**
|
|
@@ -304,23 +322,23 @@ export interface MembershipListParams extends CursorPageParams {
|
|
|
304
322
|
*/
|
|
305
323
|
order?: 'id' | 'created_at' | 'status' | 'canceled_at' | 'date_joined' | 'total_spend' | null;
|
|
306
324
|
/**
|
|
307
|
-
*
|
|
325
|
+
* Filter to only memberships belonging to these plan identifiers.
|
|
308
326
|
*/
|
|
309
327
|
plan_ids?: Array<string> | null;
|
|
310
328
|
/**
|
|
311
|
-
*
|
|
329
|
+
* Filter to only memberships belonging to these product identifiers.
|
|
312
330
|
*/
|
|
313
331
|
product_ids?: Array<string> | null;
|
|
314
332
|
/**
|
|
315
|
-
*
|
|
333
|
+
* Filter to only memberships that used these promo code identifiers.
|
|
316
334
|
*/
|
|
317
335
|
promo_code_ids?: Array<string> | null;
|
|
318
336
|
/**
|
|
319
|
-
*
|
|
337
|
+
* Filter to only memberships matching these statuses.
|
|
320
338
|
*/
|
|
321
339
|
statuses?: Array<Shared.MembershipStatus> | null;
|
|
322
340
|
/**
|
|
323
|
-
*
|
|
341
|
+
* Filter to only memberships belonging to these user identifiers.
|
|
324
342
|
*/
|
|
325
343
|
user_ids?: Array<string> | null;
|
|
326
344
|
}
|
|
@@ -332,8 +350,8 @@ export interface MembershipCancelParams {
|
|
|
332
350
|
}
|
|
333
351
|
export interface MembershipPauseParams {
|
|
334
352
|
/**
|
|
335
|
-
* Whether to void
|
|
336
|
-
* future
|
|
353
|
+
* Whether to void any outstanding past-due payments on this membership, preventing
|
|
354
|
+
* future collection attempts.
|
|
337
355
|
*/
|
|
338
356
|
void_payments?: boolean | null;
|
|
339
357
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"memberships.d.ts","sourceRoot":"","sources":["../src/resources/memberships.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI7E;;;;;;;;OAQG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAIhC
|
|
1
|
+
{"version":3,"file":"memberships.d.ts","sourceRoot":"","sources":["../src/resources/memberships.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI7E;;;;;;;;OAQG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAIhC;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,sBAAsB,CAAC;IAIzE;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAIhC;;;;;;;;;OASG;IACH,KAAK,CACH,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAIhC;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI3E;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;CAG9E;AAED,MAAM,MAAM,iCAAiC,GAAG,UAAU,CAAC,sBAAsB,CAAC,CAAC;AAEnF;;;GAGG;AACH,MAAM,MAAM,aAAa,GACrB,eAAe,GACf,WAAW,GACX,kBAAkB,GAClB,kBAAkB,GAClB,gBAAgB,GAChB,OAAO,GACP,SAAS,CAAC;AAEd;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAE9B;;;OAGG;IACH,aAAa,EAAE,aAAa,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,OAAO,EAAE,sBAAsB,CAAC,OAAO,CAAC;IAExC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,MAAM,EAAE,sBAAsB,CAAC,MAAM,GAAG,IAAI,CAAC;IAE7C;;;OAGG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAErC;;;OAGG;IACH,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAC;IAElC;;OAEG;IACH,OAAO,EAAE,sBAAsB,CAAC,OAAO,CAAC;IAExC;;;OAGG;IACH,UAAU,EAAE,sBAAsB,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpD;;;OAGG;IACH,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,gBAAgB,CAAC;IAEhC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC,IAAI,GAAG,IAAI,CAAC;CAC1C;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;;OAGG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;;OAGG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAC9C;AAED,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC;IAE7C;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;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,QAAQ,GAAG,aAAa,GAAG,aAAa,GAAG,aAAa,GAAG,IAAI,CAAC;IAE9F;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;IAEjD;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,iBAAiB,CAAC,EAAE,eAAe,GAAG,WAAW,GAAG,IAAI,CAAC;CAC1D;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
|
package/resources/memberships.js
CHANGED
|
@@ -7,7 +7,7 @@ const pagination_1 = require("../core/pagination.js");
|
|
|
7
7
|
const path_1 = require("../internal/utils/path.js");
|
|
8
8
|
class Memberships extends resource_1.APIResource {
|
|
9
9
|
/**
|
|
10
|
-
* Retrieves
|
|
10
|
+
* Retrieves the details of an existing membership.
|
|
11
11
|
*
|
|
12
12
|
* Required permissions:
|
|
13
13
|
*
|
|
@@ -18,7 +18,7 @@ class Memberships extends resource_1.APIResource {
|
|
|
18
18
|
return this._client.get((0, path_1.path) `/memberships/${id}`, options);
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
|
-
* Update a membership
|
|
21
|
+
* Update a membership's metadata or other mutable properties.
|
|
22
22
|
*
|
|
23
23
|
* Required permissions:
|
|
24
24
|
*
|
|
@@ -30,7 +30,8 @@ class Memberships extends resource_1.APIResource {
|
|
|
30
30
|
return this._client.patch((0, path_1.path) `/memberships/${id}`, { body, ...options });
|
|
31
31
|
}
|
|
32
32
|
/**
|
|
33
|
-
*
|
|
33
|
+
* Returns a paginated list of memberships, with optional filtering by product,
|
|
34
|
+
* plan, status, and user.
|
|
34
35
|
*
|
|
35
36
|
* Required permissions:
|
|
36
37
|
*
|
|
@@ -41,8 +42,8 @@ class Memberships extends resource_1.APIResource {
|
|
|
41
42
|
return this._client.getAPIList('/memberships', (pagination_1.CursorPage), { query, ...options });
|
|
42
43
|
}
|
|
43
44
|
/**
|
|
44
|
-
*
|
|
45
|
-
* period
|
|
45
|
+
* Cancel a membership either immediately or at the end of the current billing
|
|
46
|
+
* period. Immediate cancellation revokes access right away.
|
|
46
47
|
*
|
|
47
48
|
* Required permissions:
|
|
48
49
|
*
|
|
@@ -54,7 +55,8 @@ class Memberships extends resource_1.APIResource {
|
|
|
54
55
|
return this._client.post((0, path_1.path) `/memberships/${id}/cancel`, { body, ...options });
|
|
55
56
|
}
|
|
56
57
|
/**
|
|
57
|
-
*
|
|
58
|
+
* Pause a membership's recurring payments. The customer retains access but will
|
|
59
|
+
* not be charged until the membership is resumed.
|
|
58
60
|
*
|
|
59
61
|
* Required permissions:
|
|
60
62
|
*
|
|
@@ -66,7 +68,8 @@ class Memberships extends resource_1.APIResource {
|
|
|
66
68
|
return this._client.post((0, path_1.path) `/memberships/${id}/pause`, { body, ...options });
|
|
67
69
|
}
|
|
68
70
|
/**
|
|
69
|
-
*
|
|
71
|
+
* Resume a previously paused membership's recurring payments. Billing resumes on
|
|
72
|
+
* the next cycle.
|
|
70
73
|
*
|
|
71
74
|
* Required permissions:
|
|
72
75
|
*
|
|
@@ -78,7 +81,8 @@ class Memberships extends resource_1.APIResource {
|
|
|
78
81
|
return this._client.post((0, path_1.path) `/memberships/${id}/resume`, options);
|
|
79
82
|
}
|
|
80
83
|
/**
|
|
81
|
-
*
|
|
84
|
+
* Reverse a pending cancellation for a membership that was scheduled to cancel at
|
|
85
|
+
* period end.
|
|
82
86
|
*
|
|
83
87
|
* Required permissions:
|
|
84
88
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"memberships.js","sourceRoot":"","sources":["../src/resources/memberships.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CACJ,EAAU,EACV,OAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"memberships.js","sourceRoot":"","sources":["../src/resources/memberships.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CACJ,EAAU,EACV,OAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,uBAAkC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5G,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAU,EACV,OAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CACH,EAAU,EACV,OAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;CACF;AA7GD,kCA6GC"}
|
|
@@ -4,7 +4,7 @@ import { CursorPage } from "../core/pagination.mjs";
|
|
|
4
4
|
import { path } from "../internal/utils/path.mjs";
|
|
5
5
|
export class Memberships extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
* Retrieves
|
|
7
|
+
* Retrieves the details of an existing membership.
|
|
8
8
|
*
|
|
9
9
|
* Required permissions:
|
|
10
10
|
*
|
|
@@ -15,7 +15,7 @@ export class Memberships extends APIResource {
|
|
|
15
15
|
return this._client.get(path `/memberships/${id}`, options);
|
|
16
16
|
}
|
|
17
17
|
/**
|
|
18
|
-
* Update a membership
|
|
18
|
+
* Update a membership's metadata or other mutable properties.
|
|
19
19
|
*
|
|
20
20
|
* Required permissions:
|
|
21
21
|
*
|
|
@@ -27,7 +27,8 @@ export class Memberships extends APIResource {
|
|
|
27
27
|
return this._client.patch(path `/memberships/${id}`, { body, ...options });
|
|
28
28
|
}
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* Returns a paginated list of memberships, with optional filtering by product,
|
|
31
|
+
* plan, status, and user.
|
|
31
32
|
*
|
|
32
33
|
* Required permissions:
|
|
33
34
|
*
|
|
@@ -38,8 +39,8 @@ export class Memberships extends APIResource {
|
|
|
38
39
|
return this._client.getAPIList('/memberships', (CursorPage), { query, ...options });
|
|
39
40
|
}
|
|
40
41
|
/**
|
|
41
|
-
*
|
|
42
|
-
* period
|
|
42
|
+
* Cancel a membership either immediately or at the end of the current billing
|
|
43
|
+
* period. Immediate cancellation revokes access right away.
|
|
43
44
|
*
|
|
44
45
|
* Required permissions:
|
|
45
46
|
*
|
|
@@ -51,7 +52,8 @@ export class Memberships extends APIResource {
|
|
|
51
52
|
return this._client.post(path `/memberships/${id}/cancel`, { body, ...options });
|
|
52
53
|
}
|
|
53
54
|
/**
|
|
54
|
-
*
|
|
55
|
+
* Pause a membership's recurring payments. The customer retains access but will
|
|
56
|
+
* not be charged until the membership is resumed.
|
|
55
57
|
*
|
|
56
58
|
* Required permissions:
|
|
57
59
|
*
|
|
@@ -63,7 +65,8 @@ export class Memberships extends APIResource {
|
|
|
63
65
|
return this._client.post(path `/memberships/${id}/pause`, { body, ...options });
|
|
64
66
|
}
|
|
65
67
|
/**
|
|
66
|
-
*
|
|
68
|
+
* Resume a previously paused membership's recurring payments. Billing resumes on
|
|
69
|
+
* the next cycle.
|
|
67
70
|
*
|
|
68
71
|
* Required permissions:
|
|
69
72
|
*
|
|
@@ -75,7 +78,8 @@ export class Memberships extends APIResource {
|
|
|
75
78
|
return this._client.post(path `/memberships/${id}/resume`, options);
|
|
76
79
|
}
|
|
77
80
|
/**
|
|
78
|
-
*
|
|
81
|
+
* Reverse a pending cancellation for a membership that was scheduled to cancel at
|
|
82
|
+
* period end.
|
|
79
83
|
*
|
|
80
84
|
* Required permissions:
|
|
81
85
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"memberships.mjs","sourceRoot":"","sources":["../src/resources/memberships.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CACJ,EAAU,EACV,OAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"memberships.mjs","sourceRoot":"","sources":["../src/resources/memberships.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CACJ,EAAU,EACV,OAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,UAAkC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5G,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAU,EACV,OAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CACH,EAAU,EACV,OAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;CACF"}
|