@surgeapi/node 0.25.6 → 0.26.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 +11 -0
- package/LICENSE +201 -21
- package/README.md +318 -115
- 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 +208 -0
- package/client.d.mts.map +1 -0
- package/client.d.ts +208 -0
- package/client.d.ts.map +1 -0
- package/client.js +476 -0
- package/client.js.map +1 -0
- package/client.mjs +472 -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/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 +6 -0
- package/index.d.mts.map +1 -0
- package/index.d.ts +6 -4
- package/index.d.ts.map +1 -0
- package/index.js +28 -42
- package/index.js.map +1 -0
- package/index.mjs +7 -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/package.json +139 -44
- 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/accounts.d.mts +526 -0
- package/resources/accounts.d.mts.map +1 -0
- package/resources/accounts.d.ts +526 -0
- package/resources/accounts.d.ts.map +1 -0
- package/resources/accounts.js +49 -0
- package/resources/accounts.js.map +1 -0
- package/resources/accounts.mjs +45 -0
- package/resources/accounts.mjs.map +1 -0
- package/resources/blasts.d.mts +110 -0
- package/resources/blasts.d.mts.map +1 -0
- package/resources/blasts.d.ts +110 -0
- package/resources/blasts.d.ts.map +1 -0
- package/resources/blasts.js +23 -0
- package/resources/blasts.js.map +1 -0
- package/resources/blasts.mjs +19 -0
- package/resources/blasts.mjs.map +1 -0
- package/resources/campaigns.d.mts +346 -0
- package/resources/campaigns.d.mts.map +1 -0
- package/resources/campaigns.d.ts +346 -0
- package/resources/campaigns.d.ts.map +1 -0
- package/resources/campaigns.js +41 -0
- package/resources/campaigns.js.map +1 -0
- package/resources/campaigns.mjs +37 -0
- package/resources/campaigns.mjs.map +1 -0
- package/resources/contacts.d.mts +151 -0
- package/resources/contacts.d.mts.map +1 -0
- package/resources/contacts.d.ts +151 -0
- package/resources/contacts.d.ts.map +1 -0
- package/resources/contacts.js +52 -0
- package/resources/contacts.js.map +1 -0
- package/resources/contacts.mjs +48 -0
- package/resources/contacts.mjs.map +1 -0
- package/resources/index.d.mts +11 -0
- package/resources/index.d.mts.map +1 -0
- package/resources/index.d.ts +11 -0
- package/resources/index.d.ts.map +1 -0
- package/resources/index.js +25 -0
- package/resources/index.js.map +1 -0
- package/resources/index.mjs +12 -0
- package/resources/index.mjs.map +1 -0
- package/resources/messages.d.mts +263 -0
- package/resources/messages.d.mts.map +1 -0
- package/resources/messages.d.ts +263 -0
- package/resources/messages.d.ts.map +1 -0
- package/resources/messages.js +52 -0
- package/resources/messages.js.map +1 -0
- package/resources/messages.mjs +48 -0
- package/resources/messages.mjs.map +1 -0
- package/resources/phone-numbers.d.mts +90 -0
- package/resources/phone-numbers.d.mts.map +1 -0
- package/resources/phone-numbers.d.ts +90 -0
- package/resources/phone-numbers.d.ts.map +1 -0
- package/resources/phone-numbers.js +24 -0
- package/resources/phone-numbers.js.map +1 -0
- package/resources/phone-numbers.mjs +20 -0
- package/resources/phone-numbers.mjs.map +1 -0
- package/resources/shared.d.mts +20 -0
- package/resources/shared.d.mts.map +1 -0
- package/resources/shared.d.ts +20 -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/users.d.mts +170 -0
- package/resources/users.d.mts.map +1 -0
- package/resources/users.d.ts +170 -0
- package/resources/users.d.ts.map +1 -0
- package/resources/users.js +65 -0
- package/resources/users.js.map +1 -0
- package/resources/users.mjs +61 -0
- package/resources/users.mjs.map +1 -0
- package/resources/verifications.d.mts +96 -0
- package/resources/verifications.d.mts.map +1 -0
- package/resources/verifications.d.ts +96 -0
- package/resources/verifications.d.ts.map +1 -0
- package/resources/verifications.js +37 -0
- package/resources/verifications.js.map +1 -0
- package/resources/verifications.mjs +33 -0
- package/resources/verifications.mjs.map +1 -0
- package/resources/webhooks.d.mts +484 -0
- package/resources/webhooks.d.mts.map +1 -0
- package/resources/webhooks.d.ts +484 -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 +874 -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/resource.ts +11 -0
- package/src/core/uploads.ts +2 -0
- package/src/error.ts +2 -0
- package/src/index.ts +22 -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/resource.ts +2 -0
- package/src/resources/accounts.ts +778 -0
- package/src/resources/blasts.ts +140 -0
- package/src/resources/campaigns.ts +417 -0
- package/src/resources/contacts.ts +181 -0
- package/src/resources/index.ts +60 -0
- package/src/resources/messages.ts +314 -0
- package/src/resources/phone-numbers.ts +111 -0
- package/src/resources/shared.ts +21 -0
- package/src/resources/users.ts +209 -0
- package/src/resources/verifications.ts +121 -0
- package/src/resources/webhooks.ts +605 -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 -1
- package/version.d.ts.map +1 -0
- package/version.js +3 -2
- package/version.js.map +1 -0
- package/version.mjs +2 -0
- package/version.mjs.map +1 -0
- package/Client.d.ts +0 -49
- package/Client.js +0 -47
- package/api/errors/ConflictError.d.ts +0 -9
- package/api/errors/ConflictError.js +0 -52
- package/api/errors/UnprocessableEntityError.d.ts +0 -9
- package/api/errors/UnprocessableEntityError.js +0 -52
- package/api/errors/index.d.ts +0 -2
- package/api/errors/index.js +0 -18
- package/api/index.d.ts +0 -3
- package/api/index.js +0 -19
- package/api/resources/accounts/client/Client.d.ts +0 -59
- package/api/resources/accounts/client/Client.js +0 -179
- package/api/resources/accounts/client/index.d.ts +0 -1
- package/api/resources/accounts/client/index.js +0 -17
- package/api/resources/accounts/client/requests/CreateAccountRequest.d.ts +0 -16
- package/api/resources/accounts/client/requests/CreateAccountRequest.js +0 -5
- package/api/resources/accounts/client/requests/UpdateAccountRequest.d.ts +0 -16
- package/api/resources/accounts/client/requests/UpdateAccountRequest.js +0 -5
- package/api/resources/accounts/client/requests/index.d.ts +0 -2
- package/api/resources/accounts/client/requests/index.js +0 -2
- package/api/resources/accounts/index.d.ts +0 -1
- package/api/resources/accounts/index.js +0 -17
- package/api/resources/blasts/client/Client.d.ts +0 -51
- package/api/resources/blasts/client/Client.js +0 -129
- package/api/resources/blasts/client/index.d.ts +0 -1
- package/api/resources/blasts/client/index.js +0 -17
- package/api/resources/blasts/client/requests/BlastRequest.d.ts +0 -30
- package/api/resources/blasts/client/requests/BlastRequest.js +0 -5
- package/api/resources/blasts/client/requests/index.d.ts +0 -1
- package/api/resources/blasts/client/requests/index.js +0 -2
- package/api/resources/blasts/index.d.ts +0 -1
- package/api/resources/blasts/index.js +0 -17
- package/api/resources/contacts/client/Client.d.ts +0 -81
- package/api/resources/contacts/client/Client.js +0 -242
- package/api/resources/contacts/client/index.d.ts +0 -1
- package/api/resources/contacts/client/index.js +0 -2
- package/api/resources/contacts/index.d.ts +0 -1
- package/api/resources/contacts/index.js +0 -17
- package/api/resources/index.d.ts +0 -14
- package/api/resources/index.js +0 -53
- package/api/resources/messages/client/Client.d.ts +0 -54
- package/api/resources/messages/client/Client.js +0 -132
- package/api/resources/messages/client/index.d.ts +0 -1
- package/api/resources/messages/client/index.js +0 -17
- package/api/resources/messages/client/requests/MessageRequest.d.ts +0 -28
- package/api/resources/messages/client/requests/MessageRequest.js +0 -5
- package/api/resources/messages/client/requests/index.d.ts +0 -1
- package/api/resources/messages/client/requests/index.js +0 -2
- package/api/resources/messages/index.d.ts +0 -1
- package/api/resources/messages/index.js +0 -17
- package/api/resources/phoneNumbers/client/Client.d.ts +0 -45
- package/api/resources/phoneNumbers/client/Client.js +0 -123
- package/api/resources/phoneNumbers/client/index.d.ts +0 -1
- package/api/resources/phoneNumbers/client/index.js +0 -17
- package/api/resources/phoneNumbers/client/requests/CreatePhoneNumberRequest.d.ts +0 -17
- package/api/resources/phoneNumbers/client/requests/CreatePhoneNumberRequest.js +0 -5
- package/api/resources/phoneNumbers/client/requests/index.d.ts +0 -1
- package/api/resources/phoneNumbers/client/requests/index.js +0 -2
- package/api/resources/phoneNumbers/index.d.ts +0 -2
- package/api/resources/phoneNumbers/index.js +0 -18
- package/api/resources/phoneNumbers/types/CreatePhoneNumberRequestType.d.ts +0 -11
- package/api/resources/phoneNumbers/types/CreatePhoneNumberRequestType.js +0 -10
- package/api/resources/phoneNumbers/types/index.d.ts +0 -1
- package/api/resources/phoneNumbers/types/index.js +0 -17
- package/api/resources/users/client/Client.d.ts +0 -61
- package/api/resources/users/client/Client.js +0 -180
- package/api/resources/users/client/index.d.ts +0 -1
- package/api/resources/users/client/index.js +0 -17
- package/api/resources/users/client/requests/UserRequest.d.ts +0 -25
- package/api/resources/users/client/requests/UserRequest.js +0 -5
- package/api/resources/users/client/requests/index.d.ts +0 -1
- package/api/resources/users/client/requests/index.js +0 -2
- package/api/resources/users/index.d.ts +0 -1
- package/api/resources/users/index.js +0 -17
- package/api/resources/verifications/client/Client.d.ts +0 -60
- package/api/resources/verifications/client/Client.js +0 -188
- package/api/resources/verifications/client/index.d.ts +0 -1
- package/api/resources/verifications/client/index.js +0 -17
- package/api/resources/verifications/client/requests/VerificationCheckRequest.d.ts +0 -13
- package/api/resources/verifications/client/requests/VerificationCheckRequest.js +0 -5
- package/api/resources/verifications/client/requests/VerificationRequest.d.ts +0 -13
- package/api/resources/verifications/client/requests/VerificationRequest.js +0 -5
- package/api/resources/verifications/client/requests/index.d.ts +0 -2
- package/api/resources/verifications/client/requests/index.js +0 -2
- package/api/resources/verifications/index.d.ts +0 -1
- package/api/resources/verifications/index.js +0 -17
- package/api/types/AccountResponse.d.ts +0 -14
- package/api/types/AccountResponse.js +0 -5
- package/api/types/AttachmentParams.d.ts +0 -10
- package/api/types/AttachmentParams.js +0 -5
- package/api/types/AttachmentResponse.d.ts +0 -14
- package/api/types/AttachmentResponse.js +0 -5
- package/api/types/BlastResponse.d.ts +0 -18
- package/api/types/BlastResponse.js +0 -5
- package/api/types/BlastResponseAttachmentsItem.d.ts +0 -7
- package/api/types/BlastResponseAttachmentsItem.js +0 -5
- package/api/types/Contact.d.ts +0 -16
- package/api/types/Contact.js +0 -5
- package/api/types/ContactRequest.d.ts +0 -18
- package/api/types/ContactRequest.js +0 -5
- package/api/types/ContactResponse.d.ts +0 -20
- package/api/types/ContactResponse.js +0 -5
- package/api/types/Conversation.d.ts +0 -13
- package/api/types/Conversation.js +0 -5
- package/api/types/ConversationPhoneNumber.d.ts +0 -15
- package/api/types/ConversationPhoneNumber.js +0 -5
- package/api/types/ConversationPhoneNumberType.d.ts +0 -13
- package/api/types/ConversationPhoneNumberType.js +0 -12
- package/api/types/MessageConversationContactParams.d.ts +0 -14
- package/api/types/MessageConversationContactParams.js +0 -5
- package/api/types/MessageConversationParams.d.ts +0 -12
- package/api/types/MessageConversationParams.js +0 -5
- package/api/types/MessageResponse.d.ts +0 -15
- package/api/types/MessageResponse.js +0 -5
- package/api/types/PhoneNumber.d.ts +0 -15
- package/api/types/PhoneNumber.js +0 -5
- package/api/types/PhoneNumberType.d.ts +0 -11
- package/api/types/PhoneNumberType.js +0 -10
- package/api/types/UserResponse.d.ts +0 -18
- package/api/types/UserResponse.js +0 -5
- package/api/types/Verification.d.ts +0 -17
- package/api/types/Verification.js +0 -5
- package/api/types/VerificationCheckAlreadyVerifiedResponse.d.ts +0 -12
- package/api/types/VerificationCheckAlreadyVerifiedResponse.js +0 -5
- package/api/types/VerificationCheckAlreadyVerifiedResponseResult.d.ts +0 -14
- package/api/types/VerificationCheckAlreadyVerifiedResponseResult.js +0 -13
- package/api/types/VerificationCheckIncorrectResponse.d.ts +0 -12
- package/api/types/VerificationCheckIncorrectResponse.js +0 -5
- package/api/types/VerificationCheckIncorrectResponseResult.d.ts +0 -12
- package/api/types/VerificationCheckIncorrectResponseResult.js +0 -11
- package/api/types/VerificationCheckOkResponse.d.ts +0 -21
- package/api/types/VerificationCheckOkResponse.js +0 -5
- package/api/types/VerificationCheckOkResponseResult.d.ts +0 -21
- package/api/types/VerificationCheckOkResponseResult.js +0 -13
- package/api/types/VerificationStatus.d.ts +0 -13
- package/api/types/VerificationStatus.js +0 -12
- package/api/types/index.d.ts +0 -25
- package/api/types/index.js +0 -41
- package/core/auth/BasicAuth.d.ts +0 -8
- package/core/auth/BasicAuth.js +0 -26
- package/core/auth/BearerToken.d.ts +0 -5
- package/core/auth/BearerToken.js +0 -15
- package/core/auth/index.d.ts +0 -2
- package/core/auth/index.js +0 -7
- package/core/fetcher/APIResponse.d.ts +0 -20
- package/core/fetcher/APIResponse.js +0 -2
- package/core/fetcher/Fetcher.d.ts +0 -39
- package/core/fetcher/Fetcher.js +0 -107
- package/core/fetcher/Headers.d.ts +0 -2
- package/core/fetcher/Headers.js +0 -84
- package/core/fetcher/HttpResponsePromise.d.ts +0 -58
- package/core/fetcher/HttpResponsePromise.js +0 -103
- package/core/fetcher/RawResponse.d.ts +0 -29
- package/core/fetcher/RawResponse.js +0 -44
- package/core/fetcher/Supplier.d.ts +0 -4
- package/core/fetcher/Supplier.js +0 -22
- package/core/fetcher/createRequestUrl.d.ts +0 -1
- package/core/fetcher/createRequestUrl.js +0 -12
- package/core/fetcher/getFetchFn.d.ts +0 -4
- package/core/fetcher/getFetchFn.js +0 -68
- package/core/fetcher/getHeader.d.ts +0 -1
- package/core/fetcher/getHeader.js +0 -11
- package/core/fetcher/getRequestBody.d.ts +0 -7
- package/core/fetcher/getRequestBody.js +0 -23
- package/core/fetcher/getResponseBody.d.ts +0 -1
- package/core/fetcher/getResponseBody.js +0 -54
- package/core/fetcher/index.d.ts +0 -8
- package/core/fetcher/index.js +0 -15
- package/core/fetcher/makeRequest.d.ts +0 -1
- package/core/fetcher/makeRequest.js +0 -42
- package/core/fetcher/requestWithRetries.d.ts +0 -1
- package/core/fetcher/requestWithRetries.js +0 -40
- package/core/fetcher/signals.d.ts +0 -11
- package/core/fetcher/signals.js +0 -36
- package/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.d.ts +0 -30
- package/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.js +0 -247
- package/core/fetcher/stream-wrappers/NodePre18StreamWrapper.d.ts +0 -21
- package/core/fetcher/stream-wrappers/NodePre18StreamWrapper.js +0 -126
- package/core/fetcher/stream-wrappers/UndiciStreamWrapper.d.ts +0 -31
- package/core/fetcher/stream-wrappers/UndiciStreamWrapper.js +0 -229
- package/core/fetcher/stream-wrappers/chooseStreamWrapper.d.ts +0 -18
- package/core/fetcher/stream-wrappers/chooseStreamWrapper.js +0 -59
- package/core/index.d.ts +0 -3
- package/core/index.js +0 -19
- package/core/json.d.ts +0 -15
- package/core/json.js +0 -24
- package/core/runtime/index.d.ts +0 -1
- package/core/runtime/index.js +0 -5
- package/core/runtime/runtime.d.ts +0 -9
- package/core/runtime/runtime.js +0 -103
- package/dist/Client.d.ts +0 -49
- package/dist/Client.js +0 -47
- package/dist/api/errors/ConflictError.d.ts +0 -9
- package/dist/api/errors/ConflictError.js +0 -52
- package/dist/api/errors/UnprocessableEntityError.d.ts +0 -9
- package/dist/api/errors/UnprocessableEntityError.js +0 -52
- package/dist/api/errors/index.d.ts +0 -2
- package/dist/api/errors/index.js +0 -18
- package/dist/api/index.d.ts +0 -3
- package/dist/api/index.js +0 -19
- package/dist/api/resources/accounts/client/Client.d.ts +0 -59
- package/dist/api/resources/accounts/client/Client.js +0 -179
- package/dist/api/resources/accounts/client/index.d.ts +0 -1
- package/dist/api/resources/accounts/client/index.js +0 -17
- package/dist/api/resources/accounts/client/requests/CreateAccountRequest.d.ts +0 -16
- package/dist/api/resources/accounts/client/requests/CreateAccountRequest.js +0 -5
- package/dist/api/resources/accounts/client/requests/UpdateAccountRequest.d.ts +0 -16
- package/dist/api/resources/accounts/client/requests/UpdateAccountRequest.js +0 -5
- package/dist/api/resources/accounts/client/requests/index.d.ts +0 -2
- package/dist/api/resources/accounts/client/requests/index.js +0 -2
- package/dist/api/resources/accounts/index.d.ts +0 -1
- package/dist/api/resources/accounts/index.js +0 -17
- package/dist/api/resources/blasts/client/Client.d.ts +0 -51
- package/dist/api/resources/blasts/client/Client.js +0 -129
- package/dist/api/resources/blasts/client/index.d.ts +0 -1
- package/dist/api/resources/blasts/client/index.js +0 -17
- package/dist/api/resources/blasts/client/requests/BlastRequest.d.ts +0 -30
- package/dist/api/resources/blasts/client/requests/BlastRequest.js +0 -5
- package/dist/api/resources/blasts/client/requests/index.d.ts +0 -1
- package/dist/api/resources/blasts/client/requests/index.js +0 -2
- package/dist/api/resources/blasts/index.d.ts +0 -1
- package/dist/api/resources/blasts/index.js +0 -17
- package/dist/api/resources/contacts/client/Client.d.ts +0 -81
- package/dist/api/resources/contacts/client/Client.js +0 -242
- package/dist/api/resources/contacts/client/index.d.ts +0 -1
- package/dist/api/resources/contacts/client/index.js +0 -2
- package/dist/api/resources/contacts/index.d.ts +0 -1
- package/dist/api/resources/contacts/index.js +0 -17
- package/dist/api/resources/index.d.ts +0 -14
- package/dist/api/resources/index.js +0 -53
- package/dist/api/resources/messages/client/Client.d.ts +0 -54
- package/dist/api/resources/messages/client/Client.js +0 -132
- package/dist/api/resources/messages/client/index.d.ts +0 -1
- package/dist/api/resources/messages/client/index.js +0 -17
- package/dist/api/resources/messages/client/requests/MessageRequest.d.ts +0 -28
- package/dist/api/resources/messages/client/requests/MessageRequest.js +0 -5
- package/dist/api/resources/messages/client/requests/index.d.ts +0 -1
- package/dist/api/resources/messages/client/requests/index.js +0 -2
- package/dist/api/resources/messages/index.d.ts +0 -1
- package/dist/api/resources/messages/index.js +0 -17
- package/dist/api/resources/phoneNumbers/client/Client.d.ts +0 -45
- package/dist/api/resources/phoneNumbers/client/Client.js +0 -123
- package/dist/api/resources/phoneNumbers/client/index.d.ts +0 -1
- package/dist/api/resources/phoneNumbers/client/index.js +0 -17
- package/dist/api/resources/phoneNumbers/client/requests/CreatePhoneNumberRequest.d.ts +0 -17
- package/dist/api/resources/phoneNumbers/client/requests/CreatePhoneNumberRequest.js +0 -5
- package/dist/api/resources/phoneNumbers/client/requests/index.d.ts +0 -1
- package/dist/api/resources/phoneNumbers/client/requests/index.js +0 -2
- package/dist/api/resources/phoneNumbers/index.d.ts +0 -2
- package/dist/api/resources/phoneNumbers/index.js +0 -18
- package/dist/api/resources/phoneNumbers/types/CreatePhoneNumberRequestType.d.ts +0 -11
- package/dist/api/resources/phoneNumbers/types/CreatePhoneNumberRequestType.js +0 -10
- package/dist/api/resources/phoneNumbers/types/index.d.ts +0 -1
- package/dist/api/resources/phoneNumbers/types/index.js +0 -17
- package/dist/api/resources/users/client/Client.d.ts +0 -61
- package/dist/api/resources/users/client/Client.js +0 -180
- package/dist/api/resources/users/client/index.d.ts +0 -1
- package/dist/api/resources/users/client/index.js +0 -17
- package/dist/api/resources/users/client/requests/UserRequest.d.ts +0 -25
- package/dist/api/resources/users/client/requests/UserRequest.js +0 -5
- package/dist/api/resources/users/client/requests/index.d.ts +0 -1
- package/dist/api/resources/users/client/requests/index.js +0 -2
- package/dist/api/resources/users/index.d.ts +0 -1
- package/dist/api/resources/users/index.js +0 -17
- package/dist/api/resources/verifications/client/Client.d.ts +0 -60
- package/dist/api/resources/verifications/client/Client.js +0 -188
- package/dist/api/resources/verifications/client/index.d.ts +0 -1
- package/dist/api/resources/verifications/client/index.js +0 -17
- package/dist/api/resources/verifications/client/requests/VerificationCheckRequest.d.ts +0 -13
- package/dist/api/resources/verifications/client/requests/VerificationCheckRequest.js +0 -5
- package/dist/api/resources/verifications/client/requests/VerificationRequest.d.ts +0 -13
- package/dist/api/resources/verifications/client/requests/VerificationRequest.js +0 -5
- package/dist/api/resources/verifications/client/requests/index.d.ts +0 -2
- package/dist/api/resources/verifications/client/requests/index.js +0 -2
- package/dist/api/resources/verifications/index.d.ts +0 -1
- package/dist/api/resources/verifications/index.js +0 -17
- package/dist/api/types/AccountResponse.d.ts +0 -14
- package/dist/api/types/AccountResponse.js +0 -5
- package/dist/api/types/AttachmentParams.d.ts +0 -10
- package/dist/api/types/AttachmentParams.js +0 -5
- package/dist/api/types/AttachmentResponse.d.ts +0 -14
- package/dist/api/types/AttachmentResponse.js +0 -5
- package/dist/api/types/BlastResponse.d.ts +0 -18
- package/dist/api/types/BlastResponse.js +0 -5
- package/dist/api/types/BlastResponseAttachmentsItem.d.ts +0 -7
- package/dist/api/types/BlastResponseAttachmentsItem.js +0 -5
- package/dist/api/types/Contact.d.ts +0 -16
- package/dist/api/types/Contact.js +0 -5
- package/dist/api/types/ContactRequest.d.ts +0 -18
- package/dist/api/types/ContactRequest.js +0 -5
- package/dist/api/types/ContactResponse.d.ts +0 -20
- package/dist/api/types/ContactResponse.js +0 -5
- package/dist/api/types/Conversation.d.ts +0 -13
- package/dist/api/types/Conversation.js +0 -5
- package/dist/api/types/ConversationPhoneNumber.d.ts +0 -15
- package/dist/api/types/ConversationPhoneNumber.js +0 -5
- package/dist/api/types/ConversationPhoneNumberType.d.ts +0 -13
- package/dist/api/types/ConversationPhoneNumberType.js +0 -12
- package/dist/api/types/MessageConversationContactParams.d.ts +0 -14
- package/dist/api/types/MessageConversationContactParams.js +0 -5
- package/dist/api/types/MessageConversationParams.d.ts +0 -12
- package/dist/api/types/MessageConversationParams.js +0 -5
- package/dist/api/types/MessageResponse.d.ts +0 -15
- package/dist/api/types/MessageResponse.js +0 -5
- package/dist/api/types/PhoneNumber.d.ts +0 -15
- package/dist/api/types/PhoneNumber.js +0 -5
- package/dist/api/types/PhoneNumberType.d.ts +0 -11
- package/dist/api/types/PhoneNumberType.js +0 -10
- package/dist/api/types/UserResponse.d.ts +0 -18
- package/dist/api/types/UserResponse.js +0 -5
- package/dist/api/types/Verification.d.ts +0 -17
- package/dist/api/types/Verification.js +0 -5
- package/dist/api/types/VerificationCheckAlreadyVerifiedResponse.d.ts +0 -12
- package/dist/api/types/VerificationCheckAlreadyVerifiedResponse.js +0 -5
- package/dist/api/types/VerificationCheckAlreadyVerifiedResponseResult.d.ts +0 -14
- package/dist/api/types/VerificationCheckAlreadyVerifiedResponseResult.js +0 -13
- package/dist/api/types/VerificationCheckIncorrectResponse.d.ts +0 -12
- package/dist/api/types/VerificationCheckIncorrectResponse.js +0 -5
- package/dist/api/types/VerificationCheckIncorrectResponseResult.d.ts +0 -12
- package/dist/api/types/VerificationCheckIncorrectResponseResult.js +0 -11
- package/dist/api/types/VerificationCheckOkResponse.d.ts +0 -21
- package/dist/api/types/VerificationCheckOkResponse.js +0 -5
- package/dist/api/types/VerificationCheckOkResponseResult.d.ts +0 -21
- package/dist/api/types/VerificationCheckOkResponseResult.js +0 -13
- package/dist/api/types/VerificationStatus.d.ts +0 -13
- package/dist/api/types/VerificationStatus.js +0 -12
- package/dist/api/types/index.d.ts +0 -25
- package/dist/api/types/index.js +0 -41
- package/dist/core/auth/BasicAuth.d.ts +0 -8
- package/dist/core/auth/BasicAuth.js +0 -26
- package/dist/core/auth/BearerToken.d.ts +0 -5
- package/dist/core/auth/BearerToken.js +0 -15
- package/dist/core/auth/index.d.ts +0 -2
- package/dist/core/auth/index.js +0 -7
- package/dist/core/fetcher/APIResponse.d.ts +0 -20
- package/dist/core/fetcher/APIResponse.js +0 -2
- package/dist/core/fetcher/Fetcher.d.ts +0 -39
- package/dist/core/fetcher/Fetcher.js +0 -107
- package/dist/core/fetcher/Headers.d.ts +0 -2
- package/dist/core/fetcher/Headers.js +0 -84
- package/dist/core/fetcher/HttpResponsePromise.d.ts +0 -58
- package/dist/core/fetcher/HttpResponsePromise.js +0 -103
- package/dist/core/fetcher/RawResponse.d.ts +0 -29
- package/dist/core/fetcher/RawResponse.js +0 -44
- package/dist/core/fetcher/Supplier.d.ts +0 -4
- package/dist/core/fetcher/Supplier.js +0 -22
- package/dist/core/fetcher/createRequestUrl.d.ts +0 -1
- package/dist/core/fetcher/createRequestUrl.js +0 -12
- package/dist/core/fetcher/getFetchFn.d.ts +0 -4
- package/dist/core/fetcher/getFetchFn.js +0 -68
- package/dist/core/fetcher/getHeader.d.ts +0 -1
- package/dist/core/fetcher/getHeader.js +0 -11
- package/dist/core/fetcher/getRequestBody.d.ts +0 -7
- package/dist/core/fetcher/getRequestBody.js +0 -23
- package/dist/core/fetcher/getResponseBody.d.ts +0 -1
- package/dist/core/fetcher/getResponseBody.js +0 -54
- package/dist/core/fetcher/index.d.ts +0 -8
- package/dist/core/fetcher/index.js +0 -15
- package/dist/core/fetcher/makeRequest.d.ts +0 -1
- package/dist/core/fetcher/makeRequest.js +0 -42
- package/dist/core/fetcher/requestWithRetries.d.ts +0 -1
- package/dist/core/fetcher/requestWithRetries.js +0 -40
- package/dist/core/fetcher/signals.d.ts +0 -11
- package/dist/core/fetcher/signals.js +0 -36
- package/dist/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.d.ts +0 -30
- package/dist/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.js +0 -247
- package/dist/core/fetcher/stream-wrappers/NodePre18StreamWrapper.d.ts +0 -21
- package/dist/core/fetcher/stream-wrappers/NodePre18StreamWrapper.js +0 -126
- package/dist/core/fetcher/stream-wrappers/UndiciStreamWrapper.d.ts +0 -31
- package/dist/core/fetcher/stream-wrappers/UndiciStreamWrapper.js +0 -229
- package/dist/core/fetcher/stream-wrappers/chooseStreamWrapper.d.ts +0 -18
- package/dist/core/fetcher/stream-wrappers/chooseStreamWrapper.js +0 -59
- package/dist/core/index.d.ts +0 -3
- package/dist/core/index.js +0 -19
- package/dist/core/json.d.ts +0 -15
- package/dist/core/json.js +0 -24
- package/dist/core/runtime/index.d.ts +0 -1
- package/dist/core/runtime/index.js +0 -5
- package/dist/core/runtime/runtime.d.ts +0 -9
- package/dist/core/runtime/runtime.js +0 -103
- package/dist/environments.d.ts +0 -7
- package/dist/environments.js +0 -9
- package/dist/errors/SurgeError.d.ts +0 -15
- package/dist/errors/SurgeError.js +0 -30
- package/dist/errors/SurgeTimeoutError.d.ts +0 -6
- package/dist/errors/SurgeTimeoutError.js +0 -13
- package/dist/errors/index.d.ts +0 -2
- package/dist/errors/index.js +0 -7
- package/dist/index.d.ts +0 -4
- package/dist/index.js +0 -44
- package/dist/version.d.ts +0 -1
- package/dist/version.js +0 -4
- package/environments.d.ts +0 -7
- package/environments.js +0 -9
- package/errors/SurgeError.d.ts +0 -15
- package/errors/SurgeError.js +0 -30
- package/errors/SurgeTimeoutError.d.ts +0 -6
- package/errors/SurgeTimeoutError.js +0 -13
- package/errors/index.d.ts +0 -2
- package/errors/index.js +0 -7
- package/jest.config.mjs +0 -8
- package/reference.md +0 -897
- package/scripts/rename-to-esm-files.js +0 -115
|
@@ -0,0 +1,263 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import * as MessagesAPI from "./messages.js";
|
|
3
|
+
import * as ContactsAPI from "./contacts.js";
|
|
4
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
5
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
6
|
+
export declare class Messages extends APIResource {
|
|
7
|
+
/**
|
|
8
|
+
* Creates and enqueues a new message to be sent.
|
|
9
|
+
*
|
|
10
|
+
* Messages are always sent asynchronously. When you hit this endpoint, the message
|
|
11
|
+
* will be created within Surge's system and enqueued for sending, and then the id
|
|
12
|
+
* for the new message will be returned. When the message is actually sent, a
|
|
13
|
+
* `message.sent` webhook event will be triggered and sent to any webhook endpoints
|
|
14
|
+
* that you have subscribed to this event type. Then a `message.delivered` webhook
|
|
15
|
+
* event will be triggered when the carrier sends us a delivery receipt.
|
|
16
|
+
*
|
|
17
|
+
* By default all messages will be sent immediately. If you would like to schedule
|
|
18
|
+
* sending for some time up to 60 days in the future, you can do that by providing
|
|
19
|
+
* a value for the `send_at` field. This should be formatted as an ISO8601 datetime
|
|
20
|
+
* like `2028-10-14T18:06:00Z`.
|
|
21
|
+
*
|
|
22
|
+
* You must include either a `body` or `attachments` field (or both) in the request
|
|
23
|
+
* body. The `body` field should contain the text of the message you want to send,
|
|
24
|
+
* and the `attachments` field should be an array of objects with a `url` field
|
|
25
|
+
* pointing to the file you want to attach. Surge will download these files and
|
|
26
|
+
* send them as attachments in the message.
|
|
27
|
+
*
|
|
28
|
+
* You can provide either a `conversation` object or a `to` field to specify the
|
|
29
|
+
* intended recipient of the message, but an error will be returned if both fields
|
|
30
|
+
* are provided. Similarly the `from` field cannot be used together with the
|
|
31
|
+
* `conversation` field, and `conversation.phone_number` should be specified
|
|
32
|
+
* instead.
|
|
33
|
+
*
|
|
34
|
+
* @example
|
|
35
|
+
* ```ts
|
|
36
|
+
* const message = await client.messages.create(
|
|
37
|
+
* 'acct_01j9a43avnfqzbjfch6pygv1td',
|
|
38
|
+
* {
|
|
39
|
+
* conversation: {
|
|
40
|
+
* contact: { phone_number: '+18015551234' },
|
|
41
|
+
* },
|
|
42
|
+
* },
|
|
43
|
+
* );
|
|
44
|
+
* ```
|
|
45
|
+
*/
|
|
46
|
+
create(accountID: string, body: MessageCreateParams, options?: RequestOptions): APIPromise<Message>;
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Params for creating an attachment
|
|
50
|
+
*/
|
|
51
|
+
export interface AttachmentParams {
|
|
52
|
+
/**
|
|
53
|
+
* The URL of the attachment.
|
|
54
|
+
*/
|
|
55
|
+
url: string;
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* A Message is a communication sent to a Contact.
|
|
59
|
+
*/
|
|
60
|
+
export interface Message {
|
|
61
|
+
/**
|
|
62
|
+
* Unique identifier for the object.
|
|
63
|
+
*/
|
|
64
|
+
id?: string;
|
|
65
|
+
attachments?: Array<Message.Attachment>;
|
|
66
|
+
/**
|
|
67
|
+
* The message body.
|
|
68
|
+
*/
|
|
69
|
+
body?: string;
|
|
70
|
+
/**
|
|
71
|
+
* A conversation with a Contact
|
|
72
|
+
*/
|
|
73
|
+
conversation?: Message.Conversation;
|
|
74
|
+
}
|
|
75
|
+
export declare namespace Message {
|
|
76
|
+
/**
|
|
77
|
+
* An Attachment is a file that can be sent with a message.
|
|
78
|
+
*/
|
|
79
|
+
interface Attachment {
|
|
80
|
+
/**
|
|
81
|
+
* Unique identifier for the object.
|
|
82
|
+
*/
|
|
83
|
+
id?: string;
|
|
84
|
+
/**
|
|
85
|
+
* The type of attachment.
|
|
86
|
+
*/
|
|
87
|
+
type?: string;
|
|
88
|
+
/**
|
|
89
|
+
* The URL of the attachment.
|
|
90
|
+
*/
|
|
91
|
+
url?: string;
|
|
92
|
+
}
|
|
93
|
+
/**
|
|
94
|
+
* A conversation with a Contact
|
|
95
|
+
*/
|
|
96
|
+
interface Conversation {
|
|
97
|
+
/**
|
|
98
|
+
* Unique identifier for the object.
|
|
99
|
+
*/
|
|
100
|
+
id: string;
|
|
101
|
+
/**
|
|
102
|
+
* A contact who has consented to receive messages
|
|
103
|
+
*/
|
|
104
|
+
contact: ContactsAPI.Contact;
|
|
105
|
+
/**
|
|
106
|
+
* This is the phone number tied to the Surge account.
|
|
107
|
+
*/
|
|
108
|
+
phone_number?: Conversation.PhoneNumber;
|
|
109
|
+
}
|
|
110
|
+
namespace Conversation {
|
|
111
|
+
/**
|
|
112
|
+
* This is the phone number tied to the Surge account.
|
|
113
|
+
*/
|
|
114
|
+
interface PhoneNumber {
|
|
115
|
+
/**
|
|
116
|
+
* Unique identifier for the phone number
|
|
117
|
+
*/
|
|
118
|
+
id: string;
|
|
119
|
+
/**
|
|
120
|
+
* The canonical format of the phone number.
|
|
121
|
+
*/
|
|
122
|
+
number: string;
|
|
123
|
+
/**
|
|
124
|
+
* Whether the phone number is local, toll-free, or short code
|
|
125
|
+
*/
|
|
126
|
+
type: 'local' | 'toll_free' | 'short_code' | 'demo';
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
/**
|
|
131
|
+
* Payload for creating a message. Either an attachment or the body must be given.
|
|
132
|
+
* You can specify the recipient either using the 'conversation' parameter or the
|
|
133
|
+
* 'to'/'from' parameters, but not both.
|
|
134
|
+
*/
|
|
135
|
+
export type MessageParams = MessageParams.MessageParamsWithConversation | MessageParams.SimpleMessageParams;
|
|
136
|
+
export declare namespace MessageParams {
|
|
137
|
+
/**
|
|
138
|
+
* Create a message while including parameters for the conversation in which the
|
|
139
|
+
* message should be sent.
|
|
140
|
+
*/
|
|
141
|
+
interface MessageParamsWithConversation {
|
|
142
|
+
/**
|
|
143
|
+
* Params for selecting or creating a new conversation. Either the id or the
|
|
144
|
+
* Contact must be given.
|
|
145
|
+
*/
|
|
146
|
+
conversation: MessageParamsWithConversation.Conversation;
|
|
147
|
+
attachments?: Array<MessagesAPI.AttachmentParams>;
|
|
148
|
+
/**
|
|
149
|
+
* The message body.
|
|
150
|
+
*/
|
|
151
|
+
body?: string;
|
|
152
|
+
/**
|
|
153
|
+
* An optional datetime for scheduling message up to a couple of months in the
|
|
154
|
+
* future.
|
|
155
|
+
*/
|
|
156
|
+
send_at?: string;
|
|
157
|
+
}
|
|
158
|
+
namespace MessageParamsWithConversation {
|
|
159
|
+
/**
|
|
160
|
+
* Params for selecting or creating a new conversation. Either the id or the
|
|
161
|
+
* Contact must be given.
|
|
162
|
+
*/
|
|
163
|
+
interface Conversation {
|
|
164
|
+
/**
|
|
165
|
+
* Parameters for creating a contact
|
|
166
|
+
*/
|
|
167
|
+
contact: ContactsAPI.ContactParams;
|
|
168
|
+
/**
|
|
169
|
+
* The phone number from which to send the message. This can be either the phone
|
|
170
|
+
* number in E.164 format or a Surge phone number id.
|
|
171
|
+
*/
|
|
172
|
+
phone_number?: string;
|
|
173
|
+
}
|
|
174
|
+
}
|
|
175
|
+
/**
|
|
176
|
+
* Create a basic message by specifying just the to/from phone numbers.
|
|
177
|
+
*/
|
|
178
|
+
interface SimpleMessageParams {
|
|
179
|
+
/**
|
|
180
|
+
* The recipient's phone number in E.164 format. Cannot be used together with
|
|
181
|
+
* 'conversation'.
|
|
182
|
+
*/
|
|
183
|
+
to: string;
|
|
184
|
+
attachments?: Array<MessagesAPI.AttachmentParams>;
|
|
185
|
+
/**
|
|
186
|
+
* The message body.
|
|
187
|
+
*/
|
|
188
|
+
body?: string;
|
|
189
|
+
/**
|
|
190
|
+
* The sender's phone number in E.164 format or phone number ID. If omitted, uses
|
|
191
|
+
* the account's default phone number. Cannot be used together with 'conversation'.
|
|
192
|
+
*/
|
|
193
|
+
from?: string;
|
|
194
|
+
/**
|
|
195
|
+
* An optional datetime for scheduling message up to a couple of months in the
|
|
196
|
+
* future.
|
|
197
|
+
*/
|
|
198
|
+
send_at?: string;
|
|
199
|
+
}
|
|
200
|
+
}
|
|
201
|
+
export type MessageCreateParams = MessageCreateParams.MessageParamsWithConversation | MessageCreateParams.SimpleMessageParams;
|
|
202
|
+
export declare namespace MessageCreateParams {
|
|
203
|
+
interface MessageParamsWithConversation {
|
|
204
|
+
/**
|
|
205
|
+
* Params for selecting or creating a new conversation. Either the id or the
|
|
206
|
+
* Contact must be given.
|
|
207
|
+
*/
|
|
208
|
+
conversation: MessageParamsWithConversation.Conversation;
|
|
209
|
+
attachments?: Array<AttachmentParams>;
|
|
210
|
+
/**
|
|
211
|
+
* The message body.
|
|
212
|
+
*/
|
|
213
|
+
body?: string;
|
|
214
|
+
/**
|
|
215
|
+
* An optional datetime for scheduling message up to a couple of months in the
|
|
216
|
+
* future.
|
|
217
|
+
*/
|
|
218
|
+
send_at?: string;
|
|
219
|
+
}
|
|
220
|
+
namespace MessageParamsWithConversation {
|
|
221
|
+
/**
|
|
222
|
+
* Params for selecting or creating a new conversation. Either the id or the
|
|
223
|
+
* Contact must be given.
|
|
224
|
+
*/
|
|
225
|
+
interface Conversation {
|
|
226
|
+
/**
|
|
227
|
+
* Parameters for creating a contact
|
|
228
|
+
*/
|
|
229
|
+
contact: ContactsAPI.ContactParams;
|
|
230
|
+
/**
|
|
231
|
+
* The phone number from which to send the message. This can be either the phone
|
|
232
|
+
* number in E.164 format or a Surge phone number id.
|
|
233
|
+
*/
|
|
234
|
+
phone_number?: string;
|
|
235
|
+
}
|
|
236
|
+
}
|
|
237
|
+
interface SimpleMessageParams {
|
|
238
|
+
/**
|
|
239
|
+
* The recipient's phone number in E.164 format. Cannot be used together with
|
|
240
|
+
* 'conversation'.
|
|
241
|
+
*/
|
|
242
|
+
to: string;
|
|
243
|
+
attachments?: Array<AttachmentParams>;
|
|
244
|
+
/**
|
|
245
|
+
* The message body.
|
|
246
|
+
*/
|
|
247
|
+
body?: string;
|
|
248
|
+
/**
|
|
249
|
+
* The sender's phone number in E.164 format or phone number ID. If omitted, uses
|
|
250
|
+
* the account's default phone number. Cannot be used together with 'conversation'.
|
|
251
|
+
*/
|
|
252
|
+
from?: string;
|
|
253
|
+
/**
|
|
254
|
+
* An optional datetime for scheduling message up to a couple of months in the
|
|
255
|
+
* future.
|
|
256
|
+
*/
|
|
257
|
+
send_at?: string;
|
|
258
|
+
}
|
|
259
|
+
}
|
|
260
|
+
export declare namespace Messages {
|
|
261
|
+
export { type AttachmentParams as AttachmentParams, type Message as Message, type MessageParams as MessageParams, type MessageCreateParams as MessageCreateParams, };
|
|
262
|
+
}
|
|
263
|
+
//# sourceMappingURL=messages.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;CAGpG;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,WAAW,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAExC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC;CACrC;AAED,yBAAiB,OAAO,CAAC;IACvB;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;IAED;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC;QAE7B;;WAEG;QACH,YAAY,CAAC,EAAE,YAAY,CAAC,WAAW,CAAC;KACzC;IAED,UAAiB,YAAY,CAAC;QAC5B;;WAEG;QACH,UAAiB,WAAW;YAC1B;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,IAAI,EAAE,OAAO,GAAG,WAAW,GAAG,YAAY,GAAG,MAAM,CAAC;SACrD;KACF;CACF;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,aAAa,CAAC,6BAA6B,GAAG,aAAa,CAAC,mBAAmB,CAAC;AAE5G,yBAAiB,aAAa,CAAC;IAC7B;;;OAGG;IACH,UAAiB,6BAA6B;QAC5C;;;WAGG;QACH,YAAY,EAAE,6BAA6B,CAAC,YAAY,CAAC;QAEzD,WAAW,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;QAElD;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED,UAAiB,6BAA6B,CAAC;QAC7C;;;WAGG;QACH,UAAiB,YAAY;YAC3B;;eAEG;YACH,OAAO,EAAE,WAAW,CAAC,aAAa,CAAC;YAEnC;;;eAGG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;SACvB;KACF;IAED;;OAEG;IACH,UAAiB,mBAAmB;QAClC;;;WAGG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX,WAAW,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;QAElD;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,MAAM,mBAAmB,GAC3B,mBAAmB,CAAC,6BAA6B,GACjD,mBAAmB,CAAC,mBAAmB,CAAC;AAE5C,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,UAAiB,6BAA6B;QAC5C;;;WAGG;QACH,YAAY,EAAE,6BAA6B,CAAC,YAAY,CAAC;QAEzD,WAAW,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;QAEtC;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED,UAAiB,6BAA6B,CAAC;QAC7C;;;WAGG;QACH,UAAiB,YAAY;YAC3B;;eAEG;YACH,OAAO,EAAE,WAAW,CAAC,aAAa,CAAC;YAEnC;;;eAGG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;SACvB;KACF;IAED,UAAiB,mBAAmB;QAClC;;;WAGG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX,WAAW,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;QAEtC;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|
|
@@ -0,0 +1,52 @@
|
|
|
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.Messages = void 0;
|
|
5
|
+
const resource_1 = require("../core/resource.js");
|
|
6
|
+
const path_1 = require("../internal/utils/path.js");
|
|
7
|
+
class Messages extends resource_1.APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Creates and enqueues a new message to be sent.
|
|
10
|
+
*
|
|
11
|
+
* Messages are always sent asynchronously. When you hit this endpoint, the message
|
|
12
|
+
* will be created within Surge's system and enqueued for sending, and then the id
|
|
13
|
+
* for the new message will be returned. When the message is actually sent, a
|
|
14
|
+
* `message.sent` webhook event will be triggered and sent to any webhook endpoints
|
|
15
|
+
* that you have subscribed to this event type. Then a `message.delivered` webhook
|
|
16
|
+
* event will be triggered when the carrier sends us a delivery receipt.
|
|
17
|
+
*
|
|
18
|
+
* By default all messages will be sent immediately. If you would like to schedule
|
|
19
|
+
* sending for some time up to 60 days in the future, you can do that by providing
|
|
20
|
+
* a value for the `send_at` field. This should be formatted as an ISO8601 datetime
|
|
21
|
+
* like `2028-10-14T18:06:00Z`.
|
|
22
|
+
*
|
|
23
|
+
* You must include either a `body` or `attachments` field (or both) in the request
|
|
24
|
+
* body. The `body` field should contain the text of the message you want to send,
|
|
25
|
+
* and the `attachments` field should be an array of objects with a `url` field
|
|
26
|
+
* pointing to the file you want to attach. Surge will download these files and
|
|
27
|
+
* send them as attachments in the message.
|
|
28
|
+
*
|
|
29
|
+
* You can provide either a `conversation` object or a `to` field to specify the
|
|
30
|
+
* intended recipient of the message, but an error will be returned if both fields
|
|
31
|
+
* are provided. Similarly the `from` field cannot be used together with the
|
|
32
|
+
* `conversation` field, and `conversation.phone_number` should be specified
|
|
33
|
+
* instead.
|
|
34
|
+
*
|
|
35
|
+
* @example
|
|
36
|
+
* ```ts
|
|
37
|
+
* const message = await client.messages.create(
|
|
38
|
+
* 'acct_01j9a43avnfqzbjfch6pygv1td',
|
|
39
|
+
* {
|
|
40
|
+
* conversation: {
|
|
41
|
+
* contact: { phone_number: '+18015551234' },
|
|
42
|
+
* },
|
|
43
|
+
* },
|
|
44
|
+
* );
|
|
45
|
+
* ```
|
|
46
|
+
*/
|
|
47
|
+
create(accountID, body, options) {
|
|
48
|
+
return this._client.post((0, path_1.path) `/accounts/${accountID}/messages`, { body, ...options });
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
exports.Messages = Messages;
|
|
52
|
+
//# sourceMappingURL=messages.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"messages.js","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAK/C,oDAA8C;AAE9C,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAyB,EAAE,OAAwB;QAC3E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;CACF;AA3CD,4BA2CC"}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../core/resource.mjs";
|
|
3
|
+
import { path } from "../internal/utils/path.mjs";
|
|
4
|
+
export class Messages extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Creates and enqueues a new message to be sent.
|
|
7
|
+
*
|
|
8
|
+
* Messages are always sent asynchronously. When you hit this endpoint, the message
|
|
9
|
+
* will be created within Surge's system and enqueued for sending, and then the id
|
|
10
|
+
* for the new message will be returned. When the message is actually sent, a
|
|
11
|
+
* `message.sent` webhook event will be triggered and sent to any webhook endpoints
|
|
12
|
+
* that you have subscribed to this event type. Then a `message.delivered` webhook
|
|
13
|
+
* event will be triggered when the carrier sends us a delivery receipt.
|
|
14
|
+
*
|
|
15
|
+
* By default all messages will be sent immediately. If you would like to schedule
|
|
16
|
+
* sending for some time up to 60 days in the future, you can do that by providing
|
|
17
|
+
* a value for the `send_at` field. This should be formatted as an ISO8601 datetime
|
|
18
|
+
* like `2028-10-14T18:06:00Z`.
|
|
19
|
+
*
|
|
20
|
+
* You must include either a `body` or `attachments` field (or both) in the request
|
|
21
|
+
* body. The `body` field should contain the text of the message you want to send,
|
|
22
|
+
* and the `attachments` field should be an array of objects with a `url` field
|
|
23
|
+
* pointing to the file you want to attach. Surge will download these files and
|
|
24
|
+
* send them as attachments in the message.
|
|
25
|
+
*
|
|
26
|
+
* You can provide either a `conversation` object or a `to` field to specify the
|
|
27
|
+
* intended recipient of the message, but an error will be returned if both fields
|
|
28
|
+
* are provided. Similarly the `from` field cannot be used together with the
|
|
29
|
+
* `conversation` field, and `conversation.phone_number` should be specified
|
|
30
|
+
* instead.
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* ```ts
|
|
34
|
+
* const message = await client.messages.create(
|
|
35
|
+
* 'acct_01j9a43avnfqzbjfch6pygv1td',
|
|
36
|
+
* {
|
|
37
|
+
* conversation: {
|
|
38
|
+
* contact: { phone_number: '+18015551234' },
|
|
39
|
+
* },
|
|
40
|
+
* },
|
|
41
|
+
* );
|
|
42
|
+
* ```
|
|
43
|
+
*/
|
|
44
|
+
create(accountID, body, options) {
|
|
45
|
+
return this._client.post(path `/accounts/${accountID}/messages`, { body, ...options });
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
//# sourceMappingURL=messages.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"messages.mjs","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAKf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAyB,EAAE,OAAwB;QAC3E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,SAAS,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;CACF"}
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
3
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
4
|
+
export declare class PhoneNumbers extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Purchase a new phone number for the account. You can specify search criteria or
|
|
7
|
+
* let the system select a random number.
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```ts
|
|
11
|
+
* const phoneNumber = await client.phoneNumbers.purchase(
|
|
12
|
+
* 'acct_01j9a43avnfqzbjfch6pygv1td',
|
|
13
|
+
* );
|
|
14
|
+
* ```
|
|
15
|
+
*/
|
|
16
|
+
purchase(accountID: string, body: PhoneNumberPurchaseParams, options?: RequestOptions): APIPromise<PhoneNumber>;
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* A phone number that can be used to send and receive messages and calls
|
|
20
|
+
*/
|
|
21
|
+
export interface PhoneNumber {
|
|
22
|
+
/**
|
|
23
|
+
* Unique identifier for the phone number
|
|
24
|
+
*/
|
|
25
|
+
id: string;
|
|
26
|
+
/**
|
|
27
|
+
* The phone number in E.164 format
|
|
28
|
+
*/
|
|
29
|
+
number: string;
|
|
30
|
+
/**
|
|
31
|
+
* Whether the phone number is local, toll-free, or short code
|
|
32
|
+
*/
|
|
33
|
+
type: 'local' | 'toll_free';
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* Parameters for purchasing a new phone number. The system will automatically
|
|
37
|
+
* infer the type in certain cases:
|
|
38
|
+
*
|
|
39
|
+
* - If only area_code is provided, type is inferred from the area code
|
|
40
|
+
* - If only latitude/longitude are provided, type is inferred as 'local'
|
|
41
|
+
* - Otherwise, type must be explicitly specified
|
|
42
|
+
*/
|
|
43
|
+
export interface PhoneNumberPurchaseParams {
|
|
44
|
+
/**
|
|
45
|
+
* The desired area code for this phone number. If provided without type, the type
|
|
46
|
+
* will be inferred.
|
|
47
|
+
*/
|
|
48
|
+
area_code?: string;
|
|
49
|
+
/**
|
|
50
|
+
* Latitude to search for nearby phone numbers. Must be used with longitude. If
|
|
51
|
+
* provided without type, type will be inferred as 'local'.
|
|
52
|
+
*/
|
|
53
|
+
latitude?: number;
|
|
54
|
+
/**
|
|
55
|
+
* Longitude to search for nearby phone numbers. Must be used with latitude. If
|
|
56
|
+
* provided without type, type will be inferred as 'local'.
|
|
57
|
+
*/
|
|
58
|
+
longitude?: number;
|
|
59
|
+
/**
|
|
60
|
+
* Whether the phone number is local or toll-free. Can be omitted if area_code or
|
|
61
|
+
* latitude/longitude are provided.
|
|
62
|
+
*/
|
|
63
|
+
type?: 'local' | 'toll_free';
|
|
64
|
+
}
|
|
65
|
+
export interface PhoneNumberPurchaseParams {
|
|
66
|
+
/**
|
|
67
|
+
* The desired area code for this phone number. If provided without type, the type
|
|
68
|
+
* will be inferred.
|
|
69
|
+
*/
|
|
70
|
+
area_code?: string;
|
|
71
|
+
/**
|
|
72
|
+
* Latitude to search for nearby phone numbers. Must be used with longitude. If
|
|
73
|
+
* provided without type, type will be inferred as 'local'.
|
|
74
|
+
*/
|
|
75
|
+
latitude?: number;
|
|
76
|
+
/**
|
|
77
|
+
* Longitude to search for nearby phone numbers. Must be used with latitude. If
|
|
78
|
+
* provided without type, type will be inferred as 'local'.
|
|
79
|
+
*/
|
|
80
|
+
longitude?: number;
|
|
81
|
+
/**
|
|
82
|
+
* Whether the phone number is local or toll-free. Can be omitted if area_code or
|
|
83
|
+
* latitude/longitude are provided.
|
|
84
|
+
*/
|
|
85
|
+
type?: 'local' | 'toll_free';
|
|
86
|
+
}
|
|
87
|
+
export declare namespace PhoneNumbers {
|
|
88
|
+
export { type PhoneNumber as PhoneNumber, type PhoneNumberPurchaseParams as PhoneNumberPurchaseParams };
|
|
89
|
+
}
|
|
90
|
+
//# sourceMappingURL=phone-numbers.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"phone-numbers.d.mts","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;OAUG;IACH,QAAQ,CACN,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,WAAW,CAAC;CAG3B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,OAAO,GAAG,WAAW,CAAC;CAC7B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,WAAW,CAAC;CAC9B;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,WAAW,CAAC;CAC9B;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EAAE,KAAK,WAAW,IAAI,WAAW,EAAE,KAAK,yBAAyB,IAAI,yBAAyB,EAAE,CAAC;CACzG"}
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
3
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
4
|
+
export declare class PhoneNumbers extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Purchase a new phone number for the account. You can specify search criteria or
|
|
7
|
+
* let the system select a random number.
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```ts
|
|
11
|
+
* const phoneNumber = await client.phoneNumbers.purchase(
|
|
12
|
+
* 'acct_01j9a43avnfqzbjfch6pygv1td',
|
|
13
|
+
* );
|
|
14
|
+
* ```
|
|
15
|
+
*/
|
|
16
|
+
purchase(accountID: string, body: PhoneNumberPurchaseParams, options?: RequestOptions): APIPromise<PhoneNumber>;
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* A phone number that can be used to send and receive messages and calls
|
|
20
|
+
*/
|
|
21
|
+
export interface PhoneNumber {
|
|
22
|
+
/**
|
|
23
|
+
* Unique identifier for the phone number
|
|
24
|
+
*/
|
|
25
|
+
id: string;
|
|
26
|
+
/**
|
|
27
|
+
* The phone number in E.164 format
|
|
28
|
+
*/
|
|
29
|
+
number: string;
|
|
30
|
+
/**
|
|
31
|
+
* Whether the phone number is local, toll-free, or short code
|
|
32
|
+
*/
|
|
33
|
+
type: 'local' | 'toll_free';
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* Parameters for purchasing a new phone number. The system will automatically
|
|
37
|
+
* infer the type in certain cases:
|
|
38
|
+
*
|
|
39
|
+
* - If only area_code is provided, type is inferred from the area code
|
|
40
|
+
* - If only latitude/longitude are provided, type is inferred as 'local'
|
|
41
|
+
* - Otherwise, type must be explicitly specified
|
|
42
|
+
*/
|
|
43
|
+
export interface PhoneNumberPurchaseParams {
|
|
44
|
+
/**
|
|
45
|
+
* The desired area code for this phone number. If provided without type, the type
|
|
46
|
+
* will be inferred.
|
|
47
|
+
*/
|
|
48
|
+
area_code?: string;
|
|
49
|
+
/**
|
|
50
|
+
* Latitude to search for nearby phone numbers. Must be used with longitude. If
|
|
51
|
+
* provided without type, type will be inferred as 'local'.
|
|
52
|
+
*/
|
|
53
|
+
latitude?: number;
|
|
54
|
+
/**
|
|
55
|
+
* Longitude to search for nearby phone numbers. Must be used with latitude. If
|
|
56
|
+
* provided without type, type will be inferred as 'local'.
|
|
57
|
+
*/
|
|
58
|
+
longitude?: number;
|
|
59
|
+
/**
|
|
60
|
+
* Whether the phone number is local or toll-free. Can be omitted if area_code or
|
|
61
|
+
* latitude/longitude are provided.
|
|
62
|
+
*/
|
|
63
|
+
type?: 'local' | 'toll_free';
|
|
64
|
+
}
|
|
65
|
+
export interface PhoneNumberPurchaseParams {
|
|
66
|
+
/**
|
|
67
|
+
* The desired area code for this phone number. If provided without type, the type
|
|
68
|
+
* will be inferred.
|
|
69
|
+
*/
|
|
70
|
+
area_code?: string;
|
|
71
|
+
/**
|
|
72
|
+
* Latitude to search for nearby phone numbers. Must be used with longitude. If
|
|
73
|
+
* provided without type, type will be inferred as 'local'.
|
|
74
|
+
*/
|
|
75
|
+
latitude?: number;
|
|
76
|
+
/**
|
|
77
|
+
* Longitude to search for nearby phone numbers. Must be used with latitude. If
|
|
78
|
+
* provided without type, type will be inferred as 'local'.
|
|
79
|
+
*/
|
|
80
|
+
longitude?: number;
|
|
81
|
+
/**
|
|
82
|
+
* Whether the phone number is local or toll-free. Can be omitted if area_code or
|
|
83
|
+
* latitude/longitude are provided.
|
|
84
|
+
*/
|
|
85
|
+
type?: 'local' | 'toll_free';
|
|
86
|
+
}
|
|
87
|
+
export declare namespace PhoneNumbers {
|
|
88
|
+
export { type PhoneNumber as PhoneNumber, type PhoneNumberPurchaseParams as PhoneNumberPurchaseParams };
|
|
89
|
+
}
|
|
90
|
+
//# sourceMappingURL=phone-numbers.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"phone-numbers.d.ts","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;OAUG;IACH,QAAQ,CACN,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,WAAW,CAAC;CAG3B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,OAAO,GAAG,WAAW,CAAC;CAC7B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,WAAW,CAAC;CAC9B;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,WAAW,CAAC;CAC9B;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EAAE,KAAK,WAAW,IAAI,WAAW,EAAE,KAAK,yBAAyB,IAAI,yBAAyB,EAAE,CAAC;CACzG"}
|
|
@@ -0,0 +1,24 @@
|
|
|
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.PhoneNumbers = void 0;
|
|
5
|
+
const resource_1 = require("../core/resource.js");
|
|
6
|
+
const path_1 = require("../internal/utils/path.js");
|
|
7
|
+
class PhoneNumbers extends resource_1.APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Purchase a new phone number for the account. You can specify search criteria or
|
|
10
|
+
* let the system select a random number.
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* const phoneNumber = await client.phoneNumbers.purchase(
|
|
15
|
+
* 'acct_01j9a43avnfqzbjfch6pygv1td',
|
|
16
|
+
* );
|
|
17
|
+
* ```
|
|
18
|
+
*/
|
|
19
|
+
purchase(accountID, body, options) {
|
|
20
|
+
return this._client.post((0, path_1.path) `/accounts/${accountID}/phone_numbers`, { body, ...options });
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
exports.PhoneNumbers = PhoneNumbers;
|
|
24
|
+
//# sourceMappingURL=phone-numbers.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"phone-numbers.js","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;OAUG;IACH,QAAQ,CACN,SAAiB,EACjB,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;CACF;AAnBD,oCAmBC"}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../core/resource.mjs";
|
|
3
|
+
import { path } from "../internal/utils/path.mjs";
|
|
4
|
+
export class PhoneNumbers extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Purchase a new phone number for the account. You can specify search criteria or
|
|
7
|
+
* let the system select a random number.
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```ts
|
|
11
|
+
* const phoneNumber = await client.phoneNumbers.purchase(
|
|
12
|
+
* 'acct_01j9a43avnfqzbjfch6pygv1td',
|
|
13
|
+
* );
|
|
14
|
+
* ```
|
|
15
|
+
*/
|
|
16
|
+
purchase(accountID, body, options) {
|
|
17
|
+
return this._client.post(path `/accounts/${accountID}/phone_numbers`, { body, ...options });
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
//# sourceMappingURL=phone-numbers.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"phone-numbers.mjs","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;OAUG;IACH,QAAQ,CACN,SAAiB,EACjB,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,SAAS,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;CACF"}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* An error response
|
|
3
|
+
*/
|
|
4
|
+
export interface Error {
|
|
5
|
+
/**
|
|
6
|
+
* A human-readable error message.
|
|
7
|
+
*/
|
|
8
|
+
message: string;
|
|
9
|
+
/**
|
|
10
|
+
* A unique error code.
|
|
11
|
+
*/
|
|
12
|
+
type: string;
|
|
13
|
+
/**
|
|
14
|
+
* Additional details about the error.
|
|
15
|
+
*/
|
|
16
|
+
detail?: {
|
|
17
|
+
[key: string]: unknown;
|
|
18
|
+
};
|
|
19
|
+
}
|
|
20
|
+
//# sourceMappingURL=shared.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"shared.d.mts","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACrC"}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* An error response
|
|
3
|
+
*/
|
|
4
|
+
export interface Error {
|
|
5
|
+
/**
|
|
6
|
+
* A human-readable error message.
|
|
7
|
+
*/
|
|
8
|
+
message: string;
|
|
9
|
+
/**
|
|
10
|
+
* A unique error code.
|
|
11
|
+
*/
|
|
12
|
+
type: string;
|
|
13
|
+
/**
|
|
14
|
+
* Additional details about the error.
|
|
15
|
+
*/
|
|
16
|
+
detail?: {
|
|
17
|
+
[key: string]: unknown;
|
|
18
|
+
};
|
|
19
|
+
}
|
|
20
|
+
//# sourceMappingURL=shared.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACrC"}
|