From 1ef01f84a513088a562c36bdd8cbf3aac780126d Mon Sep 17 00:00:00 2001 From: Antoine SEIN <142824551+asein-sinch@users.noreply.github.com> Date: Fri, 19 Apr 2024 18:14:59 +0200 Subject: [PATCH] DEVEXP-394: Prepare release v1.0.0 (#69) --- README.md | 3 --- examples/integrated-flows-examples/package.json | 2 +- examples/simple-examples/package.json | 2 +- examples/webhooks/package.json | 2 +- packages/conversation/CHANGELOG.md | 6 ++++++ packages/conversation/README.md | 3 --- packages/conversation/package.json | 4 ++-- packages/fax/CHANGELOG.md | 3 +++ packages/fax/package.json | 4 ++-- packages/numbers/CHANGELOG.md | 3 +++ packages/numbers/README.md | 3 --- packages/numbers/package.json | 4 ++-- packages/sdk-client/CHANGELOG.md | 3 +++ packages/sdk-client/README.md | 3 --- packages/sdk-client/package.json | 2 +- packages/sdk-core/CHANGELOG.md | 8 ++++++++ packages/sdk-core/README.md | 3 --- packages/sdk-core/package.json | 14 +++++++------- packages/sms/CHANGELOG.md | 3 +++ packages/sms/README.md | 3 --- packages/sms/package.json | 4 ++-- packages/verification/CHANGELOG.md | 6 ++++++ packages/verification/README.md | 3 --- packages/verification/package.json | 4 ++-- packages/voice/CHANGELOG.md | 3 +++ packages/voice/README.md | 4 ---- packages/voice/package.json | 4 ++-- 27 files changed, 58 insertions(+), 48 deletions(-) diff --git a/README.md b/README.md index f784ac70..7ecdc056 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,6 @@ Once logged-in you'll find different sets of credentials to access to the variou For more information on the Sinch APIs on which this SDK is based, refer to the official [developer documentation portal](developers.sinch.com). -> Warning: -> **This SDK is currently available to selected developers for preview use only. It is being provided for the purpose of collecting feedback, and should not be used in production environments.** - ## Prerequisites Before being able to execute the commands described below, you will need to install Node.js. We recommend to [install the current or the LTS version](https://nodejs.org/en). diff --git a/examples/integrated-flows-examples/package.json b/examples/integrated-flows-examples/package.json index a9fe52e4..57fcd52d 100644 --- a/examples/integrated-flows-examples/package.json +++ b/examples/integrated-flows-examples/package.json @@ -13,7 +13,7 @@ "verification:app": "yarn compile && node dist/verification/app.js" }, "dependencies": { - "@sinch/sdk-core": "^0.0.5", + "@sinch/sdk-core": "^1.0.0", "@types/node": "^20.8.7", "dotenv": "^16.3.1", "inquirer": "^9.2.14", diff --git a/examples/simple-examples/package.json b/examples/simple-examples/package.json index e645cb89..3145c819 100644 --- a/examples/simple-examples/package.json +++ b/examples/simple-examples/package.json @@ -153,7 +153,7 @@ "voice:conferences:kickAll": "ts-node src/voice/conferences/kickAll.ts" }, "dependencies": { - "@sinch/sdk-core": "^0.0.5", + "@sinch/sdk-core": "^1.0.0", "dotenv": "^16.3.1" }, "devDependencies": { diff --git a/examples/webhooks/package.json b/examples/webhooks/package.json index da99390d..652c96ad 100644 --- a/examples/webhooks/package.json +++ b/examples/webhooks/package.json @@ -15,7 +15,7 @@ "@nestjs/common": "^10.3.7", "@nestjs/core": "^10.3.7", "@nestjs/platform-express": "^10.3.7", - "@sinch/sdk-core": "^0.0.5", + "@sinch/sdk-core": "^1.0.0", "dotenv": "^16.3.1", "raw-body": "^2.5.2", "reflect-metadata": "^0.1.13", diff --git a/packages/conversation/CHANGELOG.md b/packages/conversation/CHANGELOG.md index c444e10c..af87198e 100644 --- a/packages/conversation/CHANGELOG.md +++ b/packages/conversation/CHANGELOG.md @@ -1,3 +1,9 @@ +## Version 1.0.0 +- [Tech] Update dependency `@sinch/sdk-client` to `1.0.0` +- [Feature][Breaking TS] Refactor `OmniMessage` interface to `OmniMessageOverride` to highlight its override nature +- [Feature][Breaking TS] Refactor the `section` array elements interface of a "List Message": the new interfaces are now called `ChoiceItemWrapper` and `ProductItemWrapper` and contain a `ChoiceItem` and a `ProductItem` in their respective properties `choice` and `product` +- [Feature] Add helpers to build `ChoiceItemWrapper` and `ProductItemWrapper` objects. + ## Version 0.0.5 - [Tech] Update dependency `@sinch/sdk-client` to `0.0.5` - [Tech][Breaking] Export all model interfaces under the namespace `Conversation` diff --git a/packages/conversation/README.md b/packages/conversation/README.md index 3cedab11..1ed2537a 100644 --- a/packages/conversation/README.md +++ b/packages/conversation/README.md @@ -2,9 +2,6 @@ This package contains the Sinch Conversation SDK for Node.js for use with [Sinch APIs](https://developers.sinch.com/). To use it, you will need a Sinch account. Please [sign up](https://dashboard.sinch.com/signup) or [log in](https://dashboard.sinch.com/login) if you already have one. -> Warning: -> **This SDK is currently available to selected developers for preview use only. It is being provided for the purpose of collecting feedback, and should not be used in production environments.** - ## Installation We recommend to use this SDK as part of the `@sinch/sdk-core` package as it will take care about the authentication plugins to use. diff --git a/packages/conversation/package.json b/packages/conversation/package.json index 79fd4ae5..7d23b667 100644 --- a/packages/conversation/package.json +++ b/packages/conversation/package.json @@ -1,6 +1,6 @@ { "name": "@sinch/conversation", - "version": "0.0.5", + "version": "1.0.0", "description": "Sinch Conversation API", "homepage": "", "repository": { @@ -28,7 +28,7 @@ "compile": "tsc -p tsconfig.build.json && tsc -p tsconfig.tests.json && rimraf dist/tests tsconfig.build.tsbuildinfo" }, "dependencies": { - "@sinch/sdk-client": "^0.0.5" + "@sinch/sdk-client": "^1.0.0" }, "devDependencies": {}, "publishConfig": { diff --git a/packages/fax/CHANGELOG.md b/packages/fax/CHANGELOG.md index e34d39e0..47058843 100644 --- a/packages/fax/CHANGELOG.md +++ b/packages/fax/CHANGELOG.md @@ -1,3 +1,6 @@ +## Version 1.0.0 +- [Tech] Update dependency `@sinch/sdk-client` to `1.0.0` + ## Version 0.0.5 - [Tech] Update dependency `@sinch/sdk-client` to `0.0.5` - [Tech][Breaking] Export all model interfaces under the namespace `Fax` diff --git a/packages/fax/package.json b/packages/fax/package.json index b58ef1cb..25294aa6 100644 --- a/packages/fax/package.json +++ b/packages/fax/package.json @@ -1,6 +1,6 @@ { "name": "@sinch/fax", - "version": "0.0.5", + "version": "1.0.0", "description": "Sinch Fax API", "homepage": "", "repository": { @@ -28,7 +28,7 @@ "compile": "tsc -p tsconfig.build.json && tsc -p tsconfig.tests.json && rimraf dist/tests && rimraf tsconfig.build.tsbuildinfo" }, "dependencies": { - "@sinch/sdk-client": "^0.0.5" + "@sinch/sdk-client": "^1.0.0" }, "devDependencies": {}, "publishConfig": { diff --git a/packages/numbers/CHANGELOG.md b/packages/numbers/CHANGELOG.md index addd2365..3d6ad52b 100644 --- a/packages/numbers/CHANGELOG.md +++ b/packages/numbers/CHANGELOG.md @@ -1,3 +1,6 @@ +## Version 1.0.0 +- [Tech] Update dependency `@sinch/sdk-client` to `1.0.0` + ## Version 0.0.5 - [Tech] Update dependency `@sinch/sdk-client` to `0.0.5` - [Tech][Breaking] Export all model interfaces under the namespace `Numbers` diff --git a/packages/numbers/README.md b/packages/numbers/README.md index a48f2244..afb1ca15 100644 --- a/packages/numbers/README.md +++ b/packages/numbers/README.md @@ -2,9 +2,6 @@ This package contains the Sinch Numbers SDK for Node.js for use with [Sinch APIs](https://developers.sinch.com/). To use it, you will need a Sinch account. Please [sign up](https://dashboard.sinch.com/signup) or [log in](https://dashboard.sinch.com/login) if you already have one. -> Warning: -> **This SDK is currently available to selected developers for preview use only. It is being provided for the purpose of collecting feedback, and should not be used in production environments.** - ## Installation We recommend to use this SDK as part of the [`@sinch/sdk-core`](../../packages/sdk-core) package in order to make the most out of all the Sinch products. diff --git a/packages/numbers/package.json b/packages/numbers/package.json index 0eb91182..effbce30 100644 --- a/packages/numbers/package.json +++ b/packages/numbers/package.json @@ -1,6 +1,6 @@ { "name": "@sinch/numbers", - "version": "0.0.5", + "version": "1.0.0", "description": "Sinch Numbers API", "homepage": "", "repository": { @@ -28,7 +28,7 @@ "compile": "tsc -p tsconfig.build.json && tsc -p tsconfig.tests.json && rimraf dist/tests && rimraf tsconfig.build.tsbuildinfo" }, "dependencies": { - "@sinch/sdk-client": "^0.0.5" + "@sinch/sdk-client": "^1.0.0" }, "devDependencies": {}, "publishConfig": { diff --git a/packages/sdk-client/CHANGELOG.md b/packages/sdk-client/CHANGELOG.md index c4b620aa..992a7ef6 100644 --- a/packages/sdk-client/CHANGELOG.md +++ b/packages/sdk-client/CHANGELOG.md @@ -1,3 +1,6 @@ +## Version 1.0.0 +- No change + ## Version 0.0.5 - [Tech] Break circular dependencies - [Tech][Breaking] Rename `basepath` with `hostname` in the `ApiClientOptions` interface diff --git a/packages/sdk-client/README.md b/packages/sdk-client/README.md index b9d7014e..b255eecf 100644 --- a/packages/sdk-client/README.md +++ b/packages/sdk-client/README.md @@ -13,9 +13,6 @@ There are 5 folders in this package: - response plugins will modify the response, e.g.: response content is checked and transformed into an exception if the content is empty. - `utils`: it contains some utility methods that are used by the API SDKs, such as the methods to validate headers are valid in a callback event request, or a method to convert text to hexadecimal for a UDH header -> Warning: -> **This SDK is currently available to selected developers for preview use only. It is being provided for the purpose of collecting feedback, and should not be used in production environments.** - ## Architecture ![High level architecture](./documentation/High-level-architecture.png) diff --git a/packages/sdk-client/package.json b/packages/sdk-client/package.json index 0125e18e..bc37c4a6 100644 --- a/packages/sdk-client/package.json +++ b/packages/sdk-client/package.json @@ -1,6 +1,6 @@ { "name": "@sinch/sdk-client", - "version": "0.0.5", + "version": "1.0.0", "description": "Core services related to interacting with Sinch API", "homepage": "", "repository": { diff --git a/packages/sdk-core/CHANGELOG.md b/packages/sdk-core/CHANGELOG.md index b940d174..296846e3 100644 --- a/packages/sdk-core/CHANGELOG.md +++ b/packages/sdk-core/CHANGELOG.md @@ -1,3 +1,11 @@ +## Version 1.0.0 +- Update dependency `@sinch/numbers` to version `1.0.0` +- Update dependency `@sinch/sms` to version `1.0.0` +- Update dependency `@sinch/verification` to version `1.0.0` +- Update dependency `@sinch/voice` to version `1.0.0` +- Update dependency `@sinch/conversation` to version `1.0.0` +- Update dependency `@sinch/fax` to version `1.0.0` + ## Version 0.0.5 - Update dependency `@sinch/numbers` to version `0.0.5` - Update dependency `@sinch/sms` to version `0.0.5` diff --git a/packages/sdk-core/README.md b/packages/sdk-core/README.md index abdb2b9a..8d85220c 100644 --- a/packages/sdk-core/README.md +++ b/packages/sdk-core/README.md @@ -2,9 +2,6 @@ This package contains the Sinch Client SDK for Node.js. To use it, you will need a Sinch account. Please [sign up](https://dashboard.sinch.com/signup) or [log in](https://dashboard.sinch.com/login) if you already have one. -> Warning: -> **This SDK is currently available to selected developers for preview use only. It is being provided for the purpose of collecting feedback, and should not be used in production environments.** - ## Installation ### With NPM diff --git a/packages/sdk-core/package.json b/packages/sdk-core/package.json index da352259..8aab9e3d 100644 --- a/packages/sdk-core/package.json +++ b/packages/sdk-core/package.json @@ -1,6 +1,6 @@ { "name": "@sinch/sdk-core", - "version": "0.0.5", + "version": "1.0.0", "description": "Node.js client for the Sinch API platform", "homepage": "", "repository": { @@ -29,12 +29,12 @@ "compile": "tsc --build --verbose" }, "dependencies": { - "@sinch/conversation": "^0.0.5", - "@sinch/fax": "^0.0.5", - "@sinch/numbers": "^0.0.5", - "@sinch/sms": "^0.0.5", - "@sinch/verification": "^0.0.5", - "@sinch/voice": "^0.0.5" + "@sinch/conversation": "^1.0.0", + "@sinch/fax": "^1.0.0", + "@sinch/numbers": "^1.0.0", + "@sinch/sms": "^1.0.0", + "@sinch/verification": "^1.0.0", + "@sinch/voice": "^1.0.0" }, "devDependencies": {}, "publishConfig": { diff --git a/packages/sms/CHANGELOG.md b/packages/sms/CHANGELOG.md index ea9279aa..1d33a005 100644 --- a/packages/sms/CHANGELOG.md +++ b/packages/sms/CHANGELOG.md @@ -1,3 +1,6 @@ +## Version 1.0.0 +- [Tech] Update dependency `@sinch/sdk-client` to `1.0.0` + ## Version 0.0.5 - [Tech] Update dependency `@sinch/sdk-client` to `0.0.5` - [Tech][Breaking] Export all model interfaces under the namespace `Sms` diff --git a/packages/sms/README.md b/packages/sms/README.md index e1920e62..671d9417 100644 --- a/packages/sms/README.md +++ b/packages/sms/README.md @@ -2,9 +2,6 @@ This package contains the Sinch SMS SDK for Node.js for use with [Sinch APIs](https://developers.sinch.com/). To use it, you will need a Sinch account. Please [sign up](https://dashboard.sinch.com/signup) or [log in](https://dashboard.sinch.com/login) if you already have one. -> Warning: -> **This SDK is currently available to selected developers for preview use only. It is being provided for the purpose of collecting feedback, and should not be used in production environments.** - ## Installation We recommend to use this SDK as part of the [`@sinch/sdk-core`](../../packages/sdk-core) package in order to make the most out of all the Sinch products. diff --git a/packages/sms/package.json b/packages/sms/package.json index e52ce401..a852ca9c 100644 --- a/packages/sms/package.json +++ b/packages/sms/package.json @@ -1,6 +1,6 @@ { "name": "@sinch/sms", - "version": "0.0.5", + "version": "1.0.0", "description": "Sinch SMS API", "homepage": "", "repository": { @@ -28,7 +28,7 @@ "compile": "tsc -p tsconfig.build.json && tsc -p tsconfig.tests.json && rimraf dist/tests tsconfig.build.tsbuildinfo" }, "dependencies": { - "@sinch/sdk-client": "^0.0.5" + "@sinch/sdk-client": "^1.0.0" }, "devDependencies": {}, "publishConfig": { diff --git a/packages/verification/CHANGELOG.md b/packages/verification/CHANGELOG.md index 32f402cb..fe2c7e20 100644 --- a/packages/verification/CHANGELOG.md +++ b/packages/verification/CHANGELOG.md @@ -1,3 +1,9 @@ +## Version 1.0.0 +- [Tech] Update dependency `@sinch/sdk-client` to `1.0.0` +- [Feature] Update SDK from the latest specification + - Add `smsOptions` and `calloutOptions` to the respective Start Verification operations + - Update response interfaces for Report Verification operations + ## Version 0.0.5 - [Tech] Update dependency `@sinch/sdk-client` to `0.0.5` - [Tech][Breaking] Export all model interfaces under the namespace `Verification` diff --git a/packages/verification/README.md b/packages/verification/README.md index fade18cc..7a7631a4 100644 --- a/packages/verification/README.md +++ b/packages/verification/README.md @@ -2,9 +2,6 @@ This package contains the Sinch Verification SDK for Node.js for use with [Sinch APIs](https://developers.sinch.com/). To use it, you will need a Sinch account. Please [sign up](https://dashboard.sinch.com/signup) or [log in](https://dashboard.sinch.com/login) if you already have one. -> Warning: -> **This SDK is currently available to selected developers for preview use only. It is being provided for the purpose of collecting feedback, and should not be used in production environments.** - ## Installation We recommend to use this SDK as part of the [`@sinch/sdk-core`](../../packages/sdk-core) package in order to make the most out of all the Sinch products. diff --git a/packages/verification/package.json b/packages/verification/package.json index 6656e1cd..d3e97758 100644 --- a/packages/verification/package.json +++ b/packages/verification/package.json @@ -1,6 +1,6 @@ { "name": "@sinch/verification", - "version": "0.0.5", + "version": "1.0.0", "description": "Sinch Verification API", "homepage": "", "repository": { @@ -28,7 +28,7 @@ "compile": "tsc -p tsconfig.build.json && tsc -p tsconfig.tests.json && rimraf dist/tests tsconfig.build.tsbuildinfo" }, "dependencies": { - "@sinch/sdk-client": "^0.0.5" + "@sinch/sdk-client": "^1.0.0" }, "devDependencies": {}, "publishConfig": { diff --git a/packages/voice/CHANGELOG.md b/packages/voice/CHANGELOG.md index 65aee68e..fe04aa17 100644 --- a/packages/voice/CHANGELOG.md +++ b/packages/voice/CHANGELOG.md @@ -1,3 +1,6 @@ +## Version 1.0.0 +- [Tech] Update dependency `@sinch/sdk-client` to `1.0.0` + ## Version 0.0.5 - [Tech] Update dependency `@sinch/sdk-client` to `0.0.5` - [Tech][Breaking] Export all model interfaces under the namespace `Voice` diff --git a/packages/voice/README.md b/packages/voice/README.md index ba30d338..d343e5b8 100644 --- a/packages/voice/README.md +++ b/packages/voice/README.md @@ -2,10 +2,6 @@ This package contains the Sinch Voice SDK for Node.js for use with [Sinch APIs](https://developers.sinch.com/). To use it, you will need a Sinch account. Please [sign up](https://dashboard.sinch.com/signup) or [log in](https://dashboard.sinch.com/login) if you already have one. -> Warning: -> **This SDK is currently available to selected developers for preview use only. It is being provided for the purpose of collecting feedback, and should not be used in production environments.** - - ## Installation We recommend to use this SDK as part of the [`@sinch/sdk-core`](../../packages/sdk-core) package in order to make the most out of all the Sinch products. diff --git a/packages/voice/package.json b/packages/voice/package.json index 3165a57b..0f46e8a6 100644 --- a/packages/voice/package.json +++ b/packages/voice/package.json @@ -1,6 +1,6 @@ { "name": "@sinch/voice", - "version": "0.0.5", + "version": "1.0.0", "description": "Sinch Voice API", "homepage": "", "repository": { @@ -28,7 +28,7 @@ "compile": "tsc -p tsconfig.build.json && tsc -p tsconfig.tests.json && rimraf dist/tests tsconfig.build.tsbuildinfo" }, "dependencies": { - "@sinch/sdk-client": "^0.0.5" + "@sinch/sdk-client": "^1.0.0" }, "devDependencies": {}, "publishConfig": {