release: 0.1.0-alpha.3 (#8)

* chore: rebuild project due to codegen change (#7)
* chore: rebuild project due to codegen change (#9)
* feat(api): update via SDK Studio (#10)
* docs: remove suggestion to use `npm` call out (#11)
* chore: remove redundant word in comment (#12)
* feat(api): update via SDK Studio (#13)
* release: 0.1.0-alpha.3

---------

Co-authored-by: stainless-app[bot] <142633134+stainless-app[bot]@users.noreply.github.com>

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0-alpha.2"
+  ".": "0.1.0-alpha.3"
 }

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 5
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/prelude%2Fprelude-c1f72f65743e762371400a6f36ba21d4e68ceaa351cb3ea7674cbc04a39e298c.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/prelude%2Fprelude-64c1896dedae5302f4967c8edb2a675a48cba330193a20bdda1409fe3f9f9972.yml

CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 0.1.0-alpha.3 (2024-11-27)
+
+Full Changelog: [v0.1.0-alpha.2...v0.1.0-alpha.3](https://github.com/prelude-so/node-sdk/compare/v0.1.0-alpha.2...v0.1.0-alpha.3)
+
+### Features
+
+* **api:** update via SDK Studio ([#10](https://github.com/prelude-so/node-sdk/issues/10)) ([d277131](https://github.com/prelude-so/node-sdk/commit/d277131154feb7cce57a19607d47a82e68379cc3))
+* **api:** update via SDK Studio ([#13](https://github.com/prelude-so/node-sdk/issues/13)) ([9076480](https://github.com/prelude-so/node-sdk/commit/90764803242e1f86cc395afb2999cbf65c577e22))
+
+
+### Chores
+
+* rebuild project due to codegen change ([#7](https://github.com/prelude-so/node-sdk/issues/7)) ([fbd619a](https://github.com/prelude-so/node-sdk/commit/fbd619a97871f32f2f6db1bef742056ff3e88316))
+* rebuild project due to codegen change ([#9](https://github.com/prelude-so/node-sdk/issues/9)) ([4f36b85](https://github.com/prelude-so/node-sdk/commit/4f36b85418435bd41634c259d86f30cac04468fc))
+* remove redundant word in comment ([#12](https://github.com/prelude-so/node-sdk/issues/12)) ([df260b2](https://github.com/prelude-so/node-sdk/commit/df260b24e841d66cae8cbd841554703d499a0c82))
+
+
+### Documentation
+
+* remove suggestion to use `npm` call out ([#11](https://github.com/prelude-so/node-sdk/issues/11)) ([21912b9](https://github.com/prelude-so/node-sdk/commit/21912b969ff5b0d0d01d97ffddbcb4ad89b829ea))
+
 ## 0.1.0-alpha.2 (2024-11-13)
 
 Full Changelog: [v0.1.0-alpha.1...v0.1.0-alpha.2](https://github.com/prelude-so/node-sdk/compare/v0.1.0-alpha.1...v0.1.0-alpha.2)

README.md

@@ -293,6 +293,15 @@ TypeScript >= 4.5 is supported.
 
 The following runtimes are supported:
 
+- Web browsers (Up-to-date Chrome, Firefox, Safari, Edge, and more)
+- Node.js 18 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.
+- Deno v1.28.0 or higher.
+- Bun 1.0 or later.
+- Cloudflare Workers.
+- Vercel Edge Runtime.
+- Jest 28 or greater with the `"node"` environment (`"jsdom"` is not supported at this time).
+- Nitro v2.6 or greater.
+
 Note that React Native is not supported at this time.
 
 If you are interested in other runtime environments, please open or upvote an issue on GitHub.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prelude.so/sdk",
-  "version": "0.1.0-alpha.2",
+  "version": "0.1.0-alpha.3",
   "description": "The official TypeScript library for the Prelude API",
   "author": "Prelude <[email protected]>",
   "types": "dist/index.d.ts",
@@ -45,7 +45,6 @@
     "jest": "^29.4.0",
     "prettier": "^3.0.0",
     "ts-jest": "^29.1.0",
-    "ts-morph": "^19.0.0",
     "ts-node": "^10.5.0",
     "tsc-multi": "^1.1.0",
     "tsconfig-paths": "^4.0.0",

scripts/build

@@ -32,7 +32,7 @@ npm exec tsc-multi
 # copy over handwritten .js/.mjs/.d.ts files
 cp src/_shims/*.{d.ts,js,mjs,md} dist/_shims
 cp src/_shims/auto/*.{d.ts,js,mjs} dist/_shims/auto
-# we need to add exports = module.exports = Prelude Node to index.js;
+# we need to add exports = module.exports = Prelude to index.js;
 # No way to get that from index.ts because it would cause compile errors
 # when building .mjs
 node scripts/utils/fix-index-exports.cjs

src/index.ts

@@ -203,7 +203,7 @@ export declare namespace Prelude {
   };
 }
 
-export { toFile, fileFromPath } from '@prelude.so/sdk/uploads';
+export { toFile, fileFromPath } from './uploads';
 export {
   PreludeError,
   APIError,
@@ -218,6 +218,6 @@ export {
   InternalServerError,
   PermissionDeniedError,
   UnprocessableEntityError,
-} from '@prelude.so/sdk/error';
+} from './error';
 
 export default Prelude;

src/resources/verification.ts

@@ -31,24 +31,24 @@ export interface VerificationCreateResponse {
   /**
    * The verification identifier.
    */
-  id?: string;
+  id: string;
 
   /**
-   * The metadata for this verification.
+   * The method used for verifying this phone number.
    */
-  metadata?: VerificationCreateResponse.Metadata;
+  method: 'message';
 
   /**
-   * The method used for verifying this phone number.
+   * The status of the verification.
    */
-  method?: 'message';
-
-  request_id?: string;
+  status: 'success' | 'retry' | 'blocked';
 
   /**
-   * The status of the verification.
+   * The metadata for this verification.
    */
-  status?: 'success' | 'retry' | 'blocked';
+  metadata?: VerificationCreateResponse.Metadata;
+
+  request_id?: string;
 }
 
 export namespace VerificationCreateResponse {
@@ -61,6 +61,11 @@ export namespace VerificationCreateResponse {
 }
 
 export interface VerificationCheckResponse {
+  /**
+   * The status of the check.
+   */
+  status: 'success' | 'failure' | 'expired_or_not_found';
+
   /**
    * The verification identifier.
    */
@@ -72,11 +77,6 @@ export interface VerificationCheckResponse {
   metadata?: VerificationCheckResponse.Metadata;
 
   request_id?: string;
-
-  /**
-   * The status of the check.
-   */
-  status?: 'success' | 'failure' | 'expired';
 }
 
 export namespace VerificationCheckResponse {
@@ -148,6 +148,13 @@ export namespace VerificationCreateParams {
      */
     app_realm?: string;
 
+    /**
+     * The custom code to use for OTP verification. This feature is only available for
+     * compatibility purposes and subject to Prelude’s approval. Contact us to discuss
+     * your use case.
+     */
+    custom_code?: string;
+
     /**
      * A BCP-47 formatted locale string with the language the text message will be sent
      * to. If there's no locale set, the language will be determined by the country
@@ -193,7 +200,7 @@ export namespace VerificationCreateParams {
     /**
      * The type of the user's device.
      */
-    device_platform?: 'android' | 'ios' | 'web';
+    device_platform?: 'android' | 'ios' | 'ipados' | 'tvos' | 'web';
 
     /**
      * The IP address of the user's device.

src/resources/watch.ts

@@ -26,21 +26,21 @@ export interface WatchFeedBackResponse {
   /**
    * A unique identifier for your feedback request.
    */
-  id?: string;
+  id: string;
 }
 
 export interface WatchPredictResponse {
   /**
    * A unique identifier for your prediction request.
    */
-  id?: string;
+  id: string;
 
   /**
    * A label indicating the trustworthiness of the phone number.
    */
-  prediction?: 'allow' | 'block';
+  prediction: 'allow' | 'block';
 
-  reasoning?: WatchPredictResponse.Reasoning;
+  reasoning: WatchPredictResponse.Reasoning;
 }
 
 export namespace WatchPredictResponse {

src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.1.0-alpha.2'; // x-release-please-version
+export const VERSION = '0.1.0-alpha.3'; // x-release-please-version

tests/api-resources/transactional.test.ts

@@ -11,7 +11,10 @@ const client = new Prelude({
 describe('resource transactional', () => {
   // skipped: currently no good way to test endpoints defining callbacks, Prism mock server will fail trying to reach the provided callback url
   test.skip('send: only required params', async () => {
-    const responsePromise = client.transactional.send({ template_id: 'template_id', to: 'to' });
+    const responsePromise = client.transactional.send({
+      template_id: 'template_01jd1xq0cffycayqtdkdbv4d61',
+      to: '+30123456789',
+    });
     const rawResponse = await responsePromise.asResponse();
     expect(rawResponse).toBeInstanceOf(Response);
     const response = await responsePromise;
@@ -24,13 +27,13 @@ describe('resource transactional', () => {
   // skipped: currently no good way to test endpoints defining callbacks, Prism mock server will fail trying to reach the provided callback url
   test.skip('send: required and optional params', async () => {
     const response = await client.transactional.send({
-      template_id: 'template_id',
-      to: 'to',
+      template_id: 'template_01jd1xq0cffycayqtdkdbv4d61',
+      to: '+30123456789',
       callback_url: 'callback_url',
       correlation_id: 'correlation_id',
       expires_at: 'expires_at',
       from: 'from',
-      variables: { foo: 'string' },
+      variables: { foo: 'bar' },
     });
   });
 });

tests/api-resources/verification.test.ts

@@ -28,6 +28,7 @@ describe('resource verification', () => {
       metadata: { correlation_id: 'correlation_id' },
       options: {
         app_realm: 'app_realm',
+        custom_code: 'custom_code',
         locale: 'el-GR',
         sender_id: 'sender_id',
         template_id: 'template_id',

yarn.lock

@@ -759,16 +759,6 @@
   dependencies:
     "@swc/counter" "^0.1.3"
 
-"@ts-morph/common@~0.20.0":
-  version "0.20.0"
-  resolved "https://registry.yarnpkg.com/@ts-morph/common/-/common-0.20.0.tgz#3f161996b085ba4519731e4d24c35f6cba5b80af"
-  integrity sha512-7uKjByfbPpwuzkstL3L5MQyuXPSKdoNG93Fmi2JoDcTf3pEP731JdRFAduRVkOs8oqxPsXKA+ScrWkdQ8t/I+Q==
-  dependencies:
-    fast-glob "^3.2.12"
-    minimatch "^7.4.3"
-    mkdirp "^2.1.6"
-    path-browserify "^1.0.1"
-
 "@tsconfig/node10@^1.0.7":
   version "1.0.8"
   resolved "https://registry.yarnpkg.com/@tsconfig/node10/-/node10-1.0.8.tgz#c1e4e80d6f964fbecb3359c43bd48b40f7cadad9"
@@ -1315,11 +1305,6 @@ co@^4.6.0:
   resolved "https://registry.yarnpkg.com/co/-/co-4.6.0.tgz#6ea6bdf3d853ae54ccb8e47bfa0bf3f9031fb184"
   integrity sha512-QVb0dM5HvG+uaxitm8wONl7jltx8dqhfU33DcqtOZcLSVIKSDDLDi7+0LbAKiyI8hD9u42m2YxXSkMGWThaecQ==
 
-code-block-writer@^12.0.0:
-  version "12.0.0"
-  resolved "https://registry.yarnpkg.com/code-block-writer/-/code-block-writer-12.0.0.tgz#4dd58946eb4234105aff7f0035977b2afdc2a770"
-  integrity sha512-q4dMFMlXtKR3XNBHyMHt/3pwYNA69EDk00lloMOaaUMKPUXBw6lpXtbu3MMVG6/uOihGnRDOlkyqsONEUj60+w==
-
 collect-v8-coverage@^1.0.0:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/collect-v8-coverage/-/collect-v8-coverage-1.0.2.tgz#c0b29bcd33bcd0779a1344c2136051e6afd3d9e9"
@@ -2680,23 +2665,11 @@ minimatch@^3.0.4, minimatch@^3.0.5, minimatch@^3.1.1, minimatch@^3.1.2:
   dependencies:
     brace-expansion "^1.1.7"
 
-minimatch@^7.4.3:
-  version "7.4.6"
-  resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-7.4.6.tgz#845d6f254d8f4a5e4fd6baf44d5f10c8448365fb"
-  integrity sha512-sBz8G/YjVniEz6lKPNpKxXwazJe4c19fEfV2GDMX6AjFz+MX9uDWIZW8XreVhkFW3fkIdTv/gxWr/Kks5FFAVw==
-  dependencies:
-    brace-expansion "^2.0.1"
-
 minimist@^1.2.6:
   version "1.2.6"
   resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.6.tgz#8637a5b759ea0d6e98702cfb3a9283323c93af44"
   integrity sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q==
 
-mkdirp@^2.1.6:
-  version "2.1.6"
-  resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-2.1.6.tgz#964fbcb12b2d8c5d6fbc62a963ac95a273e2cc19"
-  integrity sha512-+hEnITedc8LAtIP9u3HJDFIdcLV2vXP33sqLLIzkv1Db1zO/1OxbvYf0Y1OC/S/Qo5dxHXepofhmxL02PsKe+A==
-
 [email protected]:
   version "2.1.2"
   resolved "https://registry.yarnpkg.com/ms/-/ms-2.1.2.tgz#d09d1f357b443f493382a8eb3ccd183872ae6009"
@@ -2860,11 +2833,6 @@ parse-json@^5.2.0:
     json-parse-even-better-errors "^2.3.0"
     lines-and-columns "^1.1.6"
 
-path-browserify@^1.0.1:
-  version "1.0.1"
-  resolved "https://registry.yarnpkg.com/path-browserify/-/path-browserify-1.0.1.tgz#d98454a9c3753d5790860f16f68867b9e46be1fd"
-  integrity sha512-b7uo2UCUOYZcnF/3ID0lulOJi/bafxa1xPe7ZPsammBSpjSWQkjNxlt635YGS2MiR9GjvuXCtz2emr3jbsz98g==
-
 path-exists@^4.0.0:
   version "4.0.0"
   resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-4.0.0.tgz#513bdbe2d3b95d7762e8c1137efa195c6c61b5b3"
@@ -3283,14 +3251,6 @@ ts-jest@^29.1.0:
     semver "^7.5.3"
     yargs-parser "^21.0.1"
 
-ts-morph@^19.0.0:
-  version "19.0.0"
-  resolved "https://registry.yarnpkg.com/ts-morph/-/ts-morph-19.0.0.tgz#43e95fb0156c3fe3c77c814ac26b7d0be2f93169"
-  integrity sha512-D6qcpiJdn46tUqV45vr5UGM2dnIEuTGNxVhg0sk5NX11orcouwj6i1bMqZIz2mZTZB1Hcgy7C3oEVhAT+f6mbQ==
-  dependencies:
-    "@ts-morph/common" "~0.20.0"
-    code-block-writer "^12.0.0"
-
 ts-node@^10.5.0:
   version "10.7.0"
   resolved "https://registry.yarnpkg.com/ts-node/-/ts-node-10.7.0.tgz#35d503d0fab3e2baa672a0e94f4b40653c2463f5"