[ACS][JobRouter] GA Version

custom-words.txt

@@ -562,6 +562,7 @@ continuationtoken
 continuousdataexports
 continuouswebjobs
 contoso
+Contoso's
 contosodataset
 contosomedia
 contributer
@@ -2942,6 +2943,7 @@ ulaanbaatar
 unallocated
 unarchive
 unassign
+unassigning
 unassignment
 unassigns
 unattend

specification/communication/Communication.JobRouter/.gitignore

@@ -0,0 +1,3 @@
+**/package.json
+**/package-lock.json
+**/.npmrc

specification/communication/Communication.JobRouter/README.md

@@ -0,0 +1,68 @@
+# Azure Communication Job Router TypeSpec Specification
+
+The TypeSpec and generated API specification for the Azure Communication Job Router.
+
+## Development Environment
+
+0. Change directory into the `specification\communication\Communication.JobRouter\` directory.
+
+1. Install Node.js 16 LTS and ensure you are able to run the npm command in a command prompt:
+
+   ```console
+   npm --version
+   ```
+
+2. Install Azure DevOps Auth helper for npm to pull the libraries from the secured feed
+
+   ```console
+   npm install -g vsts-npm-auth
+   vsts-npm-auth -config .npmrc
+   ```
+
+3. Install TypeSpec compiler and libraries:
+
+   ```console
+   npm install -g @typespec/compiler
+   ```
+
+4. (Optional) Install the TypeSpec extension for your editor of choice:
+
+   - Visual Studio Code
+
+     ``` console
+     tsp code install
+     ```
+
+   - Visual Studio
+
+     ``` console
+     tsp vs install
+     ```
+
+5. Install node package dependencies:
+
+   ```console
+   tsp install
+   ```
+
+6. Compile TypeSpec to Swagger.  This will update the files in the directory `..\data-plane\JobRouter\<version-status>\<api-version>\communicationservicejobrouter.json`:
+
+   ```console
+   npx tsp compile specification\communication\Communication.JobRouter
+   ```
+
+7. To re-generate examples, download and install the [OAV
+   tool](https://github.com/Azure/oav) and run it: note: This directory is taken
+   from [azure-rest-api-specs](https://github.com/Azure/azure-rest-api-specs),
+   and the following commands should be run from there.
+
+   ```console
+   npm install -g oav@latest
+   oav generate-examples <path to communicationservicejobrouter.json>
+   ```
+
+## Testing and Viewing API as an Interface
+
+1. Visit the official [Swagger Editor](https://editor.swagger.io/).
+
+2. Copy the generated Swagger from `communicationservicejobrouter.json` and paste it into the editor.

specification/communication/Communication.JobRouter/client.tsp

@@ -0,0 +1,122 @@
+// client.tsp
+import "@azure-tools/typespec-client-generator-core";
+import "@typespec/versioning";
+
+import "./main.tsp";
+
+using Azure.ClientGenerator.Core;
+using TypeSpec.Versioning;
+
+@useDependency(AzureCommunicationRoutingService.Versions.c2023_11_01)
+namespace ClientForAcsJobRouter;
+
+// Your customizations here
+@client({
+  name: "JobRouterAdministrationClient",
+  service: AzureCommunicationRoutingService,
+})
+interface JobRouterAdministrationRestClient {
+  @internal("csharp")
+  @internal("java")
+  upsertDistributionPolicy is AzureCommunicationRoutingService.JobRouterAdministrationOperations.upsertDistributionPolicy;
+
+  getDistributionPolicy is AzureCommunicationRoutingService.JobRouterAdministrationOperations.getDistributionPolicy;
+
+  listDistributionPolicies is AzureCommunicationRoutingService.JobRouterAdministrationOperations.listDistributionPolicies;
+
+  deleteDistributionPolicy is AzureCommunicationRoutingService.JobRouterAdministrationOperations.deleteDistributionPolicy;
+
+  @internal("csharp")
+  @internal("java")
+  upsertClassificationPolicy is AzureCommunicationRoutingService.JobRouterAdministrationOperations.upsertClassificationPolicy;
+
+  getClassificationPolicy is AzureCommunicationRoutingService.JobRouterAdministrationOperations.getClassificationPolicy;
+
+  listClassificationPolicies is AzureCommunicationRoutingService.JobRouterAdministrationOperations.listClassificationPolicies;
+
+  deleteClassificationPolicy is AzureCommunicationRoutingService.JobRouterAdministrationOperations.deleteClassificationPolicy;
+
+  @internal("csharp")
+  @internal("java")
+  upsertExceptionPolicy is AzureCommunicationRoutingService.JobRouterAdministrationOperations.upsertExceptionPolicy;
+
+  getExceptionPolicy is AzureCommunicationRoutingService.JobRouterAdministrationOperations.getExceptionPolicy;
+
+  listExceptionPolicies is AzureCommunicationRoutingService.JobRouterAdministrationOperations.listExceptionPolicies;
+
+  deleteExceptionPolicy is AzureCommunicationRoutingService.JobRouterAdministrationOperations.deleteExceptionPolicy;
+
+  @internal("csharp")
+  @internal("java")
+  upsertQueue is AzureCommunicationRoutingService.JobRouterAdministrationOperations.upsertQueue;
+
+  getQueue is AzureCommunicationRoutingService.JobRouterAdministrationOperations.getQueue;
+
+  listQueues is AzureCommunicationRoutingService.JobRouterAdministrationOperations.listQueues;
+
+  deleteQueue is AzureCommunicationRoutingService.JobRouterAdministrationOperations.deleteQueue;
+}
+
+@client({
+  name: "JobRouterClient",
+  service: AzureCommunicationRoutingService,
+})
+interface JobRouterRestClient {
+  @internal("csharp")
+  @internal("java")
+  upsertJob is AzureCommunicationRoutingService.JobRouterOperations.upsertJob;
+
+  getJob is AzureCommunicationRoutingService.JobRouterOperations.getJob;
+
+  deleteJob is AzureCommunicationRoutingService.JobRouterOperations.deleteJob;
+
+  @internal("csharp")
+  @internal("python")
+  @internal("java")
+  reclassify is AzureCommunicationRoutingService.JobRouterOperations.reclassify;
+
+  @internal("csharp")
+  @internal("python")
+  @internal("java")
+  cancel is AzureCommunicationRoutingService.JobRouterOperations.cancel;
+
+  @internal("csharp")
+  @internal("python")
+  @internal("java")
+  complete is AzureCommunicationRoutingService.JobRouterOperations.complete;
+
+  @internal("csharp")
+  @internal("python")
+  @internal("java")
+  close is AzureCommunicationRoutingService.JobRouterOperations.close;
+
+  listJobs is AzureCommunicationRoutingService.JobRouterOperations.listJobs;
+
+  #suppress "@azure-tools/typespec-azure-core/no-explicit-routes-resource-ops" "Need to revist how to correctly define singletons https://github.com/Azure/azure-rest-api-specs/issues/25605#issuecomment-1736265997"
+  #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Need to revist how to correctly define singletons https://github.com/Azure/azure-rest-api-specs/issues/25605#issuecomment-1736265997"
+  getQueuePosition is AzureCommunicationRoutingService.JobRouterOperations.getInQueuePosition;
+
+  @internal("csharp")
+  unassign is AzureCommunicationRoutingService.JobRouterOperations.unassign;
+
+  accept is AzureCommunicationRoutingService.JobRouterOperations.accept;
+
+  @internal("csharp")
+  @internal("python")
+  @internal("java")
+  decline is AzureCommunicationRoutingService.JobRouterOperations.decline;
+
+  #suppress "@azure-tools/typespec-azure-core/no-explicit-routes-resource-ops" "Need to revist how to correctly define singletons https://github.com/Azure/azure-rest-api-specs/issues/25605#issuecomment-1736265997"
+  #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Need to revist how to correctly define singletons https://github.com/Azure/azure-rest-api-specs/issues/25605#issuecomment-1736265997"
+  getQueueStatistics is AzureCommunicationRoutingService.JobRouterOperations.getQueueStatistics;
+
+  @internal("csharp")
+  @internal("java")
+  upsertWorker is AzureCommunicationRoutingService.JobRouterOperations.upsertWorker;
+
+  getWorker is AzureCommunicationRoutingService.JobRouterOperations.getWorker;
+
+  deleteWorker is AzureCommunicationRoutingService.JobRouterOperations.deleteWorker;
+
+  listWorkers is AzureCommunicationRoutingService.JobRouterOperations.listWorkers;
+}

specification/communication/Communication.JobRouter/examples/2023-11-01/ClassificationPolicies_CreateClassificationPolicy.json

@@ -0,0 +1,96 @@
+{
+  "title": "Creates a Classification Policy",
+  "operationId": "JobRouterAdministrationOperations_UpsertClassificationPolicy",
+  "parameters": {
+    "endpoint": "https://contoso.westus.communications.azure.com",
+    "api-version": "2023-11-01",
+    "classificationPolicyId": "90eb00c4-234e-4df7-a231-ef7895518384",
+    "resource": {
+      "name": "Main",
+      "fallbackQueueId": "MainQueue",
+      "queueSelectorAttachments": [
+        {
+          "kind": "conditional",
+          "condition": {
+            "kind": "expression-rule",
+            "language": "powerFx",
+            "expression": "1 = 1"
+          },
+          "queueSelectors": [
+            {
+              "key": "foo",
+              "labelOperator": "equal",
+              "value": "bar"
+            }
+          ]
+        }
+      ],
+      "prioritizationRule": {
+        "kind": "static-rule",
+        "value": "2"
+      }
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "90eb00c4-234e-4df7-a231-ef7895518384",
+        "name": "Main",
+        "fallbackQueueId": "MainQueue",
+        "queueSelectorAttachments": [
+          {
+            "kind": "conditional",
+            "condition": {
+              "kind": "expression-rule",
+              "language": "powerFx",
+              "expression": "1 = 1"
+            },
+            "queueSelectors": [
+              {
+                "key": "foo",
+                "labelOperator": "equal",
+                "value": "bar"
+              }
+            ]
+          }
+        ],
+        "prioritizationRule": {
+          "kind": "static-rule",
+          "value": "2"
+        },
+        "workerSelectorAttachments": [],
+        "etag": "etag"
+      }
+    },
+    "201": {
+      "body": {
+        "id": "90eb00c4-234e-4df7-a231-ef7895518384",
+        "name": "Main",
+        "fallbackQueueId": "MainQueue",
+        "queueSelectorAttachments": [
+          {
+            "kind": "conditional",
+            "condition": {
+              "kind": "expression-rule",
+              "language": "powerFx",
+              "expression": "1 = 1"
+            },
+            "queueSelectors": [
+              {
+                "key": "foo",
+                "labelOperator": "equal",
+                "value": "bar"
+              }
+            ]
+          }
+        ],
+        "prioritizationRule": {
+          "kind": "static-rule",
+          "value": "2"
+        },
+        "workerSelectorAttachments": [],
+        "etag": "etag"
+      }
+    }
+  }
+}

specification/communication/Communication.JobRouter/examples/2023-11-01/ClassificationPolicies_DeleteClassificationPolicy.json

@@ -0,0 +1,12 @@
+{
+  "title": "Delete a classification policy",
+  "operationId": "JobRouterAdministrationOperations_DeleteClassificationPolicy",
+  "parameters": {
+    "endpoint": "https://contoso.westus.communications.azure.com",
+    "api-version": "2023-11-01",
+    "classificationPolicyId": "MainClassificationPolicy"
+  },
+  "responses": {
+    "204": {}
+  }
+}

specification/communication/Communication.JobRouter/examples/2023-11-01/ClassificationPolicies_GetClassificationPolicy.json

@@ -0,0 +1,47 @@
+{
+  "title": "Retrieves an existing classification policy by Id",
+  "operationId": "JobRouterAdministrationOperations_GetClassificationPolicy",
+  "parameters": {
+    "endpoint": "https://contoso.westus.communications.azure.com",
+    "api-version": "2023-11-01",
+    "classificationPolicyId": "MainClassificationPolicy"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "MainClassificationPolicy",
+        "name": "Main",
+        "fallbackQueueId": "MainQueue",
+        "queueSelectorAttachments": [
+          {
+            "kind": "conditional",
+            "condition": {
+              "kind": "expression-rule",
+              "language": "powerFx",
+              "expression": "1 = 1"
+            },
+            "queueSelectors": [
+              {
+                "key": "foo",
+                "labelOperator": "equal",
+                "value": "bar"
+              }
+            ]
+          }
+        ],
+        "prioritizationRule": {
+          "kind": "static-rule",
+          "value": "2"
+        },
+        "workerSelectorAttachments": [
+          {
+            "kind": "pass-through",
+            "key": "language",
+            "labelOperator": "equal"
+          }
+        ],
+        "etag": "etag"
+      }
+    }
+  }
+}