@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,124 @@
|
|
|
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 Experiences extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Required permissions:
|
|
8
|
+
*
|
|
9
|
+
* - `experience:create`
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* ```ts
|
|
13
|
+
* const experience = await client.experiences.create({
|
|
14
|
+
* app_id: 'app_xxxxxxxxxxxxxx',
|
|
15
|
+
* company_id: 'biz_xxxxxxxxxxxxxx',
|
|
16
|
+
* });
|
|
17
|
+
* ```
|
|
18
|
+
*/
|
|
19
|
+
create(body, options) {
|
|
20
|
+
return this._client.post('/experiences', { body, ...options });
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Retrieves an experience by ID
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* ```ts
|
|
27
|
+
* const experience = await client.experiences.retrieve(
|
|
28
|
+
* 'exp_xxxxxxxxxxxxxx',
|
|
29
|
+
* );
|
|
30
|
+
* ```
|
|
31
|
+
*/
|
|
32
|
+
retrieve(id, options) {
|
|
33
|
+
return this._client.get(path `/experiences/${id}`, options);
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* Required permissions:
|
|
37
|
+
*
|
|
38
|
+
* - `experience:update`
|
|
39
|
+
*
|
|
40
|
+
* @example
|
|
41
|
+
* ```ts
|
|
42
|
+
* const experience = await client.experiences.update(
|
|
43
|
+
* 'exp_xxxxxxxxxxxxxx',
|
|
44
|
+
* );
|
|
45
|
+
* ```
|
|
46
|
+
*/
|
|
47
|
+
update(id, body = {}, options) {
|
|
48
|
+
return this._client.patch(path `/experiences/${id}`, { body, ...options });
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Lists experiences for a company
|
|
52
|
+
*
|
|
53
|
+
* Required permissions:
|
|
54
|
+
*
|
|
55
|
+
* - `experience:hidden_experience:read`
|
|
56
|
+
*
|
|
57
|
+
* @example
|
|
58
|
+
* ```ts
|
|
59
|
+
* // Automatically fetches more pages as needed.
|
|
60
|
+
* for await (const experienceListResponse of client.experiences.list(
|
|
61
|
+
* { company_id: 'biz_xxxxxxxxxxxxxx' },
|
|
62
|
+
* )) {
|
|
63
|
+
* // ...
|
|
64
|
+
* }
|
|
65
|
+
* ```
|
|
66
|
+
*/
|
|
67
|
+
list(query, options) {
|
|
68
|
+
return this._client.getAPIList('/experiences', (CursorPage), { query, ...options });
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* Required permissions:
|
|
72
|
+
*
|
|
73
|
+
* - `experience:delete`
|
|
74
|
+
*
|
|
75
|
+
* @example
|
|
76
|
+
* ```ts
|
|
77
|
+
* const experience = await client.experiences.delete(
|
|
78
|
+
* 'exp_xxxxxxxxxxxxxx',
|
|
79
|
+
* );
|
|
80
|
+
* ```
|
|
81
|
+
*/
|
|
82
|
+
delete(id, options) {
|
|
83
|
+
return this._client.delete(path `/experiences/${id}`, options);
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* Adds an experience to an product, making it accessible to the product's
|
|
87
|
+
* customers.
|
|
88
|
+
*
|
|
89
|
+
* Required permissions:
|
|
90
|
+
*
|
|
91
|
+
* - `experience:attach`
|
|
92
|
+
*
|
|
93
|
+
* @example
|
|
94
|
+
* ```ts
|
|
95
|
+
* const experience = await client.experiences.attach(
|
|
96
|
+
* 'exp_xxxxxxxxxxxxxx',
|
|
97
|
+
* { product_id: 'prod_xxxxxxxxxxxxx' },
|
|
98
|
+
* );
|
|
99
|
+
* ```
|
|
100
|
+
*/
|
|
101
|
+
attach(id, body, options) {
|
|
102
|
+
return this._client.post(path `/experiences/${id}/attach`, { body, ...options });
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* Removes an experience from an product, making it inaccessible to the product's
|
|
106
|
+
* customers.
|
|
107
|
+
*
|
|
108
|
+
* Required permissions:
|
|
109
|
+
*
|
|
110
|
+
* - `experience:detach`
|
|
111
|
+
*
|
|
112
|
+
* @example
|
|
113
|
+
* ```ts
|
|
114
|
+
* const experience = await client.experiences.detach(
|
|
115
|
+
* 'exp_xxxxxxxxxxxxxx',
|
|
116
|
+
* { product_id: 'prod_xxxxxxxxxxxxx' },
|
|
117
|
+
* );
|
|
118
|
+
* ```
|
|
119
|
+
*/
|
|
120
|
+
detach(id, body, options) {
|
|
121
|
+
return this._client.post(path `/experiences/${id}/detach`, { body, ...options });
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
//# sourceMappingURL=experiences.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"experiences.mjs","sourceRoot":"","sources":["../src/resources/experiences.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAU,EACV,OAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,UAAkC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5G,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,EAAU,EAAE,IAA4B,EAAE,OAAwB;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,EAAU,EAAE,IAA4B,EAAE,OAAwB;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;CACF"}
|
|
@@ -0,0 +1,242 @@
|
|
|
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 ForumPosts extends APIResource {
|
|
7
|
+
/**
|
|
8
|
+
* Create a new forum post
|
|
9
|
+
*
|
|
10
|
+
* Required permissions:
|
|
11
|
+
*
|
|
12
|
+
* - `forum:post:create`
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```ts
|
|
16
|
+
* const forumPost = await client.forumPosts.create({
|
|
17
|
+
* experience_id: 'exp_xxxxxxxxxxxxxx',
|
|
18
|
+
* });
|
|
19
|
+
* ```
|
|
20
|
+
*/
|
|
21
|
+
create(body: ForumPostCreateParams, options?: RequestOptions): APIPromise<Shared.ForumPost>;
|
|
22
|
+
/**
|
|
23
|
+
* Retrieves a forum post by ID
|
|
24
|
+
*
|
|
25
|
+
* Required permissions:
|
|
26
|
+
*
|
|
27
|
+
* - `forum:read`
|
|
28
|
+
*
|
|
29
|
+
* @example
|
|
30
|
+
* ```ts
|
|
31
|
+
* const forumPost = await client.forumPosts.retrieve('id');
|
|
32
|
+
* ```
|
|
33
|
+
*/
|
|
34
|
+
retrieve(id: string, options?: RequestOptions): APIPromise<Shared.ForumPost>;
|
|
35
|
+
/**
|
|
36
|
+
* Lists forum posts
|
|
37
|
+
*
|
|
38
|
+
* Required permissions:
|
|
39
|
+
*
|
|
40
|
+
* - `forum:read`
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* ```ts
|
|
44
|
+
* // Automatically fetches more pages as needed.
|
|
45
|
+
* for await (const forumPostListResponse of client.forumPosts.list(
|
|
46
|
+
* { experience_id: 'exp_xxxxxxxxxxxxxx' },
|
|
47
|
+
* )) {
|
|
48
|
+
* // ...
|
|
49
|
+
* }
|
|
50
|
+
* ```
|
|
51
|
+
*/
|
|
52
|
+
list(query: ForumPostListParams, options?: RequestOptions): PagePromise<ForumPostListResponsesCursorPage, ForumPostListResponse>;
|
|
53
|
+
}
|
|
54
|
+
export type ForumPostListResponsesCursorPage = CursorPage<ForumPostListResponse>;
|
|
55
|
+
/**
|
|
56
|
+
* Represents a post in forum
|
|
57
|
+
*/
|
|
58
|
+
export interface ForumPostListResponse {
|
|
59
|
+
/**
|
|
60
|
+
* The unique identifier for the entity
|
|
61
|
+
*/
|
|
62
|
+
id: string;
|
|
63
|
+
/**
|
|
64
|
+
* The amount of comments on this post
|
|
65
|
+
*/
|
|
66
|
+
comment_count: number;
|
|
67
|
+
/**
|
|
68
|
+
* The content of the forum post in Markdown format
|
|
69
|
+
*/
|
|
70
|
+
content: string | null;
|
|
71
|
+
/**
|
|
72
|
+
* Whether the forum post has been edited
|
|
73
|
+
*/
|
|
74
|
+
is_edited: boolean;
|
|
75
|
+
/**
|
|
76
|
+
* Whether this forum post is pinned
|
|
77
|
+
*/
|
|
78
|
+
is_pinned: boolean;
|
|
79
|
+
/**
|
|
80
|
+
* Whether the user that sent the post is an admin of the company
|
|
81
|
+
*/
|
|
82
|
+
is_poster_admin: boolean;
|
|
83
|
+
/**
|
|
84
|
+
* The number of likes this post has received
|
|
85
|
+
*/
|
|
86
|
+
like_count: number | null;
|
|
87
|
+
/**
|
|
88
|
+
* The ID of the parent forum post, if applicable
|
|
89
|
+
*/
|
|
90
|
+
parent_id: string | null;
|
|
91
|
+
/**
|
|
92
|
+
* The title of the forum post
|
|
93
|
+
*/
|
|
94
|
+
title: string | null;
|
|
95
|
+
/**
|
|
96
|
+
* The user who created this forum post
|
|
97
|
+
*/
|
|
98
|
+
user: ForumPostListResponse.User;
|
|
99
|
+
/**
|
|
100
|
+
* The number of times this message has been viewed
|
|
101
|
+
*/
|
|
102
|
+
view_count: number | null;
|
|
103
|
+
}
|
|
104
|
+
export declare namespace ForumPostListResponse {
|
|
105
|
+
/**
|
|
106
|
+
* The user who created this forum post
|
|
107
|
+
*/
|
|
108
|
+
interface User {
|
|
109
|
+
/**
|
|
110
|
+
* The internal ID of the user.
|
|
111
|
+
*/
|
|
112
|
+
id: string;
|
|
113
|
+
/**
|
|
114
|
+
* The name of the user from their Whop account.
|
|
115
|
+
*/
|
|
116
|
+
name: string | null;
|
|
117
|
+
/**
|
|
118
|
+
* The username of the user from their Whop account.
|
|
119
|
+
*/
|
|
120
|
+
username: string;
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
export interface ForumPostCreateParams {
|
|
124
|
+
/**
|
|
125
|
+
* The experience to create this post in
|
|
126
|
+
*/
|
|
127
|
+
experience_id: string;
|
|
128
|
+
/**
|
|
129
|
+
* The attachments for this post
|
|
130
|
+
*/
|
|
131
|
+
attachments?: Array<ForumPostCreateParams.Attachment> | null;
|
|
132
|
+
/**
|
|
133
|
+
* This is the main body of the post in Markdown format. Hidden if paywalled and
|
|
134
|
+
* user hasn't purchased access to it.
|
|
135
|
+
*/
|
|
136
|
+
content?: string | null;
|
|
137
|
+
/**
|
|
138
|
+
* This is used to determine if the post should be sent as a 'mention' notification
|
|
139
|
+
* to all of the users who are in the experience. This means that anyone with
|
|
140
|
+
* 'mentions' enabled will receive a notification about this post.
|
|
141
|
+
*/
|
|
142
|
+
is_mention?: boolean | null;
|
|
143
|
+
/**
|
|
144
|
+
* The ID of the parent post. Set it to the ID of the post you want to comment on
|
|
145
|
+
* or don't include it if its a top level post.
|
|
146
|
+
*/
|
|
147
|
+
parent_id?: string | null;
|
|
148
|
+
/**
|
|
149
|
+
* The amount to paywall this post by. A paywalled post requires the user to
|
|
150
|
+
* purchase it in order to view its content.
|
|
151
|
+
*/
|
|
152
|
+
paywall_amount?: number | null;
|
|
153
|
+
/**
|
|
154
|
+
* The available currencies on the platform
|
|
155
|
+
*/
|
|
156
|
+
paywall_currency?: Shared.Currency | null;
|
|
157
|
+
/**
|
|
158
|
+
* Whether the post should be pinned
|
|
159
|
+
*/
|
|
160
|
+
pinned?: boolean | null;
|
|
161
|
+
/**
|
|
162
|
+
* The poll for this post
|
|
163
|
+
*/
|
|
164
|
+
poll?: ForumPostCreateParams.Poll | null;
|
|
165
|
+
/**
|
|
166
|
+
* The title of the post. Only visible if paywalled.
|
|
167
|
+
*/
|
|
168
|
+
title?: string | null;
|
|
169
|
+
}
|
|
170
|
+
export declare namespace ForumPostCreateParams {
|
|
171
|
+
/**
|
|
172
|
+
* Input for an attachment
|
|
173
|
+
*/
|
|
174
|
+
interface Attachment {
|
|
175
|
+
/**
|
|
176
|
+
* The ID of an existing attachment object. Use this when updating a resource and
|
|
177
|
+
* keeping a subset of the attachments. Don't use this unless you know what you're
|
|
178
|
+
* doing.
|
|
179
|
+
*/
|
|
180
|
+
id?: string | null;
|
|
181
|
+
/**
|
|
182
|
+
* This ID should be used the first time you upload an attachment. It is the ID of
|
|
183
|
+
* the direct upload that was created when uploading the file to S3 via the
|
|
184
|
+
* mediaDirectUpload mutation.
|
|
185
|
+
*/
|
|
186
|
+
direct_upload_id?: string | null;
|
|
187
|
+
}
|
|
188
|
+
/**
|
|
189
|
+
* The poll for this post
|
|
190
|
+
*/
|
|
191
|
+
interface Poll {
|
|
192
|
+
/**
|
|
193
|
+
* The options for the poll. Must have sequential IDs starting from 1
|
|
194
|
+
*/
|
|
195
|
+
options: Array<Poll.Option>;
|
|
196
|
+
}
|
|
197
|
+
namespace Poll {
|
|
198
|
+
/**
|
|
199
|
+
* Input type for a single poll option
|
|
200
|
+
*/
|
|
201
|
+
interface Option {
|
|
202
|
+
/**
|
|
203
|
+
* Sequential ID for the poll option (starting from '1')
|
|
204
|
+
*/
|
|
205
|
+
id: string;
|
|
206
|
+
/**
|
|
207
|
+
* The text of the poll option
|
|
208
|
+
*/
|
|
209
|
+
text: string;
|
|
210
|
+
}
|
|
211
|
+
}
|
|
212
|
+
}
|
|
213
|
+
export interface ForumPostListParams extends CursorPageParams {
|
|
214
|
+
/**
|
|
215
|
+
* The ID of the experience to list forum posts for
|
|
216
|
+
*/
|
|
217
|
+
experience_id: string;
|
|
218
|
+
/**
|
|
219
|
+
* Returns the elements in the list that come before the specified cursor.
|
|
220
|
+
*/
|
|
221
|
+
before?: string | null;
|
|
222
|
+
/**
|
|
223
|
+
* Returns the first _n_ elements from the list.
|
|
224
|
+
*/
|
|
225
|
+
first?: number | null;
|
|
226
|
+
/**
|
|
227
|
+
* Returns the last _n_ elements from the list.
|
|
228
|
+
*/
|
|
229
|
+
last?: number | null;
|
|
230
|
+
/**
|
|
231
|
+
* The ID of the parent post to list forum post comments for
|
|
232
|
+
*/
|
|
233
|
+
parent_id?: string | null;
|
|
234
|
+
/**
|
|
235
|
+
* Set to true to only return pinned posts
|
|
236
|
+
*/
|
|
237
|
+
pinned?: boolean | null;
|
|
238
|
+
}
|
|
239
|
+
export declare namespace ForumPosts {
|
|
240
|
+
export { type ForumPostListResponse as ForumPostListResponse, type ForumPostListResponsesCursorPage as ForumPostListResponsesCursorPage, type ForumPostCreateParams as ForumPostCreateParams, type ForumPostListParams as ForumPostListParams, };
|
|
241
|
+
}
|
|
242
|
+
//# sourceMappingURL=forum-posts.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"forum-posts.d.mts","sourceRoot":"","sources":["../src/resources/forum-posts.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,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC;IAI3F;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC;IAI5E;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,EAAE,mBAAmB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,gCAAgC,EAAE,qBAAqB,CAAC;CAGxE;AAED,MAAM,MAAM,gCAAgC,GAAG,UAAU,CAAC,qBAAqB,CAAC,CAAC;AAEjF;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IAE7D;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,qBAAqB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,UAAU;QACzB;;;;WAIG;QACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnB;;;;WAIG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;KAC7B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;CACF;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|
|
@@ -0,0 +1,242 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import * as Shared from "./shared.js";
|
|
3
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
4
|
+
import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.js";
|
|
5
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
6
|
+
export declare class ForumPosts extends APIResource {
|
|
7
|
+
/**
|
|
8
|
+
* Create a new forum post
|
|
9
|
+
*
|
|
10
|
+
* Required permissions:
|
|
11
|
+
*
|
|
12
|
+
* - `forum:post:create`
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```ts
|
|
16
|
+
* const forumPost = await client.forumPosts.create({
|
|
17
|
+
* experience_id: 'exp_xxxxxxxxxxxxxx',
|
|
18
|
+
* });
|
|
19
|
+
* ```
|
|
20
|
+
*/
|
|
21
|
+
create(body: ForumPostCreateParams, options?: RequestOptions): APIPromise<Shared.ForumPost>;
|
|
22
|
+
/**
|
|
23
|
+
* Retrieves a forum post by ID
|
|
24
|
+
*
|
|
25
|
+
* Required permissions:
|
|
26
|
+
*
|
|
27
|
+
* - `forum:read`
|
|
28
|
+
*
|
|
29
|
+
* @example
|
|
30
|
+
* ```ts
|
|
31
|
+
* const forumPost = await client.forumPosts.retrieve('id');
|
|
32
|
+
* ```
|
|
33
|
+
*/
|
|
34
|
+
retrieve(id: string, options?: RequestOptions): APIPromise<Shared.ForumPost>;
|
|
35
|
+
/**
|
|
36
|
+
* Lists forum posts
|
|
37
|
+
*
|
|
38
|
+
* Required permissions:
|
|
39
|
+
*
|
|
40
|
+
* - `forum:read`
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* ```ts
|
|
44
|
+
* // Automatically fetches more pages as needed.
|
|
45
|
+
* for await (const forumPostListResponse of client.forumPosts.list(
|
|
46
|
+
* { experience_id: 'exp_xxxxxxxxxxxxxx' },
|
|
47
|
+
* )) {
|
|
48
|
+
* // ...
|
|
49
|
+
* }
|
|
50
|
+
* ```
|
|
51
|
+
*/
|
|
52
|
+
list(query: ForumPostListParams, options?: RequestOptions): PagePromise<ForumPostListResponsesCursorPage, ForumPostListResponse>;
|
|
53
|
+
}
|
|
54
|
+
export type ForumPostListResponsesCursorPage = CursorPage<ForumPostListResponse>;
|
|
55
|
+
/**
|
|
56
|
+
* Represents a post in forum
|
|
57
|
+
*/
|
|
58
|
+
export interface ForumPostListResponse {
|
|
59
|
+
/**
|
|
60
|
+
* The unique identifier for the entity
|
|
61
|
+
*/
|
|
62
|
+
id: string;
|
|
63
|
+
/**
|
|
64
|
+
* The amount of comments on this post
|
|
65
|
+
*/
|
|
66
|
+
comment_count: number;
|
|
67
|
+
/**
|
|
68
|
+
* The content of the forum post in Markdown format
|
|
69
|
+
*/
|
|
70
|
+
content: string | null;
|
|
71
|
+
/**
|
|
72
|
+
* Whether the forum post has been edited
|
|
73
|
+
*/
|
|
74
|
+
is_edited: boolean;
|
|
75
|
+
/**
|
|
76
|
+
* Whether this forum post is pinned
|
|
77
|
+
*/
|
|
78
|
+
is_pinned: boolean;
|
|
79
|
+
/**
|
|
80
|
+
* Whether the user that sent the post is an admin of the company
|
|
81
|
+
*/
|
|
82
|
+
is_poster_admin: boolean;
|
|
83
|
+
/**
|
|
84
|
+
* The number of likes this post has received
|
|
85
|
+
*/
|
|
86
|
+
like_count: number | null;
|
|
87
|
+
/**
|
|
88
|
+
* The ID of the parent forum post, if applicable
|
|
89
|
+
*/
|
|
90
|
+
parent_id: string | null;
|
|
91
|
+
/**
|
|
92
|
+
* The title of the forum post
|
|
93
|
+
*/
|
|
94
|
+
title: string | null;
|
|
95
|
+
/**
|
|
96
|
+
* The user who created this forum post
|
|
97
|
+
*/
|
|
98
|
+
user: ForumPostListResponse.User;
|
|
99
|
+
/**
|
|
100
|
+
* The number of times this message has been viewed
|
|
101
|
+
*/
|
|
102
|
+
view_count: number | null;
|
|
103
|
+
}
|
|
104
|
+
export declare namespace ForumPostListResponse {
|
|
105
|
+
/**
|
|
106
|
+
* The user who created this forum post
|
|
107
|
+
*/
|
|
108
|
+
interface User {
|
|
109
|
+
/**
|
|
110
|
+
* The internal ID of the user.
|
|
111
|
+
*/
|
|
112
|
+
id: string;
|
|
113
|
+
/**
|
|
114
|
+
* The name of the user from their Whop account.
|
|
115
|
+
*/
|
|
116
|
+
name: string | null;
|
|
117
|
+
/**
|
|
118
|
+
* The username of the user from their Whop account.
|
|
119
|
+
*/
|
|
120
|
+
username: string;
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
export interface ForumPostCreateParams {
|
|
124
|
+
/**
|
|
125
|
+
* The experience to create this post in
|
|
126
|
+
*/
|
|
127
|
+
experience_id: string;
|
|
128
|
+
/**
|
|
129
|
+
* The attachments for this post
|
|
130
|
+
*/
|
|
131
|
+
attachments?: Array<ForumPostCreateParams.Attachment> | null;
|
|
132
|
+
/**
|
|
133
|
+
* This is the main body of the post in Markdown format. Hidden if paywalled and
|
|
134
|
+
* user hasn't purchased access to it.
|
|
135
|
+
*/
|
|
136
|
+
content?: string | null;
|
|
137
|
+
/**
|
|
138
|
+
* This is used to determine if the post should be sent as a 'mention' notification
|
|
139
|
+
* to all of the users who are in the experience. This means that anyone with
|
|
140
|
+
* 'mentions' enabled will receive a notification about this post.
|
|
141
|
+
*/
|
|
142
|
+
is_mention?: boolean | null;
|
|
143
|
+
/**
|
|
144
|
+
* The ID of the parent post. Set it to the ID of the post you want to comment on
|
|
145
|
+
* or don't include it if its a top level post.
|
|
146
|
+
*/
|
|
147
|
+
parent_id?: string | null;
|
|
148
|
+
/**
|
|
149
|
+
* The amount to paywall this post by. A paywalled post requires the user to
|
|
150
|
+
* purchase it in order to view its content.
|
|
151
|
+
*/
|
|
152
|
+
paywall_amount?: number | null;
|
|
153
|
+
/**
|
|
154
|
+
* The available currencies on the platform
|
|
155
|
+
*/
|
|
156
|
+
paywall_currency?: Shared.Currency | null;
|
|
157
|
+
/**
|
|
158
|
+
* Whether the post should be pinned
|
|
159
|
+
*/
|
|
160
|
+
pinned?: boolean | null;
|
|
161
|
+
/**
|
|
162
|
+
* The poll for this post
|
|
163
|
+
*/
|
|
164
|
+
poll?: ForumPostCreateParams.Poll | null;
|
|
165
|
+
/**
|
|
166
|
+
* The title of the post. Only visible if paywalled.
|
|
167
|
+
*/
|
|
168
|
+
title?: string | null;
|
|
169
|
+
}
|
|
170
|
+
export declare namespace ForumPostCreateParams {
|
|
171
|
+
/**
|
|
172
|
+
* Input for an attachment
|
|
173
|
+
*/
|
|
174
|
+
interface Attachment {
|
|
175
|
+
/**
|
|
176
|
+
* The ID of an existing attachment object. Use this when updating a resource and
|
|
177
|
+
* keeping a subset of the attachments. Don't use this unless you know what you're
|
|
178
|
+
* doing.
|
|
179
|
+
*/
|
|
180
|
+
id?: string | null;
|
|
181
|
+
/**
|
|
182
|
+
* This ID should be used the first time you upload an attachment. It is the ID of
|
|
183
|
+
* the direct upload that was created when uploading the file to S3 via the
|
|
184
|
+
* mediaDirectUpload mutation.
|
|
185
|
+
*/
|
|
186
|
+
direct_upload_id?: string | null;
|
|
187
|
+
}
|
|
188
|
+
/**
|
|
189
|
+
* The poll for this post
|
|
190
|
+
*/
|
|
191
|
+
interface Poll {
|
|
192
|
+
/**
|
|
193
|
+
* The options for the poll. Must have sequential IDs starting from 1
|
|
194
|
+
*/
|
|
195
|
+
options: Array<Poll.Option>;
|
|
196
|
+
}
|
|
197
|
+
namespace Poll {
|
|
198
|
+
/**
|
|
199
|
+
* Input type for a single poll option
|
|
200
|
+
*/
|
|
201
|
+
interface Option {
|
|
202
|
+
/**
|
|
203
|
+
* Sequential ID for the poll option (starting from '1')
|
|
204
|
+
*/
|
|
205
|
+
id: string;
|
|
206
|
+
/**
|
|
207
|
+
* The text of the poll option
|
|
208
|
+
*/
|
|
209
|
+
text: string;
|
|
210
|
+
}
|
|
211
|
+
}
|
|
212
|
+
}
|
|
213
|
+
export interface ForumPostListParams extends CursorPageParams {
|
|
214
|
+
/**
|
|
215
|
+
* The ID of the experience to list forum posts for
|
|
216
|
+
*/
|
|
217
|
+
experience_id: string;
|
|
218
|
+
/**
|
|
219
|
+
* Returns the elements in the list that come before the specified cursor.
|
|
220
|
+
*/
|
|
221
|
+
before?: string | null;
|
|
222
|
+
/**
|
|
223
|
+
* Returns the first _n_ elements from the list.
|
|
224
|
+
*/
|
|
225
|
+
first?: number | null;
|
|
226
|
+
/**
|
|
227
|
+
* Returns the last _n_ elements from the list.
|
|
228
|
+
*/
|
|
229
|
+
last?: number | null;
|
|
230
|
+
/**
|
|
231
|
+
* The ID of the parent post to list forum post comments for
|
|
232
|
+
*/
|
|
233
|
+
parent_id?: string | null;
|
|
234
|
+
/**
|
|
235
|
+
* Set to true to only return pinned posts
|
|
236
|
+
*/
|
|
237
|
+
pinned?: boolean | null;
|
|
238
|
+
}
|
|
239
|
+
export declare namespace ForumPosts {
|
|
240
|
+
export { type ForumPostListResponse as ForumPostListResponse, type ForumPostListResponsesCursorPage as ForumPostListResponsesCursorPage, type ForumPostCreateParams as ForumPostCreateParams, type ForumPostListParams as ForumPostListParams, };
|
|
241
|
+
}
|
|
242
|
+
//# sourceMappingURL=forum-posts.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"forum-posts.d.ts","sourceRoot":"","sources":["../src/resources/forum-posts.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,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC;IAI3F;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC;IAI5E;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,EAAE,mBAAmB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,gCAAgC,EAAE,qBAAqB,CAAC;CAGxE;AAED,MAAM,MAAM,gCAAgC,GAAG,UAAU,CAAC,qBAAqB,CAAC,CAAC;AAEjF;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IAE7D;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,qBAAqB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,UAAU;QACzB;;;;WAIG;QACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnB;;;;WAIG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;KAC7B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;CACF;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.ForumPosts = void 0;
|
|
5
|
+
const resource_1 = require("../core/resource.js");
|
|
6
|
+
const pagination_1 = require("../core/pagination.js");
|
|
7
|
+
const path_1 = require("../internal/utils/path.js");
|
|
8
|
+
class ForumPosts extends resource_1.APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* Create a new forum post
|
|
11
|
+
*
|
|
12
|
+
* Required permissions:
|
|
13
|
+
*
|
|
14
|
+
* - `forum:post:create`
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```ts
|
|
18
|
+
* const forumPost = await client.forumPosts.create({
|
|
19
|
+
* experience_id: 'exp_xxxxxxxxxxxxxx',
|
|
20
|
+
* });
|
|
21
|
+
* ```
|
|
22
|
+
*/
|
|
23
|
+
create(body, options) {
|
|
24
|
+
return this._client.post('/forum_posts', { body, ...options });
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Retrieves a forum post by ID
|
|
28
|
+
*
|
|
29
|
+
* Required permissions:
|
|
30
|
+
*
|
|
31
|
+
* - `forum:read`
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
* ```ts
|
|
35
|
+
* const forumPost = await client.forumPosts.retrieve('id');
|
|
36
|
+
* ```
|
|
37
|
+
*/
|
|
38
|
+
retrieve(id, options) {
|
|
39
|
+
return this._client.get((0, path_1.path) `/forum_posts/${id}`, options);
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Lists forum posts
|
|
43
|
+
*
|
|
44
|
+
* Required permissions:
|
|
45
|
+
*
|
|
46
|
+
* - `forum:read`
|
|
47
|
+
*
|
|
48
|
+
* @example
|
|
49
|
+
* ```ts
|
|
50
|
+
* // Automatically fetches more pages as needed.
|
|
51
|
+
* for await (const forumPostListResponse of client.forumPosts.list(
|
|
52
|
+
* { experience_id: 'exp_xxxxxxxxxxxxxx' },
|
|
53
|
+
* )) {
|
|
54
|
+
* // ...
|
|
55
|
+
* }
|
|
56
|
+
* ```
|
|
57
|
+
*/
|
|
58
|
+
list(query, options) {
|
|
59
|
+
return this._client.getAPIList('/forum_posts', (pagination_1.CursorPage), { query, ...options });
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
exports.ForumPosts = ForumPosts;
|
|
63
|
+
//# sourceMappingURL=forum-posts.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"forum-posts.js","sourceRoot":"","sources":["../src/resources/forum-posts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAA2B,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;OAWG;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;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,uBAAiC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;CACF;AA1DD,gCA0DC"}
|