@whop/sdk 0.0.1-canary.0
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 +108 -0
- package/LICENSE +201 -0
- package/README.md +399 -0
- package/api-promise.d.mts +2 -0
- package/api-promise.d.mts.map +1 -0
- package/api-promise.d.ts +2 -0
- package/api-promise.d.ts.map +1 -0
- package/api-promise.js +6 -0
- package/api-promise.js.map +1 -0
- package/api-promise.mjs +2 -0
- package/api-promise.mjs.map +1 -0
- package/client.d.mts +316 -0
- package/client.d.mts.map +1 -0
- package/client.d.ts +316 -0
- package/client.d.ts.map +1 -0
- package/client.js +536 -0
- package/client.js.map +1 -0
- package/client.mjs +532 -0
- package/client.mjs.map +1 -0
- package/core/api-promise.d.mts +46 -0
- package/core/api-promise.d.mts.map +1 -0
- package/core/api-promise.d.ts +46 -0
- package/core/api-promise.d.ts.map +1 -0
- package/core/api-promise.js +74 -0
- package/core/api-promise.js.map +1 -0
- package/core/api-promise.mjs +70 -0
- package/core/api-promise.mjs.map +1 -0
- package/core/error.d.mts +46 -0
- package/core/error.d.mts.map +1 -0
- package/core/error.d.ts +46 -0
- package/core/error.d.ts.map +1 -0
- package/core/error.js +113 -0
- package/core/error.js.map +1 -0
- package/core/error.mjs +97 -0
- package/core/error.mjs.map +1 -0
- package/core/pagination.d.mts +58 -0
- package/core/pagination.d.mts.map +1 -0
- package/core/pagination.d.ts +58 -0
- package/core/pagination.d.ts.map +1 -0
- package/core/pagination.js +101 -0
- package/core/pagination.js.map +1 -0
- package/core/pagination.mjs +95 -0
- package/core/pagination.mjs.map +1 -0
- package/core/resource.d.mts +6 -0
- package/core/resource.d.mts.map +1 -0
- package/core/resource.d.ts +6 -0
- package/core/resource.d.ts.map +1 -0
- package/core/resource.js +11 -0
- package/core/resource.js.map +1 -0
- package/core/resource.mjs +7 -0
- package/core/resource.mjs.map +1 -0
- package/core/uploads.d.mts +3 -0
- package/core/uploads.d.mts.map +1 -0
- package/core/uploads.d.ts +3 -0
- package/core/uploads.d.ts.map +1 -0
- package/core/uploads.js +6 -0
- package/core/uploads.js.map +1 -0
- package/core/uploads.mjs +2 -0
- package/core/uploads.mjs.map +1 -0
- package/error.d.mts +2 -0
- package/error.d.mts.map +1 -0
- package/error.d.ts +2 -0
- package/error.d.ts.map +1 -0
- package/error.js +6 -0
- package/error.js.map +1 -0
- package/error.mjs +2 -0
- package/error.mjs.map +1 -0
- package/index.d.mts +7 -0
- package/index.d.mts.map +1 -0
- package/index.d.ts +7 -0
- package/index.d.ts.map +1 -0
- package/index.js +32 -0
- package/index.js.map +1 -0
- package/index.mjs +8 -0
- package/index.mjs.map +1 -0
- package/internal/builtin-types.d.mts +73 -0
- package/internal/builtin-types.d.mts.map +1 -0
- package/internal/builtin-types.d.ts +73 -0
- package/internal/builtin-types.d.ts.map +1 -0
- package/internal/builtin-types.js +4 -0
- package/internal/builtin-types.js.map +1 -0
- package/internal/builtin-types.mjs +3 -0
- package/internal/builtin-types.mjs.map +1 -0
- package/internal/detect-platform.d.mts +15 -0
- package/internal/detect-platform.d.mts.map +1 -0
- package/internal/detect-platform.d.ts +15 -0
- package/internal/detect-platform.d.ts.map +1 -0
- package/internal/detect-platform.js +162 -0
- package/internal/detect-platform.js.map +1 -0
- package/internal/detect-platform.mjs +157 -0
- package/internal/detect-platform.mjs.map +1 -0
- package/internal/errors.d.mts +3 -0
- package/internal/errors.d.mts.map +1 -0
- package/internal/errors.d.ts +3 -0
- package/internal/errors.d.ts.map +1 -0
- package/internal/errors.js +41 -0
- package/internal/errors.js.map +1 -0
- package/internal/errors.mjs +36 -0
- package/internal/errors.mjs.map +1 -0
- package/internal/headers.d.mts +20 -0
- package/internal/headers.d.mts.map +1 -0
- package/internal/headers.d.ts +20 -0
- package/internal/headers.d.ts.map +1 -0
- package/internal/headers.js +79 -0
- package/internal/headers.js.map +1 -0
- package/internal/headers.mjs +74 -0
- package/internal/headers.mjs.map +1 -0
- package/internal/parse.d.mts +12 -0
- package/internal/parse.d.mts.map +1 -0
- package/internal/parse.d.ts +12 -0
- package/internal/parse.d.ts.map +1 -0
- package/internal/parse.js +35 -0
- package/internal/parse.js.map +1 -0
- package/internal/parse.mjs +32 -0
- package/internal/parse.mjs.map +1 -0
- package/internal/qs/formats.d.mts +7 -0
- package/internal/qs/formats.d.mts.map +1 -0
- package/internal/qs/formats.d.ts +7 -0
- package/internal/qs/formats.d.ts.map +1 -0
- package/internal/qs/formats.js +13 -0
- package/internal/qs/formats.js.map +1 -0
- package/internal/qs/formats.mjs +9 -0
- package/internal/qs/formats.mjs.map +1 -0
- package/internal/qs/index.d.mts +10 -0
- package/internal/qs/index.d.mts.map +1 -0
- package/internal/qs/index.d.ts +10 -0
- package/internal/qs/index.d.ts.map +1 -0
- package/internal/qs/index.js +14 -0
- package/internal/qs/index.js.map +1 -0
- package/internal/qs/index.mjs +10 -0
- package/internal/qs/index.mjs.map +1 -0
- package/internal/qs/stringify.d.mts +3 -0
- package/internal/qs/stringify.d.mts.map +1 -0
- package/internal/qs/stringify.d.ts +3 -0
- package/internal/qs/stringify.d.ts.map +1 -0
- package/internal/qs/stringify.js +277 -0
- package/internal/qs/stringify.js.map +1 -0
- package/internal/qs/stringify.mjs +274 -0
- package/internal/qs/stringify.mjs.map +1 -0
- package/internal/qs/types.d.mts +57 -0
- package/internal/qs/types.d.mts.map +1 -0
- package/internal/qs/types.d.ts +57 -0
- package/internal/qs/types.d.ts.map +1 -0
- package/internal/qs/types.js +3 -0
- package/internal/qs/types.js.map +1 -0
- package/internal/qs/types.mjs +2 -0
- package/internal/qs/types.mjs.map +1 -0
- package/internal/qs/utils.d.mts +15 -0
- package/internal/qs/utils.d.mts.map +1 -0
- package/internal/qs/utils.d.ts +15 -0
- package/internal/qs/utils.d.ts.map +1 -0
- package/internal/qs/utils.js +230 -0
- package/internal/qs/utils.js.map +1 -0
- package/internal/qs/utils.mjs +217 -0
- package/internal/qs/utils.mjs.map +1 -0
- package/internal/request-options.d.mts +75 -0
- package/internal/request-options.d.mts.map +1 -0
- package/internal/request-options.d.ts +75 -0
- package/internal/request-options.d.ts.map +1 -0
- package/internal/request-options.js +14 -0
- package/internal/request-options.js.map +1 -0
- package/internal/request-options.mjs +10 -0
- package/internal/request-options.mjs.map +1 -0
- package/internal/shim-types.d.mts +17 -0
- package/internal/shim-types.d.mts.map +1 -0
- package/internal/shim-types.d.ts +17 -0
- package/internal/shim-types.d.ts.map +1 -0
- package/internal/shim-types.js +4 -0
- package/internal/shim-types.js.map +1 -0
- package/internal/shim-types.mjs +3 -0
- package/internal/shim-types.mjs.map +1 -0
- package/internal/shims.d.mts +20 -0
- package/internal/shims.d.mts.map +1 -0
- package/internal/shims.d.ts +20 -0
- package/internal/shims.d.ts.map +1 -0
- package/internal/shims.js +92 -0
- package/internal/shims.js.map +1 -0
- package/internal/shims.mjs +85 -0
- package/internal/shims.mjs.map +1 -0
- package/internal/to-file.d.mts +45 -0
- package/internal/to-file.d.mts.map +1 -0
- package/internal/to-file.d.ts +45 -0
- package/internal/to-file.d.ts.map +1 -0
- package/internal/to-file.js +91 -0
- package/internal/to-file.js.map +1 -0
- package/internal/to-file.mjs +88 -0
- package/internal/to-file.mjs.map +1 -0
- package/internal/tslib.js +81 -0
- package/internal/tslib.mjs +17 -0
- package/internal/types.d.mts +69 -0
- package/internal/types.d.mts.map +1 -0
- package/internal/types.d.ts +69 -0
- package/internal/types.d.ts.map +1 -0
- package/internal/types.js +4 -0
- package/internal/types.js.map +1 -0
- package/internal/types.mjs +3 -0
- package/internal/types.mjs.map +1 -0
- package/internal/uploads.d.mts +42 -0
- package/internal/uploads.d.mts.map +1 -0
- package/internal/uploads.d.ts +42 -0
- package/internal/uploads.d.ts.map +1 -0
- package/internal/uploads.js +141 -0
- package/internal/uploads.js.map +1 -0
- package/internal/uploads.mjs +131 -0
- package/internal/uploads.mjs.map +1 -0
- package/internal/utils/base64.d.mts +3 -0
- package/internal/utils/base64.d.mts.map +1 -0
- package/internal/utils/base64.d.ts +3 -0
- package/internal/utils/base64.d.ts.map +1 -0
- package/internal/utils/base64.js +38 -0
- package/internal/utils/base64.js.map +1 -0
- package/internal/utils/base64.mjs +33 -0
- package/internal/utils/base64.mjs.map +1 -0
- package/internal/utils/bytes.d.mts +4 -0
- package/internal/utils/bytes.d.mts.map +1 -0
- package/internal/utils/bytes.d.ts +4 -0
- package/internal/utils/bytes.d.ts.map +1 -0
- package/internal/utils/bytes.js +31 -0
- package/internal/utils/bytes.js.map +1 -0
- package/internal/utils/bytes.mjs +26 -0
- package/internal/utils/bytes.mjs.map +1 -0
- package/internal/utils/env.d.mts +9 -0
- package/internal/utils/env.d.mts.map +1 -0
- package/internal/utils/env.d.ts +9 -0
- package/internal/utils/env.d.ts.map +1 -0
- package/internal/utils/env.js +22 -0
- package/internal/utils/env.js.map +1 -0
- package/internal/utils/env.mjs +18 -0
- package/internal/utils/env.mjs.map +1 -0
- package/internal/utils/log.d.mts +37 -0
- package/internal/utils/log.d.mts.map +1 -0
- package/internal/utils/log.d.ts +37 -0
- package/internal/utils/log.d.ts.map +1 -0
- package/internal/utils/log.js +85 -0
- package/internal/utils/log.js.map +1 -0
- package/internal/utils/log.mjs +79 -0
- package/internal/utils/log.mjs.map +1 -0
- package/internal/utils/path.d.mts +15 -0
- package/internal/utils/path.d.mts.map +1 -0
- package/internal/utils/path.d.ts +15 -0
- package/internal/utils/path.d.ts.map +1 -0
- package/internal/utils/path.js +79 -0
- package/internal/utils/path.js.map +1 -0
- package/internal/utils/path.mjs +74 -0
- package/internal/utils/path.mjs.map +1 -0
- package/internal/utils/sleep.d.mts +2 -0
- package/internal/utils/sleep.d.mts.map +1 -0
- package/internal/utils/sleep.d.ts +2 -0
- package/internal/utils/sleep.d.ts.map +1 -0
- package/internal/utils/sleep.js +7 -0
- package/internal/utils/sleep.js.map +1 -0
- package/internal/utils/sleep.mjs +3 -0
- package/internal/utils/sleep.mjs.map +1 -0
- package/internal/utils/uuid.d.mts +5 -0
- package/internal/utils/uuid.d.mts.map +1 -0
- package/internal/utils/uuid.d.ts +5 -0
- package/internal/utils/uuid.d.ts.map +1 -0
- package/internal/utils/uuid.js +19 -0
- package/internal/utils/uuid.js.map +1 -0
- package/internal/utils/uuid.mjs +15 -0
- package/internal/utils/uuid.mjs.map +1 -0
- package/internal/utils/values.d.mts +18 -0
- package/internal/utils/values.d.mts.map +1 -0
- package/internal/utils/values.d.ts +18 -0
- package/internal/utils/values.d.ts.map +1 -0
- package/internal/utils/values.js +112 -0
- package/internal/utils/values.js.map +1 -0
- package/internal/utils/values.mjs +94 -0
- package/internal/utils/values.mjs.map +1 -0
- package/internal/utils.d.mts +7 -0
- package/internal/utils.d.mts.map +1 -0
- package/internal/utils.d.ts +7 -0
- package/internal/utils.d.ts.map +1 -0
- package/internal/utils.js +11 -0
- package/internal/utils.js.map +1 -0
- package/internal/utils.mjs +8 -0
- package/internal/utils.mjs.map +1 -0
- package/lib/verify-user-token.d.mts +21 -0
- package/lib/verify-user-token.d.mts.map +1 -0
- package/lib/verify-user-token.d.ts +21 -0
- package/lib/verify-user-token.d.ts.map +1 -0
- package/lib/verify-user-token.js +69 -0
- package/lib/verify-user-token.js.map +1 -0
- package/lib/verify-user-token.mjs +64 -0
- package/lib/verify-user-token.mjs.map +1 -0
- package/package.json +160 -0
- package/pagination.d.mts +2 -0
- package/pagination.d.mts.map +1 -0
- package/pagination.d.ts +2 -0
- package/pagination.d.ts.map +1 -0
- package/pagination.js +6 -0
- package/pagination.js.map +1 -0
- package/pagination.mjs +2 -0
- package/pagination.mjs.map +1 -0
- package/resource.d.mts +2 -0
- package/resource.d.mts.map +1 -0
- package/resource.d.ts +2 -0
- package/resource.d.ts.map +1 -0
- package/resource.js +6 -0
- package/resource.js.map +1 -0
- package/resource.mjs +2 -0
- package/resource.mjs.map +1 -0
- package/resources/app-builds.d.mts +196 -0
- package/resources/app-builds.d.mts.map +1 -0
- package/resources/app-builds.d.ts +196 -0
- package/resources/app-builds.d.ts.map +1 -0
- package/resources/app-builds.js +84 -0
- package/resources/app-builds.js.map +1 -0
- package/resources/app-builds.mjs +80 -0
- package/resources/app-builds.mjs.map +1 -0
- package/resources/apps.d.mts +279 -0
- package/resources/apps.d.mts.map +1 -0
- package/resources/apps.d.ts +279 -0
- package/resources/apps.d.ts.map +1 -0
- package/resources/apps.js +77 -0
- package/resources/apps.js.map +1 -0
- package/resources/apps.mjs +73 -0
- package/resources/apps.mjs.map +1 -0
- package/resources/authorized-users.d.mts +136 -0
- package/resources/authorized-users.d.mts.map +1 -0
- package/resources/authorized-users.d.ts +136 -0
- package/resources/authorized-users.d.ts.map +1 -0
- package/resources/authorized-users.js +36 -0
- package/resources/authorized-users.js.map +1 -0
- package/resources/authorized-users.mjs +32 -0
- package/resources/authorized-users.mjs.map +1 -0
- package/resources/chat-channels.d.mts +158 -0
- package/resources/chat-channels.d.mts.map +1 -0
- package/resources/chat-channels.d.ts +158 -0
- package/resources/chat-channels.d.ts.map +1 -0
- package/resources/chat-channels.js +66 -0
- package/resources/chat-channels.js.map +1 -0
- package/resources/chat-channels.mjs +62 -0
- package/resources/chat-channels.mjs.map +1 -0
- package/resources/checkout-configurations.d.mts +319 -0
- package/resources/checkout-configurations.d.mts.map +1 -0
- package/resources/checkout-configurations.d.ts +319 -0
- package/resources/checkout-configurations.d.ts.map +1 -0
- package/resources/checkout-configurations.js +66 -0
- package/resources/checkout-configurations.js.map +1 -0
- package/resources/checkout-configurations.mjs +62 -0
- package/resources/checkout-configurations.mjs.map +1 -0
- package/resources/companies.d.mts +15 -0
- package/resources/companies.d.mts.map +1 -0
- package/resources/companies.d.ts +15 -0
- package/resources/companies.d.ts.map +1 -0
- package/resources/companies.js +20 -0
- package/resources/companies.js.map +1 -0
- package/resources/companies.mjs +16 -0
- package/resources/companies.mjs.map +1 -0
- package/resources/course-lesson-interactions.d.mts +61 -0
- package/resources/course-lesson-interactions.d.mts.map +1 -0
- package/resources/course-lesson-interactions.d.ts +61 -0
- package/resources/course-lesson-interactions.d.ts.map +1 -0
- package/resources/course-lesson-interactions.js +33 -0
- package/resources/course-lesson-interactions.js.map +1 -0
- package/resources/course-lesson-interactions.mjs +29 -0
- package/resources/course-lesson-interactions.mjs.map +1 -0
- package/resources/entries.d.mts +169 -0
- package/resources/entries.d.mts.map +1 -0
- package/resources/entries.d.ts +169 -0
- package/resources/entries.d.ts.map +1 -0
- package/resources/entries.js +55 -0
- package/resources/entries.js.map +1 -0
- package/resources/entries.mjs +51 -0
- package/resources/entries.mjs.map +1 -0
- package/resources/experiences.d.mts +277 -0
- package/resources/experiences.d.mts.map +1 -0
- package/resources/experiences.d.ts +277 -0
- package/resources/experiences.d.ts.map +1 -0
- package/resources/experiences.js +128 -0
- package/resources/experiences.js.map +1 -0
- package/resources/experiences.mjs +124 -0
- package/resources/experiences.mjs.map +1 -0
- package/resources/forum-posts.d.mts +242 -0
- package/resources/forum-posts.d.mts.map +1 -0
- package/resources/forum-posts.d.ts +242 -0
- package/resources/forum-posts.d.ts.map +1 -0
- package/resources/forum-posts.js +63 -0
- package/resources/forum-posts.js.map +1 -0
- package/resources/forum-posts.mjs +59 -0
- package/resources/forum-posts.mjs.map +1 -0
- package/resources/index.d.mts +25 -0
- package/resources/index.d.mts.map +1 -0
- package/resources/index.d.ts +25 -0
- package/resources/index.d.ts.map +1 -0
- package/resources/index.js +53 -0
- package/resources/index.js.map +1 -0
- package/resources/index.mjs +26 -0
- package/resources/index.mjs.map +1 -0
- package/resources/invoices.d.mts +296 -0
- package/resources/invoices.d.mts.map +1 -0
- package/resources/invoices.d.ts +296 -0
- package/resources/invoices.d.ts.map +1 -0
- package/resources/invoices.js +88 -0
- package/resources/invoices.js.map +1 -0
- package/resources/invoices.mjs +84 -0
- package/resources/invoices.mjs.map +1 -0
- package/resources/ledger-accounts.d.mts +116 -0
- package/resources/ledger-accounts.d.mts.map +1 -0
- package/resources/ledger-accounts.d.ts +116 -0
- package/resources/ledger-accounts.d.ts.map +1 -0
- package/resources/ledger-accounts.js +20 -0
- package/resources/ledger-accounts.js.map +1 -0
- package/resources/ledger-accounts.mjs +16 -0
- package/resources/ledger-accounts.mjs.map +1 -0
- package/resources/memberships.d.mts +287 -0
- package/resources/memberships.d.mts.map +1 -0
- package/resources/memberships.d.ts +287 -0
- package/resources/memberships.d.ts.map +1 -0
- package/resources/memberships.js +76 -0
- package/resources/memberships.js.map +1 -0
- package/resources/memberships.mjs +72 -0
- package/resources/memberships.mjs.map +1 -0
- package/resources/messages.d.mts +245 -0
- package/resources/messages.d.mts.map +1 -0
- package/resources/messages.d.ts +245 -0
- package/resources/messages.d.ts.map +1 -0
- package/resources/messages.js +41 -0
- package/resources/messages.js.map +1 -0
- package/resources/messages.mjs +37 -0
- package/resources/messages.mjs.map +1 -0
- package/resources/payments.d.mts +472 -0
- package/resources/payments.d.mts.map +1 -0
- package/resources/payments.d.ts +472 -0
- package/resources/payments.d.ts.map +1 -0
- package/resources/payments.js +129 -0
- package/resources/payments.js.map +1 -0
- package/resources/payments.mjs +125 -0
- package/resources/payments.mjs.map +1 -0
- package/resources/plans.d.mts +479 -0
- package/resources/plans.d.mts.map +1 -0
- package/resources/plans.d.ts +479 -0
- package/resources/plans.d.ts.map +1 -0
- package/resources/plans.js +104 -0
- package/resources/plans.js.map +1 -0
- package/resources/plans.mjs +100 -0
- package/resources/plans.mjs.map +1 -0
- package/resources/products.d.mts +425 -0
- package/resources/products.d.mts.map +1 -0
- package/resources/products.d.ts +425 -0
- package/resources/products.d.ts.map +1 -0
- package/resources/products.js +102 -0
- package/resources/products.js.map +1 -0
- package/resources/products.mjs +98 -0
- package/resources/products.mjs.map +1 -0
- package/resources/reactions.d.mts +105 -0
- package/resources/reactions.d.mts.map +1 -0
- package/resources/reactions.d.ts +105 -0
- package/resources/reactions.d.ts.map +1 -0
- package/resources/reactions.js +41 -0
- package/resources/reactions.js.map +1 -0
- package/resources/reactions.mjs +37 -0
- package/resources/reactions.mjs.map +1 -0
- package/resources/shared.d.mts +2309 -0
- package/resources/shared.d.mts.map +1 -0
- package/resources/shared.d.ts +2309 -0
- package/resources/shared.d.ts.map +1 -0
- package/resources/shared.js +4 -0
- package/resources/shared.js.map +1 -0
- package/resources/shared.mjs +3 -0
- package/resources/shared.mjs.map +1 -0
- package/resources/shipments.d.mts +159 -0
- package/resources/shipments.d.mts.map +1 -0
- package/resources/shipments.d.ts +159 -0
- package/resources/shipments.d.ts.map +1 -0
- package/resources/shipments.js +68 -0
- package/resources/shipments.js.map +1 -0
- package/resources/shipments.mjs +64 -0
- package/resources/shipments.mjs.map +1 -0
- package/resources/support-channels.d.mts +151 -0
- package/resources/support-channels.d.mts.map +1 -0
- package/resources/support-channels.d.ts +151 -0
- package/resources/support-channels.d.ts.map +1 -0
- package/resources/support-channels.js +69 -0
- package/resources/support-channels.js.map +1 -0
- package/resources/support-channels.mjs +65 -0
- package/resources/support-channels.mjs.map +1 -0
- package/resources/transfers.d.mts +158 -0
- package/resources/transfers.d.mts.map +1 -0
- package/resources/transfers.d.ts +158 -0
- package/resources/transfers.d.ts.map +1 -0
- package/resources/transfers.js +66 -0
- package/resources/transfers.js.map +1 -0
- package/resources/transfers.mjs +62 -0
- package/resources/transfers.mjs.map +1 -0
- package/resources/users.d.mts +58 -0
- package/resources/users.d.mts.map +1 -0
- package/resources/users.d.ts +58 -0
- package/resources/users.d.ts.map +1 -0
- package/resources/users.js +23 -0
- package/resources/users.js.map +1 -0
- package/resources/users.mjs +19 -0
- package/resources/users.mjs.map +1 -0
- package/resources/webhooks.d.mts +101 -0
- package/resources/webhooks.d.mts.map +1 -0
- package/resources/webhooks.d.ts +101 -0
- package/resources/webhooks.d.ts.map +1 -0
- package/resources/webhooks.js +20 -0
- package/resources/webhooks.js.map +1 -0
- package/resources/webhooks.mjs +16 -0
- package/resources/webhooks.mjs.map +1 -0
- package/resources.d.mts +2 -0
- package/resources.d.mts.map +1 -0
- package/resources.d.ts +2 -0
- package/resources.d.ts.map +1 -0
- package/resources.js +5 -0
- package/resources.js.map +1 -0
- package/resources.mjs +2 -0
- package/resources.mjs.map +1 -0
- package/src/api-promise.ts +2 -0
- package/src/client.ts +1197 -0
- package/src/core/README.md +3 -0
- package/src/core/api-promise.ts +92 -0
- package/src/core/error.ts +130 -0
- package/src/core/pagination.ts +161 -0
- package/src/core/resource.ts +11 -0
- package/src/core/uploads.ts +2 -0
- package/src/error.ts +2 -0
- package/src/index.ts +23 -0
- package/src/internal/README.md +3 -0
- package/src/internal/builtin-types.ts +93 -0
- package/src/internal/detect-platform.ts +196 -0
- package/src/internal/errors.ts +33 -0
- package/src/internal/headers.ts +97 -0
- package/src/internal/parse.ts +50 -0
- package/src/internal/qs/LICENSE.md +13 -0
- package/src/internal/qs/README.md +3 -0
- package/src/internal/qs/formats.ts +10 -0
- package/src/internal/qs/index.ts +13 -0
- package/src/internal/qs/stringify.ts +385 -0
- package/src/internal/qs/types.ts +71 -0
- package/src/internal/qs/utils.ts +265 -0
- package/src/internal/request-options.ts +91 -0
- package/src/internal/shim-types.ts +26 -0
- package/src/internal/shims.ts +107 -0
- package/src/internal/to-file.ts +154 -0
- package/src/internal/types.ts +95 -0
- package/src/internal/uploads.ts +187 -0
- package/src/internal/utils/base64.ts +40 -0
- package/src/internal/utils/bytes.ts +32 -0
- package/src/internal/utils/env.ts +18 -0
- package/src/internal/utils/log.ts +126 -0
- package/src/internal/utils/path.ts +88 -0
- package/src/internal/utils/sleep.ts +3 -0
- package/src/internal/utils/uuid.ts +17 -0
- package/src/internal/utils/values.ts +105 -0
- package/src/internal/utils.ts +8 -0
- package/src/lib/.keep +4 -0
- package/src/lib/verify-user-token.ts +121 -0
- package/src/pagination.ts +2 -0
- package/src/resource.ts +2 -0
- package/src/resources/app-builds.ts +242 -0
- package/src/resources/apps.ts +355 -0
- package/src/resources/authorized-users.ts +177 -0
- package/src/resources/chat-channels.ts +207 -0
- package/src/resources/checkout-configurations.ts +397 -0
- package/src/resources/companies.ts +20 -0
- package/src/resources/course-lesson-interactions.ts +85 -0
- package/src/resources/entries.ts +216 -0
- package/src/resources/experiences.ts +349 -0
- package/src/resources/forum-posts.ts +298 -0
- package/src/resources/index.ts +158 -0
- package/src/resources/invoices.ts +363 -0
- package/src/resources/ledger-accounts.ts +141 -0
- package/src/resources/memberships.ts +378 -0
- package/src/resources/messages.ts +303 -0
- package/src/resources/payments.ts +585 -0
- package/src/resources/plans.ts +594 -0
- package/src/resources/products.ts +527 -0
- package/src/resources/reactions.ts +139 -0
- package/src/resources/shared.ts +3086 -0
- package/src/resources/shipments.ts +200 -0
- package/src/resources/support-channels.ts +193 -0
- package/src/resources/transfers.ts +200 -0
- package/src/resources/users.ts +84 -0
- package/src/resources/webhooks.ts +144 -0
- package/src/resources.ts +1 -0
- package/src/tsconfig.json +11 -0
- package/src/uploads.ts +2 -0
- package/src/version.ts +1 -0
- package/uploads.d.mts +2 -0
- package/uploads.d.mts.map +1 -0
- package/uploads.d.ts +2 -0
- package/uploads.d.ts.map +1 -0
- package/uploads.js +6 -0
- package/uploads.js.map +1 -0
- package/uploads.mjs +2 -0
- package/uploads.mjs.map +1 -0
- package/version.d.mts +2 -0
- package/version.d.mts.map +1 -0
- package/version.d.ts +2 -0
- package/version.d.ts.map +1 -0
- package/version.js +5 -0
- package/version.js.map +1 -0
- package/version.mjs +2 -0
- package/version.mjs.map +1 -0
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../core/resource.mjs";
|
|
3
|
+
import { CursorPage } from "../core/pagination.mjs";
|
|
4
|
+
import { path } from "../internal/utils/path.mjs";
|
|
5
|
+
export class Payments extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Retrieves a payment by ID
|
|
8
|
+
*
|
|
9
|
+
* Required permissions:
|
|
10
|
+
*
|
|
11
|
+
* - `payment:basic:read`
|
|
12
|
+
* - `plan:basic:read`
|
|
13
|
+
* - `access_pass:basic:read`
|
|
14
|
+
* - `member:email:read`
|
|
15
|
+
* - `member:basic:read`
|
|
16
|
+
* - `member:phone:read`
|
|
17
|
+
* - `promo_code:basic:read`
|
|
18
|
+
*
|
|
19
|
+
* @example
|
|
20
|
+
* ```ts
|
|
21
|
+
* const payment = await client.payments.retrieve(
|
|
22
|
+
* 'pay_xxxxxxxxxxxxxx',
|
|
23
|
+
* );
|
|
24
|
+
* ```
|
|
25
|
+
*/
|
|
26
|
+
retrieve(id, options) {
|
|
27
|
+
return this._client.get(path `/payments/${id}`, options);
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Lists payments
|
|
31
|
+
*
|
|
32
|
+
* Required permissions:
|
|
33
|
+
*
|
|
34
|
+
* - `payment:basic:read`
|
|
35
|
+
* - `plan:basic:read`
|
|
36
|
+
* - `access_pass:basic:read`
|
|
37
|
+
* - `member:email:read`
|
|
38
|
+
* - `member:basic:read`
|
|
39
|
+
* - `member:phone:read`
|
|
40
|
+
* - `promo_code:basic:read`
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* ```ts
|
|
44
|
+
* // Automatically fetches more pages as needed.
|
|
45
|
+
* for await (const paymentListResponse of client.payments.list(
|
|
46
|
+
* { company_id: 'biz_xxxxxxxxxxxxxx' },
|
|
47
|
+
* )) {
|
|
48
|
+
* // ...
|
|
49
|
+
* }
|
|
50
|
+
* ```
|
|
51
|
+
*/
|
|
52
|
+
list(query, options) {
|
|
53
|
+
return this._client.getAPIList('/payments', (CursorPage), { query, ...options });
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Refunds a payment
|
|
57
|
+
*
|
|
58
|
+
* Required permissions:
|
|
59
|
+
*
|
|
60
|
+
* - `payment:manage`
|
|
61
|
+
* - `plan:basic:read`
|
|
62
|
+
* - `access_pass:basic:read`
|
|
63
|
+
* - `member:email:read`
|
|
64
|
+
* - `member:basic:read`
|
|
65
|
+
* - `member:phone:read`
|
|
66
|
+
* - `promo_code:basic:read`
|
|
67
|
+
*
|
|
68
|
+
* @example
|
|
69
|
+
* ```ts
|
|
70
|
+
* const payment = await client.payments.refund(
|
|
71
|
+
* 'pay_xxxxxxxxxxxxxx',
|
|
72
|
+
* );
|
|
73
|
+
* ```
|
|
74
|
+
*/
|
|
75
|
+
refund(id, body = {}, options) {
|
|
76
|
+
return this._client.post(path `/payments/${id}/refund`, { body, ...options });
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* Retries a payment
|
|
80
|
+
*
|
|
81
|
+
* Required permissions:
|
|
82
|
+
*
|
|
83
|
+
* - `payment:manage`
|
|
84
|
+
* - `plan:basic:read`
|
|
85
|
+
* - `access_pass:basic:read`
|
|
86
|
+
* - `member:email:read`
|
|
87
|
+
* - `member:basic:read`
|
|
88
|
+
* - `member:phone:read`
|
|
89
|
+
* - `promo_code:basic:read`
|
|
90
|
+
*
|
|
91
|
+
* @example
|
|
92
|
+
* ```ts
|
|
93
|
+
* const payment = await client.payments.retry(
|
|
94
|
+
* 'pay_xxxxxxxxxxxxxx',
|
|
95
|
+
* );
|
|
96
|
+
* ```
|
|
97
|
+
*/
|
|
98
|
+
retry(id, options) {
|
|
99
|
+
return this._client.post(path `/payments/${id}/retry`, options);
|
|
100
|
+
}
|
|
101
|
+
/**
|
|
102
|
+
* Voids a payment
|
|
103
|
+
*
|
|
104
|
+
* Required permissions:
|
|
105
|
+
*
|
|
106
|
+
* - `payment:manage`
|
|
107
|
+
* - `plan:basic:read`
|
|
108
|
+
* - `access_pass:basic:read`
|
|
109
|
+
* - `member:email:read`
|
|
110
|
+
* - `member:basic:read`
|
|
111
|
+
* - `member:phone:read`
|
|
112
|
+
* - `promo_code:basic:read`
|
|
113
|
+
*
|
|
114
|
+
* @example
|
|
115
|
+
* ```ts
|
|
116
|
+
* const payment = await client.payments.void(
|
|
117
|
+
* 'pay_xxxxxxxxxxxxxx',
|
|
118
|
+
* );
|
|
119
|
+
* ```
|
|
120
|
+
*/
|
|
121
|
+
void(id, options) {
|
|
122
|
+
return this._client.post(path `/payments/${id}/void`, options);
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
//# sourceMappingURL=payments.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"payments.mjs","sourceRoot":"","sources":["../src/resources/payments.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,IAAI,CACF,KAAwB,EACxB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA,UAA+B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACJ,EAAU,EACV,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,EAAU,EAAE,OAAwB;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,CAAC,EAAU,EAAE,OAAwB;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;CACF"}
|
|
@@ -0,0 +1,479 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import * as Shared from "./shared.mjs";
|
|
3
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
4
|
+
import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.mjs";
|
|
5
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
6
|
+
export declare class Plans extends APIResource {
|
|
7
|
+
/**
|
|
8
|
+
* Create a new Plan
|
|
9
|
+
*
|
|
10
|
+
* Required permissions:
|
|
11
|
+
*
|
|
12
|
+
* - `plan:create`
|
|
13
|
+
* - `access_pass:basic:read`
|
|
14
|
+
* - `plan:basic:read`
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```ts
|
|
18
|
+
* const plan = await client.plans.create({
|
|
19
|
+
* company_id: 'biz_xxxxxxxxxxxxxx',
|
|
20
|
+
* product_id: 'prod_xxxxxxxxxxxxx',
|
|
21
|
+
* });
|
|
22
|
+
* ```
|
|
23
|
+
*/
|
|
24
|
+
create(body: PlanCreateParams, options?: RequestOptions): APIPromise<Shared.Plan>;
|
|
25
|
+
/**
|
|
26
|
+
* Retrieves a plan by ID
|
|
27
|
+
*
|
|
28
|
+
* Required permissions:
|
|
29
|
+
*
|
|
30
|
+
* - `plan:basic:read`
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* ```ts
|
|
34
|
+
* const plan = await client.plans.retrieve(
|
|
35
|
+
* 'plan_xxxxxxxxxxxxx',
|
|
36
|
+
* );
|
|
37
|
+
* ```
|
|
38
|
+
*/
|
|
39
|
+
retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Plan>;
|
|
40
|
+
/**
|
|
41
|
+
* Update an existing Plan
|
|
42
|
+
*
|
|
43
|
+
* Required permissions:
|
|
44
|
+
*
|
|
45
|
+
* - `plan:update`
|
|
46
|
+
* - `access_pass:basic:read`
|
|
47
|
+
* - `plan:basic:read`
|
|
48
|
+
*
|
|
49
|
+
* @example
|
|
50
|
+
* ```ts
|
|
51
|
+
* const plan = await client.plans.update(
|
|
52
|
+
* 'plan_xxxxxxxxxxxxx',
|
|
53
|
+
* );
|
|
54
|
+
* ```
|
|
55
|
+
*/
|
|
56
|
+
update(id: string, body?: PlanUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Shared.Plan>;
|
|
57
|
+
/**
|
|
58
|
+
* Lists plans for a company
|
|
59
|
+
*
|
|
60
|
+
* Required permissions:
|
|
61
|
+
*
|
|
62
|
+
* - `plan:basic:read`
|
|
63
|
+
*
|
|
64
|
+
* @example
|
|
65
|
+
* ```ts
|
|
66
|
+
* // Automatically fetches more pages as needed.
|
|
67
|
+
* for await (const planListResponse of client.plans.list({
|
|
68
|
+
* company_id: 'biz_xxxxxxxxxxxxxx',
|
|
69
|
+
* })) {
|
|
70
|
+
* // ...
|
|
71
|
+
* }
|
|
72
|
+
* ```
|
|
73
|
+
*/
|
|
74
|
+
list(query: PlanListParams, options?: RequestOptions): PagePromise<PlanListResponsesCursorPage, PlanListResponse>;
|
|
75
|
+
/**
|
|
76
|
+
* Delete an existing Plan
|
|
77
|
+
*
|
|
78
|
+
* Required permissions:
|
|
79
|
+
*
|
|
80
|
+
* - `plan:delete`
|
|
81
|
+
*
|
|
82
|
+
* @example
|
|
83
|
+
* ```ts
|
|
84
|
+
* const plan = await client.plans.delete(
|
|
85
|
+
* 'plan_xxxxxxxxxxxxx',
|
|
86
|
+
* );
|
|
87
|
+
* ```
|
|
88
|
+
*/
|
|
89
|
+
delete(id: string, options?: RequestOptions): APIPromise<PlanDeleteResponse>;
|
|
90
|
+
}
|
|
91
|
+
export type PlanListResponsesCursorPage = CursorPage<PlanListResponse>;
|
|
92
|
+
/**
|
|
93
|
+
* An object representing a (sanitized) plan of an access pass.
|
|
94
|
+
*/
|
|
95
|
+
export interface PlanListResponse {
|
|
96
|
+
/**
|
|
97
|
+
* The internal ID of the plan.
|
|
98
|
+
*/
|
|
99
|
+
id: string;
|
|
100
|
+
/**
|
|
101
|
+
* The interval at which the plan charges (renewal plans).
|
|
102
|
+
*/
|
|
103
|
+
billing_period: number | null;
|
|
104
|
+
/**
|
|
105
|
+
* The company for the plan.
|
|
106
|
+
*/
|
|
107
|
+
company: PlanListResponse.Company | null;
|
|
108
|
+
/**
|
|
109
|
+
* When the plan was created.
|
|
110
|
+
*/
|
|
111
|
+
created_at: string;
|
|
112
|
+
/**
|
|
113
|
+
* The respective currency identifier for the plan.
|
|
114
|
+
*/
|
|
115
|
+
currency: Shared.Currency;
|
|
116
|
+
/**
|
|
117
|
+
* The description of the plan.
|
|
118
|
+
*/
|
|
119
|
+
description: string | null;
|
|
120
|
+
/**
|
|
121
|
+
* The interval at which the plan charges (expiration plans).
|
|
122
|
+
*/
|
|
123
|
+
expiration_days: number | null;
|
|
124
|
+
/**
|
|
125
|
+
* The price a person has to pay for a plan on the initial purchase.
|
|
126
|
+
*/
|
|
127
|
+
initial_price: number;
|
|
128
|
+
/**
|
|
129
|
+
* A personal description or notes section for the business.
|
|
130
|
+
*/
|
|
131
|
+
internal_notes: string | null;
|
|
132
|
+
/**
|
|
133
|
+
* The invoice associated with this plan.
|
|
134
|
+
*/
|
|
135
|
+
invoice: PlanListResponse.Invoice | null;
|
|
136
|
+
/**
|
|
137
|
+
* The number of members for the plan.
|
|
138
|
+
*/
|
|
139
|
+
member_count: number | null;
|
|
140
|
+
/**
|
|
141
|
+
* Indicates if the plan is a one time payment or recurring.
|
|
142
|
+
*/
|
|
143
|
+
plan_type: Shared.PlanType;
|
|
144
|
+
/**
|
|
145
|
+
* The access pass for the plan.
|
|
146
|
+
*/
|
|
147
|
+
product: PlanListResponse.Product | null;
|
|
148
|
+
/**
|
|
149
|
+
* The direct link to purchase the product.
|
|
150
|
+
*/
|
|
151
|
+
purchase_url: string;
|
|
152
|
+
/**
|
|
153
|
+
* This is the release method the business uses to sell this plan.
|
|
154
|
+
*/
|
|
155
|
+
release_method: Shared.ReleaseMethod;
|
|
156
|
+
/**
|
|
157
|
+
* The price a person has to pay for a plan on the renewal purchase.
|
|
158
|
+
*/
|
|
159
|
+
renewal_price: number;
|
|
160
|
+
/**
|
|
161
|
+
* The number of free trial days added before a renewal plan.
|
|
162
|
+
*/
|
|
163
|
+
trial_period_days: number | null;
|
|
164
|
+
/**
|
|
165
|
+
* When the plan was last updated.
|
|
166
|
+
*/
|
|
167
|
+
updated_at: string;
|
|
168
|
+
/**
|
|
169
|
+
* Shows or hides the plan from public/business view.
|
|
170
|
+
*/
|
|
171
|
+
visibility: Shared.Visibility;
|
|
172
|
+
}
|
|
173
|
+
export declare namespace PlanListResponse {
|
|
174
|
+
/**
|
|
175
|
+
* The company for the plan.
|
|
176
|
+
*/
|
|
177
|
+
interface Company {
|
|
178
|
+
/**
|
|
179
|
+
* The ID (tag) of the company.
|
|
180
|
+
*/
|
|
181
|
+
id: string;
|
|
182
|
+
/**
|
|
183
|
+
* The title of the company.
|
|
184
|
+
*/
|
|
185
|
+
title: string;
|
|
186
|
+
}
|
|
187
|
+
/**
|
|
188
|
+
* The invoice associated with this plan.
|
|
189
|
+
*/
|
|
190
|
+
interface Invoice {
|
|
191
|
+
/**
|
|
192
|
+
* The ID of the invoice.
|
|
193
|
+
*/
|
|
194
|
+
id: string;
|
|
195
|
+
}
|
|
196
|
+
/**
|
|
197
|
+
* The access pass for the plan.
|
|
198
|
+
*/
|
|
199
|
+
interface Product {
|
|
200
|
+
/**
|
|
201
|
+
* The internal ID of the public product.
|
|
202
|
+
*/
|
|
203
|
+
id: string;
|
|
204
|
+
/**
|
|
205
|
+
* The title of the product. Use for Whop 4.0.
|
|
206
|
+
*/
|
|
207
|
+
title: string;
|
|
208
|
+
}
|
|
209
|
+
}
|
|
210
|
+
/**
|
|
211
|
+
* Represents `true` or `false` values.
|
|
212
|
+
*/
|
|
213
|
+
export type PlanDeleteResponse = boolean;
|
|
214
|
+
export interface PlanCreateParams {
|
|
215
|
+
/**
|
|
216
|
+
* The company the plan should be created for.
|
|
217
|
+
*/
|
|
218
|
+
company_id: string;
|
|
219
|
+
/**
|
|
220
|
+
* The product the plan is related to.
|
|
221
|
+
*/
|
|
222
|
+
product_id: string;
|
|
223
|
+
/**
|
|
224
|
+
* The interval at which the plan charges (renewal plans).
|
|
225
|
+
*/
|
|
226
|
+
billing_period?: number | null;
|
|
227
|
+
/**
|
|
228
|
+
* The available currencies on the platform
|
|
229
|
+
*/
|
|
230
|
+
currency?: Shared.Currency | null;
|
|
231
|
+
/**
|
|
232
|
+
* An array of custom field objects.
|
|
233
|
+
*/
|
|
234
|
+
custom_fields?: Array<PlanCreateParams.CustomField> | null;
|
|
235
|
+
/**
|
|
236
|
+
* The description of the plan.
|
|
237
|
+
*/
|
|
238
|
+
description?: string | null;
|
|
239
|
+
/**
|
|
240
|
+
* The interval at which the plan charges (expiration plans).
|
|
241
|
+
*/
|
|
242
|
+
expiration_days?: number | null;
|
|
243
|
+
/**
|
|
244
|
+
* An image for the plan. This will be visible on the product page to customers.
|
|
245
|
+
*/
|
|
246
|
+
image?: PlanCreateParams.Image | null;
|
|
247
|
+
/**
|
|
248
|
+
* An additional amount charged upon first purchase.
|
|
249
|
+
*/
|
|
250
|
+
initial_price?: number | null;
|
|
251
|
+
/**
|
|
252
|
+
* A personal description or notes section for the business.
|
|
253
|
+
*/
|
|
254
|
+
internal_notes?: string | null;
|
|
255
|
+
/**
|
|
256
|
+
* Whether or not the tax is included in a plan's price (or if it hasn't been set
|
|
257
|
+
* up)
|
|
258
|
+
*/
|
|
259
|
+
override_tax_type?: Shared.TaxType | null;
|
|
260
|
+
/**
|
|
261
|
+
* The type of plan that can be attached to an access pass
|
|
262
|
+
*/
|
|
263
|
+
plan_type?: Shared.PlanType | null;
|
|
264
|
+
/**
|
|
265
|
+
* The methods of how a plan can be released.
|
|
266
|
+
*/
|
|
267
|
+
release_method?: Shared.ReleaseMethod | null;
|
|
268
|
+
/**
|
|
269
|
+
* The amount the customer is charged every billing period.
|
|
270
|
+
*/
|
|
271
|
+
renewal_price?: number | null;
|
|
272
|
+
/**
|
|
273
|
+
* The title of the plan. This will be visible on the product page to customers.
|
|
274
|
+
*/
|
|
275
|
+
title?: string | null;
|
|
276
|
+
/**
|
|
277
|
+
* The number of free trial days added before a renewal plan.
|
|
278
|
+
*/
|
|
279
|
+
trial_period_days?: number | null;
|
|
280
|
+
/**
|
|
281
|
+
* Visibility of a resource
|
|
282
|
+
*/
|
|
283
|
+
visibility?: Shared.Visibility | null;
|
|
284
|
+
}
|
|
285
|
+
export declare namespace PlanCreateParams {
|
|
286
|
+
interface CustomField {
|
|
287
|
+
/**
|
|
288
|
+
* The type of the custom field.
|
|
289
|
+
*/
|
|
290
|
+
field_type: 'text';
|
|
291
|
+
/**
|
|
292
|
+
* The name of the custom field.
|
|
293
|
+
*/
|
|
294
|
+
name: string;
|
|
295
|
+
/**
|
|
296
|
+
* The ID of the custom field (if being updated)
|
|
297
|
+
*/
|
|
298
|
+
id?: string | null;
|
|
299
|
+
/**
|
|
300
|
+
* The order of the field.
|
|
301
|
+
*/
|
|
302
|
+
order?: number | null;
|
|
303
|
+
/**
|
|
304
|
+
* The placeholder value of the field.
|
|
305
|
+
*/
|
|
306
|
+
placeholder?: string | null;
|
|
307
|
+
/**
|
|
308
|
+
* Whether or not the field is required.
|
|
309
|
+
*/
|
|
310
|
+
required?: boolean | null;
|
|
311
|
+
}
|
|
312
|
+
/**
|
|
313
|
+
* An image for the plan. This will be visible on the product page to customers.
|
|
314
|
+
*/
|
|
315
|
+
interface Image {
|
|
316
|
+
/**
|
|
317
|
+
* The ID of an existing attachment object. Use this when updating a resource and
|
|
318
|
+
* keeping a subset of the attachments. Don't use this unless you know what you're
|
|
319
|
+
* doing.
|
|
320
|
+
*/
|
|
321
|
+
id?: string | null;
|
|
322
|
+
/**
|
|
323
|
+
* This ID should be used the first time you upload an attachment. It is the ID of
|
|
324
|
+
* the direct upload that was created when uploading the file to S3 via the
|
|
325
|
+
* mediaDirectUpload mutation.
|
|
326
|
+
*/
|
|
327
|
+
direct_upload_id?: string | null;
|
|
328
|
+
}
|
|
329
|
+
}
|
|
330
|
+
export interface PlanUpdateParams {
|
|
331
|
+
/**
|
|
332
|
+
* The interval at which the plan charges (renewal plans).
|
|
333
|
+
*/
|
|
334
|
+
billing_period?: number | null;
|
|
335
|
+
/**
|
|
336
|
+
* The available currencies on the platform
|
|
337
|
+
*/
|
|
338
|
+
currency?: Shared.Currency | null;
|
|
339
|
+
/**
|
|
340
|
+
* An array of custom field objects.
|
|
341
|
+
*/
|
|
342
|
+
custom_fields?: Array<PlanUpdateParams.CustomField> | null;
|
|
343
|
+
/**
|
|
344
|
+
* The description of the plan.
|
|
345
|
+
*/
|
|
346
|
+
description?: string | null;
|
|
347
|
+
/**
|
|
348
|
+
* The interval at which the plan charges (expiration plans).
|
|
349
|
+
*/
|
|
350
|
+
expiration_days?: number | null;
|
|
351
|
+
/**
|
|
352
|
+
* An image for the plan. This will be visible on the product page to customers.
|
|
353
|
+
*/
|
|
354
|
+
image?: PlanUpdateParams.Image | null;
|
|
355
|
+
/**
|
|
356
|
+
* An additional amount charged upon first purchase.
|
|
357
|
+
*/
|
|
358
|
+
initial_price?: number | null;
|
|
359
|
+
/**
|
|
360
|
+
* A personal description or notes section for the business.
|
|
361
|
+
*/
|
|
362
|
+
internal_notes?: string | null;
|
|
363
|
+
/**
|
|
364
|
+
* Whether or not to offer a discount to cancel a subscription.
|
|
365
|
+
*/
|
|
366
|
+
offer_cancel_discount?: boolean | null;
|
|
367
|
+
/**
|
|
368
|
+
* Whether or not the tax is included in a plan's price (or if it hasn't been set
|
|
369
|
+
* up)
|
|
370
|
+
*/
|
|
371
|
+
override_tax_type?: Shared.TaxType | null;
|
|
372
|
+
/**
|
|
373
|
+
* The amount the customer is charged every billing period.
|
|
374
|
+
*/
|
|
375
|
+
renewal_price?: number | null;
|
|
376
|
+
/**
|
|
377
|
+
* The title of the plan. This will be visible on the product page to customers.
|
|
378
|
+
*/
|
|
379
|
+
title?: string | null;
|
|
380
|
+
/**
|
|
381
|
+
* The number of free trial days added before a renewal plan.
|
|
382
|
+
*/
|
|
383
|
+
trial_period_days?: number | null;
|
|
384
|
+
/**
|
|
385
|
+
* Visibility of a resource
|
|
386
|
+
*/
|
|
387
|
+
visibility?: Shared.Visibility | null;
|
|
388
|
+
}
|
|
389
|
+
export declare namespace PlanUpdateParams {
|
|
390
|
+
interface CustomField {
|
|
391
|
+
/**
|
|
392
|
+
* The type of the custom field.
|
|
393
|
+
*/
|
|
394
|
+
field_type: 'text';
|
|
395
|
+
/**
|
|
396
|
+
* The name of the custom field.
|
|
397
|
+
*/
|
|
398
|
+
name: string;
|
|
399
|
+
/**
|
|
400
|
+
* The ID of the custom field (if being updated)
|
|
401
|
+
*/
|
|
402
|
+
id?: string | null;
|
|
403
|
+
/**
|
|
404
|
+
* The order of the field.
|
|
405
|
+
*/
|
|
406
|
+
order?: number | null;
|
|
407
|
+
/**
|
|
408
|
+
* The placeholder value of the field.
|
|
409
|
+
*/
|
|
410
|
+
placeholder?: string | null;
|
|
411
|
+
/**
|
|
412
|
+
* Whether or not the field is required.
|
|
413
|
+
*/
|
|
414
|
+
required?: boolean | null;
|
|
415
|
+
}
|
|
416
|
+
/**
|
|
417
|
+
* An image for the plan. This will be visible on the product page to customers.
|
|
418
|
+
*/
|
|
419
|
+
interface Image {
|
|
420
|
+
/**
|
|
421
|
+
* The ID of an existing attachment object. Use this when updating a resource and
|
|
422
|
+
* keeping a subset of the attachments. Don't use this unless you know what you're
|
|
423
|
+
* doing.
|
|
424
|
+
*/
|
|
425
|
+
id?: string | null;
|
|
426
|
+
/**
|
|
427
|
+
* This ID should be used the first time you upload an attachment. It is the ID of
|
|
428
|
+
* the direct upload that was created when uploading the file to S3 via the
|
|
429
|
+
* mediaDirectUpload mutation.
|
|
430
|
+
*/
|
|
431
|
+
direct_upload_id?: string | null;
|
|
432
|
+
}
|
|
433
|
+
}
|
|
434
|
+
export interface PlanListParams extends CursorPageParams {
|
|
435
|
+
/**
|
|
436
|
+
* The ID of the company
|
|
437
|
+
*/
|
|
438
|
+
company_id: string;
|
|
439
|
+
/**
|
|
440
|
+
* Returns the elements in the list that come before the specified cursor.
|
|
441
|
+
*/
|
|
442
|
+
before?: string | null;
|
|
443
|
+
/**
|
|
444
|
+
* The direction of the sort.
|
|
445
|
+
*/
|
|
446
|
+
direction?: Shared.Direction | null;
|
|
447
|
+
/**
|
|
448
|
+
* Returns the first _n_ elements from the list.
|
|
449
|
+
*/
|
|
450
|
+
first?: number | null;
|
|
451
|
+
/**
|
|
452
|
+
* Returns the last _n_ elements from the list.
|
|
453
|
+
*/
|
|
454
|
+
last?: number | null;
|
|
455
|
+
/**
|
|
456
|
+
* The ways a relation of Plans can be ordered
|
|
457
|
+
*/
|
|
458
|
+
order?: 'id' | 'active_members_count' | 'created_at' | 'internal_notes' | 'expires_at' | null;
|
|
459
|
+
/**
|
|
460
|
+
* The plan type to filter the plans by
|
|
461
|
+
*/
|
|
462
|
+
plan_types?: Array<Shared.PlanType> | null;
|
|
463
|
+
/**
|
|
464
|
+
* The product IDs to filter the plans by
|
|
465
|
+
*/
|
|
466
|
+
product_ids?: Array<string> | null;
|
|
467
|
+
/**
|
|
468
|
+
* The release method to filter the plans by
|
|
469
|
+
*/
|
|
470
|
+
release_methods?: Array<Shared.ReleaseMethod> | null;
|
|
471
|
+
/**
|
|
472
|
+
* The visibility to filter the plans by
|
|
473
|
+
*/
|
|
474
|
+
visibilities?: Array<Shared.VisibilityFilter> | null;
|
|
475
|
+
}
|
|
476
|
+
export declare namespace Plans {
|
|
477
|
+
export { type PlanListResponse as PlanListResponse, type PlanDeleteResponse as PlanDeleteResponse, type PlanListResponsesCursorPage as PlanListResponsesCursorPage, type PlanCreateParams as PlanCreateParams, type PlanUpdateParams as PlanUpdateParams, type PlanListParams as PlanListParams, };
|
|
478
|
+
}
|
|
479
|
+
//# sourceMappingURL=plans.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"plans.d.mts","sourceRoot":"","sources":["../src/resources/plans.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,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC;IAIjF;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC;IAIvE;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC;IAI1B;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,EAAE,cAAc,EACrB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,2BAA2B,EAAE,gBAAgB,CAAC;IAI7D;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAG7E;AAED,MAAM,MAAM,2BAA2B,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC;AAEvE;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,OAAO,EAAE,gBAAgB,CAAC,OAAO,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,OAAO,EAAE,gBAAgB,CAAC,OAAO,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE3B;;OAEG;IACH,OAAO,EAAE,gBAAgB,CAAC,OAAO,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC,aAAa,CAAC;IAErC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC;CAC/B;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC;AAEzC,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;IAE3D;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC,KAAK,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;CACvC;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,WAAW;QAC1B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB;;;;WAIG;QACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnB;;;;WAIG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;IAE3D;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC,KAAK,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEvC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;CACvC;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,WAAW;QAC1B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB;;;;WAIG;QACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnB;;;;WAIG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;CACF;AAED,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACtD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;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,sBAAsB,GAAG,YAAY,GAAG,gBAAgB,GAAG,YAAY,GAAG,IAAI,CAAC;IAE9F;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;CACtD;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;CACH"}
|