Add SDK for Tiering #26121

classBabacar-msft · 2023-06-06T20:11:05Z

This is the (internal/private) SDK for Tiering, currently, retrieves limits for each capability (SMS/PSTN Calling/Phone Number purchasing) for a specific resource/tier.

On a high level all of these endpoints are here to achieve that:

Get acquired number limits - how many numbers a resource has already acquired and the limits
Get tier info - retrieving tier information for a resource

github-actions · 2023-06-06T20:11:37Z

Thank you for your contribution @classBabacar-msft! We will review the pull request and get back to you soon.

HarshaNalluru · 2023-06-08T18:01:29Z

sdk/communication/communication-tiering/README.md

@@ -0,0 +1,142 @@
+# Azure Communication Tiering client library for JavaScript
+
+The Tiering client library allows developers to retrieves limits for each capability (SMS/PSTN Calling/Phone Number purchasing) for a specific resource/tier.


Suggested change

The Tiering client library allows developers to retrieves limits for each capability (SMS/PSTN Calling/Phone Number purchasing) for a specific resource/tier.

The Tiering client library allows developers to retrieve limits for each capability (SMS/PSTN Calling/Phone Number purchasing) for a specific resource/tier.

jeremymeng · 2023-06-12T21:03:07Z

sdk/communication/communication-tiering/src/tieringClient.ts

