@azure/web-pubsub 1.0.0-beta.3 → 1.0.1-alpha.20220103.2

package/dist-esm/src/generated/operations/webPubSub.js

@@ -6,8 +6,9 @@
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
 import * as coreClient from "@azure/core-client";
+import * as Mappers from "../models/mappers";
 import * as Parameters from "../models/parameters";
-/** Class representing a WebPubSub. */
+/** Class containing WebPubSub operations. */
 export class WebPubSubImpl {
     /**
      * Initialize a new instance of the class WebPubSub class.
@@ -16,6 +17,24 @@ export class WebPubSubImpl {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * Generate token for the client to connect Azure Web PubSub service.
+     * @param hub Target hub name, which should start with alphabetic characters and only contain
+     *            alpha-numeric characters or underscore.
+     * @param options The options parameters.
+     */
+    generateClientToken(hub, options) {
+        return this.client.sendOperationRequest({ hub, options }, generateClientTokenOperationSpec);
+    }
+    /**
+     * Close the connections in the hub.
+     * @param hub Target hub name, which should start with alphabetic characters and only contain
+     *            alpha-numeric characters or underscore.
+     * @param options The options parameters.
+     */
+    closeAllConnections(hub, options) {
+        return this.client.sendOperationRequest({ hub, options }, closeAllConnectionsOperationSpec);
+    }
     /**
      * Broadcast content inside request body to all the connected client connections.
      * @param args Includes all the parameters for this operation.
@@ -68,8 +87,8 @@ export class WebPubSubImpl {
      * @param connectionId Target connection Id.
      * @param options The options parameters.
      */
-    closeClientConnection(hub, connectionId, options) {
-        return this.client.sendOperationRequest({ hub, connectionId, options }, closeClientConnectionOperationSpec);
+    closeConnection(hub, connectionId, options) {
+        return this.client.sendOperationRequest({ hub, connectionId, options }, closeConnectionOperationSpec);
     }
     /**
      * Send content inside request body to the specific connection.
@@ -118,6 +137,16 @@ export class WebPubSubImpl {
     groupExists(hub, group, options) {
         return this.client.sendOperationRequest({ hub, group, options }, groupExistsOperationSpec);
     }
+    /**
+     * Close connections in the specific group.
+     * @param hub Target hub name, which should start with alphabetic characters and only contain
+     *            alpha-numeric characters or underscore.
+     * @param group Target group name, which length should be greater than 0 and less than 1025.
+     * @param options The options parameters.
+     */
+    closeGroupConnections(hub, group, options) {
+        return this.client.sendOperationRequest({ hub, group, options }, closeGroupConnectionsOperationSpec);
+    }
     /**
      * Send content inside request body to a group of connections.
      * @param args Includes all the parameters for this operation.
@@ -187,6 +216,16 @@ export class WebPubSubImpl {
     userExists(hub, userId, options) {
         return this.client.sendOperationRequest({ hub, userId, options }, userExistsOperationSpec);
     }
+    /**
+     * Close connections for the specific user.
+     * @param hub Target hub name, which should start with alphabetic characters and only contain
+     *            alpha-numeric characters or underscore.
+     * @param userId The user Id.
+     * @param options The options parameters.
+     */
+    closeUserConnections(hub, userId, options) {
+        return this.client.sendOperationRequest({ hub, userId, options }, closeUserConnectionsOperationSpec);
+    }
     /**
      * Send content inside request body to the specific user.
      * @param args Includes all the parameters for this operation.
@@ -291,224 +330,441 @@ export class WebPubSubImpl {
     }
 }
 // Operation Specifications
-const serializer = coreClient.createSerializer({}, /* isXml */ false);
+const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
+const generateClientTokenOperationSpec = {
+    path: "/api/hubs/{hub}/:generateToken",
+    httpMethod: "POST",
+    responses: {
+        200: {
+            bodyMapper: Mappers.ClientTokenResponse
+        },
+        default: {
+            bodyMapper: Mappers.ErrorDetail,
+            headersMapper: Mappers.WebPubSubGenerateClientTokenExceptionHeaders
+        }
+    },
+    queryParameters: [
+        Parameters.apiVersion,
+        Parameters.userId,
+        Parameters.roles,
+        Parameters.expirationTimeInMinutes
+    ],
+    urlParameters: [Parameters.endpoint, Parameters.hub],
+    headerParameters: [Parameters.accept],
+    serializer
+};
+const closeAllConnectionsOperationSpec = {
+    path: "/api/hubs/{hub}/:closeConnections",
+    httpMethod: "POST",
+    responses: {
+        204: {},
+        default: {
+            bodyMapper: Mappers.ErrorDetail,
+            headersMapper: Mappers.WebPubSubCloseAllConnectionsExceptionHeaders
+        }
+    },
+    queryParameters: [
+        Parameters.apiVersion,
+        Parameters.excluded,
+        Parameters.reason
+    ],
+    urlParameters: [Parameters.endpoint, Parameters.hub],
+    headerParameters: [Parameters.accept],
+    serializer
+};
 const sendToAll$binaryOperationSpec = {
     path: "/api/hubs/{hub}/:send",
     httpMethod: "POST",
-    responses: { 202: {}, default: {} },
+    responses: {
+        202: {},
+        default: {
+            bodyMapper: Mappers.ErrorDetail,
+            headersMapper: Mappers.WebPubSubSendToAllExceptionHeaders
+        }
+    },
     requestBody: Parameters.message,
-    queryParameters: [Parameters.apiVersion, Parameters.excluded],
-    urlParameters: [Parameters.$host, Parameters.hub],
-    headerParameters: [Parameters.contentType],
+    queryParameters: [Parameters.apiVersion, Parameters.excludedConnections],
+    urlParameters: [Parameters.endpoint, Parameters.hub],
+    headerParameters: [Parameters.contentType, Parameters.accept1],
     mediaType: "binary",
     serializer
 };
 const sendToAll$textOperationSpec = {
     path: "/api/hubs/{hub}/:send",
     httpMethod: "POST",
-    responses: { 202: {}, default: {} },
+    responses: {
+        202: {},
+        default: {
+            bodyMapper: Mappers.ErrorDetail,
+            headersMapper: Mappers.WebPubSubSendToAllExceptionHeaders
+        }
+    },
     requestBody: Parameters.message1,
-    queryParameters: [Parameters.apiVersion, Parameters.excluded],
-    urlParameters: [Parameters.$host, Parameters.hub],
-    headerParameters: [Parameters.contentType1],
+    queryParameters: [Parameters.apiVersion, Parameters.excludedConnections],
+    urlParameters: [Parameters.endpoint, Parameters.hub],
+    headerParameters: [Parameters.contentType1, Parameters.accept2],
     mediaType: "text",
     serializer
 };
 const connectionExistsOperationSpec = {
     path: "/api/hubs/{hub}/connections/{connectionId}",
     httpMethod: "HEAD",
-    responses: { 200: {}, 404: {}, default: {} },
+    responses: {
+        200: {},
+        404: {},
+        default: {
+            bodyMapper: Mappers.ErrorDetail,
+            headersMapper: Mappers.WebPubSubConnectionExistsExceptionHeaders
+        }
+    },
     queryParameters: [Parameters.apiVersion],
-    urlParameters: [Parameters.$host, Parameters.hub, Parameters.connectionId],
+    urlParameters: [Parameters.endpoint, Parameters.hub, Parameters.connectionId],
+    headerParameters: [Parameters.accept],
     serializer
 };
-const closeClientConnectionOperationSpec = {
+const closeConnectionOperationSpec = {
     path: "/api/hubs/{hub}/connections/{connectionId}",
     httpMethod: "DELETE",
-    responses: { 200: {}, default: {} },
+    responses: {
+        204: {},
+        default: {
+            bodyMapper: Mappers.ErrorDetail,
+            headersMapper: Mappers.WebPubSubCloseConnectionExceptionHeaders
+        }
+    },
     queryParameters: [Parameters.apiVersion, Parameters.reason],
-    urlParameters: [Parameters.$host, Parameters.hub, Parameters.connectionId],
+    urlParameters: [Parameters.endpoint, Parameters.hub, Parameters.connectionId],
+    headerParameters: [Parameters.accept],
     serializer
 };
 const sendToConnection$binaryOperationSpec = {
     path: "/api/hubs/{hub}/connections/{connectionId}/:send",
     httpMethod: "POST",
-    responses: { 202: {}, default: {} },
+    responses: {
+        202: {},
+        default: {
+            bodyMapper: Mappers.ErrorDetail,
+            headersMapper: Mappers.WebPubSubSendToConnectionExceptionHeaders
+        }
+    },
     requestBody: Parameters.message,
     queryParameters: [Parameters.apiVersion],
-    urlParameters: [Parameters.$host, Parameters.hub, Parameters.connectionId],
-    headerParameters: [Parameters.contentType],
+    urlParameters: [Parameters.endpoint, Parameters.hub, Parameters.connectionId],
+    headerParameters: [Parameters.contentType, Parameters.accept1],
     mediaType: "binary",
     serializer
 };
 const sendToConnection$textOperationSpec = {
     path: "/api/hubs/{hub}/connections/{connectionId}/:send",
     httpMethod: "POST",
-    responses: { 202: {}, default: {} },
+    responses: {
+        202: {},
+        default: {
+            bodyMapper: Mappers.ErrorDetail,
+            headersMapper: Mappers.WebPubSubSendToConnectionExceptionHeaders
+        }
+    },
     requestBody: Parameters.message1,
     queryParameters: [Parameters.apiVersion],
-    urlParameters: [Parameters.$host, Parameters.hub, Parameters.connectionId],
-    headerParameters: [Parameters.contentType1],
+    urlParameters: [Parameters.endpoint, Parameters.hub, Parameters.connectionId],
+    headerParameters: [Parameters.contentType1, Parameters.accept2],
     mediaType: "text",
     serializer
 };
 const groupExistsOperationSpec = {
     path: "/api/hubs/{hub}/groups/{group}",
     httpMethod: "HEAD",
-    responses: { 200: {}, 404: {}, default: {} },
+    responses: {
+        200: {},
+        404: {},
+        default: {
+            bodyMapper: Mappers.ErrorDetail,
+            headersMapper: Mappers.WebPubSubGroupExistsExceptionHeaders
+        }
+    },
     queryParameters: [Parameters.apiVersion],
-    urlParameters: [Parameters.$host, Parameters.hub, Parameters.group],
+    urlParameters: [Parameters.endpoint, Parameters.hub, Parameters.group],
+    headerParameters: [Parameters.accept],
+    serializer
+};
+const closeGroupConnectionsOperationSpec = {
+    path: "/api/hubs/{hub}/groups/{group}/:closeConnections",
+    httpMethod: "POST",
+    responses: {
+        204: {},
+        default: {
+            bodyMapper: Mappers.ErrorDetail,
+            headersMapper: Mappers.WebPubSubCloseGroupConnectionsExceptionHeaders
+        }
+    },
+    queryParameters: [
+        Parameters.apiVersion,
+        Parameters.excluded,
+        Parameters.reason
+    ],
+    urlParameters: [Parameters.endpoint, Parameters.hub, Parameters.group],
+    headerParameters: [Parameters.accept],
     serializer
 };
 const sendToGroup$binaryOperationSpec = {
     path: "/api/hubs/{hub}/groups/{group}/:send",
     httpMethod: "POST",
-    responses: { 202: {}, default: {} },
+    responses: {
+        202: {},
+        default: {
+            bodyMapper: Mappers.ErrorDetail,
+            headersMapper: Mappers.WebPubSubSendToGroupExceptionHeaders
+        }
+    },
     requestBody: Parameters.message,
-    queryParameters: [Parameters.apiVersion, Parameters.excluded],
-    urlParameters: [Parameters.$host, Parameters.hub, Parameters.group],
-    headerParameters: [Parameters.contentType],
+    queryParameters: [Parameters.apiVersion, Parameters.excludedConnections],
+    urlParameters: [Parameters.endpoint, Parameters.hub, Parameters.group],
+    headerParameters: [Parameters.contentType, Parameters.accept1],
     mediaType: "binary",
     serializer
 };
 const sendToGroup$textOperationSpec = {
     path: "/api/hubs/{hub}/groups/{group}/:send",
     httpMethod: "POST",
-    responses: { 202: {}, default: {} },
+    responses: {
+        202: {},
+        default: {
+            bodyMapper: Mappers.ErrorDetail,
+            headersMapper: Mappers.WebPubSubSendToGroupExceptionHeaders
+        }
+    },
     requestBody: Parameters.message1,
-    queryParameters: [Parameters.apiVersion, Parameters.excluded],
-    urlParameters: [Parameters.$host, Parameters.hub, Parameters.group],
-    headerParameters: [Parameters.contentType1],
+    queryParameters: [Parameters.apiVersion, Parameters.excludedConnections],
+    urlParameters: [Parameters.endpoint, Parameters.hub, Parameters.group],
+    headerParameters: [Parameters.contentType1, Parameters.accept2],
     mediaType: "text",
     serializer
 };
 const addConnectionToGroupOperationSpec = {
     path: "/api/hubs/{hub}/groups/{group}/connections/{connectionId}",
     httpMethod: "PUT",
-    responses: { 200: {}, 404: {}, default: {} },
+    responses: {
+        200: {},
+        404: {},
+        default: {
+            bodyMapper: Mappers.ErrorDetail,
+            headersMapper: Mappers.WebPubSubAddConnectionToGroupExceptionHeaders
+        }
+    },
     queryParameters: [Parameters.apiVersion],
     urlParameters: [
-        Parameters.$host,
+        Parameters.endpoint,
         Parameters.hub,
         Parameters.connectionId,
         Parameters.group
     ],
+    headerParameters: [Parameters.accept],
     serializer
 };
 const removeConnectionFromGroupOperationSpec = {
     path: "/api/hubs/{hub}/groups/{group}/connections/{connectionId}",
     httpMethod: "DELETE",
-    responses: { 200: {}, default: {} },
+    responses: {
+        204: {},
+        default: {
+            bodyMapper: Mappers.ErrorDetail,
+            headersMapper: Mappers.WebPubSubRemoveConnectionFromGroupExceptionHeaders
+        }
+    },
     queryParameters: [Parameters.apiVersion],
     urlParameters: [
-        Parameters.$host,
+        Parameters.endpoint,
         Parameters.hub,
         Parameters.connectionId,
         Parameters.group
     ],
+    headerParameters: [Parameters.accept],
     serializer
 };
 const userExistsOperationSpec = {
     path: "/api/hubs/{hub}/users/{userId}",
     httpMethod: "HEAD",
-    responses: { 200: {}, 404: {}, default: {} },
+    responses: {
+        200: {},
+        404: {},
+        default: {
+            bodyMapper: Mappers.ErrorDetail,
+            headersMapper: Mappers.WebPubSubUserExistsExceptionHeaders
+        }
+    },
     queryParameters: [Parameters.apiVersion],
-    urlParameters: [Parameters.$host, Parameters.hub, Parameters.userId],
+    urlParameters: [Parameters.endpoint, Parameters.hub, Parameters.userId1],
+    headerParameters: [Parameters.accept],
+    serializer
+};
+const closeUserConnectionsOperationSpec = {
+    path: "/api/hubs/{hub}/users/{userId}/:closeConnections",
+    httpMethod: "POST",
+    responses: {
+        204: {},
+        default: {
+            bodyMapper: Mappers.ErrorDetail,
+            headersMapper: Mappers.WebPubSubCloseUserConnectionsExceptionHeaders
+        }
+    },
+    queryParameters: [
+        Parameters.apiVersion,
+        Parameters.excluded,
+        Parameters.reason
+    ],
+    urlParameters: [Parameters.endpoint, Parameters.hub, Parameters.userId1],
+    headerParameters: [Parameters.accept],
     serializer
 };
 const sendToUser$binaryOperationSpec = {
     path: "/api/hubs/{hub}/users/{userId}/:send",
     httpMethod: "POST",
-    responses: { 202: {}, default: {} },
+    responses: {
+        202: {},
+        default: {
+            bodyMapper: Mappers.ErrorDetail,
+            headersMapper: Mappers.WebPubSubSendToUserExceptionHeaders
+        }
+    },
     requestBody: Parameters.message,
     queryParameters: [Parameters.apiVersion],
-    urlParameters: [Parameters.$host, Parameters.hub, Parameters.userId],
-    headerParameters: [Parameters.contentType],
+    urlParameters: [Parameters.endpoint, Parameters.hub, Parameters.userId1],
+    headerParameters: [Parameters.contentType, Parameters.accept1],
     mediaType: "binary",
     serializer
 };
 const sendToUser$textOperationSpec = {
     path: "/api/hubs/{hub}/users/{userId}/:send",
     httpMethod: "POST",
-    responses: { 202: {}, default: {} },
+    responses: {
+        202: {},
+        default: {
+            bodyMapper: Mappers.ErrorDetail,
+            headersMapper: Mappers.WebPubSubSendToUserExceptionHeaders
+        }
+    },
     requestBody: Parameters.message1,
     queryParameters: [Parameters.apiVersion],
-    urlParameters: [Parameters.$host, Parameters.hub, Parameters.userId],
-    headerParameters: [Parameters.contentType1],
+    urlParameters: [Parameters.endpoint, Parameters.hub, Parameters.userId1],
+    headerParameters: [Parameters.contentType1, Parameters.accept2],
     mediaType: "text",
     serializer
 };
 const addUserToGroupOperationSpec = {
     path: "/api/hubs/{hub}/users/{userId}/groups/{group}",
     httpMethod: "PUT",
-    responses: { 200: {}, 404: {}, default: {} },
+    responses: {
+        200: {},
+        404: {},
+        default: {
+            bodyMapper: Mappers.ErrorDetail,
+            headersMapper: Mappers.WebPubSubAddUserToGroupExceptionHeaders
+        }
+    },
     queryParameters: [Parameters.apiVersion],
     urlParameters: [
-        Parameters.$host,
+        Parameters.endpoint,
         Parameters.hub,
         Parameters.group,
-        Parameters.userId
+        Parameters.userId1
     ],
+    headerParameters: [Parameters.accept],
     serializer
 };
 const removeUserFromGroupOperationSpec = {
     path: "/api/hubs/{hub}/users/{userId}/groups/{group}",
     httpMethod: "DELETE",
-    responses: { 200: {}, default: {} },
+    responses: {
+        204: {},
+        default: {
+            bodyMapper: Mappers.ErrorDetail,
+            headersMapper: Mappers.WebPubSubRemoveUserFromGroupExceptionHeaders
+        }
+    },
     queryParameters: [Parameters.apiVersion],
     urlParameters: [
-        Parameters.$host,
+        Parameters.endpoint,
         Parameters.hub,
         Parameters.group,
-        Parameters.userId
+        Parameters.userId1
     ],
+    headerParameters: [Parameters.accept],
     serializer
 };
 const removeUserFromAllGroupsOperationSpec = {
     path: "/api/hubs/{hub}/users/{userId}/groups",
     httpMethod: "DELETE",
-    responses: { 200: {}, default: {} },
+    responses: {
+        204: {},
+        default: {
+            bodyMapper: Mappers.ErrorDetail,
+            headersMapper: Mappers.WebPubSubRemoveUserFromAllGroupsExceptionHeaders
+        }
+    },
     queryParameters: [Parameters.apiVersion],
-    urlParameters: [Parameters.$host, Parameters.hub, Parameters.userId],
+    urlParameters: [Parameters.endpoint, Parameters.hub, Parameters.userId1],
+    headerParameters: [Parameters.accept],
     serializer
 };
 const grantPermissionOperationSpec = {
     path: "/api/hubs/{hub}/permissions/{permission}/connections/{connectionId}",
     httpMethod: "PUT",
-    responses: { 200: {}, default: {} },
+    responses: {
+        200: {},
+        default: {
+            bodyMapper: Mappers.ErrorDetail,
+            headersMapper: Mappers.WebPubSubGrantPermissionExceptionHeaders
+        }
+    },
     queryParameters: [Parameters.apiVersion, Parameters.targetName],
     urlParameters: [
-        Parameters.$host,
+        Parameters.endpoint,
         Parameters.hub,
         Parameters.connectionId,
         Parameters.permission
     ],
+    headerParameters: [Parameters.accept],
     serializer
 };
 const revokePermissionOperationSpec = {
     path: "/api/hubs/{hub}/permissions/{permission}/connections/{connectionId}",
     httpMethod: "DELETE",
-    responses: { 200: {}, default: {} },
+    responses: {
+        204: {},
+        default: {
+            bodyMapper: Mappers.ErrorDetail,
+            headersMapper: Mappers.WebPubSubRevokePermissionExceptionHeaders
+        }
+    },
     queryParameters: [Parameters.apiVersion, Parameters.targetName],
     urlParameters: [
-        Parameters.$host,
+        Parameters.endpoint,
         Parameters.hub,
         Parameters.connectionId,
         Parameters.permission
     ],
+    headerParameters: [Parameters.accept],
     serializer
 };
 const checkPermissionOperationSpec = {
     path: "/api/hubs/{hub}/permissions/{permission}/connections/{connectionId}",
     httpMethod: "HEAD",
-    responses: { 200: {}, 404: {}, default: {} },
+    responses: {
+        200: {},
+        404: {},
+        default: {
+            bodyMapper: Mappers.ErrorDetail,
+            headersMapper: Mappers.WebPubSubCheckPermissionExceptionHeaders
+        }
+    },
     queryParameters: [Parameters.apiVersion, Parameters.targetName],
     urlParameters: [
-        Parameters.$host,
+        Parameters.endpoint,
         Parameters.hub,
         Parameters.connectionId,
         Parameters.permission
     ],
+    headerParameters: [Parameters.accept],
     serializer
 };
 //# sourceMappingURL=webPubSub.js.map