@whop/sdk 0.0.38 → 0.0.40
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 +39 -0
- package/client.d.mts +88 -40
- package/client.d.mts.map +1 -1
- package/client.d.ts +88 -40
- package/client.d.ts.map +1 -1
- package/client.js +59 -0
- package/client.js.map +1 -1
- package/client.mjs +59 -0
- package/client.mjs.map +1 -1
- package/internal/types.d.mts +6 -6
- package/internal/types.d.mts.map +1 -1
- package/internal/types.d.ts +6 -6
- package/internal/types.d.ts.map +1 -1
- package/internal/utils/log.d.mts.map +1 -1
- package/internal/utils/log.d.ts.map +1 -1
- package/internal/utils/log.js +2 -0
- package/internal/utils/log.js.map +1 -1
- package/internal/utils/log.mjs +2 -0
- package/internal/utils/log.mjs.map +1 -1
- package/package.json +15 -9
- package/resources/accounts.d.mts +244 -0
- package/resources/accounts.d.mts.map +1 -0
- package/resources/accounts.d.ts +244 -0
- package/resources/accounts.d.ts.map +1 -0
- package/resources/accounts.js +46 -0
- package/resources/accounts.js.map +1 -0
- package/resources/accounts.mjs +42 -0
- package/resources/accounts.mjs.map +1 -0
- package/resources/ad-campaigns.d.mts +296 -0
- package/resources/ad-campaigns.d.mts.map +1 -0
- package/resources/ad-campaigns.d.ts +296 -0
- package/resources/ad-campaigns.d.ts.map +1 -0
- package/resources/ad-campaigns.js +104 -0
- package/resources/ad-campaigns.js.map +1 -0
- package/resources/ad-campaigns.mjs +100 -0
- package/resources/ad-campaigns.mjs.map +1 -0
- package/resources/ad-groups.d.mts +1461 -0
- package/resources/ad-groups.d.mts.map +1 -0
- package/resources/ad-groups.d.ts +1461 -0
- package/resources/ad-groups.d.ts.map +1 -0
- package/resources/ad-groups.js +121 -0
- package/resources/ad-groups.js.map +1 -0
- package/resources/ad-groups.mjs +117 -0
- package/resources/ad-groups.mjs.map +1 -0
- package/resources/ad-reports.d.mts +379 -0
- package/resources/ad-reports.d.mts.map +1 -0
- package/resources/ad-reports.d.ts +379 -0
- package/resources/ad-reports.d.ts.map +1 -0
- package/resources/ad-reports.js +26 -0
- package/resources/ad-reports.js.map +1 -0
- package/resources/ad-reports.mjs +22 -0
- package/resources/ad-reports.mjs.map +1 -0
- package/resources/ads.d.mts +234 -0
- package/resources/ads.d.mts.map +1 -0
- package/resources/ads.d.ts +234 -0
- package/resources/ads.d.ts.map +1 -0
- package/resources/ads.js +56 -0
- package/resources/ads.js.map +1 -0
- package/resources/ads.mjs +52 -0
- package/resources/ads.mjs.map +1 -0
- package/resources/affiliates/affiliates.d.mts +31 -31
- package/resources/affiliates/affiliates.d.mts.map +1 -1
- package/resources/affiliates/affiliates.d.ts +31 -31
- package/resources/affiliates/affiliates.d.ts.map +1 -1
- package/resources/affiliates/affiliates.js +21 -21
- package/resources/affiliates/affiliates.js.map +1 -1
- package/resources/affiliates/affiliates.mjs +21 -21
- package/resources/affiliates/affiliates.mjs.map +1 -1
- package/resources/affiliates/index.d.mts +2 -2
- package/resources/affiliates/index.d.mts.map +1 -1
- package/resources/affiliates/index.d.ts +2 -2
- package/resources/affiliates/index.d.ts.map +1 -1
- package/resources/affiliates/overrides.d.mts +37 -37
- package/resources/affiliates/overrides.d.mts.map +1 -1
- package/resources/affiliates/overrides.d.ts +37 -37
- package/resources/affiliates/overrides.d.ts.map +1 -1
- package/resources/affiliates/overrides.js +23 -23
- package/resources/affiliates/overrides.js.map +1 -1
- package/resources/affiliates/overrides.mjs +23 -23
- package/resources/affiliates/overrides.mjs.map +1 -1
- package/resources/ai-chats.d.mts +23 -23
- package/resources/ai-chats.d.mts.map +1 -1
- package/resources/ai-chats.d.ts +23 -23
- package/resources/ai-chats.d.ts.map +1 -1
- package/resources/ai-chats.js +6 -6
- package/resources/ai-chats.js.map +1 -1
- package/resources/ai-chats.mjs +6 -6
- package/resources/ai-chats.mjs.map +1 -1
- package/resources/app-builds.d.mts +54 -54
- package/resources/app-builds.d.mts.map +1 -1
- package/resources/app-builds.d.ts +54 -54
- package/resources/app-builds.d.ts.map +1 -1
- package/resources/app-builds.js +21 -21
- package/resources/app-builds.js.map +1 -1
- package/resources/app-builds.mjs +21 -21
- package/resources/app-builds.mjs.map +1 -1
- package/resources/apps.d.mts +57 -57
- package/resources/apps.d.mts.map +1 -1
- package/resources/apps.d.ts +57 -57
- package/resources/apps.d.ts.map +1 -1
- package/resources/apps.js +15 -15
- package/resources/apps.js.map +1 -1
- package/resources/apps.mjs +15 -15
- package/resources/apps.mjs.map +1 -1
- package/resources/authorized-users.d.mts +36 -36
- package/resources/authorized-users.d.mts.map +1 -1
- package/resources/authorized-users.d.ts +36 -36
- package/resources/authorized-users.d.ts.map +1 -1
- package/resources/authorized-users.js +21 -21
- package/resources/authorized-users.js.map +1 -1
- package/resources/authorized-users.mjs +21 -21
- package/resources/authorized-users.mjs.map +1 -1
- package/resources/bounties.d.mts +281 -0
- package/resources/bounties.d.mts.map +1 -0
- package/resources/bounties.d.ts +281 -0
- package/resources/bounties.d.ts.map +1 -0
- package/resources/bounties.js +63 -0
- package/resources/bounties.js.map +1 -0
- package/resources/bounties.mjs +59 -0
- package/resources/bounties.mjs.map +1 -0
- package/resources/chat-channels.d.mts +43 -43
- package/resources/chat-channels.d.mts.map +1 -1
- package/resources/chat-channels.d.ts +43 -43
- package/resources/chat-channels.d.ts.map +1 -1
- package/resources/chat-channels.js +24 -24
- package/resources/chat-channels.js.map +1 -1
- package/resources/chat-channels.mjs +24 -24
- package/resources/chat-channels.mjs.map +1 -1
- package/resources/checkout-configurations.d.mts +77 -49
- package/resources/checkout-configurations.d.mts.map +1 -1
- package/resources/checkout-configurations.d.ts +77 -49
- package/resources/checkout-configurations.d.ts.map +1 -1
- package/resources/checkout-configurations.js +11 -11
- package/resources/checkout-configurations.js.map +1 -1
- package/resources/checkout-configurations.mjs +11 -11
- package/resources/checkout-configurations.mjs.map +1 -1
- package/resources/companies.d.mts +98 -35
- package/resources/companies.d.mts.map +1 -1
- package/resources/companies.d.ts +98 -35
- package/resources/companies.d.ts.map +1 -1
- package/resources/companies.js +24 -17
- package/resources/companies.js.map +1 -1
- package/resources/companies.mjs +24 -17
- package/resources/companies.mjs.map +1 -1
- package/resources/company-token-transactions.d.mts +39 -39
- package/resources/company-token-transactions.d.mts.map +1 -1
- package/resources/company-token-transactions.d.ts +39 -39
- package/resources/company-token-transactions.d.ts.map +1 -1
- package/resources/company-token-transactions.js +14 -14
- package/resources/company-token-transactions.js.map +1 -1
- package/resources/company-token-transactions.mjs +14 -14
- package/resources/company-token-transactions.mjs.map +1 -1
- package/resources/conversions.d.mts +248 -0
- package/resources/conversions.d.mts.map +1 -0
- package/resources/conversions.d.ts +248 -0
- package/resources/conversions.d.ts.map +1 -0
- package/resources/conversions.js +30 -0
- package/resources/conversions.js.map +1 -0
- package/resources/conversions.mjs +26 -0
- package/resources/conversions.mjs.map +1 -0
- package/resources/course-chapters.d.mts +36 -36
- package/resources/course-chapters.d.mts.map +1 -1
- package/resources/course-chapters.d.ts +36 -36
- package/resources/course-chapters.d.ts.map +1 -1
- package/resources/course-chapters.js +23 -23
- package/resources/course-chapters.js.map +1 -1
- package/resources/course-chapters.mjs +23 -23
- package/resources/course-chapters.mjs.map +1 -1
- package/resources/course-lesson-interactions.d.mts +5 -5
- package/resources/course-lesson-interactions.d.mts.map +1 -1
- package/resources/course-lesson-interactions.d.ts +5 -5
- package/resources/course-lesson-interactions.d.ts.map +1 -1
- package/resources/course-lesson-interactions.js +7 -7
- package/resources/course-lesson-interactions.js.map +1 -1
- package/resources/course-lesson-interactions.mjs +7 -7
- package/resources/course-lesson-interactions.mjs.map +1 -1
- package/resources/course-lessons.d.mts +40 -40
- package/resources/course-lessons.d.mts.map +1 -1
- package/resources/course-lessons.d.ts +40 -40
- package/resources/course-lessons.d.ts.map +1 -1
- package/resources/course-lessons.js +22 -22
- package/resources/course-lessons.js.map +1 -1
- package/resources/course-lessons.mjs +22 -22
- package/resources/course-lessons.mjs.map +1 -1
- package/resources/course-students.d.mts +5 -5
- package/resources/course-students.d.mts.map +1 -1
- package/resources/course-students.d.ts +5 -5
- package/resources/course-students.d.ts.map +1 -1
- package/resources/course-students.js +10 -10
- package/resources/course-students.js.map +1 -1
- package/resources/course-students.mjs +10 -10
- package/resources/course-students.mjs.map +1 -1
- package/resources/courses.d.mts +40 -40
- package/resources/courses.d.mts.map +1 -1
- package/resources/courses.d.ts +40 -40
- package/resources/courses.d.ts.map +1 -1
- package/resources/courses.js +19 -19
- package/resources/courses.js.map +1 -1
- package/resources/courses.mjs +19 -19
- package/resources/courses.mjs.map +1 -1
- package/resources/deposits.d.mts +64 -0
- package/resources/deposits.d.mts.map +1 -0
- package/resources/deposits.d.ts +64 -0
- package/resources/deposits.d.ts.map +1 -0
- package/resources/deposits.js +16 -0
- package/resources/deposits.js.map +1 -0
- package/resources/deposits.mjs +12 -0
- package/resources/deposits.mjs.map +1 -0
- package/resources/dispute-alerts.d.mts +10 -10
- package/resources/dispute-alerts.d.mts.map +1 -1
- package/resources/dispute-alerts.d.ts +10 -10
- package/resources/dispute-alerts.d.ts.map +1 -1
- package/resources/dispute-alerts.js +13 -13
- package/resources/dispute-alerts.js.map +1 -1
- package/resources/dispute-alerts.mjs +13 -13
- package/resources/dispute-alerts.mjs.map +1 -1
- package/resources/disputes.d.mts +13 -15
- package/resources/disputes.d.mts.map +1 -1
- package/resources/disputes.d.ts +13 -15
- package/resources/disputes.d.ts.map +1 -1
- package/resources/disputes.js +11 -11
- package/resources/disputes.js.map +1 -1
- package/resources/disputes.mjs +11 -11
- package/resources/disputes.mjs.map +1 -1
- package/resources/dm-channels.d.mts +37 -37
- package/resources/dm-channels.d.mts.map +1 -1
- package/resources/dm-channels.d.ts +37 -37
- package/resources/dm-channels.d.ts.map +1 -1
- package/resources/dm-channels.js +19 -19
- package/resources/dm-channels.js.map +1 -1
- package/resources/dm-channels.mjs +19 -19
- package/resources/dm-channels.mjs.map +1 -1
- package/resources/dm-members.d.mts +38 -38
- package/resources/dm-members.d.mts.map +1 -1
- package/resources/dm-members.d.ts +38 -38
- package/resources/dm-members.d.ts.map +1 -1
- package/resources/dm-members.js +21 -21
- package/resources/dm-members.js.map +1 -1
- package/resources/dm-members.mjs +21 -21
- package/resources/dm-members.mjs.map +1 -1
- package/resources/entries.d.mts +5 -5
- package/resources/entries.d.mts.map +1 -1
- package/resources/entries.d.ts +5 -5
- package/resources/entries.d.ts.map +1 -1
- package/resources/entries.js +7 -7
- package/resources/entries.js.map +1 -1
- package/resources/entries.mjs +7 -7
- package/resources/entries.mjs.map +1 -1
- package/resources/experiences.d.mts +50 -50
- package/resources/experiences.d.mts.map +1 -1
- package/resources/experiences.d.ts +50 -50
- package/resources/experiences.d.ts.map +1 -1
- package/resources/experiences.js +17 -17
- package/resources/experiences.js.map +1 -1
- package/resources/experiences.mjs +17 -17
- package/resources/experiences.mjs.map +1 -1
- package/resources/fee-markups.d.mts +36 -36
- package/resources/fee-markups.d.mts.map +1 -1
- package/resources/fee-markups.d.ts +36 -36
- package/resources/fee-markups.d.ts.map +1 -1
- package/resources/fee-markups.js +18 -18
- package/resources/fee-markups.js.map +1 -1
- package/resources/fee-markups.mjs +18 -18
- package/resources/fee-markups.mjs.map +1 -1
- package/resources/files.d.mts +18 -1
- package/resources/files.d.mts.map +1 -1
- package/resources/files.d.ts +18 -1
- package/resources/files.d.ts.map +1 -1
- package/resources/forum-posts.d.mts +52 -48
- package/resources/forum-posts.d.mts.map +1 -1
- package/resources/forum-posts.d.ts +52 -48
- package/resources/forum-posts.d.ts.map +1 -1
- package/resources/forum-posts.js +21 -21
- package/resources/forum-posts.js.map +1 -1
- package/resources/forum-posts.mjs +21 -21
- package/resources/forum-posts.mjs.map +1 -1
- package/resources/forums.d.mts +33 -33
- package/resources/forums.d.mts.map +1 -1
- package/resources/forums.d.ts +33 -33
- package/resources/forums.d.ts.map +1 -1
- package/resources/forums.js +11 -11
- package/resources/forums.js.map +1 -1
- package/resources/forums.mjs +11 -11
- package/resources/forums.mjs.map +1 -1
- package/resources/index.d.mts +45 -35
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +45 -35
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +22 -2
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +10 -0
- package/resources/index.mjs.map +1 -1
- package/resources/invoices.d.mts +89 -84
- package/resources/invoices.d.mts.map +1 -1
- package/resources/invoices.d.ts +89 -84
- package/resources/invoices.d.ts.map +1 -1
- package/resources/invoices.js +40 -40
- package/resources/invoices.js.map +1 -1
- package/resources/invoices.mjs +40 -40
- package/resources/invoices.mjs.map +1 -1
- package/resources/leads.d.mts +53 -53
- package/resources/leads.d.mts.map +1 -1
- package/resources/leads.d.ts +53 -53
- package/resources/leads.d.ts.map +1 -1
- package/resources/leads.js +24 -24
- package/resources/leads.js.map +1 -1
- package/resources/leads.mjs +24 -24
- package/resources/leads.mjs.map +1 -1
- package/resources/ledger-accounts.d.mts +34 -1
- package/resources/ledger-accounts.d.mts.map +1 -1
- package/resources/ledger-accounts.d.ts +34 -1
- package/resources/ledger-accounts.d.ts.map +1 -1
- package/resources/members.d.mts +9 -7
- package/resources/members.d.mts.map +1 -1
- package/resources/members.d.ts +9 -7
- package/resources/members.d.ts.map +1 -1
- package/resources/members.js +7 -7
- package/resources/members.js.map +1 -1
- package/resources/members.mjs +7 -7
- package/resources/members.mjs.map +1 -1
- package/resources/memberships.d.mts +67 -47
- package/resources/memberships.d.mts.map +1 -1
- package/resources/memberships.d.ts +67 -47
- package/resources/memberships.d.ts.map +1 -1
- package/resources/memberships.js +38 -38
- package/resources/memberships.js.map +1 -1
- package/resources/memberships.mjs +38 -38
- package/resources/memberships.mjs.map +1 -1
- package/resources/messages.d.mts +36 -36
- package/resources/messages.d.mts.map +1 -1
- package/resources/messages.d.ts +36 -36
- package/resources/messages.d.ts.map +1 -1
- package/resources/messages.js +16 -16
- package/resources/messages.js.map +1 -1
- package/resources/messages.mjs +16 -16
- package/resources/messages.mjs.map +1 -1
- package/resources/payment-methods.d.mts +20 -20
- package/resources/payment-methods.d.mts.map +1 -1
- package/resources/payment-methods.d.ts +20 -20
- package/resources/payment-methods.d.ts.map +1 -1
- package/resources/payment-methods.js +10 -10
- package/resources/payment-methods.js.map +1 -1
- package/resources/payment-methods.mjs +10 -10
- package/resources/payment-methods.mjs.map +1 -1
- package/resources/payments.d.mts +177 -145
- package/resources/payments.d.mts.map +1 -1
- package/resources/payments.d.ts +177 -145
- package/resources/payments.d.ts.map +1 -1
- package/resources/payments.js +68 -68
- package/resources/payments.js.map +1 -1
- package/resources/payments.mjs +68 -68
- package/resources/payments.mjs.map +1 -1
- package/resources/payout-accounts.d.mts +1 -1
- package/resources/payout-accounts.d.ts +1 -1
- package/resources/payout-methods.d.mts +5 -5
- package/resources/payout-methods.d.mts.map +1 -1
- package/resources/payout-methods.d.ts +5 -5
- package/resources/payout-methods.d.ts.map +1 -1
- package/resources/payout-methods.js +10 -10
- package/resources/payout-methods.js.map +1 -1
- package/resources/payout-methods.mjs +10 -10
- package/resources/payout-methods.mjs.map +1 -1
- package/resources/plans.d.mts +130 -72
- package/resources/plans.d.mts.map +1 -1
- package/resources/plans.d.ts +130 -72
- package/resources/plans.d.ts.map +1 -1
- package/resources/plans.js +21 -21
- package/resources/plans.js.map +1 -1
- package/resources/plans.mjs +21 -21
- package/resources/plans.mjs.map +1 -1
- package/resources/products.d.mts +81 -65
- package/resources/products.d.mts.map +1 -1
- package/resources/products.d.ts +81 -65
- package/resources/products.d.ts.map +1 -1
- package/resources/products.js +25 -25
- package/resources/products.js.map +1 -1
- package/resources/products.mjs +25 -25
- package/resources/products.mjs.map +1 -1
- package/resources/promo-codes.d.mts +59 -59
- package/resources/promo-codes.d.mts.map +1 -1
- package/resources/promo-codes.d.ts +59 -59
- package/resources/promo-codes.d.ts.map +1 -1
- package/resources/promo-codes.js +22 -22
- package/resources/promo-codes.js.map +1 -1
- package/resources/promo-codes.mjs +22 -22
- package/resources/promo-codes.mjs.map +1 -1
- package/resources/reactions.d.mts +25 -25
- package/resources/reactions.d.mts.map +1 -1
- package/resources/reactions.d.ts +25 -25
- package/resources/reactions.d.ts.map +1 -1
- package/resources/reactions.js +11 -11
- package/resources/reactions.js.map +1 -1
- package/resources/reactions.mjs +11 -11
- package/resources/reactions.mjs.map +1 -1
- package/resources/refunds.d.mts +59 -10
- package/resources/refunds.d.mts.map +1 -1
- package/resources/refunds.d.ts +59 -10
- package/resources/refunds.d.ts.map +1 -1
- package/resources/refunds.js +12 -10
- package/resources/refunds.js.map +1 -1
- package/resources/refunds.mjs +12 -10
- package/resources/refunds.mjs.map +1 -1
- package/resources/resolution-center-cases.d.mts +6 -6
- package/resources/resolution-center-cases.d.mts.map +1 -1
- package/resources/resolution-center-cases.d.ts +6 -6
- package/resources/resolution-center-cases.d.ts.map +1 -1
- package/resources/resolution-center-cases.js +10 -10
- package/resources/resolution-center-cases.js.map +1 -1
- package/resources/resolution-center-cases.mjs +10 -10
- package/resources/resolution-center-cases.mjs.map +1 -1
- package/resources/reviews.d.mts +4 -4
- package/resources/reviews.d.mts.map +1 -1
- package/resources/reviews.d.ts +4 -4
- package/resources/reviews.d.ts.map +1 -1
- package/resources/reviews.js +6 -6
- package/resources/reviews.js.map +1 -1
- package/resources/reviews.mjs +6 -6
- package/resources/reviews.mjs.map +1 -1
- package/resources/setup-intents.d.mts +6 -6
- package/resources/setup-intents.d.mts.map +1 -1
- package/resources/setup-intents.d.ts +6 -6
- package/resources/setup-intents.d.ts.map +1 -1
- package/resources/setup-intents.js +11 -11
- package/resources/setup-intents.js.map +1 -1
- package/resources/setup-intents.mjs +11 -11
- package/resources/setup-intents.mjs.map +1 -1
- package/resources/shared.d.mts +100 -6
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +100 -6
- package/resources/shared.d.ts.map +1 -1
- package/resources/shipments.d.mts +35 -35
- package/resources/shipments.d.mts.map +1 -1
- package/resources/shipments.d.ts +35 -35
- package/resources/shipments.d.ts.map +1 -1
- package/resources/shipments.js +20 -20
- package/resources/shipments.js.map +1 -1
- package/resources/shipments.mjs +20 -20
- package/resources/shipments.mjs.map +1 -1
- package/resources/support-channels.d.mts +42 -38
- package/resources/support-channels.d.mts.map +1 -1
- package/resources/support-channels.d.ts +42 -38
- package/resources/support-channels.d.ts.map +1 -1
- package/resources/support-channels.js +21 -23
- package/resources/support-channels.js.map +1 -1
- package/resources/support-channels.mjs +21 -23
- package/resources/support-channels.mjs.map +1 -1
- package/resources/swaps.d.mts +62 -0
- package/resources/swaps.d.mts.map +1 -0
- package/resources/swaps.d.ts +62 -0
- package/resources/swaps.d.ts.map +1 -0
- package/resources/swaps.js +15 -0
- package/resources/swaps.js.map +1 -0
- package/resources/swaps.mjs +11 -0
- package/resources/swaps.mjs.map +1 -0
- package/resources/transfers.d.mts +57 -55
- package/resources/transfers.d.mts.map +1 -1
- package/resources/transfers.d.ts +57 -55
- package/resources/transfers.d.ts.map +1 -1
- package/resources/transfers.js +19 -19
- package/resources/transfers.js.map +1 -1
- package/resources/transfers.mjs +19 -19
- package/resources/transfers.mjs.map +1 -1
- package/resources/users.d.mts +20 -20
- package/resources/users.d.mts.map +1 -1
- package/resources/users.d.ts +20 -20
- package/resources/users.d.ts.map +1 -1
- package/resources/users.js +16 -16
- package/resources/users.js.map +1 -1
- package/resources/users.mjs +16 -16
- package/resources/users.mjs.map +1 -1
- package/resources/verifications.d.mts +2 -2
- package/resources/verifications.d.ts +2 -2
- package/resources/wallets.d.mts +89 -0
- package/resources/wallets.d.mts.map +1 -0
- package/resources/wallets.d.ts +89 -0
- package/resources/wallets.d.ts.map +1 -0
- package/resources/wallets.js +28 -0
- package/resources/wallets.js.map +1 -0
- package/resources/wallets.mjs +24 -0
- package/resources/wallets.mjs.map +1 -0
- package/resources/webhooks.d.mts +2182 -1196
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +2182 -1196
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/webhooks.js +31 -31
- package/resources/webhooks.js.map +1 -1
- package/resources/webhooks.mjs +31 -31
- package/resources/webhooks.mjs.map +1 -1
- package/resources/withdrawals.d.mts +47 -47
- package/resources/withdrawals.d.mts.map +1 -1
- package/resources/withdrawals.d.ts +47 -47
- package/resources/withdrawals.d.ts.map +1 -1
- package/resources/withdrawals.js +21 -21
- package/resources/withdrawals.js.map +1 -1
- package/resources/withdrawals.mjs +21 -21
- package/resources/withdrawals.mjs.map +1 -1
- package/src/client.ts +277 -60
- package/src/internal/types.ts +6 -8
- package/src/internal/utils/log.ts +2 -0
- package/src/resources/accounts.ts +318 -0
- package/src/resources/ad-campaigns.ts +376 -0
- package/src/resources/ad-groups.ts +1958 -0
- package/src/resources/ad-reports.ts +484 -0
- package/src/resources/ads.ts +295 -0
- package/src/resources/affiliates/affiliates.ts +39 -39
- package/src/resources/affiliates/index.ts +2 -2
- package/src/resources/affiliates/overrides.ts +51 -51
- package/src/resources/ai-chats.ts +33 -33
- package/src/resources/app-builds.ts +68 -68
- package/src/resources/apps.ts +86 -86
- package/src/resources/authorized-users.ts +48 -48
- package/src/resources/bounties.ts +353 -0
- package/src/resources/chat-channels.ts +57 -57
- package/src/resources/checkout-configurations.ts +101 -67
- package/src/resources/companies.ts +123 -41
- package/src/resources/company-token-transactions.ts +55 -55
- package/src/resources/conversions.ts +316 -0
- package/src/resources/course-chapters.ts +47 -47
- package/src/resources/course-lesson-interactions.ts +12 -12
- package/src/resources/course-lessons.ts +54 -54
- package/src/resources/course-students.ts +12 -12
- package/src/resources/courses.ts +51 -51
- package/src/resources/deposits.ts +87 -0
- package/src/resources/dispute-alerts.ts +18 -18
- package/src/resources/disputes.ts +18 -20
- package/src/resources/dm-channels.ts +45 -45
- package/src/resources/dm-members.ts +45 -45
- package/src/resources/entries.ts +10 -10
- package/src/resources/experiences.ts +64 -64
- package/src/resources/fee-markups.ts +44 -44
- package/src/resources/files.ts +22 -0
- package/src/resources/forum-posts.ts +65 -60
- package/src/resources/forums.ts +44 -44
- package/src/resources/index.ts +129 -57
- package/src/resources/invoices.ts +116 -110
- package/src/resources/leads.ts +64 -64
- package/src/resources/ledger-accounts.ts +41 -1
- package/src/resources/members.ts +14 -12
- package/src/resources/memberships.ts +80 -61
- package/src/resources/messages.ts +48 -48
- package/src/resources/payment-methods.ts +30 -30
- package/src/resources/payments.ts +229 -183
- package/src/resources/payout-accounts.ts +1 -1
- package/src/resources/payout-methods.ts +11 -11
- package/src/resources/plans.ts +153 -90
- package/src/resources/products.ts +98 -84
- package/src/resources/promo-codes.ts +74 -74
- package/src/resources/reactions.ts +33 -33
- package/src/resources/refunds.ts +65 -15
- package/src/resources/resolution-center-cases.ts +11 -12
- package/src/resources/reviews.ts +7 -7
- package/src/resources/setup-intents.ts +13 -13
- package/src/resources/shared.ts +107 -5
- package/src/resources/shipments.ts +44 -44
- package/src/resources/support-channels.ts +54 -49
- package/src/resources/swaps.ts +87 -0
- package/src/resources/transfers.ts +68 -66
- package/src/resources/users.ts +29 -29
- package/src/resources/verifications.ts +2 -2
- package/src/resources/wallets.ts +136 -0
- package/src/resources/webhooks.ts +2449 -1277
- package/src/resources/withdrawals.ts +55 -55
- 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/members.mjs
CHANGED
|
@@ -7,7 +7,8 @@ import { path } from "../internal/utils/path.mjs";
|
|
|
7
7
|
*/
|
|
8
8
|
export class Members extends APIResource {
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* Returns a paginated list of members for a company, with extensive filtering by
|
|
11
|
+
* product, plan, status, access level, and more.
|
|
11
12
|
*
|
|
12
13
|
* Required permissions:
|
|
13
14
|
*
|
|
@@ -15,12 +16,11 @@ export class Members extends APIResource {
|
|
|
15
16
|
* - `member:email:read`
|
|
16
17
|
* - `member:phone:read`
|
|
17
18
|
*/
|
|
18
|
-
|
|
19
|
-
return this._client.
|
|
19
|
+
list(query = {}, options) {
|
|
20
|
+
return this._client.getAPIList('/members', (CursorPage), { query, ...options });
|
|
20
21
|
}
|
|
21
22
|
/**
|
|
22
|
-
*
|
|
23
|
-
* product, plan, status, access level, and more.
|
|
23
|
+
* Retrieves the details of an existing member.
|
|
24
24
|
*
|
|
25
25
|
* Required permissions:
|
|
26
26
|
*
|
|
@@ -28,8 +28,8 @@ export class Members extends APIResource {
|
|
|
28
28
|
* - `member:email:read`
|
|
29
29
|
* - `member:phone:read`
|
|
30
30
|
*/
|
|
31
|
-
|
|
32
|
-
return this._client.
|
|
31
|
+
retrieve(id, options) {
|
|
32
|
+
return this._client.get(path `/members/${id}`, options);
|
|
33
33
|
}
|
|
34
34
|
}
|
|
35
35
|
//# sourceMappingURL=members.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"members.mjs","sourceRoot":"","sources":["../src/resources/members.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC
|
|
1
|
+
{"version":3,"file":"members.mjs","sourceRoot":"","sources":["../src/resources/members.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;OASG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,CAAA,UAA8B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;CACF"}
|
|
@@ -8,7 +8,8 @@ import { RequestOptions } from "../internal/request-options.mjs";
|
|
|
8
8
|
*/
|
|
9
9
|
export declare class Memberships extends APIResource {
|
|
10
10
|
/**
|
|
11
|
-
*
|
|
11
|
+
* Returns a paginated list of memberships, with optional filtering by product,
|
|
12
|
+
* plan, status, and user.
|
|
12
13
|
*
|
|
13
14
|
* Required permissions:
|
|
14
15
|
*
|
|
@@ -17,50 +18,31 @@ export declare class Memberships extends APIResource {
|
|
|
17
18
|
*
|
|
18
19
|
* @example
|
|
19
20
|
* ```ts
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
21
|
+
* // Automatically fetches more pages as needed.
|
|
22
|
+
* for await (const membershipListResponse of client.memberships.list()) {
|
|
23
|
+
* // ...
|
|
24
|
+
* }
|
|
23
25
|
* ```
|
|
24
26
|
*/
|
|
25
|
-
|
|
27
|
+
list(query?: MembershipListParams | null | undefined, options?: RequestOptions): PagePromise<MembershipListResponsesCursorPage, MembershipListResponse>;
|
|
26
28
|
/**
|
|
27
|
-
*
|
|
29
|
+
* Retrieves the details of an existing membership.
|
|
28
30
|
*
|
|
29
31
|
* Required permissions:
|
|
30
32
|
*
|
|
31
|
-
* - `member:manage`
|
|
32
|
-
* - `member:email:read`
|
|
33
33
|
* - `member:basic:read`
|
|
34
|
+
* - `member:email:read`
|
|
34
35
|
*
|
|
35
36
|
* @example
|
|
36
37
|
* ```ts
|
|
37
|
-
* const membership = await client.memberships.
|
|
38
|
+
* const membership = await client.memberships.retrieve(
|
|
38
39
|
* 'mem_xxxxxxxxxxxxxx',
|
|
39
40
|
* );
|
|
40
41
|
* ```
|
|
41
42
|
*/
|
|
42
|
-
|
|
43
|
-
/**
|
|
44
|
-
* Returns a paginated list of memberships, with optional filtering by product,
|
|
45
|
-
* plan, status, and user.
|
|
46
|
-
*
|
|
47
|
-
* Required permissions:
|
|
48
|
-
*
|
|
49
|
-
* - `member:basic:read`
|
|
50
|
-
* - `member:email:read`
|
|
51
|
-
*
|
|
52
|
-
* @example
|
|
53
|
-
* ```ts
|
|
54
|
-
* // Automatically fetches more pages as needed.
|
|
55
|
-
* for await (const membershipListResponse of client.memberships.list()) {
|
|
56
|
-
* // ...
|
|
57
|
-
* }
|
|
58
|
-
* ```
|
|
59
|
-
*/
|
|
60
|
-
list(query?: MembershipListParams | null | undefined, options?: RequestOptions): PagePromise<MembershipListResponsesCursorPage, MembershipListResponse>;
|
|
43
|
+
retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Membership>;
|
|
61
44
|
/**
|
|
62
|
-
*
|
|
63
|
-
* or Stripe trial.
|
|
45
|
+
* Update a membership's metadata or other mutable properties.
|
|
64
46
|
*
|
|
65
47
|
* Required permissions:
|
|
66
48
|
*
|
|
@@ -70,13 +52,12 @@ export declare class Memberships extends APIResource {
|
|
|
70
52
|
*
|
|
71
53
|
* @example
|
|
72
54
|
* ```ts
|
|
73
|
-
* const membership = await client.memberships.
|
|
55
|
+
* const membership = await client.memberships.update(
|
|
74
56
|
* 'mem_xxxxxxxxxxxxxx',
|
|
75
|
-
* { free_days: 42 },
|
|
76
57
|
* );
|
|
77
58
|
* ```
|
|
78
59
|
*/
|
|
79
|
-
|
|
60
|
+
update(id: string, body?: MembershipUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Shared.Membership>;
|
|
80
61
|
/**
|
|
81
62
|
* Cancel a membership either immediately or at the end of the current billing
|
|
82
63
|
* period. Immediate cancellation revokes access right away.
|
|
@@ -149,6 +130,25 @@ export declare class Memberships extends APIResource {
|
|
|
149
130
|
* ```
|
|
150
131
|
*/
|
|
151
132
|
uncancel(id: string, options?: RequestOptions): APIPromise<Shared.Membership>;
|
|
133
|
+
/**
|
|
134
|
+
* Add free days to extend a membership's current billing period, expiration date,
|
|
135
|
+
* or Stripe trial.
|
|
136
|
+
*
|
|
137
|
+
* Required permissions:
|
|
138
|
+
*
|
|
139
|
+
* - `member:manage`
|
|
140
|
+
* - `member:email:read`
|
|
141
|
+
* - `member:basic:read`
|
|
142
|
+
*
|
|
143
|
+
* @example
|
|
144
|
+
* ```ts
|
|
145
|
+
* const membership = await client.memberships.addFreeDays(
|
|
146
|
+
* 'mem_xxxxxxxxxxxxxx',
|
|
147
|
+
* { free_days: 42 },
|
|
148
|
+
* );
|
|
149
|
+
* ```
|
|
150
|
+
*/
|
|
151
|
+
addFreeDays(id: string, body: MembershipAddFreeDaysParams, options?: RequestOptions): APIPromise<Shared.Membership>;
|
|
152
152
|
}
|
|
153
153
|
export type MembershipListResponsesCursorPage = CursorPage<MembershipListResponse>;
|
|
154
154
|
/**
|
|
@@ -185,6 +185,12 @@ export interface MembershipListResponse {
|
|
|
185
185
|
* customer did not provide a reason.
|
|
186
186
|
*/
|
|
187
187
|
cancellation_reason: string | null;
|
|
188
|
+
/**
|
|
189
|
+
* The ID of the checkout session/configuration that produced this membership, if
|
|
190
|
+
* any. Use this to map memberships back to the checkout configuration that created
|
|
191
|
+
* them.
|
|
192
|
+
*/
|
|
193
|
+
checkout_configuration_id: string | null;
|
|
188
194
|
/**
|
|
189
195
|
* The company this membership belongs to.
|
|
190
196
|
*/
|
|
@@ -298,6 +304,13 @@ export declare namespace MembershipListResponse {
|
|
|
298
304
|
* The unique identifier for the plan.
|
|
299
305
|
*/
|
|
300
306
|
id: string;
|
|
307
|
+
/**
|
|
308
|
+
* Custom key-value pairs stored on the plan. Included in webhook payloads for
|
|
309
|
+
* payment and membership events.
|
|
310
|
+
*/
|
|
311
|
+
metadata: {
|
|
312
|
+
[key: string]: unknown;
|
|
313
|
+
} | null;
|
|
301
314
|
}
|
|
302
315
|
/**
|
|
303
316
|
* The product this membership grants access to.
|
|
@@ -307,6 +320,13 @@ export declare namespace MembershipListResponse {
|
|
|
307
320
|
* The unique identifier for the product.
|
|
308
321
|
*/
|
|
309
322
|
id: string;
|
|
323
|
+
/**
|
|
324
|
+
* Custom key-value pairs stored on the product. Included in webhook payloads for
|
|
325
|
+
* payment and membership events.
|
|
326
|
+
*/
|
|
327
|
+
metadata: {
|
|
328
|
+
[key: string]: unknown;
|
|
329
|
+
} | null;
|
|
310
330
|
/**
|
|
311
331
|
* The display name of the product shown to customers on the product page and in
|
|
312
332
|
* search results.
|
|
@@ -346,15 +366,6 @@ export declare namespace MembershipListResponse {
|
|
|
346
366
|
username: string;
|
|
347
367
|
}
|
|
348
368
|
}
|
|
349
|
-
export interface MembershipUpdateParams {
|
|
350
|
-
/**
|
|
351
|
-
* A JSON object of key-value pairs to store on the membership. Replaces any
|
|
352
|
-
* existing metadata.
|
|
353
|
-
*/
|
|
354
|
-
metadata?: {
|
|
355
|
-
[key: string]: unknown;
|
|
356
|
-
} | null;
|
|
357
|
-
}
|
|
358
369
|
export interface MembershipListParams extends CursorPageParams {
|
|
359
370
|
/**
|
|
360
371
|
* Returns the elements in the list that come before the specified cursor.
|
|
@@ -414,12 +425,14 @@ export interface MembershipListParams extends CursorPageParams {
|
|
|
414
425
|
*/
|
|
415
426
|
user_ids?: Array<string> | null;
|
|
416
427
|
}
|
|
417
|
-
export interface
|
|
428
|
+
export interface MembershipUpdateParams {
|
|
418
429
|
/**
|
|
419
|
-
*
|
|
420
|
-
*
|
|
430
|
+
* A JSON object of key-value pairs to store on the membership. Replaces any
|
|
431
|
+
* existing metadata.
|
|
421
432
|
*/
|
|
422
|
-
|
|
433
|
+
metadata?: {
|
|
434
|
+
[key: string]: unknown;
|
|
435
|
+
} | null;
|
|
423
436
|
}
|
|
424
437
|
export interface MembershipCancelParams {
|
|
425
438
|
/**
|
|
@@ -434,7 +447,14 @@ export interface MembershipPauseParams {
|
|
|
434
447
|
*/
|
|
435
448
|
void_payments?: boolean | null;
|
|
436
449
|
}
|
|
450
|
+
export interface MembershipAddFreeDaysParams {
|
|
451
|
+
/**
|
|
452
|
+
* The number of free days to add (1-1095). Extends the billing period, expiration
|
|
453
|
+
* date, or Stripe trial depending on plan type.
|
|
454
|
+
*/
|
|
455
|
+
free_days: number;
|
|
456
|
+
}
|
|
437
457
|
export declare namespace Memberships {
|
|
438
|
-
export { type CancelOptions as CancelOptions, type MembershipListResponse as MembershipListResponse, type MembershipListResponsesCursorPage as MembershipListResponsesCursorPage, type
|
|
458
|
+
export { type CancelOptions as CancelOptions, type MembershipListResponse as MembershipListResponse, type MembershipListResponsesCursorPage as MembershipListResponsesCursorPage, type MembershipListParams as MembershipListParams, type MembershipUpdateParams as MembershipUpdateParams, type MembershipCancelParams as MembershipCancelParams, type MembershipPauseParams as MembershipPauseParams, type MembershipAddFreeDaysParams as MembershipAddFreeDaysParams, };
|
|
439
459
|
}
|
|
440
460
|
//# sourceMappingURL=memberships.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"memberships.d.mts","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;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI7E;;;;;;;;;;;;;;;OAeG;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;;;;;;;;;;;;;;;;OAgBG;IACH,
|
|
1
|
+
{"version":3,"file":"memberships.d.mts","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;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,sBAAsB,CAAC;IAIzE;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI7E;;;;;;;;;;;;;;;OAeG;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;;;;;;;;;;;;;;;;OAgBG;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;;;;;;;;;;;;;;;;OAgBG;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;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI3E;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI7E;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,CACT,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;CAGjC;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;;;;OAIG;IACH,yBAAyB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;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,GAAG,IAAI,CAAC;IAE5C;;;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;QAEX;;;WAGG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;KAC7C;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAE5C;;;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,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;;;OAGG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAC9C;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,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;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,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}
|
|
@@ -8,7 +8,8 @@ import { RequestOptions } from "../internal/request-options.js";
|
|
|
8
8
|
*/
|
|
9
9
|
export declare class Memberships extends APIResource {
|
|
10
10
|
/**
|
|
11
|
-
*
|
|
11
|
+
* Returns a paginated list of memberships, with optional filtering by product,
|
|
12
|
+
* plan, status, and user.
|
|
12
13
|
*
|
|
13
14
|
* Required permissions:
|
|
14
15
|
*
|
|
@@ -17,50 +18,31 @@ export declare class Memberships extends APIResource {
|
|
|
17
18
|
*
|
|
18
19
|
* @example
|
|
19
20
|
* ```ts
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
21
|
+
* // Automatically fetches more pages as needed.
|
|
22
|
+
* for await (const membershipListResponse of client.memberships.list()) {
|
|
23
|
+
* // ...
|
|
24
|
+
* }
|
|
23
25
|
* ```
|
|
24
26
|
*/
|
|
25
|
-
|
|
27
|
+
list(query?: MembershipListParams | null | undefined, options?: RequestOptions): PagePromise<MembershipListResponsesCursorPage, MembershipListResponse>;
|
|
26
28
|
/**
|
|
27
|
-
*
|
|
29
|
+
* Retrieves the details of an existing membership.
|
|
28
30
|
*
|
|
29
31
|
* Required permissions:
|
|
30
32
|
*
|
|
31
|
-
* - `member:manage`
|
|
32
|
-
* - `member:email:read`
|
|
33
33
|
* - `member:basic:read`
|
|
34
|
+
* - `member:email:read`
|
|
34
35
|
*
|
|
35
36
|
* @example
|
|
36
37
|
* ```ts
|
|
37
|
-
* const membership = await client.memberships.
|
|
38
|
+
* const membership = await client.memberships.retrieve(
|
|
38
39
|
* 'mem_xxxxxxxxxxxxxx',
|
|
39
40
|
* );
|
|
40
41
|
* ```
|
|
41
42
|
*/
|
|
42
|
-
|
|
43
|
-
/**
|
|
44
|
-
* Returns a paginated list of memberships, with optional filtering by product,
|
|
45
|
-
* plan, status, and user.
|
|
46
|
-
*
|
|
47
|
-
* Required permissions:
|
|
48
|
-
*
|
|
49
|
-
* - `member:basic:read`
|
|
50
|
-
* - `member:email:read`
|
|
51
|
-
*
|
|
52
|
-
* @example
|
|
53
|
-
* ```ts
|
|
54
|
-
* // Automatically fetches more pages as needed.
|
|
55
|
-
* for await (const membershipListResponse of client.memberships.list()) {
|
|
56
|
-
* // ...
|
|
57
|
-
* }
|
|
58
|
-
* ```
|
|
59
|
-
*/
|
|
60
|
-
list(query?: MembershipListParams | null | undefined, options?: RequestOptions): PagePromise<MembershipListResponsesCursorPage, MembershipListResponse>;
|
|
43
|
+
retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Membership>;
|
|
61
44
|
/**
|
|
62
|
-
*
|
|
63
|
-
* or Stripe trial.
|
|
45
|
+
* Update a membership's metadata or other mutable properties.
|
|
64
46
|
*
|
|
65
47
|
* Required permissions:
|
|
66
48
|
*
|
|
@@ -70,13 +52,12 @@ export declare class Memberships extends APIResource {
|
|
|
70
52
|
*
|
|
71
53
|
* @example
|
|
72
54
|
* ```ts
|
|
73
|
-
* const membership = await client.memberships.
|
|
55
|
+
* const membership = await client.memberships.update(
|
|
74
56
|
* 'mem_xxxxxxxxxxxxxx',
|
|
75
|
-
* { free_days: 42 },
|
|
76
57
|
* );
|
|
77
58
|
* ```
|
|
78
59
|
*/
|
|
79
|
-
|
|
60
|
+
update(id: string, body?: MembershipUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Shared.Membership>;
|
|
80
61
|
/**
|
|
81
62
|
* Cancel a membership either immediately or at the end of the current billing
|
|
82
63
|
* period. Immediate cancellation revokes access right away.
|
|
@@ -149,6 +130,25 @@ export declare class Memberships extends APIResource {
|
|
|
149
130
|
* ```
|
|
150
131
|
*/
|
|
151
132
|
uncancel(id: string, options?: RequestOptions): APIPromise<Shared.Membership>;
|
|
133
|
+
/**
|
|
134
|
+
* Add free days to extend a membership's current billing period, expiration date,
|
|
135
|
+
* or Stripe trial.
|
|
136
|
+
*
|
|
137
|
+
* Required permissions:
|
|
138
|
+
*
|
|
139
|
+
* - `member:manage`
|
|
140
|
+
* - `member:email:read`
|
|
141
|
+
* - `member:basic:read`
|
|
142
|
+
*
|
|
143
|
+
* @example
|
|
144
|
+
* ```ts
|
|
145
|
+
* const membership = await client.memberships.addFreeDays(
|
|
146
|
+
* 'mem_xxxxxxxxxxxxxx',
|
|
147
|
+
* { free_days: 42 },
|
|
148
|
+
* );
|
|
149
|
+
* ```
|
|
150
|
+
*/
|
|
151
|
+
addFreeDays(id: string, body: MembershipAddFreeDaysParams, options?: RequestOptions): APIPromise<Shared.Membership>;
|
|
152
152
|
}
|
|
153
153
|
export type MembershipListResponsesCursorPage = CursorPage<MembershipListResponse>;
|
|
154
154
|
/**
|
|
@@ -185,6 +185,12 @@ export interface MembershipListResponse {
|
|
|
185
185
|
* customer did not provide a reason.
|
|
186
186
|
*/
|
|
187
187
|
cancellation_reason: string | null;
|
|
188
|
+
/**
|
|
189
|
+
* The ID of the checkout session/configuration that produced this membership, if
|
|
190
|
+
* any. Use this to map memberships back to the checkout configuration that created
|
|
191
|
+
* them.
|
|
192
|
+
*/
|
|
193
|
+
checkout_configuration_id: string | null;
|
|
188
194
|
/**
|
|
189
195
|
* The company this membership belongs to.
|
|
190
196
|
*/
|
|
@@ -298,6 +304,13 @@ export declare namespace MembershipListResponse {
|
|
|
298
304
|
* The unique identifier for the plan.
|
|
299
305
|
*/
|
|
300
306
|
id: string;
|
|
307
|
+
/**
|
|
308
|
+
* Custom key-value pairs stored on the plan. Included in webhook payloads for
|
|
309
|
+
* payment and membership events.
|
|
310
|
+
*/
|
|
311
|
+
metadata: {
|
|
312
|
+
[key: string]: unknown;
|
|
313
|
+
} | null;
|
|
301
314
|
}
|
|
302
315
|
/**
|
|
303
316
|
* The product this membership grants access to.
|
|
@@ -307,6 +320,13 @@ export declare namespace MembershipListResponse {
|
|
|
307
320
|
* The unique identifier for the product.
|
|
308
321
|
*/
|
|
309
322
|
id: string;
|
|
323
|
+
/**
|
|
324
|
+
* Custom key-value pairs stored on the product. Included in webhook payloads for
|
|
325
|
+
* payment and membership events.
|
|
326
|
+
*/
|
|
327
|
+
metadata: {
|
|
328
|
+
[key: string]: unknown;
|
|
329
|
+
} | null;
|
|
310
330
|
/**
|
|
311
331
|
* The display name of the product shown to customers on the product page and in
|
|
312
332
|
* search results.
|
|
@@ -346,15 +366,6 @@ export declare namespace MembershipListResponse {
|
|
|
346
366
|
username: string;
|
|
347
367
|
}
|
|
348
368
|
}
|
|
349
|
-
export interface MembershipUpdateParams {
|
|
350
|
-
/**
|
|
351
|
-
* A JSON object of key-value pairs to store on the membership. Replaces any
|
|
352
|
-
* existing metadata.
|
|
353
|
-
*/
|
|
354
|
-
metadata?: {
|
|
355
|
-
[key: string]: unknown;
|
|
356
|
-
} | null;
|
|
357
|
-
}
|
|
358
369
|
export interface MembershipListParams extends CursorPageParams {
|
|
359
370
|
/**
|
|
360
371
|
* Returns the elements in the list that come before the specified cursor.
|
|
@@ -414,12 +425,14 @@ export interface MembershipListParams extends CursorPageParams {
|
|
|
414
425
|
*/
|
|
415
426
|
user_ids?: Array<string> | null;
|
|
416
427
|
}
|
|
417
|
-
export interface
|
|
428
|
+
export interface MembershipUpdateParams {
|
|
418
429
|
/**
|
|
419
|
-
*
|
|
420
|
-
*
|
|
430
|
+
* A JSON object of key-value pairs to store on the membership. Replaces any
|
|
431
|
+
* existing metadata.
|
|
421
432
|
*/
|
|
422
|
-
|
|
433
|
+
metadata?: {
|
|
434
|
+
[key: string]: unknown;
|
|
435
|
+
} | null;
|
|
423
436
|
}
|
|
424
437
|
export interface MembershipCancelParams {
|
|
425
438
|
/**
|
|
@@ -434,7 +447,14 @@ export interface MembershipPauseParams {
|
|
|
434
447
|
*/
|
|
435
448
|
void_payments?: boolean | null;
|
|
436
449
|
}
|
|
450
|
+
export interface MembershipAddFreeDaysParams {
|
|
451
|
+
/**
|
|
452
|
+
* The number of free days to add (1-1095). Extends the billing period, expiration
|
|
453
|
+
* date, or Stripe trial depending on plan type.
|
|
454
|
+
*/
|
|
455
|
+
free_days: number;
|
|
456
|
+
}
|
|
437
457
|
export declare namespace Memberships {
|
|
438
|
-
export { type CancelOptions as CancelOptions, type MembershipListResponse as MembershipListResponse, type MembershipListResponsesCursorPage as MembershipListResponsesCursorPage, type
|
|
458
|
+
export { type CancelOptions as CancelOptions, type MembershipListResponse as MembershipListResponse, type MembershipListResponsesCursorPage as MembershipListResponsesCursorPage, type MembershipListParams as MembershipListParams, type MembershipUpdateParams as MembershipUpdateParams, type MembershipCancelParams as MembershipCancelParams, type MembershipPauseParams as MembershipPauseParams, type MembershipAddFreeDaysParams as MembershipAddFreeDaysParams, };
|
|
439
459
|
}
|
|
440
460
|
//# sourceMappingURL=memberships.d.ts.map
|
|
@@ -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;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI7E;;;;;;;;;;;;;;;OAeG;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;;;;;;;;;;;;;;;;OAgBG;IACH,
|
|
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;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,sBAAsB,CAAC;IAIzE;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI7E;;;;;;;;;;;;;;;OAeG;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;;;;;;;;;;;;;;;;OAgBG;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;;;;;;;;;;;;;;;;OAgBG;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;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI3E;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI7E;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,CACT,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;CAGjC;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;;;;OAIG;IACH,yBAAyB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;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,GAAG,IAAI,CAAC;IAE5C;;;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;QAEX;;;WAGG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;KAC7C;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAE5C;;;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,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;;;OAGG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAC9C;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,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;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,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}
|
package/resources/memberships.js
CHANGED
|
@@ -10,7 +10,8 @@ const path_1 = require("../internal/utils/path.js");
|
|
|
10
10
|
*/
|
|
11
11
|
class Memberships extends resource_1.APIResource {
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
13
|
+
* Returns a paginated list of memberships, with optional filtering by product,
|
|
14
|
+
* plan, status, and user.
|
|
14
15
|
*
|
|
15
16
|
* Required permissions:
|
|
16
17
|
*
|
|
@@ -19,56 +20,35 @@ class Memberships extends resource_1.APIResource {
|
|
|
19
20
|
*
|
|
20
21
|
* @example
|
|
21
22
|
* ```ts
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
23
|
+
* // Automatically fetches more pages as needed.
|
|
24
|
+
* for await (const membershipListResponse of client.memberships.list()) {
|
|
25
|
+
* // ...
|
|
26
|
+
* }
|
|
25
27
|
* ```
|
|
26
28
|
*/
|
|
27
|
-
|
|
28
|
-
return this._client.
|
|
29
|
+
list(query = {}, options) {
|
|
30
|
+
return this._client.getAPIList('/memberships', (pagination_1.CursorPage), { query, ...options });
|
|
29
31
|
}
|
|
30
32
|
/**
|
|
31
|
-
*
|
|
33
|
+
* Retrieves the details of an existing membership.
|
|
32
34
|
*
|
|
33
35
|
* Required permissions:
|
|
34
36
|
*
|
|
35
|
-
* - `member:manage`
|
|
36
|
-
* - `member:email:read`
|
|
37
37
|
* - `member:basic:read`
|
|
38
|
+
* - `member:email:read`
|
|
38
39
|
*
|
|
39
40
|
* @example
|
|
40
41
|
* ```ts
|
|
41
|
-
* const membership = await client.memberships.
|
|
42
|
+
* const membership = await client.memberships.retrieve(
|
|
42
43
|
* 'mem_xxxxxxxxxxxxxx',
|
|
43
44
|
* );
|
|
44
45
|
* ```
|
|
45
46
|
*/
|
|
46
|
-
|
|
47
|
-
return this._client.
|
|
48
|
-
}
|
|
49
|
-
/**
|
|
50
|
-
* Returns a paginated list of memberships, with optional filtering by product,
|
|
51
|
-
* plan, status, and user.
|
|
52
|
-
*
|
|
53
|
-
* Required permissions:
|
|
54
|
-
*
|
|
55
|
-
* - `member:basic:read`
|
|
56
|
-
* - `member:email:read`
|
|
57
|
-
*
|
|
58
|
-
* @example
|
|
59
|
-
* ```ts
|
|
60
|
-
* // Automatically fetches more pages as needed.
|
|
61
|
-
* for await (const membershipListResponse of client.memberships.list()) {
|
|
62
|
-
* // ...
|
|
63
|
-
* }
|
|
64
|
-
* ```
|
|
65
|
-
*/
|
|
66
|
-
list(query = {}, options) {
|
|
67
|
-
return this._client.getAPIList('/memberships', (pagination_1.CursorPage), { query, ...options });
|
|
47
|
+
retrieve(id, options) {
|
|
48
|
+
return this._client.get((0, path_1.path) `/memberships/${id}`, options);
|
|
68
49
|
}
|
|
69
50
|
/**
|
|
70
|
-
*
|
|
71
|
-
* or Stripe trial.
|
|
51
|
+
* Update a membership's metadata or other mutable properties.
|
|
72
52
|
*
|
|
73
53
|
* Required permissions:
|
|
74
54
|
*
|
|
@@ -78,14 +58,13 @@ class Memberships extends resource_1.APIResource {
|
|
|
78
58
|
*
|
|
79
59
|
* @example
|
|
80
60
|
* ```ts
|
|
81
|
-
* const membership = await client.memberships.
|
|
61
|
+
* const membership = await client.memberships.update(
|
|
82
62
|
* 'mem_xxxxxxxxxxxxxx',
|
|
83
|
-
* { free_days: 42 },
|
|
84
63
|
* );
|
|
85
64
|
* ```
|
|
86
65
|
*/
|
|
87
|
-
|
|
88
|
-
return this._client.
|
|
66
|
+
update(id, body = {}, options) {
|
|
67
|
+
return this._client.patch((0, path_1.path) `/memberships/${id}`, { body, ...options });
|
|
89
68
|
}
|
|
90
69
|
/**
|
|
91
70
|
* Cancel a membership either immediately or at the end of the current billing
|
|
@@ -167,6 +146,27 @@ class Memberships extends resource_1.APIResource {
|
|
|
167
146
|
uncancel(id, options) {
|
|
168
147
|
return this._client.post((0, path_1.path) `/memberships/${id}/uncancel`, options);
|
|
169
148
|
}
|
|
149
|
+
/**
|
|
150
|
+
* Add free days to extend a membership's current billing period, expiration date,
|
|
151
|
+
* or Stripe trial.
|
|
152
|
+
*
|
|
153
|
+
* Required permissions:
|
|
154
|
+
*
|
|
155
|
+
* - `member:manage`
|
|
156
|
+
* - `member:email:read`
|
|
157
|
+
* - `member:basic:read`
|
|
158
|
+
*
|
|
159
|
+
* @example
|
|
160
|
+
* ```ts
|
|
161
|
+
* const membership = await client.memberships.addFreeDays(
|
|
162
|
+
* 'mem_xxxxxxxxxxxxxx',
|
|
163
|
+
* { free_days: 42 },
|
|
164
|
+
* );
|
|
165
|
+
* ```
|
|
166
|
+
*/
|
|
167
|
+
addFreeDays(id, body, options) {
|
|
168
|
+
return this._client.post((0, path_1.path) `/memberships/${id}/add_free_days`, { body, ...options });
|
|
169
|
+
}
|
|
170
170
|
}
|
|
171
171
|
exports.Memberships = Memberships;
|
|
172
172
|
//# sourceMappingURL=memberships.js.map
|
|
@@ -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;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C
|
|
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;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;;;;OAgBG;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;;;;;;;;;;;;;;OAcG;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;;;;;;;;;;;;;;;OAeG;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;;;;;;;;;;;;;;;;OAgBG;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;;;;;;;;;;;;;;;;OAgBG;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;;;;;;;;;;;;;;;;OAgBG;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;;;;;;;;;;;;;;;;OAgBG;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;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,CACT,EAAU,EACV,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;CACF;AAzLD,kCAyLC"}
|