+   *
+   * @param options - Additional request options.
+   */
+  public getAcquiredNumberLimits(


This looks like a very thin wrapper around the generated code. I wonder whether we should just create a Rest-Level-Client.

How exactly would I do that?

Here's the doc https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/RLC-Swagger-quickstart.md?plain=1#L1

It basically means you publish the generated code without having to add and maintain high-level clients.

Oh, I see, if the client is lightweight its best to use RLC, one thing I should note is we do plan on growing this client in size as we go further down the line with Tiering. Would it make sense to keep it a RLC at that point? Because at that moment in time this SDK will be equal or greater than the recipient verification SDK in size.

@classBabacar-msft it's not about lightweight or not, but whether you would do heavy customization on top of the generated code to provide better customer experiences.

If we don't know if we will do heavy customization yet, wouldn't it be best to keep it like it is currently? Because I would prefer to keep it this way to match the other SDK's we created under "communication" in case we plan to make a big change to most of them in the future.

that's a fair point. I am fine with having a High Level Client. We probably want a better developer experiences for a HLC.

jeremymeng · 2023-06-13T22:30:54Z

sdk/communication/communication-tiering/swagger/README.md

+v3: true
+title: Tiering Client
+use-extension:
+  "@autorest/typescript": "6.0.0-rc.1"


would GA version work for you?

Suggested change

"@autorest/typescript": "6.0.0-rc.1"

"@autorest/typescript": "6.0.0"

Yea it should be fine, fixed.

jeremymeng · 2023-06-13T22:31:17Z

sdk/communication/communication-tiering/swagger/README.md

+```yaml
+package-name: "@azure/communication-tiering"
+description: The tiering client library retrieves limits for each capability (SMS/PSTN Calling/Phone Number purchase) for a specific resource/tier.
+package-version: 1.0.0-beta.0


first version should probably be beta.1

Suggested change

package-version: 1.0.0-beta.0

package-version: 1.0.0-beta.1

jeremymeng · 2023-06-13T22:38:54Z

sdk/communication/communication-tiering/review/communication-tiering.api.md

+}
+
+// @public (undocumented)
+export const AssetDetailsMapper: coreClient.CompositeMapper;


The mappers shouldn't be in the public api surface. Could you check why they are exported?

jeremymeng · 2023-06-13T22:44:52Z

sdk/communication/communication-tiering/src/tieringClient.ts

+   *
+   * @param options - Additional request options.
+   */
+  public getAcquiredNumberLimits(


that's a fair point. I am fine with having a High Level Client. We probably want a better developer experiences for a HLC.

jeremymeng · 2023-06-13T22:46:44Z

sdk/communication/communication-tiering/src/tieringClient.ts

+  public getAcquiredNumberLimits(
+    resourceId: string,
+    options: NumberAllotmentGetAcquiredNumberLimitsOptionalParams = {}
+  ): Promise<NumberAllotmentGetAcquiredNumberLimitsResponse> {


can you define a return type directly for getAcquiredNumberLimits() instead of re-exporting generated one. Indirections make it harder to see the shape of the type.

jeremymeng · 2023-06-13T22:47:26Z

sdk/communication/communication-tiering/src/tieringClient.ts

+  public getTierByResourceId(
+    resourceId: string,
+    options: TieringGetByResourceIdOptionalParams = {}
+  ): Promise<TieringGetByResourceIdResponse> {


can we return Promise<AcsTier>

sdk/communication/communication-tiering/swagger/swagger.json

sdk/communication/communication-tiering/test/public/getAcquiredNumberLimit.spec.ts

danielortega-msft · 2023-06-16T20:43:46Z

sdk/communication/communication-tiering/test/public/getAcquiredNumberLimit.spec.ts

@@ -23,7 +23,7 @@ describe(`TieringClient - Get Acquired Number Limits`, function () {

  it("get acquired number limits", async function () {
    // print all acquire number limits
-    const resourceId = "9d787bd6-07fc-4c7b-8e57-17f1fee41298";
+    const resourceId = env.RESOURCE_ID || "9d787bd6-07fc-4c7b-8e57-17f1fee41298";


I would suggest avoiding hardcoding this value and simply read from the env vars. In any case, in recordedClient.ts you are already setting up this same GUID as the value for env.RESOURCE_ID whenever running in playback mode, which should be more than enough.

ok that makes sense

classBabacar-msft · 2023-06-16T21:30:45Z

@danielortega-msft Can you hit the merge button, I don't have authorization to do so

Release machinelearningservices microsoft.machine learning services 2023 10 01 shadow (Azure#26104) * Adds base for updating Microsoft.MachineLearningServices from version stable/2023-04-01 to version 2023-10-01 * fix rebase * Updates API version in new specs and examples * mfe.json update description to fix linting errors (Azure#24968) Co-authored-by: Kayla Ames <[email protected]> * add headers for start/stop/restart compute examples (Azure#25072) * Adding SubscriptionId and ResourceGroup for Azure Datastore (Azure#25289) * Add query param in list job api (Azure#25374) Co-authored-by: Shail Paragbhai Shah <[email protected]> * [MachineLearning]Try fixing some lint error in 10-01 version (Azure#25519) * Try fixing some lint error * bug fix * remove unused definition * Update Example * adding queue settings to Oct 2023 stable api version (Azure#25765) * adding queue settings to Oct 2023 stable api version * update new line --------- Co-authored-by: Aaheli Chattopadhyay <[email protected]> * remove job priority (Azure#25775) Co-authored-by: Aaheli Chattopadhyay <[email protected]> * Adding MachineLearningService workspace resource publish API and registry datareference API (Azure#25619) * Adding machinelearningservices workspace publish and registry datareference API * minimize diff * minor updates on put job api summary * remove two unneeded APIs * remove extra adding long running annotation * Add managed Vnet to stable version (Azure#25729) * Add managed Vnet to stable version * update missing parameter * Update missing ref * meaningless commit trigger pipeline again * Revert "meaningless commit trigger pipeline again" This reverts commit baa386b8cf0abb96b461a27d9060188e7ed0581e. * add missing ref * Update example version * trigger pipeline * Revert "trigger pipeline" This reverts commit f989c4c91ca85dde28fa636ed82ba9c742a05db9. * add force to purge parameter * trigger pipeline * Revert "trigger pipeline" This reverts commit 42ea0f8c2dc17e42757112b279fae42a4dc6e557. * Update examples * Add format and update examples * [Model Monitoring][GA] - Add model monitoring scenarios (Azure#25801) * Add model monitoring scenarios * add * add * Update mfe.json * Update mfe.json * Update mfe.json * Update mfe.json * add ws vnet properties (Azure#25882) Co-authored-by: Aaheli Chattopadhyay <[email protected]> * Fix circular reference 2023-10-01 (Azure#25879) * TriggerType->ComputeTriggerType * RecurrenceFrequency->ComputeRecurrenceFrequency * RecurrenceSchedule->ComputeRecurrenceSchedule * description --------- Co-authored-by: Kayla Ames <[email protected]> * Adding proxy resource (Azure#25904) Co-authored-by: Shail Paragbhai Shah <[email protected]> * Add feature store api's to GA version (Azure#25594) * Add examples * Adding feature store GA api's * Sync examples * Add examples * Converting to ProxyResource --------- Co-authored-by: Shail Paragbhai Shah <[email protected]> * add serverless compute settings (Azure#26012) Co-authored-by: Aaheli Chattopadhyay <[email protected]> * [MachineLearningService]Add featurestore property to stable version (Azure#26121) * Add workspace kind and featureStoreSettings * add description * Add description for ComputeRuntimeDti * remove featurestore settings for lint * remove Kind * Revert "remove featurestore settings for lint" This reverts commit f4d7ae352baf966aeba9085bd06df3456bd17bef. * Update readme fix --------- Co-authored-by: Kayla Ames <[email protected]> Co-authored-by: libc16 <[email protected]> Co-authored-by: Chunyu Li <[email protected]> Co-authored-by: shail2208 <[email protected]> Co-authored-by: Shail Paragbhai Shah <[email protected]> Co-authored-by: ZhidaLiu <[email protected]> Co-authored-by: ac923 <[email protected]> Co-authored-by: Aaheli Chattopadhyay <[email protected]> Co-authored-by: chaoyu-msft <[email protected]> Co-authored-by: Mathieu St-Louis <[email protected]>

classBabacar-msft added 15 commits May 18, 2023 11:18

Rush config files

c7f122d

SDK for tiering

1770290

autorest code for tiering

e2f8099

updating swagger

4bf82ff

updating swagger.json

514f781

Changing function name in client

5236e53

updating samples

03bde07

generated code

bb256fc

api extractor

00711a1

updating the swagger

ab99bc8

tests

88021ff

coverage generator

aebd56f

adding documentation

ce6b226

removing apiref

8e4848b

Merge branch 'main' into bndoye/sdkForTiering

81c9c95

classBabacar-msft requested review from witemple-msft, deyaaeldeen, mikeharder, ckairen, jeremymeng, bterlson and xirzec as code owners June 6, 2023 20:11

github-actions bot added Community Contribution Community members are working on the issue customer-reported Issues that are reported by GitHub users external to the Azure organization. labels Jun 6, 2023

rush updating

96581d0

HarshaNalluru reviewed Jun 8, 2023

View reviewed changes

classBabacar-msft added 2 commits June 8, 2023 13:46

Adding unknown word and editing readme

1dc9f70

Merge branch 'main' into bndoye/sdkForTiering

6e42803

jeremymeng reviewed Jun 12, 2023

View reviewed changes

classBabacar-msft requested a review from HarshaNalluru June 12, 2023 22:37

jeremymeng reviewed Jun 13, 2023

View reviewed changes

Addressing PR Comments

ab11c86

classBabacar-msft requested a review from jeremymeng June 14, 2023 18:08

classBabacar-msft and others added 3 commits June 14, 2023 13:16

updating beta version

82ec663

versioning

3398bab

Merge branch 'main' into bndoye/sdkForTiering

f1df02f

danielortega-msft reviewed Jun 16, 2023

View reviewed changes

sdk/communication/communication-tiering/swagger/swagger.json Show resolved Hide resolved

sdk/communication/communication-tiering/test/public/getAcquiredNumberLimit.spec.ts Outdated Show resolved Hide resolved

Adding environment variables to test

16e6e94

classBabacar-msft requested a review from danielortega-msft June 16, 2023 20:26

danielortega-msft requested changes Jun 16, 2023

View reviewed changes

Removing hardcoded environment variable for tests

4130fc8

danielortega-msft approved these changes Jun 16, 2023

View reviewed changes

danielortega-msft merged commit ac2f393 into Azure:main Jun 16, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add SDK for Tiering #26121

Add SDK for Tiering #26121

classBabacar-msft commented Jun 6, 2023 •

edited

Loading

github-actions bot commented Jun 6, 2023

HarshaNalluru Jun 8, 2023

jeremymeng Jun 12, 2023

classBabacar-msft Jun 12, 2023

jeremymeng Jun 13, 2023

classBabacar-msft Jun 13, 2023

jeremymeng Jun 13, 2023

classBabacar-msft Jun 13, 2023

jeremymeng Jun 13, 2023

jeremymeng Jun 13, 2023

classBabacar-msft Jun 14, 2023

jeremymeng Jun 13, 2023

classBabacar-msft Jun 14, 2023

jeremymeng Jun 13, 2023

classBabacar-msft Jun 14, 2023

jeremymeng Jun 13, 2023

jeremymeng Jun 13, 2023

classBabacar-msft Jun 14, 2023

jeremymeng Jun 13, 2023

classBabacar-msft Jun 14, 2023

danielortega-msft Jun 16, 2023

classBabacar-msft Jun 16, 2023

classBabacar-msft commented Jun 16, 2023

		@@ -0,0 +1,142 @@
		# Azure Communication Tiering client library for JavaScript

		The Tiering client library allows developers to retrieves limits for each capability (SMS/PSTN Calling/Phone Number purchasing) for a specific resource/tier.

	"@autorest/typescript": "6.0.0-rc.1"
	"@autorest/typescript": "6.0.0"

Add SDK for Tiering #26121

Add SDK for Tiering #26121

Conversation

classBabacar-msft commented Jun 6, 2023 • edited Loading

github-actions bot commented Jun 6, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

classBabacar-msft commented Jun 16, 2023

classBabacar-msft commented Jun 6, 2023 •

edited

Loading