diff --git a/lib/services/customerInsightsManagement/LICENSE.txt b/lib/services/customerInsightsManagement/LICENSE.txt index a70e8cf660..5431ba98b9 100644 --- a/lib/services/customerInsightsManagement/LICENSE.txt +++ b/lib/services/customerInsightsManagement/LICENSE.txt @@ -1,21 +1,21 @@ -The MIT License (MIT) - -Copyright (c) 2018 Microsoft - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +The MIT License (MIT) + +Copyright (c) 2018 Microsoft + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/lib/services/customerInsightsManagement/README.md b/lib/services/customerInsightsManagement/README.md index 56b307e7b1..2cf430c5e9 100644 --- a/lib/services/customerInsightsManagement/README.md +++ b/lib/services/customerInsightsManagement/README.md @@ -1,40 +1,41 @@ ---- -uid: azure-arm-customerinsights -summary: *content - ---- -# Microsoft Azure SDK for Node.js - CustomerInsightsManagementClient -This project provides a Node.js package for accessing Azure. Right now it supports: -- **Node.js version 6.x.x or higher** - -## Features - - -## How to Install - -```bash -npm install azure-arm-customerinsights -``` - -## How to use - -### Authentication, client creation and list operations as an example. - -```javascript -const msRestAzure = require("ms-rest-azure"); -const CustomerInsightsManagementClient = require("azure-arm-customerinsights"); -msRestAzure.interactiveLogin().then((creds) => { - const subscriptionId = ""; - const client = new CustomerInsightsManagementClient(creds, subscriptionId); - return client.operations.list().then((result) => { - console.log("The result is:"); - console.log(result); - }); -}).catch((err) => { - console.log('An error ocurred:'); - console.dir(err, {depth: null, colors: true}); -}); - -## Related projects - -- [Microsoft Azure SDK for Node.js](https://github.com/Azure/azure-sdk-for-node) +--- +uid: azure-arm-customerinsights +summary: *content + +--- +**This SDK will be deprecated next year and will be replaced by a new TypeScript-based isomorphic SDK (found at https://github.com/Azure/azure-sdk-for-js) which works on Node.js and browsers.** +## Microsoft Azure SDK for Node.js - CustomerInsightsManagementClient +This project provides a Node.js package for accessing Azure. Right now it supports: +- **Node.js version 6.x.x or higher** + +### Features + + +### How to Install + +```bash +npm install azure-arm-customerinsights +``` + +### How to use + +#### Authentication, client creation and list operations as an example. + +```javascript +const msRestAzure = require("ms-rest-azure"); +const CustomerInsightsManagementClient = require("azure-arm-customerinsights"); +msRestAzure.interactiveLogin().then((creds) => { + const subscriptionId = ""; + const client = new CustomerInsightsManagementClient(creds, subscriptionId); + return client.operations.list().then((result) => { + console.log("The result is:"); + console.log(result); + }); +}).catch((err) => { + console.log('An error occurred:'); + console.dir(err, {depth: null, colors: true}); +}); + +### Related projects + +- [Microsoft Azure SDK for Node.js](https://github.com/Azure/azure-sdk-for-node) diff --git a/lib/services/customerInsightsManagement/lib/customerInsightsManagementClient.d.ts b/lib/services/customerInsightsManagement/lib/customerInsightsManagementClient.d.ts index d9c81ebf0a..a39bb3ffb8 100644 --- a/lib/services/customerInsightsManagement/lib/customerInsightsManagementClient.d.ts +++ b/lib/services/customerInsightsManagement/lib/customerInsightsManagementClient.d.ts @@ -34,11 +34,11 @@ export default class CustomerInsightsManagementClient extends AzureServiceClient * * @param {boolean} [options.noRetryPolicy] - If set to true, turn off default retry policy * - * @param {string} [options.acceptLanguage] - Gets or sets the preferred language for the response. + * @param {string} [options.acceptLanguage] - The preferred language for the response. * - * @param {number} [options.longRunningOperationRetryTimeout] - Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30. + * @param {number} [options.longRunningOperationRetryTimeout] - The retry timeout in seconds for Long Running Operations. Default value is 30. * - * @param {boolean} [options.generateClientRequestId] - When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. + * @param {boolean} [options.generateClientRequestId] - Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. * */ constructor(credentials: ServiceClientCredentials, subscriptionId: string, baseUri?: string, options?: AzureServiceClientOptions); diff --git a/lib/services/customerInsightsManagement/lib/customerInsightsManagementClient.js b/lib/services/customerInsightsManagement/lib/customerInsightsManagementClient.js index 13ee64db46..f9976a7288 100644 --- a/lib/services/customerInsightsManagement/lib/customerInsightsManagementClient.js +++ b/lib/services/customerInsightsManagement/lib/customerInsightsManagementClient.js @@ -34,9 +34,9 @@ class CustomerInsightsManagementClient extends ServiceClient { * @param {object} [options.requestOptions] - Options for the underlying request object * {@link https://github.com/request/request#requestoptions-callback Options doc} * @param {boolean} [options.noRetryPolicy] - If set to true, turn off default retry policy - * @param {string} [options.acceptLanguage] - Gets or sets the preferred language for the response. - * @param {number} [options.longRunningOperationRetryTimeout] - Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30. - * @param {boolean} [options.generateClientRequestId] - When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. + * @param {string} [options.acceptLanguage] - The preferred language for the response. + * @param {number} [options.longRunningOperationRetryTimeout] - The retry timeout in seconds for Long Running Operations. Default value is 30. + * @param {boolean} [options.generateClientRequestId] - Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. */ constructor(credentials, subscriptionId, baseUri, options) { if (credentials === null || credentials === undefined) { diff --git a/lib/services/customerInsightsManagement/lib/models/assignmentPrincipal.js b/lib/services/customerInsightsManagement/lib/models/assignmentPrincipal.js index 9bc95c416c..f07e085fd0 100644 --- a/lib/services/customerInsightsManagement/lib/models/assignmentPrincipal.js +++ b/lib/services/customerInsightsManagement/lib/models/assignmentPrincipal.js @@ -17,9 +17,9 @@ class AssignmentPrincipal { /** * Create a AssignmentPrincipal. - * @member {string} principalId The principal id being assigned to. - * @member {string} principalType The Type of the principal ID. - * @member {object} [principalMetadata] Other metadata for the principal. + * @property {string} principalId The principal id being assigned to. + * @property {string} principalType The Type of the principal ID. + * @property {object} [principalMetadata] Other metadata for the principal. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/authorizationPolicy.js b/lib/services/customerInsightsManagement/lib/models/authorizationPolicy.js index 9e4ec26845..0587ac2c41 100644 --- a/lib/services/customerInsightsManagement/lib/models/authorizationPolicy.js +++ b/lib/services/customerInsightsManagement/lib/models/authorizationPolicy.js @@ -17,10 +17,11 @@ class AuthorizationPolicy { /** * Create a AuthorizationPolicy. - * @member {string} [policyName] Name of the policy. - * @member {array} permissions The permissions associated with the policy. - * @member {string} [primaryKey] Primary key assiciated with the policy. - * @member {string} [secondaryKey] Secondary key assiciated with the policy. + * @property {string} [policyName] Name of the policy. + * @property {array} permissions The permissions associated with the policy. + * @property {string} [primaryKey] Primary key associated with the policy. + * @property {string} [secondaryKey] Secondary key associated with the + * policy. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/authorizationPolicyListResult.js b/lib/services/customerInsightsManagement/lib/models/authorizationPolicyListResult.js index 7cc104f269..16b8c75241 100644 --- a/lib/services/customerInsightsManagement/lib/models/authorizationPolicyListResult.js +++ b/lib/services/customerInsightsManagement/lib/models/authorizationPolicyListResult.js @@ -16,7 +16,7 @@ class AuthorizationPolicyListResult extends Array { /** * Create a AuthorizationPolicyListResult. - * @member {string} [nextLink] Link to the next set of results. + * @property {string} [nextLink] Link to the next set of results. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/authorizationPolicyResourceFormat.js b/lib/services/customerInsightsManagement/lib/models/authorizationPolicyResourceFormat.js index d3578f927c..97ae984ae7 100644 --- a/lib/services/customerInsightsManagement/lib/models/authorizationPolicyResourceFormat.js +++ b/lib/services/customerInsightsManagement/lib/models/authorizationPolicyResourceFormat.js @@ -20,10 +20,11 @@ const models = require('./index'); class AuthorizationPolicyResourceFormat extends models['ProxyResource'] { /** * Create a AuthorizationPolicyResourceFormat. - * @member {string} [policyName] Name of the policy. - * @member {array} permissions The permissions associated with the policy. - * @member {string} [primaryKey] Primary key assiciated with the policy. - * @member {string} [secondaryKey] Secondary key assiciated with the policy. + * @property {string} [policyName] Name of the policy. + * @property {array} permissions The permissions associated with the policy. + * @property {string} [primaryKey] Primary key associated with the policy. + * @property {string} [secondaryKey] Secondary key associated with the + * policy. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/azureBlobConnectorProperties.js b/lib/services/customerInsightsManagement/lib/models/azureBlobConnectorProperties.js index 6c25a383f3..2a913dea5e 100644 --- a/lib/services/customerInsightsManagement/lib/models/azureBlobConnectorProperties.js +++ b/lib/services/customerInsightsManagement/lib/models/azureBlobConnectorProperties.js @@ -17,7 +17,7 @@ class AzureBlobConnectorProperties { /** * Create a AzureBlobConnectorProperties. - * @member {string} connectionKeyVaultUrl The connection KeyVault URL. + * @property {string} connectionKeyVaultUrl The connection KeyVault URL. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/canonicalProfileDefinition.js b/lib/services/customerInsightsManagement/lib/models/canonicalProfileDefinition.js index 8c78efcaae..6abf488fe1 100644 --- a/lib/services/customerInsightsManagement/lib/models/canonicalProfileDefinition.js +++ b/lib/services/customerInsightsManagement/lib/models/canonicalProfileDefinition.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * Definition of canonical profile. * @@ -19,8 +17,8 @@ const models = require('./index'); class CanonicalProfileDefinition { /** * Create a CanonicalProfileDefinition. - * @member {number} [canonicalProfileId] Canonical profile ID. - * @member {array} [properties] Properties of the canonical profile. + * @property {number} [canonicalProfileId] Canonical profile ID. + * @property {array} [properties] Properties of the canonical profile. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/canonicalProfileDefinitionPropertiesItem.js b/lib/services/customerInsightsManagement/lib/models/canonicalProfileDefinitionPropertiesItem.js index 32e99248e7..780f8ec964 100644 --- a/lib/services/customerInsightsManagement/lib/models/canonicalProfileDefinitionPropertiesItem.js +++ b/lib/services/customerInsightsManagement/lib/models/canonicalProfileDefinitionPropertiesItem.js @@ -17,12 +17,13 @@ class CanonicalProfileDefinitionPropertiesItem { /** * Create a CanonicalProfileDefinitionPropertiesItem. - * @member {string} [profileName] Profile name. - * @member {string} [profilePropertyName] Property name of profile. - * @member {number} [rank] The rank. - * @member {string} [type] Type of canonical property value. Possible values - * include: 'Numeric', 'Categorical', 'DerivedCategorical', 'DerivedNumeric' - * @member {string} [value] Value of the canonical property. + * @property {string} [profileName] Profile name. + * @property {string} [profilePropertyName] Property name of profile. + * @property {number} [rank] The rank. + * @property {string} [type] Type of canonical property value. Possible + * values include: 'Numeric', 'Categorical', 'DerivedCategorical', + * 'DerivedNumeric' + * @property {string} [value] Value of the canonical property. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/connectorListResult.js b/lib/services/customerInsightsManagement/lib/models/connectorListResult.js index 5df765d8dc..6d6c0d43b7 100644 --- a/lib/services/customerInsightsManagement/lib/models/connectorListResult.js +++ b/lib/services/customerInsightsManagement/lib/models/connectorListResult.js @@ -16,7 +16,7 @@ class ConnectorListResult extends Array { /** * Create a ConnectorListResult. - * @member {string} [nextLink] Link to the next set of results. + * @property {string} [nextLink] Link to the next set of results. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/connectorMappingAvailability.js b/lib/services/customerInsightsManagement/lib/models/connectorMappingAvailability.js index d899102cd9..38b14188e4 100644 --- a/lib/services/customerInsightsManagement/lib/models/connectorMappingAvailability.js +++ b/lib/services/customerInsightsManagement/lib/models/connectorMappingAvailability.js @@ -17,9 +17,9 @@ class ConnectorMappingAvailability { /** * Create a ConnectorMappingAvailability. - * @member {string} [frequency] The frequency to update. Possible values + * @property {string} [frequency] The frequency to update. Possible values * include: 'Minute', 'Hour', 'Day', 'Week', 'Month' - * @member {number} interval The interval of the given frequency to use. + * @property {number} interval The interval of the given frequency to use. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/connectorMappingCompleteOperation.js b/lib/services/customerInsightsManagement/lib/models/connectorMappingCompleteOperation.js index 8a253a0818..369d7902e7 100644 --- a/lib/services/customerInsightsManagement/lib/models/connectorMappingCompleteOperation.js +++ b/lib/services/customerInsightsManagement/lib/models/connectorMappingCompleteOperation.js @@ -17,9 +17,9 @@ class ConnectorMappingCompleteOperation { /** * Create a ConnectorMappingCompleteOperation. - * @member {string} [completionOperationType] The type of completion + * @property {string} [completionOperationType] The type of completion * operation. Possible values include: 'DoNothing', 'DeleteFile', 'MoveFile' - * @member {string} [destinationFolder] The destination folder where files + * @property {string} [destinationFolder] The destination folder where files * will be moved to once the import is done. */ constructor() { diff --git a/lib/services/customerInsightsManagement/lib/models/connectorMappingErrorManagement.js b/lib/services/customerInsightsManagement/lib/models/connectorMappingErrorManagement.js index 4abb5d5c33..81c0de3246 100644 --- a/lib/services/customerInsightsManagement/lib/models/connectorMappingErrorManagement.js +++ b/lib/services/customerInsightsManagement/lib/models/connectorMappingErrorManagement.js @@ -11,16 +11,16 @@ 'use strict'; /** - * The error mangement. + * The error management. * */ class ConnectorMappingErrorManagement { /** * Create a ConnectorMappingErrorManagement. - * @member {string} errorManagementType The type of error management to use + * @property {string} errorManagementType The type of error management to use * for the mapping. Possible values include: 'RejectAndContinue', * 'StopImport', 'RejectUntilLimit' - * @member {number} [errorLimit] The error limit allowed while importing + * @property {number} [errorLimit] The error limit allowed while importing * data. */ constructor() { diff --git a/lib/services/customerInsightsManagement/lib/models/connectorMappingFormat.js b/lib/services/customerInsightsManagement/lib/models/connectorMappingFormat.js index 39ef91a2f2..1e025095a4 100644 --- a/lib/services/customerInsightsManagement/lib/models/connectorMappingFormat.js +++ b/lib/services/customerInsightsManagement/lib/models/connectorMappingFormat.js @@ -17,14 +17,14 @@ class ConnectorMappingFormat { /** * Create a ConnectorMappingFormat. - * @member {string} [columnDelimiter] The character that signifies a break + * @property {string} [columnDelimiter] The character that signifies a break * between columns. - * @member {string} [acceptLanguage] The oData language. - * @member {string} [quoteCharacter] Quote character, used to indicate + * @property {string} [acceptLanguage] The oData language. + * @property {string} [quoteCharacter] Quote character, used to indicate * enquoted fields. - * @member {string} [quoteEscapeCharacter] Escape character for quotes, can + * @property {string} [quoteEscapeCharacter] Escape character for quotes, can * be the same as the quoteCharacter. - * @member {string} [arraySeparator] Character separating array elements. + * @property {string} [arraySeparator] Character separating array elements. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/connectorMappingListResult.js b/lib/services/customerInsightsManagement/lib/models/connectorMappingListResult.js index 122403f88e..31df0ea776 100644 --- a/lib/services/customerInsightsManagement/lib/models/connectorMappingListResult.js +++ b/lib/services/customerInsightsManagement/lib/models/connectorMappingListResult.js @@ -16,7 +16,7 @@ class ConnectorMappingListResult extends Array { /** * Create a ConnectorMappingListResult. - * @member {string} [nextLink] Link to the next set of results. + * @property {string} [nextLink] Link to the next set of results. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/connectorMappingProperties.js b/lib/services/customerInsightsManagement/lib/models/connectorMappingProperties.js index f09a64e4dc..3279ae2a5d 100644 --- a/lib/services/customerInsightsManagement/lib/models/connectorMappingProperties.js +++ b/lib/services/customerInsightsManagement/lib/models/connectorMappingProperties.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * The connector mapping properties. * @@ -19,37 +17,38 @@ const models = require('./index'); class ConnectorMappingProperties { /** * Create a ConnectorMappingProperties. - * @member {string} [folderPath] The folder path for the mapping. - * @member {string} [fileFilter] The file filter for the mapping. - * @member {boolean} [hasHeader] If the file contains a header or not. - * @member {object} errorManagement The error management setting for the + * @property {string} [folderPath] The folder path for the mapping. + * @property {string} [fileFilter] The file filter for the mapping. + * @property {boolean} [hasHeader] If the file contains a header or not. + * @property {object} errorManagement The error management setting for the * mapping. - * @member {string} [errorManagement.errorManagementType] The type of error + * @property {string} [errorManagement.errorManagementType] The type of error * management to use for the mapping. Possible values include: * 'RejectAndContinue', 'StopImport', 'RejectUntilLimit' - * @member {number} [errorManagement.errorLimit] The error limit allowed + * @property {number} [errorManagement.errorLimit] The error limit allowed * while importing data. - * @member {object} format The format of mapping property. - * @member {string} [format.columnDelimiter] The character that signifies a + * @property {object} format The format of mapping property. + * @property {string} [format.columnDelimiter] The character that signifies a * break between columns. - * @member {string} [format.acceptLanguage] The oData language. - * @member {string} [format.quoteCharacter] Quote character, used to indicate - * enquoted fields. - * @member {string} [format.quoteEscapeCharacter] Escape character for + * @property {string} [format.acceptLanguage] The oData language. + * @property {string} [format.quoteCharacter] Quote character, used to + * indicate enquoted fields. + * @property {string} [format.quoteEscapeCharacter] Escape character for * quotes, can be the same as the quoteCharacter. - * @member {string} [format.arraySeparator] Character separating array + * @property {string} [format.arraySeparator] Character separating array * elements. - * @member {object} availability The availability of mapping property. - * @member {string} [availability.frequency] The frequency to update. + * @property {object} availability The availability of mapping property. + * @property {string} [availability.frequency] The frequency to update. * Possible values include: 'Minute', 'Hour', 'Day', 'Week', 'Month' - * @member {number} [availability.interval] The interval of the given + * @property {number} [availability.interval] The interval of the given * frequency to use. - * @member {array} structure Ingestion mapping information at property level. - * @member {object} completeOperation The operation after import is done. - * @member {string} [completeOperation.completionOperationType] The type of + * @property {array} structure Ingestion mapping information at property + * level. + * @property {object} completeOperation The operation after import is done. + * @property {string} [completeOperation.completionOperationType] The type of * completion operation. Possible values include: 'DoNothing', 'DeleteFile', * 'MoveFile' - * @member {string} [completeOperation.destinationFolder] The destination + * @property {string} [completeOperation.destinationFolder] The destination * folder where files will be moved to once the import is done. */ constructor() { diff --git a/lib/services/customerInsightsManagement/lib/models/connectorMappingResourceFormat.js b/lib/services/customerInsightsManagement/lib/models/connectorMappingResourceFormat.js index a71b0a0bd4..184b32d7a1 100644 --- a/lib/services/customerInsightsManagement/lib/models/connectorMappingResourceFormat.js +++ b/lib/services/customerInsightsManagement/lib/models/connectorMappingResourceFormat.js @@ -13,78 +13,78 @@ const models = require('./index'); /** - * The c onnector mapping resource format. + * The connector mapping resource format. * * @extends models['ProxyResource'] */ class ConnectorMappingResourceFormat extends models['ProxyResource'] { /** * Create a ConnectorMappingResourceFormat. - * @member {string} [connectorName] The connector name. - * @member {string} [connectorType] Type of connector. Possible values + * @property {string} [connectorName] The connector name. + * @property {string} [connectorType] Type of connector. Possible values * include: 'None', 'CRM', 'AzureBlob', 'Salesforce', 'ExchangeOnline', * 'Outbound' - * @member {date} [created] The created time. - * @member {date} [lastModified] The last monified time. - * @member {string} entityType Defines which entity type the file should map - * to. Possible values include: 'None', 'Profile', 'Interaction', + * @property {date} [created] The created time. + * @property {date} [lastModified] The last modified time. + * @property {string} entityType Defines which entity type the file should + * map to. Possible values include: 'None', 'Profile', 'Interaction', * 'Relationship' - * @member {string} entityTypeName The mapping entity name. - * @member {string} [connectorMappingName] The connector mapping name - * @member {string} [displayName] Display name for the connector mapping. - * @member {string} [description] The description of the connector mapping. - * @member {string} [dataFormatId] The DataFormat ID. - * @member {object} mappingProperties The properties of the mapping. - * @member {string} [mappingProperties.folderPath] The folder path for the + * @property {string} entityTypeName The mapping entity name. + * @property {string} [connectorMappingName] The connector mapping name + * @property {string} [displayName] Display name for the connector mapping. + * @property {string} [description] The description of the connector mapping. + * @property {string} [dataFormatId] The DataFormat ID. + * @property {object} mappingProperties The properties of the mapping. + * @property {string} [mappingProperties.folderPath] The folder path for the * mapping. - * @member {string} [mappingProperties.fileFilter] The file filter for the + * @property {string} [mappingProperties.fileFilter] The file filter for the * mapping. - * @member {boolean} [mappingProperties.hasHeader] If the file contains a + * @property {boolean} [mappingProperties.hasHeader] If the file contains a * header or not. - * @member {object} [mappingProperties.errorManagement] The error management - * setting for the mapping. - * @member {string} [mappingProperties.errorManagement.errorManagementType] + * @property {object} [mappingProperties.errorManagement] The error + * management setting for the mapping. + * @property {string} [mappingProperties.errorManagement.errorManagementType] * The type of error management to use for the mapping. Possible values * include: 'RejectAndContinue', 'StopImport', 'RejectUntilLimit' - * @member {number} [mappingProperties.errorManagement.errorLimit] The error - * limit allowed while importing data. - * @member {object} [mappingProperties.format] The format of mapping + * @property {number} [mappingProperties.errorManagement.errorLimit] The + * error limit allowed while importing data. + * @property {object} [mappingProperties.format] The format of mapping * property. - * @member {string} [mappingProperties.format.columnDelimiter] The character - * that signifies a break between columns. - * @member {string} [mappingProperties.format.acceptLanguage] The oData + * @property {string} [mappingProperties.format.columnDelimiter] The + * character that signifies a break between columns. + * @property {string} [mappingProperties.format.acceptLanguage] The oData * language. - * @member {string} [mappingProperties.format.quoteCharacter] Quote + * @property {string} [mappingProperties.format.quoteCharacter] Quote * character, used to indicate enquoted fields. - * @member {string} [mappingProperties.format.quoteEscapeCharacter] Escape + * @property {string} [mappingProperties.format.quoteEscapeCharacter] Escape * character for quotes, can be the same as the quoteCharacter. - * @member {string} [mappingProperties.format.arraySeparator] Character + * @property {string} [mappingProperties.format.arraySeparator] Character * separating array elements. - * @member {object} [mappingProperties.availability] The availability of + * @property {object} [mappingProperties.availability] The availability of * mapping property. - * @member {string} [mappingProperties.availability.frequency] The frequency - * to update. Possible values include: 'Minute', 'Hour', 'Day', 'Week', - * 'Month' - * @member {number} [mappingProperties.availability.interval] The interval of - * the given frequency to use. - * @member {array} [mappingProperties.structure] Ingestion mapping + * @property {string} [mappingProperties.availability.frequency] The + * frequency to update. Possible values include: 'Minute', 'Hour', 'Day', + * 'Week', 'Month' + * @property {number} [mappingProperties.availability.interval] The interval + * of the given frequency to use. + * @property {array} [mappingProperties.structure] Ingestion mapping * information at property level. - * @member {object} [mappingProperties.completeOperation] The operation after - * import is done. - * @member {string} + * @property {object} [mappingProperties.completeOperation] The operation + * after import is done. + * @property {string} * [mappingProperties.completeOperation.completionOperationType] The type of * completion operation. Possible values include: 'DoNothing', 'DeleteFile', * 'MoveFile' - * @member {string} [mappingProperties.completeOperation.destinationFolder] + * @property {string} [mappingProperties.completeOperation.destinationFolder] * The destination folder where files will be moved to once the import is * done. - * @member {date} [nextRunTime] The next run time based on customer's + * @property {date} [nextRunTime] The next run time based on customer's * settings. - * @member {string} [runId] The RunId. - * @member {string} [state] State of connector mapping. Possible values + * @property {string} [runId] The RunId. + * @property {string} [state] State of connector mapping. Possible values * include: 'Creating', 'Created', 'Failed', 'Ready', 'Running', 'Stopped', * 'Expiring' - * @member {string} [tenantId] The hub name. + * @property {string} [tenantId] The hub name. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/connectorMappingStructure.js b/lib/services/customerInsightsManagement/lib/models/connectorMappingStructure.js index 918756a3df..54e3377b58 100644 --- a/lib/services/customerInsightsManagement/lib/models/connectorMappingStructure.js +++ b/lib/services/customerInsightsManagement/lib/models/connectorMappingStructure.js @@ -17,11 +17,11 @@ class ConnectorMappingStructure { /** * Create a ConnectorMappingStructure. - * @member {string} propertyName The property name of the mapping entity. - * @member {string} columnName The column name of the import file. - * @member {string} [customFormatSpecifier] Custom format specifier for input - * parsing. - * @member {boolean} [isEncrypted] Indicates if the column is encrypted. + * @property {string} propertyName The property name of the mapping entity. + * @property {string} columnName The column name of the import file. + * @property {string} [customFormatSpecifier] Custom format specifier for + * input parsing. + * @property {boolean} [isEncrypted] Indicates if the column is encrypted. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/connectorResourceFormat.js b/lib/services/customerInsightsManagement/lib/models/connectorResourceFormat.js index c734f7c354..9f89707acd 100644 --- a/lib/services/customerInsightsManagement/lib/models/connectorResourceFormat.js +++ b/lib/services/customerInsightsManagement/lib/models/connectorResourceFormat.js @@ -20,19 +20,20 @@ const models = require('./index'); class ConnectorResourceFormat extends models['ProxyResource'] { /** * Create a ConnectorResourceFormat. - * @member {number} [connectorId] ID of the connector. - * @member {string} [connectorName] Name of the connector. - * @member {string} connectorType Type of connector. Possible values include: - * 'None', 'CRM', 'AzureBlob', 'Salesforce', 'ExchangeOnline', 'Outbound' - * @member {string} [displayName] Display name of the connector. - * @member {string} [description] Description of the connector. - * @member {object} connectorProperties The connector properties. - * @member {date} [created] The created time. - * @member {date} [lastModified] The last monified time. - * @member {string} [state] State of connector. Possible values include: + * @property {number} [connectorId] ID of the connector. + * @property {string} [connectorName] Name of the connector. + * @property {string} connectorType Type of connector. Possible values + * include: 'None', 'CRM', 'AzureBlob', 'Salesforce', 'ExchangeOnline', + * 'Outbound' + * @property {string} [displayName] Display name of the connector. + * @property {string} [description] Description of the connector. + * @property {object} connectorProperties The connector properties. + * @property {date} [created] The created time. + * @property {date} [lastModified] The last modified time. + * @property {string} [state] State of connector. Possible values include: * 'Creating', 'Created', 'Ready', 'Expiring', 'Deleting', 'Failed' - * @member {string} [tenantId] The hub name. - * @member {boolean} [isInternal] If this is an internal connector. + * @property {string} [tenantId] The hub name. + * @property {boolean} [isInternal] If this is an internal connector. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/crmConnectorEntities.js b/lib/services/customerInsightsManagement/lib/models/crmConnectorEntities.js index 176f059810..8e45ce85e5 100644 --- a/lib/services/customerInsightsManagement/lib/models/crmConnectorEntities.js +++ b/lib/services/customerInsightsManagement/lib/models/crmConnectorEntities.js @@ -17,9 +17,9 @@ class CrmConnectorEntities { /** * Create a CrmConnectorEntities. - * @member {string} logicalName The logical name. - * @member {string} [displayName] The display name. - * @member {boolean} [isProfile] Indicating whether this is profile. + * @property {string} logicalName The logical name. + * @property {string} [displayName] The display name. + * @property {boolean} [isProfile] Indicating whether this is profile. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/crmConnectorProperties.js b/lib/services/customerInsightsManagement/lib/models/crmConnectorProperties.js index be1c3146a2..0b062773e4 100644 --- a/lib/services/customerInsightsManagement/lib/models/crmConnectorProperties.js +++ b/lib/services/customerInsightsManagement/lib/models/crmConnectorProperties.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * The CRM connector properties. * @@ -19,11 +17,12 @@ const models = require('./index'); class CrmConnectorProperties { /** * Create a CrmConnectorProperties. - * @member {string} [connectionString] The connection string. - * @member {string} organizationId The organization ID. - * @member {string} organizationUrl The organization URL. - * @member {array} entities The entities like account, contact, opportunity. - * @member {string} [accessToken] The access token. + * @property {string} [connectionString] The connection string. + * @property {string} organizationId The organization ID. + * @property {string} organizationUrl The organization URL. + * @property {array} entities The entities like account, contact, + * opportunity. + * @property {string} [accessToken] The access token. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/dataSourcePrecedence.js b/lib/services/customerInsightsManagement/lib/models/dataSourcePrecedence.js index 2d221c5fa5..d4d2d15a38 100644 --- a/lib/services/customerInsightsManagement/lib/models/dataSourcePrecedence.js +++ b/lib/services/customerInsightsManagement/lib/models/dataSourcePrecedence.js @@ -18,14 +18,14 @@ class DataSourcePrecedence { /** * Create a DataSourcePrecedence. - * @member {string} [name] The data source name - * @member {string} [dataSourceType] The data source type. Possible values + * @property {string} [name] The data source name + * @property {string} [dataSourceType] The data source type. Possible values * include: 'Connector', 'LinkInteraction', 'SystemDefault' - * @member {string} [status] The data source status. Possible values include: - * 'None', 'Active', 'Deleted' - * @member {number} [id] The data source ID. - * @member {string} [dataSourceReferenceId] The data source reference id. - * @member {number} [precedence] the precedence value. + * @property {string} [status] The data source status. Possible values + * include: 'None', 'Active', 'Deleted' + * @property {number} [id] The data source ID. + * @property {string} [dataSourceReferenceId] The data source reference id. + * @property {number} [precedence] the precedence value. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/entityTypeDefinition.js b/lib/services/customerInsightsManagement/lib/models/entityTypeDefinition.js index 4b9395b176..d37e49812b 100644 --- a/lib/services/customerInsightsManagement/lib/models/entityTypeDefinition.js +++ b/lib/services/customerInsightsManagement/lib/models/entityTypeDefinition.js @@ -20,24 +20,24 @@ const models = require('./index'); class EntityTypeDefinition extends models['MetadataDefinitionBase'] { /** * Create a EntityTypeDefinition. - * @member {string} [apiEntitySetName] The api entity set name. This becomes - * the odata entity set name for the entity Type being refered in this - * object. - * @member {string} [entityType] Type of entity. Possible values include: + * @property {string} [apiEntitySetName] The api entity set name. This + * becomes the odata entity set name for the entity Type being referred in + * this object. + * @property {string} [entityType] Type of entity. Possible values include: * 'None', 'Profile', 'Interaction', 'Relationship' - * @member {array} [fields] The properties of the Profile. - * @member {number} [instancesCount] The instance count. - * @member {date} [lastChangedUtc] The last changed time for the type + * @property {array} [fields] The properties of the Profile. + * @property {number} [instancesCount] The instance count. + * @property {date} [lastChangedUtc] The last changed time for the type * definition. - * @member {string} [provisioningState] Provisioning state. Possible values + * @property {string} [provisioningState] Provisioning state. Possible values * include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', * 'HumanIntervention', 'Failed' - * @member {string} [schemaItemTypeLink] The schema org link. This helps ACI - * identify and suggest semantic models. - * @member {string} [tenantId] The hub name. - * @member {string} [timestampFieldName] The timestamp property name. + * @property {string} [schemaItemTypeLink] The schema org link. This helps + * ACI identify and suggest semantic models. + * @property {string} [tenantId] The hub name. + * @property {string} [timestampFieldName] The timestamp property name. * Represents the time when the interaction or profile update happened. - * @member {string} [typeName] The name of the entity. + * @property {string} [typeName] The name of the entity. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/getImageUploadUrlInput.js b/lib/services/customerInsightsManagement/lib/models/getImageUploadUrlInput.js index 416eae4a63..4b859a5e56 100644 --- a/lib/services/customerInsightsManagement/lib/models/getImageUploadUrlInput.js +++ b/lib/services/customerInsightsManagement/lib/models/getImageUploadUrlInput.js @@ -17,10 +17,10 @@ class GetImageUploadUrlInput { /** * Create a GetImageUploadUrlInput. - * @member {string} [entityType] Type of entity. Can be Profile or + * @property {string} [entityType] Type of entity. Can be Profile or * Interaction. - * @member {string} [entityTypeName] Name of the entity type. - * @member {string} [relativePath] Relative path of the image. + * @property {string} [entityTypeName] Name of the entity type. + * @property {string} [relativePath] Relative path of the image. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/hub.js b/lib/services/customerInsightsManagement/lib/models/hub.js index add20b3e48..fdfac73a40 100644 --- a/lib/services/customerInsightsManagement/lib/models/hub.js +++ b/lib/services/customerInsightsManagement/lib/models/hub.js @@ -20,18 +20,19 @@ const models = require('./index'); class Hub extends models['Resource'] { /** * Create a Hub. - * @member {string} [apiEndpoint] API endpoint URL of the hub. - * @member {string} [webEndpoint] Web endpoint URL of the hub. - * @member {string} [provisioningState] Provisioning state of the hub. - * @member {number} [tenantFeatures] The bit flags for enabled hub features. - * Bit 0 is set to 1 indicates graph is enabled, or disabled if set to 0. Bit - * 1 is set to 1 indicates the hub is disabled, or enabled if set to 0. - * @member {object} [hubBillingInfo] Billing settings of the hub. - * @member {string} [hubBillingInfo.skuName] The sku name. - * @member {number} [hubBillingInfo.minUnits] The minimum number of units + * @property {string} [apiEndpoint] API endpoint URL of the hub. + * @property {string} [webEndpoint] Web endpoint URL of the hub. + * @property {string} [provisioningState] Provisioning state of the hub. + * @property {number} [tenantFeatures] The bit flags for enabled hub + * features. Bit 0 is set to 1 indicates graph is enabled, or disabled if set + * to 0. Bit 1 is set to 1 indicates the hub is disabled, or enabled if set + * to 0. + * @property {object} [hubBillingInfo] Billing settings of the hub. + * @property {string} [hubBillingInfo.skuName] The sku name. + * @property {number} [hubBillingInfo.minUnits] The minimum number of units * will be billed. One unit is 10,000 Profiles and 100,000 Interactions. - * @member {number} [hubBillingInfo.maxUnits] The maximum number of units can - * be used. One unit is 10,000 Profiles and 100,000 Interactions. + * @property {number} [hubBillingInfo.maxUnits] The maximum number of units + * can be used. One unit is 10,000 Profiles and 100,000 Interactions. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/hubBillingInfoFormat.js b/lib/services/customerInsightsManagement/lib/models/hubBillingInfoFormat.js index 36983306d7..281b27131a 100644 --- a/lib/services/customerInsightsManagement/lib/models/hubBillingInfoFormat.js +++ b/lib/services/customerInsightsManagement/lib/models/hubBillingInfoFormat.js @@ -17,11 +17,11 @@ class HubBillingInfoFormat { /** * Create a HubBillingInfoFormat. - * @member {string} [skuName] The sku name. - * @member {number} [minUnits] The minimum number of units will be billed. + * @property {string} [skuName] The sku name. + * @property {number} [minUnits] The minimum number of units will be billed. + * One unit is 10,000 Profiles and 100,000 Interactions. + * @property {number} [maxUnits] The maximum number of units can be used. * One unit is 10,000 Profiles and 100,000 Interactions. - * @member {number} [maxUnits] The maximum number of units can be used. One - * unit is 10,000 Profiles and 100,000 Interactions. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/hubListResult.js b/lib/services/customerInsightsManagement/lib/models/hubListResult.js index 6f45837374..e3e429bd3b 100644 --- a/lib/services/customerInsightsManagement/lib/models/hubListResult.js +++ b/lib/services/customerInsightsManagement/lib/models/hubListResult.js @@ -16,7 +16,7 @@ class HubListResult extends Array { /** * Create a HubListResult. - * @member {string} [nextLink] Link for next set of results. + * @property {string} [nextLink] Link for next set of results. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/imageDefinition.js b/lib/services/customerInsightsManagement/lib/models/imageDefinition.js index e968a0f18f..8270c42845 100644 --- a/lib/services/customerInsightsManagement/lib/models/imageDefinition.js +++ b/lib/services/customerInsightsManagement/lib/models/imageDefinition.js @@ -17,9 +17,9 @@ class ImageDefinition { /** * Create a ImageDefinition. - * @member {boolean} [imageExists] Whether image exists already. - * @member {string} [contentUrl] Content URL for the image blob. - * @member {string} [relativePath] Relative path of the image. + * @property {boolean} [imageExists] Whether image exists already. + * @property {string} [contentUrl] Content URL for the image blob. + * @property {string} [relativePath] Relative path of the image. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/index.d.ts b/lib/services/customerInsightsManagement/lib/models/index.d.ts index 1bfb63dd93..2fbbcc30b2 100644 --- a/lib/services/customerInsightsManagement/lib/models/index.d.ts +++ b/lib/services/customerInsightsManagement/lib/models/index.d.ts @@ -1,1991 +1,2242 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Licensed under the MIT License. See License.txt in the project root for license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ -import { BaseResource } from 'ms-rest-azure'; -import { CloudError } from 'ms-rest-azure'; -import * as moment from 'moment'; +import { BaseResource, CloudError } from "ms-rest-azure"; +import * as moment from "moment"; -export { BaseResource } from 'ms-rest-azure'; -export { CloudError } from 'ms-rest-azure'; +export { + BaseResource, + CloudError +}; /** - * @class - * Initializes a new instance of the HubBillingInfoFormat class. - * @constructor * Hub billing info. - * - * @member {string} [skuName] The sku name. - * @member {number} [minUnits] The minimum number of units will be billed. One - * unit is 10,000 Profiles and 100,000 Interactions. - * @member {number} [maxUnits] The maximum number of units can be used. One - * unit is 10,000 Profiles and 100,000 Interactions. */ export interface HubBillingInfoFormat { + /** + * The sku name. + */ skuName?: string; + /** + * The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 + * Interactions. + */ minUnits?: number; + /** + * The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 + * Interactions. + */ maxUnits?: number; } /** - * @class - * Initializes a new instance of the Resource class. - * @constructor * Common properties of Azure resource. - * - * @member {string} [id] Resource ID. - * @member {string} [name] Resource name. - * @member {string} [type] Resource type. - * @member {string} [location] Resource location. - * @member {object} [tags] Resource tags. */ export interface Resource extends BaseResource { + /** + * Resource ID. + */ readonly id?: string; + /** + * Resource name. + */ readonly name?: string; + /** + * Resource type. + */ readonly type?: string; + /** + * Resource location. + */ location?: string; + /** + * Resource tags. + */ tags?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the Hub class. - * @constructor * Hub resource. - * - * @member {string} [apiEndpoint] API endpoint URL of the hub. - * @member {string} [webEndpoint] Web endpoint URL of the hub. - * @member {string} [provisioningState] Provisioning state of the hub. - * @member {number} [tenantFeatures] The bit flags for enabled hub features. - * Bit 0 is set to 1 indicates graph is enabled, or disabled if set to 0. Bit 1 - * is set to 1 indicates the hub is disabled, or enabled if set to 0. - * @member {object} [hubBillingInfo] Billing settings of the hub. - * @member {string} [hubBillingInfo.skuName] The sku name. - * @member {number} [hubBillingInfo.minUnits] The minimum number of units will - * be billed. One unit is 10,000 Profiles and 100,000 Interactions. - * @member {number} [hubBillingInfo.maxUnits] The maximum number of units can - * be used. One unit is 10,000 Profiles and 100,000 Interactions. */ export interface Hub extends Resource { + /** + * API endpoint URL of the hub. + */ readonly apiEndpoint?: string; + /** + * Web endpoint URL of the hub. + */ readonly webEndpoint?: string; + /** + * Provisioning state of the hub. + */ readonly provisioningState?: string; + /** + * The bit flags for enabled hub features. Bit 0 is set to 1 indicates graph is enabled, or + * disabled if set to 0. Bit 1 is set to 1 indicates the hub is disabled, or enabled if set to 0. + */ tenantFeatures?: number; + /** + * Billing settings of the hub. + */ hubBillingInfo?: HubBillingInfoFormat; } /** - * @class - * Initializes a new instance of the MetadataDefinitionBase class. - * @constructor * The Metadata definition base. - * - * @member {object} [attributes] The attributes for the Type. - * @member {object} [description] Localized descriptions for the property. - * @member {object} [displayName] Localized display names for the property. - * @member {object} [localizedAttributes] Any custom localized attributes for - * the Type. - * @member {string} [smallImage] Small Image associated with the Property or - * EntityType. - * @member {string} [mediumImage] Medium Image associated with the Property or - * EntityType. - * @member {string} [largeImage] Large Image associated with the Property or - * EntityType. */ export interface MetadataDefinitionBase { + /** + * The attributes for the Type. + */ attributes?: { [propertyName: string]: string[] }; + /** + * Localized descriptions for the property. + */ description?: { [propertyName: string]: string }; + /** + * Localized display names for the property. + */ displayName?: { [propertyName: string]: string }; + /** + * Any custom localized attributes for the Type. + */ localizedAttributes?: { [propertyName: string]: { [propertyName: string]: string } }; + /** + * Small Image associated with the Property or EntityType. + */ smallImage?: string; + /** + * Medium Image associated with the Property or EntityType. + */ mediumImage?: string; + /** + * Large Image associated with the Property or EntityType. + */ largeImage?: string; } /** - * @class - * Initializes a new instance of the ProfileEnumValidValuesFormat class. - * @constructor * Valid enum values in case of an enum property. - * - * @member {number} [value] The integer value of the enum member. - * @member {object} [localizedValueNames] Localized names of the enum member. */ export interface ProfileEnumValidValuesFormat { + /** + * The integer value of the enum member. + */ value?: number; + /** + * Localized names of the enum member. + */ localizedValueNames?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the DataSourcePrecedence class. - * @constructor - * The data source precedence is a way to know the precedence of each data - * source. - * - * @member {string} [name] The data source name - * @member {string} [dataSourceType] The data source type. Possible values - * include: 'Connector', 'LinkInteraction', 'SystemDefault' - * @member {string} [status] The data source status. Possible values include: - * 'None', 'Active', 'Deleted' - * @member {number} [id] The data source ID. - * @member {string} [dataSourceReferenceId] The data source reference id. - * @member {number} [precedence] the precedence value. + * The data source precedence is a way to know the precedence of each data source. */ export interface DataSourcePrecedence { + /** + * The data source name + */ readonly name?: string; + /** + * The data source type. Possible values include: 'Connector', 'LinkInteraction', 'SystemDefault' + */ readonly dataSourceType?: string; + /** + * The data source status. Possible values include: 'None', 'Active', 'Deleted' + */ readonly status?: string; + /** + * The data source ID. + */ readonly id?: number; + /** + * The data source reference id. + */ readonly dataSourceReferenceId?: string; + /** + * the precedence value. + */ precedence?: number; } /** - * @class - * Initializes a new instance of the PropertyDefinition class. - * @constructor * Property definition. - * - * @member {string} [arrayValueSeparator] Array value separator for properties - * with isArray set. - * @member {array} [enumValidValues] Describes valid values for an enum - * property. - * @member {string} fieldName Name of the property. - * @member {string} fieldType Type of the property. - * @member {boolean} [isArray] Indicates if the property is actually an array - * of the fieldType above on the data api. - * @member {boolean} [isEnum] Indicates if the property is an enum. - * @member {boolean} [isFlagEnum] Indicates if the property is an flag enum. - * @member {boolean} [isImage] Whether the property is an Image. - * @member {boolean} [isLocalizedString] Whether the property is a localized - * string. - * @member {boolean} [isName] Whether the property is a name or a part of name. - * @member {boolean} [isRequired] Whether property value is required on - * instances, IsRequired field only for Intercation. Profile Instance will not - * check for required field. - * @member {string} [propertyId] The ID associated with the property. - * @member {string} [schemaItemPropLink] URL encoded schema.org item prop link - * for the property. - * @member {number} [maxLength] Max length of string. Used only if type is - * string. - * @member {boolean} [isAvailableInGraph] Whether property is available in - * graph or not. - * @member {array} [dataSourcePrecedenceRules] This is specific to interactions - * modeled as activities. Data sources are used to determine where data is - * stored and also in precedence rules. */ export interface PropertyDefinition { + /** + * Array value separator for properties with isArray set. + */ arrayValueSeparator?: string; + /** + * Describes valid values for an enum property. + */ enumValidValues?: ProfileEnumValidValuesFormat[]; + /** + * Name of the property. + */ fieldName: string; + /** + * Type of the property. + */ fieldType: string; + /** + * Indicates if the property is actually an array of the fieldType above on the data api. + */ isArray?: boolean; + /** + * Indicates if the property is an enum. + */ isEnum?: boolean; + /** + * Indicates if the property is an flag enum. + */ isFlagEnum?: boolean; + /** + * Whether the property is an Image. + */ isImage?: boolean; + /** + * Whether the property is a localized string. + */ isLocalizedString?: boolean; + /** + * Whether the property is a name or a part of name. + */ isName?: boolean; + /** + * Whether property value is required on instances, IsRequired field only for Interaction. + * Profile Instance will not check for required field. + */ isRequired?: boolean; + /** + * The ID associated with the property. + */ propertyId?: string; + /** + * URL encoded schema.org item prop link for the property. + */ schemaItemPropLink?: string; + /** + * Max length of string. Used only if type is string. + */ maxLength?: number; + /** + * Whether property is available in graph or not. + */ isAvailableInGraph?: boolean; + /** + * This is specific to interactions modeled as activities. Data sources are used to determine + * where data is stored and also in precedence rules. + */ readonly dataSourcePrecedenceRules?: DataSourcePrecedence[]; } /** - * @class - * Initializes a new instance of the EntityTypeDefinition class. - * @constructor * Describes an entity. - * - * @member {string} [apiEntitySetName] The api entity set name. This becomes - * the odata entity set name for the entity Type being refered in this object. - * @member {string} [entityType] Type of entity. Possible values include: - * 'None', 'Profile', 'Interaction', 'Relationship' - * @member {array} [fields] The properties of the Profile. - * @member {number} [instancesCount] The instance count. - * @member {date} [lastChangedUtc] The last changed time for the type - * definition. - * @member {string} [provisioningState] Provisioning state. Possible values - * include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', - * 'HumanIntervention', 'Failed' - * @member {string} [schemaItemTypeLink] The schema org link. This helps ACI - * identify and suggest semantic models. - * @member {string} [tenantId] The hub name. - * @member {string} [timestampFieldName] The timestamp property name. - * Represents the time when the interaction or profile update happened. - * @member {string} [typeName] The name of the entity. */ export interface EntityTypeDefinition extends MetadataDefinitionBase { + /** + * The api entity set name. This becomes the odata entity set name for the entity Type being + * referred in this object. + */ apiEntitySetName?: string; + /** + * Type of entity. Possible values include: 'None', 'Profile', 'Interaction', 'Relationship' + */ entityType?: string; + /** + * The properties of the Profile. + */ fields?: PropertyDefinition[]; + /** + * The instance count. + */ instancesCount?: number; + /** + * The last changed time for the type definition. + */ readonly lastChangedUtc?: Date; + /** + * Provisioning state. Possible values include: 'Provisioning', 'Succeeded', 'Expiring', + * 'Deleting', 'HumanIntervention', 'Failed' + */ readonly provisioningState?: string; + /** + * The schema org link. This helps ACI identify and suggest semantic models. + */ schemaItemTypeLink?: string; + /** + * The hub name. + */ readonly tenantId?: string; + /** + * The timestamp property name. Represents the time when the interaction or profile update + * happened. + */ timestampFieldName?: string; + /** + * The name of the entity. + */ typeName?: string; } /** - * @class - * Initializes a new instance of the AuthorizationPolicy class. - * @constructor * The authorization policy. - * - * @member {string} [policyName] Name of the policy. - * @member {array} permissions The permissions associated with the policy. - * @member {string} [primaryKey] Primary key assiciated with the policy. - * @member {string} [secondaryKey] Secondary key assiciated with the policy. */ export interface AuthorizationPolicy { + /** + * Name of the policy. + */ readonly policyName?: string; + /** + * The permissions associated with the policy. + */ permissions: string[]; + /** + * Primary key associated with the policy. + */ primaryKey?: string; + /** + * Secondary key associated with the policy. + */ secondaryKey?: string; } /** - * @class - * Initializes a new instance of the SalesforceDiscoverSetting class. - * @constructor * Salesforce discover setting. - * - * @member {string} salesforceConnectionStringSecretUrl The salesforce - * connection string secret URL. */ export interface SalesforceDiscoverSetting { + /** + * The salesforce connection string secret URL. + */ salesforceConnectionStringSecretUrl: string; } /** - * @class - * Initializes a new instance of the SalesforceTable class. - * @constructor * Salesforce table. - * - * @member {string} [isProfile] Indicating whether this instance is profile. - * @member {string} tableCategory The table category. - * @member {string} tableName The name of the table. - * @member {string} [tableRemarks] The table remarks. - * @member {string} tableSchema The table schema. */ export interface SalesforceTable { + /** + * Indicating whether this instance is profile. + */ isProfile?: string; + /** + * The table category. + */ tableCategory: string; + /** + * The name of the table. + */ tableName: string; + /** + * The table remarks. + */ tableRemarks?: string; + /** + * The table schema. + */ tableSchema: string; } /** - * @class - * Initializes a new instance of the SalesforceConnectorProperties class. - * @constructor * The Salesforce connector properties. - * - * @member {object} usersetting The user settings. - * @member {string} [usersetting.salesforceConnectionStringSecretUrl] The - * salesforce connection string secret URL. - * @member {array} salesforcetables The Salesforce tables. */ export interface SalesforceConnectorProperties { + /** + * The user settings. + */ usersetting: SalesforceDiscoverSetting; + /** + * The Salesforce tables. + */ salesforcetables: SalesforceTable[]; } /** - * @class - * Initializes a new instance of the AzureBlobConnectorProperties class. - * @constructor * The Azure Blob connector properties. - * - * @member {string} connectionKeyVaultUrl The connection KeyVault URL. */ export interface AzureBlobConnectorProperties { + /** + * The connection KeyVault URL. + */ connectionKeyVaultUrl: string; } /** - * @class - * Initializes a new instance of the CrmConnectorEntities class. - * @constructor * The CRM connector entities. - * - * @member {string} logicalName The logical name. - * @member {string} [displayName] The display name. - * @member {boolean} [isProfile] Indicating whether this is profile. */ export interface CrmConnectorEntities { + /** + * The logical name. + */ logicalName: string; + /** + * The display name. + */ displayName?: string; + /** + * Indicating whether this is profile. + */ isProfile?: boolean; } /** - * @class - * Initializes a new instance of the CrmConnectorProperties class. - * @constructor * The CRM connector properties. - * - * @member {string} [connectionString] The connection string. - * @member {string} organizationId The organization ID. - * @member {string} organizationUrl The organization URL. - * @member {array} entities The entities like account, contact, opportunity. - * @member {string} [accessToken] The access token. */ export interface CrmConnectorProperties { + /** + * The connection string. + */ connectionString?: string; + /** + * The organization ID. + */ organizationId: string; + /** + * The organization URL. + */ organizationUrl: string; + /** + * The entities like account, contact, opportunity. + */ entities: CrmConnectorEntities[]; + /** + * The access token. + */ accessToken?: string; } /** - * @class - * Initializes a new instance of the ConnectorMappingErrorManagement class. - * @constructor - * The error mangement. - * - * @member {string} errorManagementType The type of error management to use for - * the mapping. Possible values include: 'RejectAndContinue', 'StopImport', - * 'RejectUntilLimit' - * @member {number} [errorLimit] The error limit allowed while importing data. + * The error management. */ export interface ConnectorMappingErrorManagement { + /** + * The type of error management to use for the mapping. Possible values include: + * 'RejectAndContinue', 'StopImport', 'RejectUntilLimit' + */ errorManagementType: string; + /** + * The error limit allowed while importing data. + */ errorLimit?: number; } /** - * @class - * Initializes a new instance of the ConnectorMappingFormat class. - * @constructor * Connector mapping property format. - * - * @member {string} [columnDelimiter] The character that signifies a break - * between columns. - * @member {string} [acceptLanguage] The oData language. - * @member {string} [quoteCharacter] Quote character, used to indicate enquoted - * fields. - * @member {string} [quoteEscapeCharacter] Escape character for quotes, can be - * the same as the quoteCharacter. - * @member {string} [arraySeparator] Character separating array elements. */ export interface ConnectorMappingFormat { + /** + * The character that signifies a break between columns. + */ columnDelimiter?: string; + /** + * The oData language. + */ acceptLanguage?: string; + /** + * Quote character, used to indicate enquoted fields. + */ quoteCharacter?: string; + /** + * Escape character for quotes, can be the same as the quoteCharacter. + */ quoteEscapeCharacter?: string; + /** + * Character separating array elements. + */ arraySeparator?: string; } /** - * @class - * Initializes a new instance of the ConnectorMappingAvailability class. - * @constructor * Connector mapping property availability. - * - * @member {string} [frequency] The frequency to update. Possible values - * include: 'Minute', 'Hour', 'Day', 'Week', 'Month' - * @member {number} interval The interval of the given frequency to use. */ export interface ConnectorMappingAvailability { + /** + * The frequency to update. Possible values include: 'Minute', 'Hour', 'Day', 'Week', 'Month' + */ frequency?: string; + /** + * The interval of the given frequency to use. + */ interval: number; } /** - * @class - * Initializes a new instance of the ConnectorMappingStructure class. - * @constructor * Connector mapping property structure. - * - * @member {string} propertyName The property name of the mapping entity. - * @member {string} columnName The column name of the import file. - * @member {string} [customFormatSpecifier] Custom format specifier for input - * parsing. - * @member {boolean} [isEncrypted] Indicates if the column is encrypted. */ export interface ConnectorMappingStructure { + /** + * The property name of the mapping entity. + */ propertyName: string; + /** + * The column name of the import file. + */ columnName: string; + /** + * Custom format specifier for input parsing. + */ customFormatSpecifier?: string; + /** + * Indicates if the column is encrypted. + */ isEncrypted?: boolean; } /** - * @class - * Initializes a new instance of the ConnectorMappingCompleteOperation class. - * @constructor * The complete operation. - * - * @member {string} [completionOperationType] The type of completion operation. - * Possible values include: 'DoNothing', 'DeleteFile', 'MoveFile' - * @member {string} [destinationFolder] The destination folder where files will - * be moved to once the import is done. */ export interface ConnectorMappingCompleteOperation { + /** + * The type of completion operation. Possible values include: 'DoNothing', 'DeleteFile', + * 'MoveFile' + */ completionOperationType?: string; + /** + * The destination folder where files will be moved to once the import is done. + */ destinationFolder?: string; } /** - * @class - * Initializes a new instance of the ConnectorMappingProperties class. - * @constructor * The connector mapping properties. - * - * @member {string} [folderPath] The folder path for the mapping. - * @member {string} [fileFilter] The file filter for the mapping. - * @member {boolean} [hasHeader] If the file contains a header or not. - * @member {object} errorManagement The error management setting for the - * mapping. - * @member {string} [errorManagement.errorManagementType] The type of error - * management to use for the mapping. Possible values include: - * 'RejectAndContinue', 'StopImport', 'RejectUntilLimit' - * @member {number} [errorManagement.errorLimit] The error limit allowed while - * importing data. - * @member {object} format The format of mapping property. - * @member {string} [format.columnDelimiter] The character that signifies a - * break between columns. - * @member {string} [format.acceptLanguage] The oData language. - * @member {string} [format.quoteCharacter] Quote character, used to indicate - * enquoted fields. - * @member {string} [format.quoteEscapeCharacter] Escape character for quotes, - * can be the same as the quoteCharacter. - * @member {string} [format.arraySeparator] Character separating array - * elements. - * @member {object} availability The availability of mapping property. - * @member {string} [availability.frequency] The frequency to update. Possible - * values include: 'Minute', 'Hour', 'Day', 'Week', 'Month' - * @member {number} [availability.interval] The interval of the given frequency - * to use. - * @member {array} structure Ingestion mapping information at property level. - * @member {object} completeOperation The operation after import is done. - * @member {string} [completeOperation.completionOperationType] The type of - * completion operation. Possible values include: 'DoNothing', 'DeleteFile', - * 'MoveFile' - * @member {string} [completeOperation.destinationFolder] The destination - * folder where files will be moved to once the import is done. */ export interface ConnectorMappingProperties { + /** + * The folder path for the mapping. + */ folderPath?: string; + /** + * The file filter for the mapping. + */ fileFilter?: string; + /** + * If the file contains a header or not. + */ hasHeader?: boolean; + /** + * The error management setting for the mapping. + */ errorManagement: ConnectorMappingErrorManagement; + /** + * The format of mapping property. + */ format: ConnectorMappingFormat; + /** + * The availability of mapping property. + */ availability: ConnectorMappingAvailability; + /** + * Ingestion mapping information at property level. + */ structure: ConnectorMappingStructure[]; + /** + * The operation after import is done. + */ completeOperation: ConnectorMappingCompleteOperation; } /** - * @class - * Initializes a new instance of the KpiThresholds class. - * @constructor * Defines the KPI Threshold limits. - * - * @member {number} lowerLimit The lower threshold limit. - * @member {number} upperLimit The upper threshold limit. - * @member {boolean} increasingKpi Whether or not the KPI is an increasing KPI. */ export interface KpiThresholds { + /** + * The lower threshold limit. + */ lowerLimit: number; + /** + * The upper threshold limit. + */ upperLimit: number; + /** + * Whether or not the KPI is an increasing KPI. + */ increasingKpi: boolean; } /** - * @class - * Initializes a new instance of the KpiGroupByMetadata class. - * @constructor * The KPI GroupBy field metadata. - * - * @member {object} [displayName] The display name. - * @member {string} [fieldName] The name of the field. - * @member {string} [fieldType] The type of the field. */ export interface KpiGroupByMetadata { + /** + * The display name. + */ displayName?: { [propertyName: string]: string }; + /** + * The name of the field. + */ fieldName?: string; + /** + * The type of the field. + */ fieldType?: string; } /** - * @class - * Initializes a new instance of the KpiParticipantProfilesMetadata class. - * @constructor * The KPI participant profile metadata. - * - * @member {string} typeName Name of the type. */ export interface KpiParticipantProfilesMetadata { + /** + * Name of the type. + */ typeName: string; } /** - * @class - * Initializes a new instance of the KpiAlias class. - * @constructor * The KPI alias. - * - * @member {string} aliasName KPI alias name. - * @member {string} expression The expression. */ export interface KpiAlias { + /** + * KPI alias name. + */ aliasName: string; + /** + * The expression. + */ expression: string; } /** - * @class - * Initializes a new instance of the KpiExtract class. - * @constructor * The KPI extract. - * - * @member {string} extractName KPI extract name. - * @member {string} expression The expression. */ export interface KpiExtract { + /** + * KPI extract name. + */ extractName: string; + /** + * The expression. + */ expression: string; } /** - * @class - * Initializes a new instance of the KpiDefinition class. - * @constructor * Defines the KPI Threshold limits. - * - * @member {string} entityType The mapping entity type. Possible values - * include: 'None', 'Profile', 'Interaction', 'Relationship' - * @member {string} entityTypeName The mapping entity name. - * @member {string} [tenantId] The hub name. - * @member {string} [kpiName] The KPI name. - * @member {object} [displayName] Localized display name for the KPI. - * @member {object} [description] Localized description for the KPI. - * @member {string} calculationWindow The calculation window. Possible values - * include: 'Lifetime', 'Hour', 'Day', 'Week', 'Month' - * @member {string} [calculationWindowFieldName] Name of calculation window - * field. - * @member {string} functionProperty The computation function for the KPI. - * Possible values include: 'Sum', 'Avg', 'Min', 'Max', 'Last', 'Count', - * 'None', 'CountDistinct' - * @member {string} expression The computation expression for the KPI. - * @member {string} [unit] The unit of measurement for the KPI. - * @member {string} [filter] The filter expression for the KPI. - * @member {array} [groupBy] the group by properties for the KPI. - * @member {array} [groupByMetadata] The KPI GroupByMetadata. - * @member {array} [participantProfilesMetadata] The participant profiles. - * @member {string} [provisioningState] Provisioning state. Possible values - * include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', - * 'HumanIntervention', 'Failed' - * @member {object} [thresHolds] The KPI thresholds. - * @member {number} [thresHolds.lowerLimit] The lower threshold limit. - * @member {number} [thresHolds.upperLimit] The upper threshold limit. - * @member {boolean} [thresHolds.increasingKpi] Whether or not the KPI is an - * increasing KPI. - * @member {array} [aliases] The aliases. - * @member {array} [extracts] The KPI extracts. */ export interface KpiDefinition { + /** + * The mapping entity type. Possible values include: 'None', 'Profile', 'Interaction', + * 'Relationship' + */ entityType: string; + /** + * The mapping entity name. + */ entityTypeName: string; + /** + * The hub name. + */ readonly tenantId?: string; + /** + * The KPI name. + */ readonly kpiName?: string; + /** + * Localized display name for the KPI. + */ displayName?: { [propertyName: string]: string }; + /** + * Localized description for the KPI. + */ description?: { [propertyName: string]: string }; + /** + * The calculation window. Possible values include: 'Lifetime', 'Hour', 'Day', 'Week', 'Month' + */ calculationWindow: string; + /** + * Name of calculation window field. + */ calculationWindowFieldName?: string; + /** + * The computation function for the KPI. Possible values include: 'Sum', 'Avg', 'Min', 'Max', + * 'Last', 'Count', 'None', 'CountDistinct' + */ functionProperty: string; + /** + * The computation expression for the KPI. + */ expression: string; + /** + * The unit of measurement for the KPI. + */ unit?: string; + /** + * The filter expression for the KPI. + */ filter?: string; + /** + * the group by properties for the KPI. + */ groupBy?: string[]; + /** + * The KPI GroupByMetadata. + */ readonly groupByMetadata?: KpiGroupByMetadata[]; + /** + * The participant profiles. + */ readonly participantProfilesMetadata?: KpiParticipantProfilesMetadata[]; + /** + * Provisioning state. Possible values include: 'Provisioning', 'Succeeded', 'Expiring', + * 'Deleting', 'HumanIntervention', 'Failed' + */ readonly provisioningState?: string; + /** + * The KPI thresholds. + */ thresHolds?: KpiThresholds; + /** + * The aliases. + */ aliases?: KpiAlias[]; + /** + * The KPI extracts. + */ extracts?: KpiExtract[]; } /** - * @class - * Initializes a new instance of the ProxyResource class. - * @constructor * Common properties of proxy resource. - * - * @member {string} [id] Resource ID. - * @member {string} [name] Resource name. - * @member {string} [type] Resource type. */ export interface ProxyResource extends BaseResource { + /** + * Resource ID. + */ readonly id?: string; + /** + * Resource name. + */ readonly name?: string; + /** + * Resource type. + */ readonly type?: string; } /** - * @class - * Initializes a new instance of the TypePropertiesMapping class. - * @constructor * Metadata for a Link's property mapping. - * - * @member {string} sourcePropertyName Property name on the source Entity Type. - * @member {string} targetPropertyName Property name on the target Entity Type. - * @member {string} [linkType] Link type. Possible values include: - * 'UpdateAlways', 'CopyIfNull' */ export interface TypePropertiesMapping { + /** + * Property name on the source Entity Type. + */ sourcePropertyName: string; + /** + * Property name on the target Entity Type. + */ targetPropertyName: string; + /** + * Link type. Possible values include: 'UpdateAlways', 'CopyIfNull' + */ linkType?: string; } /** - * @class - * Initializes a new instance of the ParticipantPropertyReference class. - * @constructor * The participant property reference. - * - * @member {string} sourcePropertyName The source property that maps to the - * target property. - * @member {string} targetPropertyName The target property that maps to the - * source property. */ export interface ParticipantPropertyReference { + /** + * The source property that maps to the target property. + */ sourcePropertyName: string; + /** + * The target property that maps to the source property. + */ targetPropertyName: string; } /** - * @class - * Initializes a new instance of the RelationshipTypeFieldMapping class. - * @constructor * Map a field of profile to its corresponding StrongId in Related Profile. - * - * @member {string} profileFieldName Specifies the fieldName in profile. - * @member {string} relatedProfileKeyProperty Specifies the KeyProperty (from - * StrongId) of the related profile. */ export interface RelationshipTypeFieldMapping { + /** + * Specifies the fieldName in profile. + */ profileFieldName: string; + /** + * Specifies the KeyProperty (from StrongId) of the related profile. + */ relatedProfileKeyProperty: string; } /** - * @class - * Initializes a new instance of the RelationshipTypeMapping class. - * @constructor * Maps fields in Profile to their corresponding StrongIds in Related Profile. - * - * @member {array} fieldMappings Maps a profile property with the StrongId of - * related profile. This is an array to support StrongIds that are composite - * key as well. */ export interface RelationshipTypeMapping { + /** + * Maps a profile property with the StrongId of related profile. This is an array to support + * StrongIds that are composite key as well. + */ fieldMappings: RelationshipTypeFieldMapping[]; } /** - * @class - * Initializes a new instance of the RelationshipLinkFieldMapping class. - * @constructor * The fields mapping for Relationships. - * - * @member {string} interactionFieldName The field name on the Interaction - * Type. - * @member {string} [linkType] Link type. Possible values include: - * 'UpdateAlways', 'CopyIfNull' - * @member {string} relationshipFieldName The field name on the Relationship - * metadata. */ export interface RelationshipLinkFieldMapping { + /** + * The field name on the Interaction Type. + */ interactionFieldName: string; + /** + * Link type. Possible values include: 'UpdateAlways', 'CopyIfNull' + */ linkType?: string; + /** + * The field name on the Relationship metadata. + */ relationshipFieldName: string; } /** - * @class - * Initializes a new instance of the ParticipantProfilePropertyReference class. - * @constructor * The participant profile property reference. - * - * @member {string} interactionPropertyName The source interaction property - * that maps to the target profile property. - * @member {string} profilePropertyName The target profile property that maps - * to the source interaction property. */ export interface ParticipantProfilePropertyReference { + /** + * The source interaction property that maps to the target profile property. + */ interactionPropertyName: string; + /** + * The target profile property that maps to the source interaction property. + */ profilePropertyName: string; } /** - * @class - * Initializes a new instance of the Participant class. - * @constructor * Describes a profile type participating in an interaction. - * - * @member {string} profileTypeName Profile type name. - * @member {array} participantPropertyReferences The property references. - * @member {string} participantName Participant name. - * @member {object} [displayName] Localized display name. - * @member {object} [description] Localized descriptions. - * @member {string} [role] The role that the participant is playing in the - * interaction. */ export interface Participant { + /** + * Profile type name. + */ profileTypeName: string; + /** + * The property references. + */ participantPropertyReferences: ParticipantPropertyReference[]; + /** + * Participant name. + */ participantName: string; + /** + * Localized display name. + */ displayName?: { [propertyName: string]: string }; + /** + * Localized descriptions. + */ description?: { [propertyName: string]: string }; + /** + * The role that the participant is playing in the interaction. + */ role?: string; } /** - * @class - * Initializes a new instance of the StrongId class. - * @constructor * Property/Properties which represent a unique ID. - * - * @member {array} keyPropertyNames The properties which make up the unique ID. - * @member {string} strongIdName The Name identifying the strong ID. - * @member {object} [displayName] Localized display name. - * @member {object} [description] Localized descriptions. */ export interface StrongId { + /** + * The properties which make up the unique ID. + */ keyPropertyNames: string[]; + /** + * The Name identifying the strong ID. + */ strongIdName: string; + /** + * Localized display name. + */ displayName?: { [propertyName: string]: string }; + /** + * Localized descriptions. + */ description?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the ProfileResourceFormat class. - * @constructor * The profile resource format. - * - * @member {object} [attributes] The attributes for the Type. - * @member {object} [description] Localized descriptions for the property. - * @member {object} [displayName] Localized display names for the property. - * @member {object} [localizedAttributes] Any custom localized attributes for - * the Type. - * @member {string} [smallImage] Small Image associated with the Property or - * EntityType. - * @member {string} [mediumImage] Medium Image associated with the Property or - * EntityType. - * @member {string} [largeImage] Large Image associated with the Property or - * EntityType. - * @member {string} [apiEntitySetName] The api entity set name. This becomes - * the odata entity set name for the entity Type being refered in this object. - * @member {string} [entityType] Type of entity. Possible values include: - * 'None', 'Profile', 'Interaction', 'Relationship' - * @member {array} [fields] The properties of the Profile. - * @member {number} [instancesCount] The instance count. - * @member {date} [lastChangedUtc] The last changed time for the type - * definition. - * @member {string} [provisioningState] Provisioning state. Possible values - * include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', - * 'HumanIntervention', 'Failed' - * @member {string} [schemaItemTypeLink] The schema org link. This helps ACI - * identify and suggest semantic models. - * @member {string} [tenantId] The hub name. - * @member {string} [timestampFieldName] The timestamp property name. - * Represents the time when the interaction or profile update happened. - * @member {string} [typeName] The name of the entity. - * @member {array} [strongIds] The strong IDs. */ export interface ProfileResourceFormat extends ProxyResource { + /** + * The attributes for the Type. + */ attributes?: { [propertyName: string]: string[] }; + /** + * Localized descriptions for the property. + */ description?: { [propertyName: string]: string }; + /** + * Localized display names for the property. + */ displayName?: { [propertyName: string]: string }; + /** + * Any custom localized attributes for the Type. + */ localizedAttributes?: { [propertyName: string]: { [propertyName: string]: string } }; + /** + * Small Image associated with the Property or EntityType. + */ smallImage?: string; + /** + * Medium Image associated with the Property or EntityType. + */ mediumImage?: string; + /** + * Large Image associated with the Property or EntityType. + */ largeImage?: string; + /** + * The api entity set name. This becomes the odata entity set name for the entity Type being + * referred in this object. + */ apiEntitySetName?: string; + /** + * Type of entity. Possible values include: 'None', 'Profile', 'Interaction', 'Relationship' + */ entityType?: string; + /** + * The properties of the Profile. + */ fields?: PropertyDefinition[]; + /** + * The instance count. + */ instancesCount?: number; + /** + * The last changed time for the type definition. + */ readonly lastChangedUtc?: Date; + /** + * Provisioning state. Possible values include: 'Provisioning', 'Succeeded', 'Expiring', + * 'Deleting', 'HumanIntervention', 'Failed' + */ readonly provisioningState?: string; + /** + * The schema org link. This helps ACI identify and suggest semantic models. + */ schemaItemTypeLink?: string; + /** + * The hub name. + */ readonly tenantId?: string; + /** + * The timestamp property name. Represents the time when the interaction or profile update + * happened. + */ timestampFieldName?: string; + /** + * The name of the entity. + */ typeName?: string; + /** + * The strong IDs. + */ strongIds?: StrongId[]; } /** - * @class - * Initializes a new instance of the InteractionResourceFormat class. - * @constructor * The interaction resource format. - * - * @member {object} [attributes] The attributes for the Type. - * @member {object} [description] Localized descriptions for the property. - * @member {object} [displayName] Localized display names for the property. - * @member {object} [localizedAttributes] Any custom localized attributes for - * the Type. - * @member {string} [smallImage] Small Image associated with the Property or - * EntityType. - * @member {string} [mediumImage] Medium Image associated with the Property or - * EntityType. - * @member {string} [largeImage] Large Image associated with the Property or - * EntityType. - * @member {string} [apiEntitySetName] The api entity set name. This becomes - * the odata entity set name for the entity Type being refered in this object. - * @member {string} [entityType] Type of entity. Possible values include: - * 'None', 'Profile', 'Interaction', 'Relationship' - * @member {array} [fields] The properties of the Profile. - * @member {number} [instancesCount] The instance count. - * @member {date} [lastChangedUtc] The last changed time for the type - * definition. - * @member {string} [provisioningState] Provisioning state. Possible values - * include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', - * 'HumanIntervention', 'Failed' - * @member {string} [schemaItemTypeLink] The schema org link. This helps ACI - * identify and suggest semantic models. - * @member {string} [tenantId] The hub name. - * @member {string} [timestampFieldName] The timestamp property name. - * Represents the time when the interaction or profile update happened. - * @member {string} [typeName] The name of the entity. - * @member {array} [idPropertyNames] The id property names. Properties which - * uniquely identify an interaction instance. - * @member {array} [participantProfiles] Profiles that participated in the - * interaction. - * @member {string} [primaryParticipantProfilePropertyName] The primary - * participant property name for an interaction ,This is used to logically - * represent the agent of the interaction, Specify the participant name here - * from ParticipantName. - * @member {array} [dataSourcePrecedenceRules] This is specific to interactions - * modeled as activities. Data sources are used to determine where data is - * stored and also in precedence rules. - * @member {string} [interactionResourceFormatName] The data source name - * @member {string} [dataSourceType] The data source type. Possible values - * include: 'Connector', 'LinkInteraction', 'SystemDefault' - * @member {string} [status] The data source status. Possible values include: - * 'None', 'Active', 'Deleted' - * @member {number} [interactionResourceFormatId] The data source ID. - * @member {string} [dataSourceReferenceId] The data source reference id. - * @member {boolean} [isActivity] An interaction can be tagged as an activity - * only during create. This enables the interaction to be editable and can - * enable merging of properties from multiple data sources based on precedence, - * which is defined at a link level. */ export interface InteractionResourceFormat extends ProxyResource { + /** + * The attributes for the Type. + */ attributes?: { [propertyName: string]: string[] }; + /** + * Localized descriptions for the property. + */ description?: { [propertyName: string]: string }; + /** + * Localized display names for the property. + */ displayName?: { [propertyName: string]: string }; + /** + * Any custom localized attributes for the Type. + */ localizedAttributes?: { [propertyName: string]: { [propertyName: string]: string } }; + /** + * Small Image associated with the Property or EntityType. + */ smallImage?: string; + /** + * Medium Image associated with the Property or EntityType. + */ mediumImage?: string; + /** + * Large Image associated with the Property or EntityType. + */ largeImage?: string; + /** + * The api entity set name. This becomes the odata entity set name for the entity Type being + * referred in this object. + */ apiEntitySetName?: string; + /** + * Type of entity. Possible values include: 'None', 'Profile', 'Interaction', 'Relationship' + */ entityType?: string; + /** + * The properties of the Profile. + */ fields?: PropertyDefinition[]; + /** + * The instance count. + */ instancesCount?: number; + /** + * The last changed time for the type definition. + */ readonly lastChangedUtc?: Date; + /** + * Provisioning state. Possible values include: 'Provisioning', 'Succeeded', 'Expiring', + * 'Deleting', 'HumanIntervention', 'Failed' + */ readonly provisioningState?: string; + /** + * The schema org link. This helps ACI identify and suggest semantic models. + */ schemaItemTypeLink?: string; + /** + * The hub name. + */ readonly tenantId?: string; + /** + * The timestamp property name. Represents the time when the interaction or profile update + * happened. + */ timestampFieldName?: string; + /** + * The name of the entity. + */ typeName?: string; + /** + * The id property names. Properties which uniquely identify an interaction instance. + */ idPropertyNames?: string[]; + /** + * Profiles that participated in the interaction. + */ participantProfiles?: Participant[]; + /** + * The primary participant property name for an interaction ,This is used to logically represent + * the agent of the interaction, Specify the participant name here from ParticipantName. + */ primaryParticipantProfilePropertyName?: string; + /** + * This is specific to interactions modeled as activities. Data sources are used to determine + * where data is stored and also in precedence rules. + */ readonly dataSourcePrecedenceRules?: DataSourcePrecedence[]; + /** + * The data source name + */ readonly interactionResourceFormatName?: string; + /** + * The data source type. Possible values include: 'Connector', 'LinkInteraction', 'SystemDefault' + */ readonly dataSourceType?: string; + /** + * The data source status. Possible values include: 'None', 'Active', 'Deleted' + */ readonly status?: string; + /** + * The data source ID. + */ readonly interactionResourceFormatId?: number; + /** + * The data source reference id. + */ readonly dataSourceReferenceId?: string; + /** + * An interaction can be tagged as an activity only during create. This enables the interaction + * to be editable and can enable merging of properties from multiple data sources based on + * precedence, which is defined at a link level. + */ isActivity?: boolean; } /** - * @class - * Initializes a new instance of the KpiResourceFormat class. - * @constructor * The KPI resource format. - * - * @member {string} entityType The mapping entity type. Possible values - * include: 'None', 'Profile', 'Interaction', 'Relationship' - * @member {string} entityTypeName The mapping entity name. - * @member {string} [tenantId] The hub name. - * @member {string} [kpiName] The KPI name. - * @member {object} [displayName] Localized display name for the KPI. - * @member {object} [description] Localized description for the KPI. - * @member {string} calculationWindow The calculation window. Possible values - * include: 'Lifetime', 'Hour', 'Day', 'Week', 'Month' - * @member {string} [calculationWindowFieldName] Name of calculation window - * field. - * @member {string} functionProperty The computation function for the KPI. - * Possible values include: 'Sum', 'Avg', 'Min', 'Max', 'Last', 'Count', - * 'None', 'CountDistinct' - * @member {string} expression The computation expression for the KPI. - * @member {string} [unit] The unit of measurement for the KPI. - * @member {string} [filter] The filter expression for the KPI. - * @member {array} [groupBy] the group by properties for the KPI. - * @member {array} [groupByMetadata] The KPI GroupByMetadata. - * @member {array} [participantProfilesMetadata] The participant profiles. - * @member {string} [provisioningState] Provisioning state. Possible values - * include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', - * 'HumanIntervention', 'Failed' - * @member {object} [thresHolds] The KPI thresholds. - * @member {number} [thresHolds.lowerLimit] The lower threshold limit. - * @member {number} [thresHolds.upperLimit] The upper threshold limit. - * @member {boolean} [thresHolds.increasingKpi] Whether or not the KPI is an - * increasing KPI. - * @member {array} [aliases] The aliases. - * @member {array} [extracts] The KPI extracts. */ export interface KpiResourceFormat extends ProxyResource { + /** + * The mapping entity type. Possible values include: 'None', 'Profile', 'Interaction', + * 'Relationship' + */ entityType: string; + /** + * The mapping entity name. + */ entityTypeName: string; + /** + * The hub name. + */ readonly tenantId?: string; + /** + * The KPI name. + */ readonly kpiName?: string; + /** + * Localized display name for the KPI. + */ displayName?: { [propertyName: string]: string }; + /** + * Localized description for the KPI. + */ description?: { [propertyName: string]: string }; + /** + * The calculation window. Possible values include: 'Lifetime', 'Hour', 'Day', 'Week', 'Month' + */ calculationWindow: string; + /** + * Name of calculation window field. + */ calculationWindowFieldName?: string; + /** + * The computation function for the KPI. Possible values include: 'Sum', 'Avg', 'Min', 'Max', + * 'Last', 'Count', 'None', 'CountDistinct' + */ functionProperty: string; + /** + * The computation expression for the KPI. + */ expression: string; + /** + * The unit of measurement for the KPI. + */ unit?: string; + /** + * The filter expression for the KPI. + */ filter?: string; + /** + * the group by properties for the KPI. + */ groupBy?: string[]; + /** + * The KPI GroupByMetadata. + */ readonly groupByMetadata?: KpiGroupByMetadata[]; + /** + * The participant profiles. + */ readonly participantProfilesMetadata?: KpiParticipantProfilesMetadata[]; + /** + * Provisioning state. Possible values include: 'Provisioning', 'Succeeded', 'Expiring', + * 'Deleting', 'HumanIntervention', 'Failed' + */ readonly provisioningState?: string; + /** + * The KPI thresholds. + */ thresHolds?: KpiThresholds; + /** + * The aliases. + */ aliases?: KpiAlias[]; + /** + * The KPI extracts. + */ extracts?: KpiExtract[]; } /** - * @class - * Initializes a new instance of the EnrichingKpi class. - * @constructor * The enriching KPI definition. - * */ export interface EnrichingKpi extends KpiDefinition { } /** - * @class - * Initializes a new instance of the ConnectorResourceFormat class. - * @constructor * The connector resource format. - * - * @member {number} [connectorId] ID of the connector. - * @member {string} [connectorName] Name of the connector. - * @member {string} connectorType Type of connector. Possible values include: - * 'None', 'CRM', 'AzureBlob', 'Salesforce', 'ExchangeOnline', 'Outbound' - * @member {string} [displayName] Display name of the connector. - * @member {string} [description] Description of the connector. - * @member {object} connectorProperties The connector properties. - * @member {date} [created] The created time. - * @member {date} [lastModified] The last monified time. - * @member {string} [state] State of connector. Possible values include: - * 'Creating', 'Created', 'Ready', 'Expiring', 'Deleting', 'Failed' - * @member {string} [tenantId] The hub name. - * @member {boolean} [isInternal] If this is an internal connector. */ export interface ConnectorResourceFormat extends ProxyResource { + /** + * ID of the connector. + */ readonly connectorId?: number; + /** + * Name of the connector. + */ connectorName?: string; + /** + * Type of connector. Possible values include: 'None', 'CRM', 'AzureBlob', 'Salesforce', + * 'ExchangeOnline', 'Outbound' + */ connectorType: string; + /** + * Display name of the connector. + */ displayName?: string; + /** + * Description of the connector. + */ description?: string; + /** + * The connector properties. + */ connectorProperties: { [propertyName: string]: any }; + /** + * The created time. + */ readonly created?: Date; + /** + * The last modified time. + */ readonly lastModified?: Date; + /** + * State of connector. Possible values include: 'Creating', 'Created', 'Ready', 'Expiring', + * 'Deleting', 'Failed' + */ readonly state?: string; + /** + * The hub name. + */ readonly tenantId?: string; + /** + * If this is an internal connector. + */ isInternal?: boolean; } /** - * @class - * Initializes a new instance of the ConnectorMappingResourceFormat class. - * @constructor - * The c onnector mapping resource format. - * - * @member {string} [connectorName] The connector name. - * @member {string} [connectorType] Type of connector. Possible values include: - * 'None', 'CRM', 'AzureBlob', 'Salesforce', 'ExchangeOnline', 'Outbound' - * @member {date} [created] The created time. - * @member {date} [lastModified] The last monified time. - * @member {string} entityType Defines which entity type the file should map - * to. Possible values include: 'None', 'Profile', 'Interaction', - * 'Relationship' - * @member {string} entityTypeName The mapping entity name. - * @member {string} [connectorMappingName] The connector mapping name - * @member {string} [displayName] Display name for the connector mapping. - * @member {string} [description] The description of the connector mapping. - * @member {string} [dataFormatId] The DataFormat ID. - * @member {object} mappingProperties The properties of the mapping. - * @member {string} [mappingProperties.folderPath] The folder path for the - * mapping. - * @member {string} [mappingProperties.fileFilter] The file filter for the - * mapping. - * @member {boolean} [mappingProperties.hasHeader] If the file contains a - * header or not. - * @member {object} [mappingProperties.errorManagement] The error management - * setting for the mapping. - * @member {string} [mappingProperties.errorManagement.errorManagementType] The - * type of error management to use for the mapping. Possible values include: - * 'RejectAndContinue', 'StopImport', 'RejectUntilLimit' - * @member {number} [mappingProperties.errorManagement.errorLimit] The error - * limit allowed while importing data. - * @member {object} [mappingProperties.format] The format of mapping property. - * @member {string} [mappingProperties.format.columnDelimiter] The character - * that signifies a break between columns. - * @member {string} [mappingProperties.format.acceptLanguage] The oData - * language. - * @member {string} [mappingProperties.format.quoteCharacter] Quote character, - * used to indicate enquoted fields. - * @member {string} [mappingProperties.format.quoteEscapeCharacter] Escape - * character for quotes, can be the same as the quoteCharacter. - * @member {string} [mappingProperties.format.arraySeparator] Character - * separating array elements. - * @member {object} [mappingProperties.availability] The availability of - * mapping property. - * @member {string} [mappingProperties.availability.frequency] The frequency to - * update. Possible values include: 'Minute', 'Hour', 'Day', 'Week', 'Month' - * @member {number} [mappingProperties.availability.interval] The interval of - * the given frequency to use. - * @member {array} [mappingProperties.structure] Ingestion mapping information - * at property level. - * @member {object} [mappingProperties.completeOperation] The operation after - * import is done. - * @member {string} - * [mappingProperties.completeOperation.completionOperationType] The type of - * completion operation. Possible values include: 'DoNothing', 'DeleteFile', - * 'MoveFile' - * @member {string} [mappingProperties.completeOperation.destinationFolder] The - * destination folder where files will be moved to once the import is done. - * @member {date} [nextRunTime] The next run time based on customer's settings. - * @member {string} [runId] The RunId. - * @member {string} [state] State of connector mapping. Possible values - * include: 'Creating', 'Created', 'Failed', 'Ready', 'Running', 'Stopped', - * 'Expiring' - * @member {string} [tenantId] The hub name. + * The connector mapping resource format. */ export interface ConnectorMappingResourceFormat extends ProxyResource { + /** + * The connector name. + */ readonly connectorName?: string; + /** + * Type of connector. Possible values include: 'None', 'CRM', 'AzureBlob', 'Salesforce', + * 'ExchangeOnline', 'Outbound' + */ connectorType?: string; + /** + * The created time. + */ readonly created?: Date; + /** + * The last modified time. + */ readonly lastModified?: Date; + /** + * Defines which entity type the file should map to. Possible values include: 'None', 'Profile', + * 'Interaction', 'Relationship' + */ entityType: string; + /** + * The mapping entity name. + */ entityTypeName: string; + /** + * The connector mapping name + */ readonly connectorMappingName?: string; + /** + * Display name for the connector mapping. + */ displayName?: string; + /** + * The description of the connector mapping. + */ description?: string; + /** + * The DataFormat ID. + */ readonly dataFormatId?: string; + /** + * The properties of the mapping. + */ mappingProperties: ConnectorMappingProperties; + /** + * The next run time based on customer's settings. + */ readonly nextRunTime?: Date; + /** + * The RunId. + */ readonly runId?: string; + /** + * State of connector mapping. Possible values include: 'Creating', 'Created', 'Failed', 'Ready', + * 'Running', 'Stopped', 'Expiring' + */ readonly state?: string; + /** + * The hub name. + */ readonly tenantId?: string; } /** - * @class - * Initializes a new instance of the AuthorizationPolicyResourceFormat class. - * @constructor * The authorization policy resource format. - * - * @member {string} [policyName] Name of the policy. - * @member {array} permissions The permissions associated with the policy. - * @member {string} [primaryKey] Primary key assiciated with the policy. - * @member {string} [secondaryKey] Secondary key assiciated with the policy. */ export interface AuthorizationPolicyResourceFormat extends ProxyResource { + /** + * Name of the policy. + */ readonly policyName?: string; + /** + * The permissions associated with the policy. + */ permissions: string[]; + /** + * Primary key associated with the policy. + */ primaryKey?: string; + /** + * Secondary key associated with the policy. + */ secondaryKey?: string; } /** - * @class - * Initializes a new instance of the LinkResourceFormat class. - * @constructor * The link resource format. - * - * @member {string} [tenantId] The hub name. - * @member {string} [linkName] The link name. - * @member {string} sourceEntityType Type of source entity. Possible values - * include: 'None', 'Profile', 'Interaction', 'Relationship' - * @member {string} targetEntityType Type of target entity. Possible values - * include: 'None', 'Profile', 'Interaction', 'Relationship' - * @member {string} sourceEntityTypeName Name of the source Entity Type. - * @member {string} targetEntityTypeName Name of the target Entity Type. - * @member {object} [displayName] Localized display name for the Link. - * @member {object} [description] Localized descriptions for the Link. - * @member {array} [mappings] The set of properties mappings between the source - * and target Types. - * @member {array} participantPropertyReferences The properties that represent - * the participating profile. - * @member {string} [provisioningState] Provisioning state. Possible values - * include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', - * 'HumanIntervention', 'Failed' - * @member {boolean} [referenceOnly] Indicating whether the link is reference - * only link. This flag is ingored if the Mappings are defined. If the mappings - * are not defined and it is set to true, links processing will not create or - * update profiles. - * @member {string} [operationType] Determines whether this link is supposed to - * create or delete instances if Link is NOT Reference Only. Possible values - * include: 'Upsert', 'Delete' */ export interface LinkResourceFormat extends ProxyResource { + /** + * The hub name. + */ readonly tenantId?: string; + /** + * The link name. + */ readonly linkName?: string; + /** + * Type of source entity. Possible values include: 'None', 'Profile', 'Interaction', + * 'Relationship' + */ sourceEntityType: string; + /** + * Type of target entity. Possible values include: 'None', 'Profile', 'Interaction', + * 'Relationship' + */ targetEntityType: string; + /** + * Name of the source Entity Type. + */ sourceEntityTypeName: string; + /** + * Name of the target Entity Type. + */ targetEntityTypeName: string; + /** + * Localized display name for the Link. + */ displayName?: { [propertyName: string]: string }; + /** + * Localized descriptions for the Link. + */ description?: { [propertyName: string]: string }; + /** + * The set of properties mappings between the source and target Types. + */ mappings?: TypePropertiesMapping[]; + /** + * The properties that represent the participating profile. + */ participantPropertyReferences: ParticipantPropertyReference[]; + /** + * Provisioning state. Possible values include: 'Provisioning', 'Succeeded', 'Expiring', + * 'Deleting', 'HumanIntervention', 'Failed' + */ readonly provisioningState?: string; + /** + * Indicating whether the link is reference only link. This flag is ignored if the Mappings are + * defined. If the mappings are not defined and it is set to true, links processing will not + * create or update profiles. + */ referenceOnly?: boolean; + /** + * Determines whether this link is supposed to create or delete instances if Link is NOT + * Reference Only. Possible values include: 'Upsert', 'Delete' + */ operationType?: string; } /** - * @class - * Initializes a new instance of the RelationshipResourceFormat class. - * @constructor * The relationship resource format. - * - * @member {string} [cardinality] The Relationship Cardinality. Possible values - * include: 'OneToOne', 'OneToMany', 'ManyToMany' - * @member {object} [displayName] Localized display name for the Relationship. - * @member {object} [description] Localized descriptions for the Relationship. - * @member {date} [expiryDateTimeUtc] The expiry date time in UTC. - * @member {array} [fields] The properties of the Relationship. - * @member {array} [lookupMappings] Optional property to be used to map fields - * in profile to their strong ids in related profile. - * @member {string} profileType Profile type. - * @member {string} [provisioningState] Provisioning state. Possible values - * include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', - * 'HumanIntervention', 'Failed' - * @member {string} [relationshipName] The Relationship name. - * @member {string} relatedProfileType Related profile being referenced. - * @member {string} [relationshipGuidId] The relationship guid id. - * @member {string} [tenantId] The hub name. */ export interface RelationshipResourceFormat extends ProxyResource { + /** + * The Relationship Cardinality. Possible values include: 'OneToOne', 'OneToMany', 'ManyToMany' + */ cardinality?: string; + /** + * Localized display name for the Relationship. + */ displayName?: { [propertyName: string]: string }; + /** + * Localized descriptions for the Relationship. + */ description?: { [propertyName: string]: string }; + /** + * The expiry date time in UTC. + */ expiryDateTimeUtc?: Date; + /** + * The properties of the Relationship. + */ fields?: PropertyDefinition[]; + /** + * Optional property to be used to map fields in profile to their strong ids in related profile. + */ lookupMappings?: RelationshipTypeMapping[]; + /** + * Profile type. + */ profileType: string; + /** + * Provisioning state. Possible values include: 'Provisioning', 'Succeeded', 'Expiring', + * 'Deleting', 'HumanIntervention', 'Failed' + */ readonly provisioningState?: string; + /** + * The Relationship name. + */ readonly relationshipName?: string; + /** + * Related profile being referenced. + */ relatedProfileType: string; + /** + * The relationship guid id. + */ readonly relationshipGuidId?: string; + /** + * The hub name. + */ readonly tenantId?: string; } /** - * @class - * Initializes a new instance of the RelationshipLinkResourceFormat class. - * @constructor * The relationship link resource format. - * - * @member {object} [displayName] Localized display name for the Relationship - * Link. - * @member {object} [description] Localized descriptions for the Relationship - * Link. - * @member {string} interactionType The InteractionType associated with the - * Relationship Link. - * @member {string} [linkName] The name of the Relationship Link. - * @member {array} [mappings] The mappings between Interaction and Relationship - * fields. - * @member {array} profilePropertyReferences The property references for the - * Profile of the Relationship. - * @member {string} [provisioningState] Provisioning state. Possible values - * include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', - * 'HumanIntervention', 'Failed' - * @member {array} relatedProfilePropertyReferences The property references for - * the Related Profile of the Relationship. - * @member {string} relationshipName The Relationship associated with the Link. - * @member {string} [relationshipGuidId] The relationship guid id. - * @member {string} [tenantId] The hub name. */ export interface RelationshipLinkResourceFormat extends ProxyResource { + /** + * Localized display name for the Relationship Link. + */ displayName?: { [propertyName: string]: string }; + /** + * Localized descriptions for the Relationship Link. + */ description?: { [propertyName: string]: string }; + /** + * The InteractionType associated with the Relationship Link. + */ interactionType: string; + /** + * The name of the Relationship Link. + */ readonly linkName?: string; + /** + * The mappings between Interaction and Relationship fields. + */ mappings?: RelationshipLinkFieldMapping[]; + /** + * The property references for the Profile of the Relationship. + */ profilePropertyReferences: ParticipantProfilePropertyReference[]; + /** + * Provisioning state. Possible values include: 'Provisioning', 'Succeeded', 'Expiring', + * 'Deleting', 'HumanIntervention', 'Failed' + */ readonly provisioningState?: string; + /** + * The property references for the Related Profile of the Relationship. + */ relatedProfilePropertyReferences: ParticipantProfilePropertyReference[]; + /** + * The Relationship associated with the Link. + */ relationshipName: string; + /** + * The relationship guid id. + */ readonly relationshipGuidId?: string; + /** + * The hub name. + */ readonly tenantId?: string; } /** - * @class - * Initializes a new instance of the ViewResourceFormat class. - * @constructor * The view resource format. - * - * @member {string} [viewName] Name of the view. - * @member {string} [userId] the user ID. - * @member {string} [tenantId] the hub name. - * @member {object} [displayName] Localized display name for the view. - * @member {string} definition View definition. - * @member {date} [changed] Date time when view was last modified. - * @member {date} [created] Date time when view was created. */ export interface ViewResourceFormat extends ProxyResource { + /** + * Name of the view. + */ readonly viewName?: string; + /** + * the user ID. + */ userId?: string; + /** + * the hub name. + */ readonly tenantId?: string; + /** + * Localized display name for the view. + */ displayName?: { [propertyName: string]: string }; + /** + * View definition. + */ definition: string; + /** + * Date time when view was last modified. + */ readonly changed?: Date; + /** + * Date time when view was created. + */ readonly created?: Date; } /** - * @class - * Initializes a new instance of the WidgetTypeResourceFormat class. - * @constructor * The WidgetTypeResourceFormat - * - * @member {string} [widgetTypeName] Name of the widget type. - * @member {string} definition Definition for widget type. - * @member {string} [description] Description for widget type. - * @member {object} [displayName] Localized display name for the widget type. - * @member {string} [imageUrl] The image URL. - * @member {string} [tenantId] The hub name. - * @member {string} [widgetVersion] The widget version. - * @member {date} [changed] Date time when widget type was last modified. - * @member {date} [created] Date time when widget type was created. */ export interface WidgetTypeResourceFormat extends ProxyResource { + /** + * Name of the widget type. + */ readonly widgetTypeName?: string; + /** + * Definition for widget type. + */ definition: string; + /** + * Description for widget type. + */ description?: string; + /** + * Localized display name for the widget type. + */ displayName?: { [propertyName: string]: string }; + /** + * The image URL. + */ imageUrl?: string; + /** + * The hub name. + */ readonly tenantId?: string; + /** + * The widget version. + */ widgetVersion?: string; + /** + * Date time when widget type was last modified. + */ readonly changed?: Date; + /** + * Date time when widget type was created. + */ readonly created?: Date; } /** - * @class - * Initializes a new instance of the AssignmentPrincipal class. - * @constructor * The AssignmentPrincipal - * - * @member {string} principalId The principal id being assigned to. - * @member {string} principalType The Type of the principal ID. - * @member {object} [principalMetadata] Other metadata for the principal. */ export interface AssignmentPrincipal { + /** + * The principal id being assigned to. + */ principalId: string; + /** + * The Type of the principal ID. + */ principalType: string; + /** + * Other metadata for the principal. + */ principalMetadata?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the ResourceSetDescription class. - * @constructor * The resource set description. - * - * @member {array} [elements] The elements included in the set. - * @member {array} [exceptions] The elements that are not included in the set, - * in case elements contains '*' indicating 'all'. */ export interface ResourceSetDescription { + /** + * The elements included in the set. + */ elements?: string[]; + /** + * The elements that are not included in the set, in case elements contains '*' indicating 'all'. + */ exceptions?: string[]; } /** - * @class - * Initializes a new instance of the RoleAssignmentResourceFormat class. - * @constructor * The Role Assignment resource format. - * - * @member {string} [tenantId] The hub name. - * @member {string} [assignmentName] The name of the metadata object. - * @member {object} [displayName] Localized display names for the metadata. - * @member {object} [description] Localized description for the metadata. - * @member {string} [provisioningState] Provisioning state. Possible values - * include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', - * 'HumanIntervention', 'Failed' - * @member {string} role Type of roles. Possible values include: 'Admin', - * 'Reader', 'ManageAdmin', 'ManageReader', 'DataAdmin', 'DataReader' - * @member {array} principals The principals being assigned to. - * @member {object} [profiles] Profiles set for the assignment. - * @member {array} [profiles.elements] The elements included in the set. - * @member {array} [profiles.exceptions] The elements that are not included in - * the set, in case elements contains '*' indicating 'all'. - * @member {object} [interactions] Interactions set for the assignment. - * @member {array} [interactions.elements] The elements included in the set. - * @member {array} [interactions.exceptions] The elements that are not included - * in the set, in case elements contains '*' indicating 'all'. - * @member {object} [links] Links set for the assignment. - * @member {array} [links.elements] The elements included in the set. - * @member {array} [links.exceptions] The elements that are not included in the - * set, in case elements contains '*' indicating 'all'. - * @member {object} [kpis] Kpis set for the assignment. - * @member {array} [kpis.elements] The elements included in the set. - * @member {array} [kpis.exceptions] The elements that are not included in the - * set, in case elements contains '*' indicating 'all'. - * @member {object} [sasPolicies] Sas Policies set for the assignment. - * @member {array} [sasPolicies.elements] The elements included in the set. - * @member {array} [sasPolicies.exceptions] The elements that are not included - * in the set, in case elements contains '*' indicating 'all'. - * @member {object} [connectors] Connectors set for the assignment. - * @member {array} [connectors.elements] The elements included in the set. - * @member {array} [connectors.exceptions] The elements that are not included - * in the set, in case elements contains '*' indicating 'all'. - * @member {object} [views] Views set for the assignment. - * @member {array} [views.elements] The elements included in the set. - * @member {array} [views.exceptions] The elements that are not included in the - * set, in case elements contains '*' indicating 'all'. - * @member {object} [relationshipLinks] The Role assignments set for the - * relationship links. - * @member {array} [relationshipLinks.elements] The elements included in the - * set. - * @member {array} [relationshipLinks.exceptions] The elements that are not - * included in the set, in case elements contains '*' indicating 'all'. - * @member {object} [relationships] The Role assignments set for the - * relationships. - * @member {array} [relationships.elements] The elements included in the set. - * @member {array} [relationships.exceptions] The elements that are not - * included in the set, in case elements contains '*' indicating 'all'. - * @member {object} [widgetTypes] Widget types set for the assignment. - * @member {array} [widgetTypes.elements] The elements included in the set. - * @member {array} [widgetTypes.exceptions] The elements that are not included - * in the set, in case elements contains '*' indicating 'all'. - * @member {object} [roleAssignments] The Role assignments set for the - * assignment. - * @member {array} [roleAssignments.elements] The elements included in the set. - * @member {array} [roleAssignments.exceptions] The elements that are not - * included in the set, in case elements contains '*' indicating 'all'. - * @member {object} [conflationPolicies] Widget types set for the assignment. - * @member {array} [conflationPolicies.elements] The elements included in the - * set. - * @member {array} [conflationPolicies.exceptions] The elements that are not - * included in the set, in case elements contains '*' indicating 'all'. - * @member {object} [segments] The Role assignments set for the assignment. - * @member {array} [segments.elements] The elements included in the set. - * @member {array} [segments.exceptions] The elements that are not included in - * the set, in case elements contains '*' indicating 'all'. */ export interface RoleAssignmentResourceFormat extends ProxyResource { + /** + * The hub name. + */ readonly tenantId?: string; + /** + * The name of the metadata object. + */ readonly assignmentName?: string; + /** + * Localized display names for the metadata. + */ displayName?: { [propertyName: string]: string }; + /** + * Localized description for the metadata. + */ description?: { [propertyName: string]: string }; + /** + * Provisioning state. Possible values include: 'Provisioning', 'Succeeded', 'Expiring', + * 'Deleting', 'HumanIntervention', 'Failed' + */ readonly provisioningState?: string; + /** + * Type of roles. Possible values include: 'Admin', 'Reader', 'ManageAdmin', 'ManageReader', + * 'DataAdmin', 'DataReader' + */ role: string; + /** + * The principals being assigned to. + */ principals: AssignmentPrincipal[]; + /** + * Profiles set for the assignment. + */ profiles?: ResourceSetDescription; + /** + * Interactions set for the assignment. + */ interactions?: ResourceSetDescription; + /** + * Links set for the assignment. + */ links?: ResourceSetDescription; + /** + * Kpis set for the assignment. + */ kpis?: ResourceSetDescription; + /** + * Sas Policies set for the assignment. + */ sasPolicies?: ResourceSetDescription; + /** + * Connectors set for the assignment. + */ connectors?: ResourceSetDescription; + /** + * Views set for the assignment. + */ views?: ResourceSetDescription; + /** + * The Role assignments set for the relationship links. + */ relationshipLinks?: ResourceSetDescription; + /** + * The Role assignments set for the relationships. + */ relationships?: ResourceSetDescription; + /** + * Widget types set for the assignment. + */ widgetTypes?: ResourceSetDescription; + /** + * The Role assignments set for the assignment. + */ roleAssignments?: ResourceSetDescription; + /** + * Widget types set for the assignment. + */ conflationPolicies?: ResourceSetDescription; + /** + * The Role assignments set for the assignment. + */ segments?: ResourceSetDescription; } /** - * @class - * Initializes a new instance of the RoleResourceFormat class. - * @constructor * The role resource format. - * - * @member {string} [roleName] The role name. - * @member {string} [description] The description of the role. */ export interface RoleResourceFormat extends ProxyResource { + /** + * The role name. + */ roleName?: string; + /** + * The description of the role. + */ description?: string; } /** - * @class - * Initializes a new instance of the GetImageUploadUrlInput class. - * @constructor * Input type for getting image upload url. - * - * @member {string} [entityType] Type of entity. Can be Profile or Interaction. - * @member {string} [entityTypeName] Name of the entity type. - * @member {string} [relativePath] Relative path of the image. */ export interface GetImageUploadUrlInput { + /** + * Type of entity. Can be Profile or Interaction. + */ entityType?: string; + /** + * Name of the entity type. + */ entityTypeName?: string; + /** + * Relative path of the image. + */ relativePath?: string; } /** - * @class - * Initializes a new instance of the ImageDefinition class. - * @constructor * The image definition. - * - * @member {boolean} [imageExists] Whether image exists already. - * @member {string} [contentUrl] Content URL for the image blob. - * @member {string} [relativePath] Relative path of the image. */ export interface ImageDefinition { + /** + * Whether image exists already. + */ imageExists?: boolean; + /** + * Content URL for the image blob. + */ contentUrl?: string; + /** + * Relative path of the image. + */ relativePath?: string; } /** - * @class - * Initializes a new instance of the RelationshipsLookup class. - * @constructor * The definition of suggested relationship for the type. - * - * @member {string} [profileName] The relationship profile. - * @member {array} [profilePropertyReferences] The property references for the - * profile type. - * @member {string} [relatedProfileName] The related profile. - * @member {array} [relatedProfilePropertyReferences] The property references - * for the related profile type. - * @member {string} [existingRelationshipName] The name of existing - * Relationship. */ export interface RelationshipsLookup { + /** + * The relationship profile. + */ readonly profileName?: string; + /** + * The property references for the profile type. + */ readonly profilePropertyReferences?: ParticipantProfilePropertyReference[]; + /** + * The related profile. + */ readonly relatedProfileName?: string; + /** + * The property references for the related profile type. + */ readonly relatedProfilePropertyReferences?: ParticipantProfilePropertyReference[]; + /** + * The name of existing Relationship. + */ readonly existingRelationshipName?: string; } /** - * @class - * Initializes a new instance of the SuggestRelationshipLinksResponse class. - * @constructor * The response of suggest relationship links operation. - * - * @member {string} [interactionName] The interaction name. - * @member {array} [suggestedRelationships] Suggested relationships for the - * type. */ export interface SuggestRelationshipLinksResponse { + /** + * The interaction name. + */ readonly interactionName?: string; + /** + * Suggested relationships for the type. + */ readonly suggestedRelationships?: RelationshipsLookup[]; } /** - * @class - * Initializes a new instance of the PredictionMappings class. - * @constructor * Definition of the link mapping of prediction. - * - * @member {string} score The score of the link mapping. - * @member {string} grade The grade of the link mapping. - * @member {string} reason The reason of the link mapping. */ export interface PredictionMappings { + /** + * The score of the link mapping. + */ score: string; + /** + * The grade of the link mapping. + */ grade: string; + /** + * The reason of the link mapping. + */ reason: string; } /** - * @class - * Initializes a new instance of the PredictionGradesItem class. - * @constructor * The definition of a prediction grade. - * - * @member {string} [gradeName] Name of the grade. - * @member {number} [minScoreThreshold] Minimum score threshold. - * @member {number} [maxScoreThreshold] Maximum score threshold. */ export interface PredictionGradesItem { + /** + * Name of the grade. + */ gradeName?: string; + /** + * Minimum score threshold. + */ minScoreThreshold?: number; + /** + * Maximum score threshold. + */ maxScoreThreshold?: number; } /** - * @class - * Initializes a new instance of the PredictionSystemGeneratedEntities class. - * @constructor * System generated entities. - * - * @member {array} [generatedInteractionTypes] Generated interaction types. - * @member {array} [generatedLinks] Generated links. - * @member {object} [generatedKpis] Generated KPIs. */ export interface PredictionSystemGeneratedEntities { + /** + * Generated interaction types. + */ generatedInteractionTypes?: string[]; + /** + * Generated links. + */ generatedLinks?: string[]; + /** + * Generated KPIs. + */ generatedKpis?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the PredictionDistributionDefinitionDistributionsItem class. - * @constructor * The definition of a prediction distribution. - * - * @member {number} [scoreThreshold] Score threshold. - * @member {number} [positives] Number of positives. - * @member {number} [negatives] Number of negatives. - * @member {number} [positivesAboveThreshold] Number of positives above - * threshold. - * @member {number} [negativesAboveThreshold] Number of negatives above - * threshold. */ export interface PredictionDistributionDefinitionDistributionsItem { + /** + * Score threshold. + */ scoreThreshold?: number; + /** + * Number of positives. + */ positives?: number; + /** + * Number of negatives. + */ negatives?: number; + /** + * Number of positives above threshold. + */ positivesAboveThreshold?: number; + /** + * Number of negatives above threshold. + */ negativesAboveThreshold?: number; } /** - * @class - * Initializes a new instance of the PredictionDistributionDefinition class. - * @constructor * The definition of the prediction distribution. - * - * @member {number} [totalPositives] Total positive in the distribution. - * @member {number} [totalNegatives] Total negatives in the distribution. - * @member {array} [distributions] Distributions of the prediction. */ export interface PredictionDistributionDefinition { + /** + * Total positive in the distribution. + */ totalPositives?: number; + /** + * Total negatives in the distribution. + */ totalNegatives?: number; + /** + * Distributions of the prediction. + */ distributions?: PredictionDistributionDefinitionDistributionsItem[]; } /** - * @class - * Initializes a new instance of the CanonicalProfileDefinitionPropertiesItem class. - * @constructor * The definition of a canonical profile property. - * - * @member {string} [profileName] Profile name. - * @member {string} [profilePropertyName] Property name of profile. - * @member {number} [rank] The rank. - * @member {string} [type] Type of canonical property value. Possible values - * include: 'Numeric', 'Categorical', 'DerivedCategorical', 'DerivedNumeric' - * @member {string} [value] Value of the canonical property. */ export interface CanonicalProfileDefinitionPropertiesItem { + /** + * Profile name. + */ profileName?: string; + /** + * Property name of profile. + */ profilePropertyName?: string; + /** + * The rank. + */ rank?: number; + /** + * Type of canonical property value. Possible values include: 'Numeric', 'Categorical', + * 'DerivedCategorical', 'DerivedNumeric' + */ type?: string; + /** + * Value of the canonical property. + */ value?: string; } /** - * @class - * Initializes a new instance of the CanonicalProfileDefinition class. - * @constructor * Definition of canonical profile. - * - * @member {number} [canonicalProfileId] Canonical profile ID. - * @member {array} [properties] Properties of the canonical profile. */ export interface CanonicalProfileDefinition { + /** + * Canonical profile ID. + */ canonicalProfileId?: number; + /** + * Properties of the canonical profile. + */ properties?: CanonicalProfileDefinitionPropertiesItem[]; } /** - * @class - * Initializes a new instance of the PredictionTrainingResults class. - * @constructor * The training results of the prediction. - * - * @member {string} [tenantId] The hub name. - * @member {string} [scoreName] Score name. - * @member {object} [predictionDistribution] Prediction distribution. - * @member {number} [predictionDistribution.totalPositives] Total positive in - * the distribution. - * @member {number} [predictionDistribution.totalNegatives] Total negatives in - * the distribution. - * @member {array} [predictionDistribution.distributions] Distributions of the - * prediction. - * @member {array} [canonicalProfiles] Canonical profiles. - * @member {number} [primaryProfileInstanceCount] Instance count of the primary - * profile. */ export interface PredictionTrainingResults { + /** + * The hub name. + */ readonly tenantId?: string; + /** + * Score name. + */ readonly scoreName?: string; + /** + * Prediction distribution. + */ readonly predictionDistribution?: PredictionDistributionDefinition; + /** + * Canonical profiles. + */ readonly canonicalProfiles?: CanonicalProfileDefinition[]; + /** + * Instance count of the primary profile. + */ readonly primaryProfileInstanceCount?: number; } /** - * @class - * Initializes a new instance of the PredictionModelStatus class. - * @constructor * The prediction model status. - * - * @member {string} [tenantId] The hub name. - * @member {string} [predictionName] The prediction name. - * @member {string} [predictionGuidId] The prediction GUID ID. - * @member {string} status Prediction model life cycle. When prediction is in - * PendingModelConfirmation status, it is allowed to update the status to - * PendingFeaturing or Active through API. Possible values include: 'New', - * 'Provisioning', 'ProvisioningFailed', 'PendingDiscovering', 'Discovering', - * 'PendingFeaturing', 'Featuring', 'FeaturingFailed', 'PendingTraining', - * 'Training', 'TrainingFailed', 'Evaluating', 'EvaluatingFailed', - * 'PendingModelConfirmation', 'Active', 'Deleted', 'HumanIntervention', - * 'Failed' - * @member {string} [message] The model status message. - * @member {number} [trainingSetCount] Count of the training set. - * @member {number} [testSetCount] Count of the test set. - * @member {number} [validationSetCount] Count of the validation set. - * @member {number} [trainingAccuracy] The training accuracy. - * @member {number} [signalsUsed] The singnas used. - * @member {string} [modelVersion] Version of the model. */ export interface PredictionModelStatus { + /** + * The hub name. + */ readonly tenantId?: string; + /** + * The prediction name. + */ readonly predictionName?: string; + /** + * The prediction GUID ID. + */ readonly predictionGuidId?: string; + /** + * Prediction model life cycle. When prediction is in PendingModelConfirmation status, it is + * allowed to update the status to PendingFeaturing or Active through API. Possible values + * include: 'New', 'Provisioning', 'ProvisioningFailed', 'PendingDiscovering', 'Discovering', + * 'PendingFeaturing', 'Featuring', 'FeaturingFailed', 'PendingTraining', 'Training', + * 'TrainingFailed', 'Evaluating', 'EvaluatingFailed', 'PendingModelConfirmation', 'Active', + * 'Deleted', 'HumanIntervention', 'Failed' + */ status: string; + /** + * The model status message. + */ readonly message?: string; + /** + * Count of the training set. + */ readonly trainingSetCount?: number; + /** + * Count of the test set. + */ readonly testSetCount?: number; + /** + * Count of the validation set. + */ readonly validationSetCount?: number; + /** + * The training accuracy. + */ readonly trainingAccuracy?: number; + /** + * The signals used. + */ readonly signalsUsed?: number; + /** + * Version of the model. + */ readonly modelVersion?: string; } /** - * @class - * Initializes a new instance of the PredictionResourceFormat class. - * @constructor * The prediction resource format. - * - * @member {object} [description] Description of the prediction. - * @member {object} [displayName] Display name of the prediction. - * @member {array} [involvedInteractionTypes] Interaction types involved in the - * prediction. - * @member {array} [involvedKpiTypes] KPI types involved in the prediction. - * @member {array} [involvedRelationships] Relationships involved in the - * prediction. - * @member {string} negativeOutcomeExpression Negative outcome expression. - * @member {string} positiveOutcomeExpression Positive outcome expression. - * @member {string} primaryProfileType Primary profile type. - * @member {string} [provisioningState] Provisioning state. Possible values - * include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', - * 'HumanIntervention', 'Failed' - * @member {string} [predictionName] Name of the prediction. - * @member {string} scopeExpression Scope expression. - * @member {string} [tenantId] The hub name. - * @member {boolean} autoAnalyze Whether do auto analyze. - * @member {object} mappings Definition of the link mapping of prediction. - * @member {string} [mappings.score] The score of the link mapping. - * @member {string} [mappings.grade] The grade of the link mapping. - * @member {string} [mappings.reason] The reason of the link mapping. - * @member {string} scoreLabel Score label. - * @member {array} [grades] The prediction grades. - * @member {object} [systemGeneratedEntities] System generated entities. - * @member {array} [systemGeneratedEntities.generatedInteractionTypes] - * Generated interaction types. - * @member {array} [systemGeneratedEntities.generatedLinks] Generated links. - * @member {object} [systemGeneratedEntities.generatedKpis] Generated KPIs. */ export interface PredictionResourceFormat extends ProxyResource { + /** + * Description of the prediction. + */ description?: { [propertyName: string]: string }; + /** + * Display name of the prediction. + */ displayName?: { [propertyName: string]: string }; + /** + * Interaction types involved in the prediction. + */ involvedInteractionTypes?: string[]; + /** + * KPI types involved in the prediction. + */ involvedKpiTypes?: string[]; + /** + * Relationships involved in the prediction. + */ involvedRelationships?: string[]; + /** + * Negative outcome expression. + */ negativeOutcomeExpression: string; + /** + * Positive outcome expression. + */ positiveOutcomeExpression: string; + /** + * Primary profile type. + */ primaryProfileType: string; + /** + * Provisioning state. Possible values include: 'Provisioning', 'Succeeded', 'Expiring', + * 'Deleting', 'HumanIntervention', 'Failed' + */ readonly provisioningState?: string; + /** + * Name of the prediction. + */ predictionName?: string; + /** + * Scope expression. + */ scopeExpression: string; + /** + * The hub name. + */ readonly tenantId?: string; + /** + * Whether do auto analyze. + */ autoAnalyze: boolean; + /** + * Definition of the link mapping of prediction. + */ mappings: PredictionMappings; + /** + * Score label. + */ scoreLabel: string; + /** + * The prediction grades. + */ grades?: PredictionGradesItem[]; + /** + * System generated entities. + */ readonly systemGeneratedEntities?: PredictionSystemGeneratedEntities; } /** - * @class - * Initializes a new instance of the OperationDisplay class. - * @constructor * The object that represents the operation. - * - * @member {string} [provider] Service provider: Microsoft.CustomerInsights - * @member {string} [resource] Resource on which the operation is performed: - * Invoice, etc. - * @member {string} [operation] Operation type: Read, write, delete, etc. */ export interface OperationDisplay { + /** + * Service provider: Microsoft.CustomerInsights + */ readonly provider?: string; + /** + * Resource on which the operation is performed: Invoice, etc. + */ readonly resource?: string; + /** + * Operation type: Read, write, delete, etc. + */ readonly operation?: string; } /** - * @class - * Initializes a new instance of the Operation class. - * @constructor * A Customer Insights REST API operation - * - * @member {string} [name] Operation name: {provider}/{resource}/{operation} - * @member {object} [display] The object that represents the operation. - * @member {string} [display.provider] Service provider: - * Microsoft.CustomerInsights - * @member {string} [display.resource] Resource on which the operation is - * performed: Invoice, etc. - * @member {string} [display.operation] Operation type: Read, write, delete, - * etc. */ export interface Operation { + /** + * Operation name: {provider}/{resource}/{operation} + */ readonly name?: string; + /** + * The object that represents the operation. + */ display?: OperationDisplay; } - /** - * @class - * Initializes a new instance of the OperationListResult class. - * @constructor - * Result of the request to list Customer Insights operations. It contains a - * list of operations and a URL link to get the next set of results. - * - * @member {string} [nextLink] URL to get the next set of operation list - * results if there are any. + * Result of the request to list Customer Insights operations. It contains a list of operations and + * a URL link to get the next set of results. */ export interface OperationListResult extends Array { + /** + * URL to get the next set of operation list results if there are any. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the HubListResult class. - * @constructor * Response of list hub operation. - * - * @member {string} [nextLink] Link for next set of results. */ export interface HubListResult extends Array { + /** + * Link for next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the ProfileListResult class. - * @constructor * The response of list profile operation. - * - * @member {string} [nextLink] Link to the next set of results. */ export interface ProfileListResult extends Array { + /** + * Link to the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the InteractionListResult class. - * @constructor * The response of list interaction operation. - * - * @member {string} [nextLink] Link to the next set of results. */ export interface InteractionListResult extends Array { + /** + * Link to the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the RelationshipListResult class. - * @constructor * The response of list relationship operation. - * - * @member {string} [nextLink] Link to the next set of results. */ export interface RelationshipListResult extends Array { + /** + * Link to the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the RelationshipLinkListResult class. - * @constructor * The response of list relationship link operation. - * - * @member {string} [nextLink] Link to the next set of results. */ export interface RelationshipLinkListResult extends Array { + /** + * Link to the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the AuthorizationPolicyListResult class. - * @constructor * The response of list authorization policy operation. - * - * @member {string} [nextLink] Link to the next set of results. */ export interface AuthorizationPolicyListResult extends Array { + /** + * Link to the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the ConnectorListResult class. - * @constructor * The response of list connector operation. - * - * @member {string} [nextLink] Link to the next set of results. */ export interface ConnectorListResult extends Array { + /** + * Link to the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the ConnectorMappingListResult class. - * @constructor * The response of list connector mapping operation. - * - * @member {string} [nextLink] Link to the next set of results. */ export interface ConnectorMappingListResult extends Array { + /** + * Link to the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the KpiListResult class. - * @constructor * The response of list KPI operation. - * - * @member {string} [nextLink] Link to the next set of results. */ export interface KpiListResult extends Array { + /** + * Link to the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the WidgetTypeListResult class. - * @constructor * The response of list widget type operation. - * - * @member {string} [nextLink] Link to the next set of results. */ export interface WidgetTypeListResult extends Array { + /** + * Link to the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the ViewListResult class. - * @constructor * The response of list view operation. - * - * @member {string} [nextLink] Link to the next set of results. */ export interface ViewListResult extends Array { + /** + * Link to the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the LinkListResult class. - * @constructor * The response of list link operation. - * - * @member {string} [nextLink] Link to the next set of results. */ export interface LinkListResult extends Array { + /** + * Link to the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the RoleListResult class. - * @constructor * The response of list role assignment operation. - * - * @member {string} [nextLink] Link to the next set of results. */ export interface RoleListResult extends Array { + /** + * Link to the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the RoleAssignmentListResult class. - * @constructor * The response of list role assignment operation. - * - * @member {string} [nextLink] Link to the next set of results. */ export interface RoleAssignmentListResult extends Array { + /** + * Link to the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the PredictionListResult class. - * @constructor * The response of list predictions operation. - * - * @member {string} [nextLink] Link to the next set of results. */ export interface PredictionListResult extends Array { + /** + * Link to the next set of results. + */ nextLink?: string; } diff --git a/lib/services/customerInsightsManagement/lib/models/interactionListResult.js b/lib/services/customerInsightsManagement/lib/models/interactionListResult.js index d833d50b96..d95061ac78 100644 --- a/lib/services/customerInsightsManagement/lib/models/interactionListResult.js +++ b/lib/services/customerInsightsManagement/lib/models/interactionListResult.js @@ -16,7 +16,7 @@ class InteractionListResult extends Array { /** * Create a InteractionListResult. - * @member {string} [nextLink] Link to the next set of results. + * @property {string} [nextLink] Link to the next set of results. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/interactionResourceFormat.js b/lib/services/customerInsightsManagement/lib/models/interactionResourceFormat.js index 62ff10b733..d0a8ea7b08 100644 --- a/lib/services/customerInsightsManagement/lib/models/interactionResourceFormat.js +++ b/lib/services/customerInsightsManagement/lib/models/interactionResourceFormat.js @@ -20,56 +20,56 @@ const models = require('./index'); class InteractionResourceFormat extends models['ProxyResource'] { /** * Create a InteractionResourceFormat. - * @member {object} [attributes] The attributes for the Type. - * @member {object} [description] Localized descriptions for the property. - * @member {object} [displayName] Localized display names for the property. - * @member {object} [localizedAttributes] Any custom localized attributes for - * the Type. - * @member {string} [smallImage] Small Image associated with the Property or - * EntityType. - * @member {string} [mediumImage] Medium Image associated with the Property + * @property {object} [attributes] The attributes for the Type. + * @property {object} [description] Localized descriptions for the property. + * @property {object} [displayName] Localized display names for the property. + * @property {object} [localizedAttributes] Any custom localized attributes + * for the Type. + * @property {string} [smallImage] Small Image associated with the Property * or EntityType. - * @member {string} [largeImage] Large Image associated with the Property or - * EntityType. - * @member {string} [apiEntitySetName] The api entity set name. This becomes - * the odata entity set name for the entity Type being refered in this - * object. - * @member {string} [entityType] Type of entity. Possible values include: + * @property {string} [mediumImage] Medium Image associated with the Property + * or EntityType. + * @property {string} [largeImage] Large Image associated with the Property + * or EntityType. + * @property {string} [apiEntitySetName] The api entity set name. This + * becomes the odata entity set name for the entity Type being referred in + * this object. + * @property {string} [entityType] Type of entity. Possible values include: * 'None', 'Profile', 'Interaction', 'Relationship' - * @member {array} [fields] The properties of the Profile. - * @member {number} [instancesCount] The instance count. - * @member {date} [lastChangedUtc] The last changed time for the type + * @property {array} [fields] The properties of the Profile. + * @property {number} [instancesCount] The instance count. + * @property {date} [lastChangedUtc] The last changed time for the type * definition. - * @member {string} [provisioningState] Provisioning state. Possible values + * @property {string} [provisioningState] Provisioning state. Possible values * include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', * 'HumanIntervention', 'Failed' - * @member {string} [schemaItemTypeLink] The schema org link. This helps ACI - * identify and suggest semantic models. - * @member {string} [tenantId] The hub name. - * @member {string} [timestampFieldName] The timestamp property name. + * @property {string} [schemaItemTypeLink] The schema org link. This helps + * ACI identify and suggest semantic models. + * @property {string} [tenantId] The hub name. + * @property {string} [timestampFieldName] The timestamp property name. * Represents the time when the interaction or profile update happened. - * @member {string} [typeName] The name of the entity. - * @member {array} [idPropertyNames] The id property names. Properties which - * uniquely identify an interaction instance. - * @member {array} [participantProfiles] Profiles that participated in the + * @property {string} [typeName] The name of the entity. + * @property {array} [idPropertyNames] The id property names. Properties + * which uniquely identify an interaction instance. + * @property {array} [participantProfiles] Profiles that participated in the * interaction. - * @member {string} [primaryParticipantProfilePropertyName] The primary + * @property {string} [primaryParticipantProfilePropertyName] The primary * participant property name for an interaction ,This is used to logically * represent the agent of the interaction, Specify the participant name here * from ParticipantName. - * @member {array} [dataSourcePrecedenceRules] This is specific to + * @property {array} [dataSourcePrecedenceRules] This is specific to * interactions modeled as activities. Data sources are used to determine * where data is stored and also in precedence rules. - * @member {string} [interactionResourceFormatName] The data source name - * @member {string} [dataSourceType] The data source type. Possible values + * @property {string} [interactionResourceFormatName] The data source name + * @property {string} [dataSourceType] The data source type. Possible values * include: 'Connector', 'LinkInteraction', 'SystemDefault' - * @member {string} [status] The data source status. Possible values include: - * 'None', 'Active', 'Deleted' - * @member {number} [interactionResourceFormatId] The data source ID. - * @member {string} [dataSourceReferenceId] The data source reference id. - * @member {boolean} [isActivity] An interaction can be tagged as an activity - * only during create. This enables the interaction to be editable and can - * enable merging of properties from multiple data sources based on + * @property {string} [status] The data source status. Possible values + * include: 'None', 'Active', 'Deleted' + * @property {number} [interactionResourceFormatId] The data source ID. + * @property {string} [dataSourceReferenceId] The data source reference id. + * @property {boolean} [isActivity] An interaction can be tagged as an + * activity only during create. This enables the interaction to be editable + * and can enable merging of properties from multiple data sources based on * precedence, which is defined at a link level. */ constructor() { diff --git a/lib/services/customerInsightsManagement/lib/models/kpiAlias.js b/lib/services/customerInsightsManagement/lib/models/kpiAlias.js index b3c8a5218e..5a1e9f1874 100644 --- a/lib/services/customerInsightsManagement/lib/models/kpiAlias.js +++ b/lib/services/customerInsightsManagement/lib/models/kpiAlias.js @@ -17,8 +17,8 @@ class KpiAlias { /** * Create a KpiAlias. - * @member {string} aliasName KPI alias name. - * @member {string} expression The expression. + * @property {string} aliasName KPI alias name. + * @property {string} expression The expression. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/kpiDefinition.js b/lib/services/customerInsightsManagement/lib/models/kpiDefinition.js index df6180428e..325e310f5c 100644 --- a/lib/services/customerInsightsManagement/lib/models/kpiDefinition.js +++ b/lib/services/customerInsightsManagement/lib/models/kpiDefinition.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * Defines the KPI Threshold limits. * @@ -19,36 +17,36 @@ const models = require('./index'); class KpiDefinition { /** * Create a KpiDefinition. - * @member {string} entityType The mapping entity type. Possible values + * @property {string} entityType The mapping entity type. Possible values * include: 'None', 'Profile', 'Interaction', 'Relationship' - * @member {string} entityTypeName The mapping entity name. - * @member {string} [tenantId] The hub name. - * @member {string} [kpiName] The KPI name. - * @member {object} [displayName] Localized display name for the KPI. - * @member {object} [description] Localized description for the KPI. - * @member {string} calculationWindow The calculation window. Possible values - * include: 'Lifetime', 'Hour', 'Day', 'Week', 'Month' - * @member {string} [calculationWindowFieldName] Name of calculation window + * @property {string} entityTypeName The mapping entity name. + * @property {string} [tenantId] The hub name. + * @property {string} [kpiName] The KPI name. + * @property {object} [displayName] Localized display name for the KPI. + * @property {object} [description] Localized description for the KPI. + * @property {string} calculationWindow The calculation window. Possible + * values include: 'Lifetime', 'Hour', 'Day', 'Week', 'Month' + * @property {string} [calculationWindowFieldName] Name of calculation window * field. - * @member {string} functionProperty The computation function for the KPI. + * @property {string} functionProperty The computation function for the KPI. * Possible values include: 'Sum', 'Avg', 'Min', 'Max', 'Last', 'Count', * 'None', 'CountDistinct' - * @member {string} expression The computation expression for the KPI. - * @member {string} [unit] The unit of measurement for the KPI. - * @member {string} [filter] The filter expression for the KPI. - * @member {array} [groupBy] the group by properties for the KPI. - * @member {array} [groupByMetadata] The KPI GroupByMetadata. - * @member {array} [participantProfilesMetadata] The participant profiles. - * @member {string} [provisioningState] Provisioning state. Possible values + * @property {string} expression The computation expression for the KPI. + * @property {string} [unit] The unit of measurement for the KPI. + * @property {string} [filter] The filter expression for the KPI. + * @property {array} [groupBy] the group by properties for the KPI. + * @property {array} [groupByMetadata] The KPI GroupByMetadata. + * @property {array} [participantProfilesMetadata] The participant profiles. + * @property {string} [provisioningState] Provisioning state. Possible values * include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', * 'HumanIntervention', 'Failed' - * @member {object} [thresHolds] The KPI thresholds. - * @member {number} [thresHolds.lowerLimit] The lower threshold limit. - * @member {number} [thresHolds.upperLimit] The upper threshold limit. - * @member {boolean} [thresHolds.increasingKpi] Whether or not the KPI is an - * increasing KPI. - * @member {array} [aliases] The aliases. - * @member {array} [extracts] The KPI extracts. + * @property {object} [thresHolds] The KPI thresholds. + * @property {number} [thresHolds.lowerLimit] The lower threshold limit. + * @property {number} [thresHolds.upperLimit] The upper threshold limit. + * @property {boolean} [thresHolds.increasingKpi] Whether or not the KPI is + * an increasing KPI. + * @property {array} [aliases] The aliases. + * @property {array} [extracts] The KPI extracts. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/kpiExtract.js b/lib/services/customerInsightsManagement/lib/models/kpiExtract.js index 8b66dea34c..6f533633cc 100644 --- a/lib/services/customerInsightsManagement/lib/models/kpiExtract.js +++ b/lib/services/customerInsightsManagement/lib/models/kpiExtract.js @@ -17,8 +17,8 @@ class KpiExtract { /** * Create a KpiExtract. - * @member {string} extractName KPI extract name. - * @member {string} expression The expression. + * @property {string} extractName KPI extract name. + * @property {string} expression The expression. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/kpiGroupByMetadata.js b/lib/services/customerInsightsManagement/lib/models/kpiGroupByMetadata.js index 1c0c77f741..0d80e6edac 100644 --- a/lib/services/customerInsightsManagement/lib/models/kpiGroupByMetadata.js +++ b/lib/services/customerInsightsManagement/lib/models/kpiGroupByMetadata.js @@ -17,9 +17,9 @@ class KpiGroupByMetadata { /** * Create a KpiGroupByMetadata. - * @member {object} [displayName] The display name. - * @member {string} [fieldName] The name of the field. - * @member {string} [fieldType] The type of the field. + * @property {object} [displayName] The display name. + * @property {string} [fieldName] The name of the field. + * @property {string} [fieldType] The type of the field. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/kpiListResult.js b/lib/services/customerInsightsManagement/lib/models/kpiListResult.js index f2cf8b5dfb..81a0025856 100644 --- a/lib/services/customerInsightsManagement/lib/models/kpiListResult.js +++ b/lib/services/customerInsightsManagement/lib/models/kpiListResult.js @@ -16,7 +16,7 @@ class KpiListResult extends Array { /** * Create a KpiListResult. - * @member {string} [nextLink] Link to the next set of results. + * @property {string} [nextLink] Link to the next set of results. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/kpiParticipantProfilesMetadata.js b/lib/services/customerInsightsManagement/lib/models/kpiParticipantProfilesMetadata.js index 498a4fb023..6fb82e70f4 100644 --- a/lib/services/customerInsightsManagement/lib/models/kpiParticipantProfilesMetadata.js +++ b/lib/services/customerInsightsManagement/lib/models/kpiParticipantProfilesMetadata.js @@ -17,7 +17,7 @@ class KpiParticipantProfilesMetadata { /** * Create a KpiParticipantProfilesMetadata. - * @member {string} typeName Name of the type. + * @property {string} typeName Name of the type. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/kpiResourceFormat.js b/lib/services/customerInsightsManagement/lib/models/kpiResourceFormat.js index 435fa8ed49..c54b2b7d8d 100644 --- a/lib/services/customerInsightsManagement/lib/models/kpiResourceFormat.js +++ b/lib/services/customerInsightsManagement/lib/models/kpiResourceFormat.js @@ -20,36 +20,36 @@ const models = require('./index'); class KpiResourceFormat extends models['ProxyResource'] { /** * Create a KpiResourceFormat. - * @member {string} entityType The mapping entity type. Possible values + * @property {string} entityType The mapping entity type. Possible values * include: 'None', 'Profile', 'Interaction', 'Relationship' - * @member {string} entityTypeName The mapping entity name. - * @member {string} [tenantId] The hub name. - * @member {string} [kpiName] The KPI name. - * @member {object} [displayName] Localized display name for the KPI. - * @member {object} [description] Localized description for the KPI. - * @member {string} calculationWindow The calculation window. Possible values - * include: 'Lifetime', 'Hour', 'Day', 'Week', 'Month' - * @member {string} [calculationWindowFieldName] Name of calculation window + * @property {string} entityTypeName The mapping entity name. + * @property {string} [tenantId] The hub name. + * @property {string} [kpiName] The KPI name. + * @property {object} [displayName] Localized display name for the KPI. + * @property {object} [description] Localized description for the KPI. + * @property {string} calculationWindow The calculation window. Possible + * values include: 'Lifetime', 'Hour', 'Day', 'Week', 'Month' + * @property {string} [calculationWindowFieldName] Name of calculation window * field. - * @member {string} functionProperty The computation function for the KPI. + * @property {string} functionProperty The computation function for the KPI. * Possible values include: 'Sum', 'Avg', 'Min', 'Max', 'Last', 'Count', * 'None', 'CountDistinct' - * @member {string} expression The computation expression for the KPI. - * @member {string} [unit] The unit of measurement for the KPI. - * @member {string} [filter] The filter expression for the KPI. - * @member {array} [groupBy] the group by properties for the KPI. - * @member {array} [groupByMetadata] The KPI GroupByMetadata. - * @member {array} [participantProfilesMetadata] The participant profiles. - * @member {string} [provisioningState] Provisioning state. Possible values + * @property {string} expression The computation expression for the KPI. + * @property {string} [unit] The unit of measurement for the KPI. + * @property {string} [filter] The filter expression for the KPI. + * @property {array} [groupBy] the group by properties for the KPI. + * @property {array} [groupByMetadata] The KPI GroupByMetadata. + * @property {array} [participantProfilesMetadata] The participant profiles. + * @property {string} [provisioningState] Provisioning state. Possible values * include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', * 'HumanIntervention', 'Failed' - * @member {object} [thresHolds] The KPI thresholds. - * @member {number} [thresHolds.lowerLimit] The lower threshold limit. - * @member {number} [thresHolds.upperLimit] The upper threshold limit. - * @member {boolean} [thresHolds.increasingKpi] Whether or not the KPI is an - * increasing KPI. - * @member {array} [aliases] The aliases. - * @member {array} [extracts] The KPI extracts. + * @property {object} [thresHolds] The KPI thresholds. + * @property {number} [thresHolds.lowerLimit] The lower threshold limit. + * @property {number} [thresHolds.upperLimit] The upper threshold limit. + * @property {boolean} [thresHolds.increasingKpi] Whether or not the KPI is + * an increasing KPI. + * @property {array} [aliases] The aliases. + * @property {array} [extracts] The KPI extracts. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/kpiThresholds.js b/lib/services/customerInsightsManagement/lib/models/kpiThresholds.js index 7d13adeead..3d26434c7c 100644 --- a/lib/services/customerInsightsManagement/lib/models/kpiThresholds.js +++ b/lib/services/customerInsightsManagement/lib/models/kpiThresholds.js @@ -17,9 +17,9 @@ class KpiThresholds { /** * Create a KpiThresholds. - * @member {number} lowerLimit The lower threshold limit. - * @member {number} upperLimit The upper threshold limit. - * @member {boolean} increasingKpi Whether or not the KPI is an increasing + * @property {number} lowerLimit The lower threshold limit. + * @property {number} upperLimit The upper threshold limit. + * @property {boolean} increasingKpi Whether or not the KPI is an increasing * KPI. */ constructor() { diff --git a/lib/services/customerInsightsManagement/lib/models/linkListResult.js b/lib/services/customerInsightsManagement/lib/models/linkListResult.js index 8b314996cb..83bed03b6f 100644 --- a/lib/services/customerInsightsManagement/lib/models/linkListResult.js +++ b/lib/services/customerInsightsManagement/lib/models/linkListResult.js @@ -16,7 +16,7 @@ class LinkListResult extends Array { /** * Create a LinkListResult. - * @member {string} [nextLink] Link to the next set of results. + * @property {string} [nextLink] Link to the next set of results. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/linkResourceFormat.js b/lib/services/customerInsightsManagement/lib/models/linkResourceFormat.js index ff93899e3c..780d7b0f6f 100644 --- a/lib/services/customerInsightsManagement/lib/models/linkResourceFormat.js +++ b/lib/services/customerInsightsManagement/lib/models/linkResourceFormat.js @@ -20,30 +20,30 @@ const models = require('./index'); class LinkResourceFormat extends models['ProxyResource'] { /** * Create a LinkResourceFormat. - * @member {string} [tenantId] The hub name. - * @member {string} [linkName] The link name. - * @member {string} sourceEntityType Type of source entity. Possible values + * @property {string} [tenantId] The hub name. + * @property {string} [linkName] The link name. + * @property {string} sourceEntityType Type of source entity. Possible values * include: 'None', 'Profile', 'Interaction', 'Relationship' - * @member {string} targetEntityType Type of target entity. Possible values + * @property {string} targetEntityType Type of target entity. Possible values * include: 'None', 'Profile', 'Interaction', 'Relationship' - * @member {string} sourceEntityTypeName Name of the source Entity Type. - * @member {string} targetEntityTypeName Name of the target Entity Type. - * @member {object} [displayName] Localized display name for the Link. - * @member {object} [description] Localized descriptions for the Link. - * @member {array} [mappings] The set of properties mappings between the + * @property {string} sourceEntityTypeName Name of the source Entity Type. + * @property {string} targetEntityTypeName Name of the target Entity Type. + * @property {object} [displayName] Localized display name for the Link. + * @property {object} [description] Localized descriptions for the Link. + * @property {array} [mappings] The set of properties mappings between the * source and target Types. - * @member {array} participantPropertyReferences The properties that + * @property {array} participantPropertyReferences The properties that * represent the participating profile. - * @member {string} [provisioningState] Provisioning state. Possible values + * @property {string} [provisioningState] Provisioning state. Possible values * include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', * 'HumanIntervention', 'Failed' - * @member {boolean} [referenceOnly] Indicating whether the link is reference - * only link. This flag is ingored if the Mappings are defined. If the - * mappings are not defined and it is set to true, links processing will not - * create or update profiles. - * @member {string} [operationType] Determines whether this link is supposed - * to create or delete instances if Link is NOT Reference Only. Possible - * values include: 'Upsert', 'Delete' + * @property {boolean} [referenceOnly] Indicating whether the link is + * reference only link. This flag is ignored if the Mappings are defined. If + * the mappings are not defined and it is set to true, links processing will + * not create or update profiles. + * @property {string} [operationType] Determines whether this link is + * supposed to create or delete instances if Link is NOT Reference Only. + * Possible values include: 'Upsert', 'Delete' */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/metadataDefinitionBase.js b/lib/services/customerInsightsManagement/lib/models/metadataDefinitionBase.js index ef7969883e..78ae182fd9 100644 --- a/lib/services/customerInsightsManagement/lib/models/metadataDefinitionBase.js +++ b/lib/services/customerInsightsManagement/lib/models/metadataDefinitionBase.js @@ -17,17 +17,17 @@ class MetadataDefinitionBase { /** * Create a MetadataDefinitionBase. - * @member {object} [attributes] The attributes for the Type. - * @member {object} [description] Localized descriptions for the property. - * @member {object} [displayName] Localized display names for the property. - * @member {object} [localizedAttributes] Any custom localized attributes for - * the Type. - * @member {string} [smallImage] Small Image associated with the Property or - * EntityType. - * @member {string} [mediumImage] Medium Image associated with the Property + * @property {object} [attributes] The attributes for the Type. + * @property {object} [description] Localized descriptions for the property. + * @property {object} [displayName] Localized display names for the property. + * @property {object} [localizedAttributes] Any custom localized attributes + * for the Type. + * @property {string} [smallImage] Small Image associated with the Property + * or EntityType. + * @property {string} [mediumImage] Medium Image associated with the Property + * or EntityType. + * @property {string} [largeImage] Large Image associated with the Property * or EntityType. - * @member {string} [largeImage] Large Image associated with the Property or - * EntityType. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/operation.js b/lib/services/customerInsightsManagement/lib/models/operation.js index f3a1d85ea1..4869bf3554 100644 --- a/lib/services/customerInsightsManagement/lib/models/operation.js +++ b/lib/services/customerInsightsManagement/lib/models/operation.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * A Customer Insights REST API operation * @@ -19,14 +17,15 @@ const models = require('./index'); class Operation { /** * Create a Operation. - * @member {string} [name] Operation name: {provider}/{resource}/{operation} - * @member {object} [display] The object that represents the operation. - * @member {string} [display.provider] Service provider: + * @property {string} [name] Operation name: + * {provider}/{resource}/{operation} + * @property {object} [display] The object that represents the operation. + * @property {string} [display.provider] Service provider: * Microsoft.CustomerInsights - * @member {string} [display.resource] Resource on which the operation is + * @property {string} [display.resource] Resource on which the operation is * performed: Invoice, etc. - * @member {string} [display.operation] Operation type: Read, write, delete, - * etc. + * @property {string} [display.operation] Operation type: Read, write, + * delete, etc. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/operationDisplay.js b/lib/services/customerInsightsManagement/lib/models/operationDisplay.js index 54c1d9acf6..fd8d854288 100644 --- a/lib/services/customerInsightsManagement/lib/models/operationDisplay.js +++ b/lib/services/customerInsightsManagement/lib/models/operationDisplay.js @@ -17,10 +17,10 @@ class OperationDisplay { /** * Create a OperationDisplay. - * @member {string} [provider] Service provider: Microsoft.CustomerInsights - * @member {string} [resource] Resource on which the operation is performed: - * Invoice, etc. - * @member {string} [operation] Operation type: Read, write, delete, etc. + * @property {string} [provider] Service provider: Microsoft.CustomerInsights + * @property {string} [resource] Resource on which the operation is + * performed: Invoice, etc. + * @property {string} [operation] Operation type: Read, write, delete, etc. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/operationListResult.js b/lib/services/customerInsightsManagement/lib/models/operationListResult.js index 497f5939c1..d4063ea403 100644 --- a/lib/services/customerInsightsManagement/lib/models/operationListResult.js +++ b/lib/services/customerInsightsManagement/lib/models/operationListResult.js @@ -17,7 +17,7 @@ class OperationListResult extends Array { /** * Create a OperationListResult. - * @member {string} [nextLink] URL to get the next set of operation list + * @property {string} [nextLink] URL to get the next set of operation list * results if there are any. */ constructor() { diff --git a/lib/services/customerInsightsManagement/lib/models/participant.js b/lib/services/customerInsightsManagement/lib/models/participant.js index a33d7afac5..2e8d37c2bc 100644 --- a/lib/services/customerInsightsManagement/lib/models/participant.js +++ b/lib/services/customerInsightsManagement/lib/models/participant.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * Describes a profile type participating in an interaction. * @@ -19,12 +17,12 @@ const models = require('./index'); class Participant { /** * Create a Participant. - * @member {string} profileTypeName Profile type name. - * @member {array} participantPropertyReferences The property references. - * @member {string} participantName Participant name. - * @member {object} [displayName] Localized display name. - * @member {object} [description] Localized descriptions. - * @member {string} [role] The role that the participant is playing in the + * @property {string} profileTypeName Profile type name. + * @property {array} participantPropertyReferences The property references. + * @property {string} participantName Participant name. + * @property {object} [displayName] Localized display name. + * @property {object} [description] Localized descriptions. + * @property {string} [role] The role that the participant is playing in the * interaction. */ constructor() { diff --git a/lib/services/customerInsightsManagement/lib/models/participantProfilePropertyReference.js b/lib/services/customerInsightsManagement/lib/models/participantProfilePropertyReference.js index 2fa9010747..591d0a638b 100644 --- a/lib/services/customerInsightsManagement/lib/models/participantProfilePropertyReference.js +++ b/lib/services/customerInsightsManagement/lib/models/participantProfilePropertyReference.js @@ -17,10 +17,10 @@ class ParticipantProfilePropertyReference { /** * Create a ParticipantProfilePropertyReference. - * @member {string} interactionPropertyName The source interaction property + * @property {string} interactionPropertyName The source interaction property * that maps to the target profile property. - * @member {string} profilePropertyName The target profile property that maps - * to the source interaction property. + * @property {string} profilePropertyName The target profile property that + * maps to the source interaction property. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/participantPropertyReference.js b/lib/services/customerInsightsManagement/lib/models/participantPropertyReference.js index 8fc0baa1b6..8fa8f27c6b 100644 --- a/lib/services/customerInsightsManagement/lib/models/participantPropertyReference.js +++ b/lib/services/customerInsightsManagement/lib/models/participantPropertyReference.js @@ -17,9 +17,9 @@ class ParticipantPropertyReference { /** * Create a ParticipantPropertyReference. - * @member {string} sourcePropertyName The source property that maps to the + * @property {string} sourcePropertyName The source property that maps to the * target property. - * @member {string} targetPropertyName The target property that maps to the + * @property {string} targetPropertyName The target property that maps to the * source property. */ constructor() { diff --git a/lib/services/customerInsightsManagement/lib/models/predictionDistributionDefinition.js b/lib/services/customerInsightsManagement/lib/models/predictionDistributionDefinition.js index 24d09bfd18..8bde8843fb 100644 --- a/lib/services/customerInsightsManagement/lib/models/predictionDistributionDefinition.js +++ b/lib/services/customerInsightsManagement/lib/models/predictionDistributionDefinition.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * The definition of the prediction distribution. * @@ -19,9 +17,9 @@ const models = require('./index'); class PredictionDistributionDefinition { /** * Create a PredictionDistributionDefinition. - * @member {number} [totalPositives] Total positive in the distribution. - * @member {number} [totalNegatives] Total negatives in the distribution. - * @member {array} [distributions] Distributions of the prediction. + * @property {number} [totalPositives] Total positive in the distribution. + * @property {number} [totalNegatives] Total negatives in the distribution. + * @property {array} [distributions] Distributions of the prediction. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/predictionDistributionDefinitionDistributionsItem.js b/lib/services/customerInsightsManagement/lib/models/predictionDistributionDefinitionDistributionsItem.js index 48dfe2a825..b8a2e1b182 100644 --- a/lib/services/customerInsightsManagement/lib/models/predictionDistributionDefinitionDistributionsItem.js +++ b/lib/services/customerInsightsManagement/lib/models/predictionDistributionDefinitionDistributionsItem.js @@ -17,12 +17,12 @@ class PredictionDistributionDefinitionDistributionsItem { /** * Create a PredictionDistributionDefinitionDistributionsItem. - * @member {number} [scoreThreshold] Score threshold. - * @member {number} [positives] Number of positives. - * @member {number} [negatives] Number of negatives. - * @member {number} [positivesAboveThreshold] Number of positives above + * @property {number} [scoreThreshold] Score threshold. + * @property {number} [positives] Number of positives. + * @property {number} [negatives] Number of negatives. + * @property {number} [positivesAboveThreshold] Number of positives above * threshold. - * @member {number} [negativesAboveThreshold] Number of negatives above + * @property {number} [negativesAboveThreshold] Number of negatives above * threshold. */ constructor() { diff --git a/lib/services/customerInsightsManagement/lib/models/predictionGradesItem.js b/lib/services/customerInsightsManagement/lib/models/predictionGradesItem.js index 1c3f6b8a99..dfecfce27f 100644 --- a/lib/services/customerInsightsManagement/lib/models/predictionGradesItem.js +++ b/lib/services/customerInsightsManagement/lib/models/predictionGradesItem.js @@ -17,9 +17,9 @@ class PredictionGradesItem { /** * Create a PredictionGradesItem. - * @member {string} [gradeName] Name of the grade. - * @member {number} [minScoreThreshold] Minimum score threshold. - * @member {number} [maxScoreThreshold] Maximum score threshold. + * @property {string} [gradeName] Name of the grade. + * @property {number} [minScoreThreshold] Minimum score threshold. + * @property {number} [maxScoreThreshold] Maximum score threshold. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/predictionListResult.js b/lib/services/customerInsightsManagement/lib/models/predictionListResult.js index 29bb718655..a0f578538f 100644 --- a/lib/services/customerInsightsManagement/lib/models/predictionListResult.js +++ b/lib/services/customerInsightsManagement/lib/models/predictionListResult.js @@ -16,7 +16,7 @@ class PredictionListResult extends Array { /** * Create a PredictionListResult. - * @member {string} [nextLink] Link to the next set of results. + * @property {string} [nextLink] Link to the next set of results. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/predictionMappings.js b/lib/services/customerInsightsManagement/lib/models/predictionMappings.js index c94ee485ad..9a54f3e191 100644 --- a/lib/services/customerInsightsManagement/lib/models/predictionMappings.js +++ b/lib/services/customerInsightsManagement/lib/models/predictionMappings.js @@ -17,9 +17,9 @@ class PredictionMappings { /** * Create a PredictionMappings. - * @member {string} score The score of the link mapping. - * @member {string} grade The grade of the link mapping. - * @member {string} reason The reason of the link mapping. + * @property {string} score The score of the link mapping. + * @property {string} grade The grade of the link mapping. + * @property {string} reason The reason of the link mapping. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/predictionModelStatus.js b/lib/services/customerInsightsManagement/lib/models/predictionModelStatus.js index 63e22c2d54..1e1a08730b 100644 --- a/lib/services/customerInsightsManagement/lib/models/predictionModelStatus.js +++ b/lib/services/customerInsightsManagement/lib/models/predictionModelStatus.js @@ -17,10 +17,10 @@ class PredictionModelStatus { /** * Create a PredictionModelStatus. - * @member {string} [tenantId] The hub name. - * @member {string} [predictionName] The prediction name. - * @member {string} [predictionGuidId] The prediction GUID ID. - * @member {string} status Prediction model life cycle. When prediction is + * @property {string} [tenantId] The hub name. + * @property {string} [predictionName] The prediction name. + * @property {string} [predictionGuidId] The prediction GUID ID. + * @property {string} status Prediction model life cycle. When prediction is * in PendingModelConfirmation status, it is allowed to update the status to * PendingFeaturing or Active through API. Possible values include: 'New', * 'Provisioning', 'ProvisioningFailed', 'PendingDiscovering', 'Discovering', @@ -28,13 +28,13 @@ class PredictionModelStatus { * 'Training', 'TrainingFailed', 'Evaluating', 'EvaluatingFailed', * 'PendingModelConfirmation', 'Active', 'Deleted', 'HumanIntervention', * 'Failed' - * @member {string} [message] The model status message. - * @member {number} [trainingSetCount] Count of the training set. - * @member {number} [testSetCount] Count of the test set. - * @member {number} [validationSetCount] Count of the validation set. - * @member {number} [trainingAccuracy] The training accuracy. - * @member {number} [signalsUsed] The singnas used. - * @member {string} [modelVersion] Version of the model. + * @property {string} [message] The model status message. + * @property {number} [trainingSetCount] Count of the training set. + * @property {number} [testSetCount] Count of the test set. + * @property {number} [validationSetCount] Count of the validation set. + * @property {number} [trainingAccuracy] The training accuracy. + * @property {number} [signalsUsed] The signals used. + * @property {string} [modelVersion] Version of the model. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/predictionResourceFormat.js b/lib/services/customerInsightsManagement/lib/models/predictionResourceFormat.js index 3d45926858..b190accff5 100644 --- a/lib/services/customerInsightsManagement/lib/models/predictionResourceFormat.js +++ b/lib/services/customerInsightsManagement/lib/models/predictionResourceFormat.js @@ -20,34 +20,35 @@ const models = require('./index'); class PredictionResourceFormat extends models['ProxyResource'] { /** * Create a PredictionResourceFormat. - * @member {object} [description] Description of the prediction. - * @member {object} [displayName] Display name of the prediction. - * @member {array} [involvedInteractionTypes] Interaction types involved in + * @property {object} [description] Description of the prediction. + * @property {object} [displayName] Display name of the prediction. + * @property {array} [involvedInteractionTypes] Interaction types involved in * the prediction. - * @member {array} [involvedKpiTypes] KPI types involved in the prediction. - * @member {array} [involvedRelationships] Relationships involved in the + * @property {array} [involvedKpiTypes] KPI types involved in the prediction. + * @property {array} [involvedRelationships] Relationships involved in the * prediction. - * @member {string} negativeOutcomeExpression Negative outcome expression. - * @member {string} positiveOutcomeExpression Positive outcome expression. - * @member {string} primaryProfileType Primary profile type. - * @member {string} [provisioningState] Provisioning state. Possible values + * @property {string} negativeOutcomeExpression Negative outcome expression. + * @property {string} positiveOutcomeExpression Positive outcome expression. + * @property {string} primaryProfileType Primary profile type. + * @property {string} [provisioningState] Provisioning state. Possible values * include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', * 'HumanIntervention', 'Failed' - * @member {string} [predictionName] Name of the prediction. - * @member {string} scopeExpression Scope expression. - * @member {string} [tenantId] The hub name. - * @member {boolean} autoAnalyze Whether do auto analyze. - * @member {object} mappings Definition of the link mapping of prediction. - * @member {string} [mappings.score] The score of the link mapping. - * @member {string} [mappings.grade] The grade of the link mapping. - * @member {string} [mappings.reason] The reason of the link mapping. - * @member {string} scoreLabel Score label. - * @member {array} [grades] The prediction grades. - * @member {object} [systemGeneratedEntities] System generated entities. - * @member {array} [systemGeneratedEntities.generatedInteractionTypes] + * @property {string} [predictionName] Name of the prediction. + * @property {string} scopeExpression Scope expression. + * @property {string} [tenantId] The hub name. + * @property {boolean} autoAnalyze Whether do auto analyze. + * @property {object} mappings Definition of the link mapping of prediction. + * @property {string} [mappings.score] The score of the link mapping. + * @property {string} [mappings.grade] The grade of the link mapping. + * @property {string} [mappings.reason] The reason of the link mapping. + * @property {string} scoreLabel Score label. + * @property {array} [grades] The prediction grades. + * @property {object} [systemGeneratedEntities] System generated entities. + * @property {array} [systemGeneratedEntities.generatedInteractionTypes] * Generated interaction types. - * @member {array} [systemGeneratedEntities.generatedLinks] Generated links. - * @member {object} [systemGeneratedEntities.generatedKpis] Generated KPIs. + * @property {array} [systemGeneratedEntities.generatedLinks] Generated + * links. + * @property {object} [systemGeneratedEntities.generatedKpis] Generated KPIs. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/predictionSystemGeneratedEntities.js b/lib/services/customerInsightsManagement/lib/models/predictionSystemGeneratedEntities.js index 3a4ad1913c..739c76cc9e 100644 --- a/lib/services/customerInsightsManagement/lib/models/predictionSystemGeneratedEntities.js +++ b/lib/services/customerInsightsManagement/lib/models/predictionSystemGeneratedEntities.js @@ -17,9 +17,9 @@ class PredictionSystemGeneratedEntities { /** * Create a PredictionSystemGeneratedEntities. - * @member {array} [generatedInteractionTypes] Generated interaction types. - * @member {array} [generatedLinks] Generated links. - * @member {object} [generatedKpis] Generated KPIs. + * @property {array} [generatedInteractionTypes] Generated interaction types. + * @property {array} [generatedLinks] Generated links. + * @property {object} [generatedKpis] Generated KPIs. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/predictionTrainingResults.js b/lib/services/customerInsightsManagement/lib/models/predictionTrainingResults.js index 4cf878b29f..e24cc7e604 100644 --- a/lib/services/customerInsightsManagement/lib/models/predictionTrainingResults.js +++ b/lib/services/customerInsightsManagement/lib/models/predictionTrainingResults.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * The training results of the prediction. * @@ -19,17 +17,17 @@ const models = require('./index'); class PredictionTrainingResults { /** * Create a PredictionTrainingResults. - * @member {string} [tenantId] The hub name. - * @member {string} [scoreName] Score name. - * @member {object} [predictionDistribution] Prediction distribution. - * @member {number} [predictionDistribution.totalPositives] Total positive in - * the distribution. - * @member {number} [predictionDistribution.totalNegatives] Total negatives + * @property {string} [tenantId] The hub name. + * @property {string} [scoreName] Score name. + * @property {object} [predictionDistribution] Prediction distribution. + * @property {number} [predictionDistribution.totalPositives] Total positive + * in the distribution. + * @property {number} [predictionDistribution.totalNegatives] Total negatives * in the distribution. - * @member {array} [predictionDistribution.distributions] Distributions of + * @property {array} [predictionDistribution.distributions] Distributions of * the prediction. - * @member {array} [canonicalProfiles] Canonical profiles. - * @member {number} [primaryProfileInstanceCount] Instance count of the + * @property {array} [canonicalProfiles] Canonical profiles. + * @property {number} [primaryProfileInstanceCount] Instance count of the * primary profile. */ constructor() { diff --git a/lib/services/customerInsightsManagement/lib/models/profileEnumValidValuesFormat.js b/lib/services/customerInsightsManagement/lib/models/profileEnumValidValuesFormat.js index 0956d44325..edd7d8a639 100644 --- a/lib/services/customerInsightsManagement/lib/models/profileEnumValidValuesFormat.js +++ b/lib/services/customerInsightsManagement/lib/models/profileEnumValidValuesFormat.js @@ -17,8 +17,9 @@ class ProfileEnumValidValuesFormat { /** * Create a ProfileEnumValidValuesFormat. - * @member {number} [value] The integer value of the enum member. - * @member {object} [localizedValueNames] Localized names of the enum member. + * @property {number} [value] The integer value of the enum member. + * @property {object} [localizedValueNames] Localized names of the enum + * member. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/profileListResult.js b/lib/services/customerInsightsManagement/lib/models/profileListResult.js index 63db20390b..25e63ec5b3 100644 --- a/lib/services/customerInsightsManagement/lib/models/profileListResult.js +++ b/lib/services/customerInsightsManagement/lib/models/profileListResult.js @@ -16,7 +16,7 @@ class ProfileListResult extends Array { /** * Create a ProfileListResult. - * @member {string} [nextLink] Link to the next set of results. + * @property {string} [nextLink] Link to the next set of results. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/profileResourceFormat.js b/lib/services/customerInsightsManagement/lib/models/profileResourceFormat.js index a0a59b867f..00e1571e9a 100644 --- a/lib/services/customerInsightsManagement/lib/models/profileResourceFormat.js +++ b/lib/services/customerInsightsManagement/lib/models/profileResourceFormat.js @@ -20,36 +20,36 @@ const models = require('./index'); class ProfileResourceFormat extends models['ProxyResource'] { /** * Create a ProfileResourceFormat. - * @member {object} [attributes] The attributes for the Type. - * @member {object} [description] Localized descriptions for the property. - * @member {object} [displayName] Localized display names for the property. - * @member {object} [localizedAttributes] Any custom localized attributes for - * the Type. - * @member {string} [smallImage] Small Image associated with the Property or - * EntityType. - * @member {string} [mediumImage] Medium Image associated with the Property + * @property {object} [attributes] The attributes for the Type. + * @property {object} [description] Localized descriptions for the property. + * @property {object} [displayName] Localized display names for the property. + * @property {object} [localizedAttributes] Any custom localized attributes + * for the Type. + * @property {string} [smallImage] Small Image associated with the Property * or EntityType. - * @member {string} [largeImage] Large Image associated with the Property or - * EntityType. - * @member {string} [apiEntitySetName] The api entity set name. This becomes - * the odata entity set name for the entity Type being refered in this - * object. - * @member {string} [entityType] Type of entity. Possible values include: + * @property {string} [mediumImage] Medium Image associated with the Property + * or EntityType. + * @property {string} [largeImage] Large Image associated with the Property + * or EntityType. + * @property {string} [apiEntitySetName] The api entity set name. This + * becomes the odata entity set name for the entity Type being referred in + * this object. + * @property {string} [entityType] Type of entity. Possible values include: * 'None', 'Profile', 'Interaction', 'Relationship' - * @member {array} [fields] The properties of the Profile. - * @member {number} [instancesCount] The instance count. - * @member {date} [lastChangedUtc] The last changed time for the type + * @property {array} [fields] The properties of the Profile. + * @property {number} [instancesCount] The instance count. + * @property {date} [lastChangedUtc] The last changed time for the type * definition. - * @member {string} [provisioningState] Provisioning state. Possible values + * @property {string} [provisioningState] Provisioning state. Possible values * include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', * 'HumanIntervention', 'Failed' - * @member {string} [schemaItemTypeLink] The schema org link. This helps ACI - * identify and suggest semantic models. - * @member {string} [tenantId] The hub name. - * @member {string} [timestampFieldName] The timestamp property name. + * @property {string} [schemaItemTypeLink] The schema org link. This helps + * ACI identify and suggest semantic models. + * @property {string} [tenantId] The hub name. + * @property {string} [timestampFieldName] The timestamp property name. * Represents the time when the interaction or profile update happened. - * @member {string} [typeName] The name of the entity. - * @member {array} [strongIds] The strong IDs. + * @property {string} [typeName] The name of the entity. + * @property {array} [strongIds] The strong IDs. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/propertyDefinition.js b/lib/services/customerInsightsManagement/lib/models/propertyDefinition.js index a230706585..706f3e409e 100644 --- a/lib/services/customerInsightsManagement/lib/models/propertyDefinition.js +++ b/lib/services/customerInsightsManagement/lib/models/propertyDefinition.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * Property definition. * @@ -19,32 +17,33 @@ const models = require('./index'); class PropertyDefinition { /** * Create a PropertyDefinition. - * @member {string} [arrayValueSeparator] Array value separator for + * @property {string} [arrayValueSeparator] Array value separator for * properties with isArray set. - * @member {array} [enumValidValues] Describes valid values for an enum + * @property {array} [enumValidValues] Describes valid values for an enum * property. - * @member {string} fieldName Name of the property. - * @member {string} fieldType Type of the property. - * @member {boolean} [isArray] Indicates if the property is actually an array - * of the fieldType above on the data api. - * @member {boolean} [isEnum] Indicates if the property is an enum. - * @member {boolean} [isFlagEnum] Indicates if the property is an flag enum. - * @member {boolean} [isImage] Whether the property is an Image. - * @member {boolean} [isLocalizedString] Whether the property is a localized - * string. - * @member {boolean} [isName] Whether the property is a name or a part of + * @property {string} fieldName Name of the property. + * @property {string} fieldType Type of the property. + * @property {boolean} [isArray] Indicates if the property is actually an + * array of the fieldType above on the data api. + * @property {boolean} [isEnum] Indicates if the property is an enum. + * @property {boolean} [isFlagEnum] Indicates if the property is an flag + * enum. + * @property {boolean} [isImage] Whether the property is an Image. + * @property {boolean} [isLocalizedString] Whether the property is a + * localized string. + * @property {boolean} [isName] Whether the property is a name or a part of * name. - * @member {boolean} [isRequired] Whether property value is required on - * instances, IsRequired field only for Intercation. Profile Instance will + * @property {boolean} [isRequired] Whether property value is required on + * instances, IsRequired field only for Interaction. Profile Instance will * not check for required field. - * @member {string} [propertyId] The ID associated with the property. - * @member {string} [schemaItemPropLink] URL encoded schema.org item prop + * @property {string} [propertyId] The ID associated with the property. + * @property {string} [schemaItemPropLink] URL encoded schema.org item prop * link for the property. - * @member {number} [maxLength] Max length of string. Used only if type is + * @property {number} [maxLength] Max length of string. Used only if type is * string. - * @member {boolean} [isAvailableInGraph] Whether property is available in + * @property {boolean} [isAvailableInGraph] Whether property is available in * graph or not. - * @member {array} [dataSourcePrecedenceRules] This is specific to + * @property {array} [dataSourcePrecedenceRules] This is specific to * interactions modeled as activities. Data sources are used to determine * where data is stored and also in precedence rules. */ diff --git a/lib/services/customerInsightsManagement/lib/models/proxyResource.js b/lib/services/customerInsightsManagement/lib/models/proxyResource.js index 2dfffe906c..59c958627a 100644 --- a/lib/services/customerInsightsManagement/lib/models/proxyResource.js +++ b/lib/services/customerInsightsManagement/lib/models/proxyResource.js @@ -20,9 +20,9 @@ const models = require('./index'); class ProxyResource extends models['BaseResource'] { /** * Create a ProxyResource. - * @member {string} [id] Resource ID. - * @member {string} [name] Resource name. - * @member {string} [type] Resource type. + * @property {string} [id] Resource ID. + * @property {string} [name] Resource name. + * @property {string} [type] Resource type. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/relationshipLinkFieldMapping.js b/lib/services/customerInsightsManagement/lib/models/relationshipLinkFieldMapping.js index 03b68eaf13..298d16a962 100644 --- a/lib/services/customerInsightsManagement/lib/models/relationshipLinkFieldMapping.js +++ b/lib/services/customerInsightsManagement/lib/models/relationshipLinkFieldMapping.js @@ -17,12 +17,12 @@ class RelationshipLinkFieldMapping { /** * Create a RelationshipLinkFieldMapping. - * @member {string} interactionFieldName The field name on the Interaction + * @property {string} interactionFieldName The field name on the Interaction * Type. - * @member {string} [linkType] Link type. Possible values include: + * @property {string} [linkType] Link type. Possible values include: * 'UpdateAlways', 'CopyIfNull' - * @member {string} relationshipFieldName The field name on the Relationship - * metadata. + * @property {string} relationshipFieldName The field name on the + * Relationship metadata. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/relationshipLinkListResult.js b/lib/services/customerInsightsManagement/lib/models/relationshipLinkListResult.js index 3a87bcd57f..386f07f8c2 100644 --- a/lib/services/customerInsightsManagement/lib/models/relationshipLinkListResult.js +++ b/lib/services/customerInsightsManagement/lib/models/relationshipLinkListResult.js @@ -16,7 +16,7 @@ class RelationshipLinkListResult extends Array { /** * Create a RelationshipLinkListResult. - * @member {string} [nextLink] Link to the next set of results. + * @property {string} [nextLink] Link to the next set of results. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/relationshipLinkResourceFormat.js b/lib/services/customerInsightsManagement/lib/models/relationshipLinkResourceFormat.js index 4efe7321d1..5069e35d45 100644 --- a/lib/services/customerInsightsManagement/lib/models/relationshipLinkResourceFormat.js +++ b/lib/services/customerInsightsManagement/lib/models/relationshipLinkResourceFormat.js @@ -20,26 +20,26 @@ const models = require('./index'); class RelationshipLinkResourceFormat extends models['ProxyResource'] { /** * Create a RelationshipLinkResourceFormat. - * @member {object} [displayName] Localized display name for the Relationship - * Link. - * @member {object} [description] Localized descriptions for the Relationship - * Link. - * @member {string} interactionType The InteractionType associated with the + * @property {object} [displayName] Localized display name for the + * Relationship Link. + * @property {object} [description] Localized descriptions for the + * Relationship Link. + * @property {string} interactionType The InteractionType associated with the * Relationship Link. - * @member {string} [linkName] The name of the Relationship Link. - * @member {array} [mappings] The mappings between Interaction and + * @property {string} [linkName] The name of the Relationship Link. + * @property {array} [mappings] The mappings between Interaction and * Relationship fields. - * @member {array} profilePropertyReferences The property references for the - * Profile of the Relationship. - * @member {string} [provisioningState] Provisioning state. Possible values + * @property {array} profilePropertyReferences The property references for + * the Profile of the Relationship. + * @property {string} [provisioningState] Provisioning state. Possible values * include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', * 'HumanIntervention', 'Failed' - * @member {array} relatedProfilePropertyReferences The property references + * @property {array} relatedProfilePropertyReferences The property references * for the Related Profile of the Relationship. - * @member {string} relationshipName The Relationship associated with the + * @property {string} relationshipName The Relationship associated with the * Link. - * @member {string} [relationshipGuidId] The relationship guid id. - * @member {string} [tenantId] The hub name. + * @property {string} [relationshipGuidId] The relationship guid id. + * @property {string} [tenantId] The hub name. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/relationshipListResult.js b/lib/services/customerInsightsManagement/lib/models/relationshipListResult.js index 1e54d54618..3d05b080ad 100644 --- a/lib/services/customerInsightsManagement/lib/models/relationshipListResult.js +++ b/lib/services/customerInsightsManagement/lib/models/relationshipListResult.js @@ -16,7 +16,7 @@ class RelationshipListResult extends Array { /** * Create a RelationshipListResult. - * @member {string} [nextLink] Link to the next set of results. + * @property {string} [nextLink] Link to the next set of results. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/relationshipResourceFormat.js b/lib/services/customerInsightsManagement/lib/models/relationshipResourceFormat.js index 7172f02278..6e14d119a2 100644 --- a/lib/services/customerInsightsManagement/lib/models/relationshipResourceFormat.js +++ b/lib/services/customerInsightsManagement/lib/models/relationshipResourceFormat.js @@ -20,24 +20,24 @@ const models = require('./index'); class RelationshipResourceFormat extends models['ProxyResource'] { /** * Create a RelationshipResourceFormat. - * @member {string} [cardinality] The Relationship Cardinality. Possible + * @property {string} [cardinality] The Relationship Cardinality. Possible * values include: 'OneToOne', 'OneToMany', 'ManyToMany' - * @member {object} [displayName] Localized display name for the + * @property {object} [displayName] Localized display name for the * Relationship. - * @member {object} [description] Localized descriptions for the + * @property {object} [description] Localized descriptions for the * Relationship. - * @member {date} [expiryDateTimeUtc] The expiry date time in UTC. - * @member {array} [fields] The properties of the Relationship. - * @member {array} [lookupMappings] Optional property to be used to map + * @property {date} [expiryDateTimeUtc] The expiry date time in UTC. + * @property {array} [fields] The properties of the Relationship. + * @property {array} [lookupMappings] Optional property to be used to map * fields in profile to their strong ids in related profile. - * @member {string} profileType Profile type. - * @member {string} [provisioningState] Provisioning state. Possible values + * @property {string} profileType Profile type. + * @property {string} [provisioningState] Provisioning state. Possible values * include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', * 'HumanIntervention', 'Failed' - * @member {string} [relationshipName] The Relationship name. - * @member {string} relatedProfileType Related profile being referenced. - * @member {string} [relationshipGuidId] The relationship guid id. - * @member {string} [tenantId] The hub name. + * @property {string} [relationshipName] The Relationship name. + * @property {string} relatedProfileType Related profile being referenced. + * @property {string} [relationshipGuidId] The relationship guid id. + * @property {string} [tenantId] The hub name. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/relationshipTypeFieldMapping.js b/lib/services/customerInsightsManagement/lib/models/relationshipTypeFieldMapping.js index 4754ca0f2a..27f54c2762 100644 --- a/lib/services/customerInsightsManagement/lib/models/relationshipTypeFieldMapping.js +++ b/lib/services/customerInsightsManagement/lib/models/relationshipTypeFieldMapping.js @@ -17,9 +17,9 @@ class RelationshipTypeFieldMapping { /** * Create a RelationshipTypeFieldMapping. - * @member {string} profileFieldName Specifies the fieldName in profile. - * @member {string} relatedProfileKeyProperty Specifies the KeyProperty (from - * StrongId) of the related profile. + * @property {string} profileFieldName Specifies the fieldName in profile. + * @property {string} relatedProfileKeyProperty Specifies the KeyProperty + * (from StrongId) of the related profile. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/relationshipTypeMapping.js b/lib/services/customerInsightsManagement/lib/models/relationshipTypeMapping.js index 45a5d522c8..ea9a83c810 100644 --- a/lib/services/customerInsightsManagement/lib/models/relationshipTypeMapping.js +++ b/lib/services/customerInsightsManagement/lib/models/relationshipTypeMapping.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * Maps fields in Profile to their corresponding StrongIds in Related Profile. * @@ -19,9 +17,9 @@ const models = require('./index'); class RelationshipTypeMapping { /** * Create a RelationshipTypeMapping. - * @member {array} fieldMappings Maps a profile property with the StrongId of - * related profile. This is an array to support StrongIds that are composite - * key as well. + * @property {array} fieldMappings Maps a profile property with the StrongId + * of related profile. This is an array to support StrongIds that are + * composite key as well. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/relationshipsLookup.js b/lib/services/customerInsightsManagement/lib/models/relationshipsLookup.js index 15889fcd0e..993379155f 100644 --- a/lib/services/customerInsightsManagement/lib/models/relationshipsLookup.js +++ b/lib/services/customerInsightsManagement/lib/models/relationshipsLookup.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * The definition of suggested relationship for the type. * @@ -19,13 +17,13 @@ const models = require('./index'); class RelationshipsLookup { /** * Create a RelationshipsLookup. - * @member {string} [profileName] The relationship profile. - * @member {array} [profilePropertyReferences] The property references for + * @property {string} [profileName] The relationship profile. + * @property {array} [profilePropertyReferences] The property references for * the profile type. - * @member {string} [relatedProfileName] The related profile. - * @member {array} [relatedProfilePropertyReferences] The property references - * for the related profile type. - * @member {string} [existingRelationshipName] The name of existing + * @property {string} [relatedProfileName] The related profile. + * @property {array} [relatedProfilePropertyReferences] The property + * references for the related profile type. + * @property {string} [existingRelationshipName] The name of existing * Relationship. */ constructor() { diff --git a/lib/services/customerInsightsManagement/lib/models/resource.js b/lib/services/customerInsightsManagement/lib/models/resource.js index 479f31bc05..479e768342 100644 --- a/lib/services/customerInsightsManagement/lib/models/resource.js +++ b/lib/services/customerInsightsManagement/lib/models/resource.js @@ -20,11 +20,11 @@ const models = require('./index'); class Resource extends models['BaseResource'] { /** * Create a Resource. - * @member {string} [id] Resource ID. - * @member {string} [name] Resource name. - * @member {string} [type] Resource type. - * @member {string} [location] Resource location. - * @member {object} [tags] Resource tags. + * @property {string} [id] Resource ID. + * @property {string} [name] Resource name. + * @property {string} [type] Resource type. + * @property {string} [location] Resource location. + * @property {object} [tags] Resource tags. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/resourceSetDescription.js b/lib/services/customerInsightsManagement/lib/models/resourceSetDescription.js index 9ffd1307ce..595ba8f3a4 100644 --- a/lib/services/customerInsightsManagement/lib/models/resourceSetDescription.js +++ b/lib/services/customerInsightsManagement/lib/models/resourceSetDescription.js @@ -17,8 +17,8 @@ class ResourceSetDescription { /** * Create a ResourceSetDescription. - * @member {array} [elements] The elements included in the set. - * @member {array} [exceptions] The elements that are not included in the + * @property {array} [elements] The elements included in the set. + * @property {array} [exceptions] The elements that are not included in the * set, in case elements contains '*' indicating 'all'. */ constructor() { diff --git a/lib/services/customerInsightsManagement/lib/models/roleAssignmentListResult.js b/lib/services/customerInsightsManagement/lib/models/roleAssignmentListResult.js index de08a4b7b5..0b3188e4a0 100644 --- a/lib/services/customerInsightsManagement/lib/models/roleAssignmentListResult.js +++ b/lib/services/customerInsightsManagement/lib/models/roleAssignmentListResult.js @@ -16,7 +16,7 @@ class RoleAssignmentListResult extends Array { /** * Create a RoleAssignmentListResult. - * @member {string} [nextLink] Link to the next set of results. + * @property {string} [nextLink] Link to the next set of results. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/roleAssignmentResourceFormat.js b/lib/services/customerInsightsManagement/lib/models/roleAssignmentResourceFormat.js index ded1859168..8ed07f5011 100644 --- a/lib/services/customerInsightsManagement/lib/models/roleAssignmentResourceFormat.js +++ b/lib/services/customerInsightsManagement/lib/models/roleAssignmentResourceFormat.js @@ -20,73 +20,76 @@ const models = require('./index'); class RoleAssignmentResourceFormat extends models['ProxyResource'] { /** * Create a RoleAssignmentResourceFormat. - * @member {string} [tenantId] The hub name. - * @member {string} [assignmentName] The name of the metadata object. - * @member {object} [displayName] Localized display names for the metadata. - * @member {object} [description] Localized description for the metadata. - * @member {string} [provisioningState] Provisioning state. Possible values + * @property {string} [tenantId] The hub name. + * @property {string} [assignmentName] The name of the metadata object. + * @property {object} [displayName] Localized display names for the metadata. + * @property {object} [description] Localized description for the metadata. + * @property {string} [provisioningState] Provisioning state. Possible values * include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', * 'HumanIntervention', 'Failed' - * @member {string} role Type of roles. Possible values include: 'Admin', + * @property {string} role Type of roles. Possible values include: 'Admin', * 'Reader', 'ManageAdmin', 'ManageReader', 'DataAdmin', 'DataReader' - * @member {array} principals The principals being assigned to. - * @member {object} [profiles] Profiles set for the assignment. - * @member {array} [profiles.elements] The elements included in the set. - * @member {array} [profiles.exceptions] The elements that are not included + * @property {array} principals The principals being assigned to. + * @property {object} [profiles] Profiles set for the assignment. + * @property {array} [profiles.elements] The elements included in the set. + * @property {array} [profiles.exceptions] The elements that are not included * in the set, in case elements contains '*' indicating 'all'. - * @member {object} [interactions] Interactions set for the assignment. - * @member {array} [interactions.elements] The elements included in the set. - * @member {array} [interactions.exceptions] The elements that are not + * @property {object} [interactions] Interactions set for the assignment. + * @property {array} [interactions.elements] The elements included in the + * set. + * @property {array} [interactions.exceptions] The elements that are not * included in the set, in case elements contains '*' indicating 'all'. - * @member {object} [links] Links set for the assignment. - * @member {array} [links.elements] The elements included in the set. - * @member {array} [links.exceptions] The elements that are not included in + * @property {object} [links] Links set for the assignment. + * @property {array} [links.elements] The elements included in the set. + * @property {array} [links.exceptions] The elements that are not included in * the set, in case elements contains '*' indicating 'all'. - * @member {object} [kpis] Kpis set for the assignment. - * @member {array} [kpis.elements] The elements included in the set. - * @member {array} [kpis.exceptions] The elements that are not included in + * @property {object} [kpis] Kpis set for the assignment. + * @property {array} [kpis.elements] The elements included in the set. + * @property {array} [kpis.exceptions] The elements that are not included in * the set, in case elements contains '*' indicating 'all'. - * @member {object} [sasPolicies] Sas Policies set for the assignment. - * @member {array} [sasPolicies.elements] The elements included in the set. - * @member {array} [sasPolicies.exceptions] The elements that are not + * @property {object} [sasPolicies] Sas Policies set for the assignment. + * @property {array} [sasPolicies.elements] The elements included in the set. + * @property {array} [sasPolicies.exceptions] The elements that are not * included in the set, in case elements contains '*' indicating 'all'. - * @member {object} [connectors] Connectors set for the assignment. - * @member {array} [connectors.elements] The elements included in the set. - * @member {array} [connectors.exceptions] The elements that are not included - * in the set, in case elements contains '*' indicating 'all'. - * @member {object} [views] Views set for the assignment. - * @member {array} [views.elements] The elements included in the set. - * @member {array} [views.exceptions] The elements that are not included in + * @property {object} [connectors] Connectors set for the assignment. + * @property {array} [connectors.elements] The elements included in the set. + * @property {array} [connectors.exceptions] The elements that are not + * included in the set, in case elements contains '*' indicating 'all'. + * @property {object} [views] Views set for the assignment. + * @property {array} [views.elements] The elements included in the set. + * @property {array} [views.exceptions] The elements that are not included in * the set, in case elements contains '*' indicating 'all'. - * @member {object} [relationshipLinks] The Role assignments set for the + * @property {object} [relationshipLinks] The Role assignments set for the * relationship links. - * @member {array} [relationshipLinks.elements] The elements included in the - * set. - * @member {array} [relationshipLinks.exceptions] The elements that are not + * @property {array} [relationshipLinks.elements] The elements included in + * the set. + * @property {array} [relationshipLinks.exceptions] The elements that are not * included in the set, in case elements contains '*' indicating 'all'. - * @member {object} [relationships] The Role assignments set for the + * @property {object} [relationships] The Role assignments set for the * relationships. - * @member {array} [relationships.elements] The elements included in the set. - * @member {array} [relationships.exceptions] The elements that are not + * @property {array} [relationships.elements] The elements included in the + * set. + * @property {array} [relationships.exceptions] The elements that are not * included in the set, in case elements contains '*' indicating 'all'. - * @member {object} [widgetTypes] Widget types set for the assignment. - * @member {array} [widgetTypes.elements] The elements included in the set. - * @member {array} [widgetTypes.exceptions] The elements that are not + * @property {object} [widgetTypes] Widget types set for the assignment. + * @property {array} [widgetTypes.elements] The elements included in the set. + * @property {array} [widgetTypes.exceptions] The elements that are not * included in the set, in case elements contains '*' indicating 'all'. - * @member {object} [roleAssignments] The Role assignments set for the + * @property {object} [roleAssignments] The Role assignments set for the * assignment. - * @member {array} [roleAssignments.elements] The elements included in the - * set. - * @member {array} [roleAssignments.exceptions] The elements that are not - * included in the set, in case elements contains '*' indicating 'all'. - * @member {object} [conflationPolicies] Widget types set for the assignment. - * @member {array} [conflationPolicies.elements] The elements included in the + * @property {array} [roleAssignments.elements] The elements included in the * set. - * @member {array} [conflationPolicies.exceptions] The elements that are not + * @property {array} [roleAssignments.exceptions] The elements that are not * included in the set, in case elements contains '*' indicating 'all'. - * @member {object} [segments] The Role assignments set for the assignment. - * @member {array} [segments.elements] The elements included in the set. - * @member {array} [segments.exceptions] The elements that are not included + * @property {object} [conflationPolicies] Widget types set for the + * assignment. + * @property {array} [conflationPolicies.elements] The elements included in + * the set. + * @property {array} [conflationPolicies.exceptions] The elements that are + * not included in the set, in case elements contains '*' indicating 'all'. + * @property {object} [segments] The Role assignments set for the assignment. + * @property {array} [segments.elements] The elements included in the set. + * @property {array} [segments.exceptions] The elements that are not included * in the set, in case elements contains '*' indicating 'all'. */ constructor() { diff --git a/lib/services/customerInsightsManagement/lib/models/roleListResult.js b/lib/services/customerInsightsManagement/lib/models/roleListResult.js index e1fe0b5cd3..96b225f8c0 100644 --- a/lib/services/customerInsightsManagement/lib/models/roleListResult.js +++ b/lib/services/customerInsightsManagement/lib/models/roleListResult.js @@ -16,7 +16,7 @@ class RoleListResult extends Array { /** * Create a RoleListResult. - * @member {string} [nextLink] Link to the next set of results. + * @property {string} [nextLink] Link to the next set of results. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/roleResourceFormat.js b/lib/services/customerInsightsManagement/lib/models/roleResourceFormat.js index 8bbc8049f7..3249035ed3 100644 --- a/lib/services/customerInsightsManagement/lib/models/roleResourceFormat.js +++ b/lib/services/customerInsightsManagement/lib/models/roleResourceFormat.js @@ -20,8 +20,8 @@ const models = require('./index'); class RoleResourceFormat extends models['ProxyResource'] { /** * Create a RoleResourceFormat. - * @member {string} [roleName] The role name. - * @member {string} [description] The description of the role. + * @property {string} [roleName] The role name. + * @property {string} [description] The description of the role. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/salesforceConnectorProperties.js b/lib/services/customerInsightsManagement/lib/models/salesforceConnectorProperties.js index 944f05bef0..7b0c683b90 100644 --- a/lib/services/customerInsightsManagement/lib/models/salesforceConnectorProperties.js +++ b/lib/services/customerInsightsManagement/lib/models/salesforceConnectorProperties.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * The Salesforce connector properties. * @@ -19,10 +17,10 @@ const models = require('./index'); class SalesforceConnectorProperties { /** * Create a SalesforceConnectorProperties. - * @member {object} usersetting The user settings. - * @member {string} [usersetting.salesforceConnectionStringSecretUrl] The + * @property {object} usersetting The user settings. + * @property {string} [usersetting.salesforceConnectionStringSecretUrl] The * salesforce connection string secret URL. - * @member {array} salesforcetables The Salesforce tables. + * @property {array} salesforcetables The Salesforce tables. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/salesforceDiscoverSetting.js b/lib/services/customerInsightsManagement/lib/models/salesforceDiscoverSetting.js index 07b16c3971..669aae3bf0 100644 --- a/lib/services/customerInsightsManagement/lib/models/salesforceDiscoverSetting.js +++ b/lib/services/customerInsightsManagement/lib/models/salesforceDiscoverSetting.js @@ -17,7 +17,7 @@ class SalesforceDiscoverSetting { /** * Create a SalesforceDiscoverSetting. - * @member {string} salesforceConnectionStringSecretUrl The salesforce + * @property {string} salesforceConnectionStringSecretUrl The salesforce * connection string secret URL. */ constructor() { diff --git a/lib/services/customerInsightsManagement/lib/models/salesforceTable.js b/lib/services/customerInsightsManagement/lib/models/salesforceTable.js index 49f031a873..53ddd9c3b0 100644 --- a/lib/services/customerInsightsManagement/lib/models/salesforceTable.js +++ b/lib/services/customerInsightsManagement/lib/models/salesforceTable.js @@ -17,11 +17,12 @@ class SalesforceTable { /** * Create a SalesforceTable. - * @member {string} [isProfile] Indicating whether this instance is profile. - * @member {string} tableCategory The table category. - * @member {string} tableName The name of the table. - * @member {string} [tableRemarks] The table remarks. - * @member {string} tableSchema The table schema. + * @property {string} [isProfile] Indicating whether this instance is + * profile. + * @property {string} tableCategory The table category. + * @property {string} tableName The name of the table. + * @property {string} [tableRemarks] The table remarks. + * @property {string} tableSchema The table schema. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/strongId.js b/lib/services/customerInsightsManagement/lib/models/strongId.js index c9a8381b84..494baddf88 100644 --- a/lib/services/customerInsightsManagement/lib/models/strongId.js +++ b/lib/services/customerInsightsManagement/lib/models/strongId.js @@ -17,11 +17,11 @@ class StrongId { /** * Create a StrongId. - * @member {array} keyPropertyNames The properties which make up the unique + * @property {array} keyPropertyNames The properties which make up the unique * ID. - * @member {string} strongIdName The Name identifying the strong ID. - * @member {object} [displayName] Localized display name. - * @member {object} [description] Localized descriptions. + * @property {string} strongIdName The Name identifying the strong ID. + * @property {object} [displayName] Localized display name. + * @property {object} [description] Localized descriptions. */ constructor() { } diff --git a/lib/services/customerInsightsManagement/lib/models/suggestRelationshipLinksResponse.js b/lib/services/customerInsightsManagement/lib/models/suggestRelationshipLinksResponse.js index 50c8542ab0..1ca7a6eee9 100644 --- a/lib/services/customerInsightsManagement/lib/models/suggestRelationshipLinksResponse.js +++ b/lib/services/customerInsightsManagement/lib/models/suggestRelationshipLinksResponse.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * The response of suggest relationship links operation. * @@ -19,8 +17,8 @@ const models = require('./index'); class SuggestRelationshipLinksResponse { /** * Create a SuggestRelationshipLinksResponse. - * @member {string} [interactionName] The interaction name. - * @member {array} [suggestedRelationships] Suggested relationships for the + * @property {string} [interactionName] The interaction name. + * @property {array} [suggestedRelationships] Suggested relationships for the * type. */ constructor() { diff --git a/lib/services/customerInsightsManagement/lib/models/typePropertiesMapping.js b/lib/services/customerInsightsManagement/lib/models/typePropertiesMapping.js index d40c6683d9..795c6ddb31 100644 --- a/lib/services/customerInsightsManagement/lib/models/typePropertiesMapping.js +++ b/lib/services/customerInsightsManagement/lib/models/typePropertiesMapping.js @@ -17,11 +17,11 @@ class TypePropertiesMapping { /** * Create a TypePropertiesMapping. - * @member {string} sourcePropertyName Property name on the source Entity + * @property {string} sourcePropertyName Property name on the source Entity * Type. - * @member {string} targetPropertyName Property name on the target Entity + * @property {string} targetPropertyName Property name on the target Entity * Type. - * @member {string} [linkType] Link type. Possible values include: + * @property {string} [linkType] Link type. Possible values include: * 'UpdateAlways', 'CopyIfNull' */ constructor() { diff --git a/lib/services/customerInsightsManagement/lib/models/viewListResult.js b/lib/services/customerInsightsManagement/lib/models/viewListResult.js index 1032cf1bb4..d7890f7c17 100644 --- a/lib/services/customerInsightsManagement/lib/models/viewListResult.js +++ b/lib/services/customerInsightsManagement/lib/models/viewListResult.js @@ -16,7 +16,7 @@ class ViewListResult extends Array { /** * Create a ViewListResult. - * @member {string} [nextLink] Link to the next set of results. + * @property {string} [nextLink] Link to the next set of results. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/viewResourceFormat.js b/lib/services/customerInsightsManagement/lib/models/viewResourceFormat.js index 5748f7fa0f..1353ba0003 100644 --- a/lib/services/customerInsightsManagement/lib/models/viewResourceFormat.js +++ b/lib/services/customerInsightsManagement/lib/models/viewResourceFormat.js @@ -20,13 +20,13 @@ const models = require('./index'); class ViewResourceFormat extends models['ProxyResource'] { /** * Create a ViewResourceFormat. - * @member {string} [viewName] Name of the view. - * @member {string} [userId] the user ID. - * @member {string} [tenantId] the hub name. - * @member {object} [displayName] Localized display name for the view. - * @member {string} definition View definition. - * @member {date} [changed] Date time when view was last modified. - * @member {date} [created] Date time when view was created. + * @property {string} [viewName] Name of the view. + * @property {string} [userId] the user ID. + * @property {string} [tenantId] the hub name. + * @property {object} [displayName] Localized display name for the view. + * @property {string} definition View definition. + * @property {date} [changed] Date time when view was last modified. + * @property {date} [created] Date time when view was created. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/widgetTypeListResult.js b/lib/services/customerInsightsManagement/lib/models/widgetTypeListResult.js index 57e3145785..40bd29a091 100644 --- a/lib/services/customerInsightsManagement/lib/models/widgetTypeListResult.js +++ b/lib/services/customerInsightsManagement/lib/models/widgetTypeListResult.js @@ -16,7 +16,7 @@ class WidgetTypeListResult extends Array { /** * Create a WidgetTypeListResult. - * @member {string} [nextLink] Link to the next set of results. + * @property {string} [nextLink] Link to the next set of results. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/models/widgetTypeResourceFormat.js b/lib/services/customerInsightsManagement/lib/models/widgetTypeResourceFormat.js index c9d54a005b..26d6e3fd3d 100644 --- a/lib/services/customerInsightsManagement/lib/models/widgetTypeResourceFormat.js +++ b/lib/services/customerInsightsManagement/lib/models/widgetTypeResourceFormat.js @@ -20,15 +20,16 @@ const models = require('./index'); class WidgetTypeResourceFormat extends models['ProxyResource'] { /** * Create a WidgetTypeResourceFormat. - * @member {string} [widgetTypeName] Name of the widget type. - * @member {string} definition Definition for widget type. - * @member {string} [description] Description for widget type. - * @member {object} [displayName] Localized display name for the widget type. - * @member {string} [imageUrl] The image URL. - * @member {string} [tenantId] The hub name. - * @member {string} [widgetVersion] The widget version. - * @member {date} [changed] Date time when widget type was last modified. - * @member {date} [created] Date time when widget type was created. + * @property {string} [widgetTypeName] Name of the widget type. + * @property {string} definition Definition for widget type. + * @property {string} [description] Description for widget type. + * @property {object} [displayName] Localized display name for the widget + * type. + * @property {string} [imageUrl] The image URL. + * @property {string} [tenantId] The hub name. + * @property {string} [widgetVersion] The widget version. + * @property {date} [changed] Date time when widget type was last modified. + * @property {date} [created] Date time when widget type was created. */ constructor() { super(); diff --git a/lib/services/customerInsightsManagement/lib/operations/authorizationPolicies.js b/lib/services/customerInsightsManagement/lib/operations/authorizationPolicies.js index bbe6c755a0..26f6115417 100644 --- a/lib/services/customerInsightsManagement/lib/operations/authorizationPolicies.js +++ b/lib/services/customerInsightsManagement/lib/operations/authorizationPolicies.js @@ -29,10 +29,10 @@ const WebResource = msRest.WebResource; * @param {array} parameters.permissions The permissions associated with the * policy. * - * @param {string} [parameters.primaryKey] Primary key assiciated with the + * @param {string} [parameters.primaryKey] Primary key associated with the * policy. * - * @param {string} [parameters.secondaryKey] Secondary key assiciated with the + * @param {string} [parameters.secondaryKey] Secondary key associated with the * policy. * * @param {object} [options] Optional Parameters. @@ -985,10 +985,10 @@ class AuthorizationPolicies { * @param {array} parameters.permissions The permissions associated with the * policy. * - * @param {string} [parameters.primaryKey] Primary key assiciated with the + * @param {string} [parameters.primaryKey] Primary key associated with the * policy. * - * @param {string} [parameters.secondaryKey] Secondary key assiciated with the + * @param {string} [parameters.secondaryKey] Secondary key associated with the * policy. * * @param {object} [options] Optional Parameters. @@ -1031,10 +1031,10 @@ class AuthorizationPolicies { * @param {array} parameters.permissions The permissions associated with the * policy. * - * @param {string} [parameters.primaryKey] Primary key assiciated with the + * @param {string} [parameters.primaryKey] Primary key associated with the * policy. * - * @param {string} [parameters.secondaryKey] Secondary key assiciated with the + * @param {string} [parameters.secondaryKey] Secondary key associated with the * policy. * * @param {object} [options] Optional Parameters. diff --git a/lib/services/customerInsightsManagement/lib/operations/index.d.ts b/lib/services/customerInsightsManagement/lib/operations/index.d.ts index ee86dc3d01..fb33b6ee52 100644 --- a/lib/services/customerInsightsManagement/lib/operations/index.d.ts +++ b/lib/services/customerInsightsManagement/lib/operations/index.d.ts @@ -779,7 +779,7 @@ export interface Profiles { * Property or EntityType. * * @param {string} [parameters.apiEntitySetName] The api entity set name. This - * becomes the odata entity set name for the entity Type being refered in this + * becomes the odata entity set name for the entity Type being referred in this * object. * * @param {string} [parameters.entityType] Type of entity. Possible values @@ -845,7 +845,7 @@ export interface Profiles { * Property or EntityType. * * @param {string} [parameters.apiEntitySetName] The api entity set name. This - * becomes the odata entity set name for the entity Type being refered in this + * becomes the odata entity set name for the entity Type being referred in this * object. * * @param {string} [parameters.entityType] Type of entity. Possible values @@ -1198,7 +1198,7 @@ export interface Profiles { * Property or EntityType. * * @param {string} [parameters.apiEntitySetName] The api entity set name. This - * becomes the odata entity set name for the entity Type being refered in this + * becomes the odata entity set name for the entity Type being referred in this * object. * * @param {string} [parameters.entityType] Type of entity. Possible values @@ -1264,7 +1264,7 @@ export interface Profiles { * Property or EntityType. * * @param {string} [parameters.apiEntitySetName] The api entity set name. This - * becomes the odata entity set name for the entity Type being refered in this + * becomes the odata entity set name for the entity Type being referred in this * object. * * @param {string} [parameters.entityType] Type of entity. Possible values @@ -1483,7 +1483,7 @@ export interface Interactions { * Property or EntityType. * * @param {string} [parameters.apiEntitySetName] The api entity set name. This - * becomes the odata entity set name for the entity Type being refered in this + * becomes the odata entity set name for the entity Type being referred in this * object. * * @param {string} [parameters.entityType] Type of entity. Possible values @@ -1563,7 +1563,7 @@ export interface Interactions { * Property or EntityType. * * @param {string} [parameters.apiEntitySetName] The api entity set name. This - * becomes the odata entity set name for the entity Type being refered in this + * becomes the odata entity set name for the entity Type being referred in this * object. * * @param {string} [parameters.entityType] Type of entity. Possible values @@ -1862,7 +1862,7 @@ export interface Interactions { * Property or EntityType. * * @param {string} [parameters.apiEntitySetName] The api entity set name. This - * becomes the odata entity set name for the entity Type being refered in this + * becomes the odata entity set name for the entity Type being referred in this * object. * * @param {string} [parameters.entityType] Type of entity. Possible values @@ -1942,7 +1942,7 @@ export interface Interactions { * Property or EntityType. * * @param {string} [parameters.apiEntitySetName] The api entity set name. This - * becomes the odata entity set name for the entity Type being refered in this + * becomes the odata entity set name for the entity Type being referred in this * object. * * @param {string} [parameters.entityType] Type of entity. Possible values @@ -3172,10 +3172,10 @@ export interface AuthorizationPolicies { * @param {array} parameters.permissions The permissions associated with the * policy. * - * @param {string} [parameters.primaryKey] Primary key assiciated with the + * @param {string} [parameters.primaryKey] Primary key associated with the * policy. * - * @param {string} [parameters.secondaryKey] Secondary key assiciated with the + * @param {string} [parameters.secondaryKey] Secondary key associated with the * policy. * * @param {object} [options] Optional Parameters. @@ -3206,10 +3206,10 @@ export interface AuthorizationPolicies { * @param {array} parameters.permissions The permissions associated with the * policy. * - * @param {string} [parameters.primaryKey] Primary key assiciated with the + * @param {string} [parameters.primaryKey] Primary key associated with the * policy. * - * @param {string} [parameters.secondaryKey] Secondary key assiciated with the + * @param {string} [parameters.secondaryKey] Secondary key associated with the * policy. * * @param {object} [options] Optional Parameters. @@ -5446,7 +5446,7 @@ export interface Views { * * @param {string} hubName The name of the hub. * - * @param {string} userId The user ID. Use * to retreive hub level views. + * @param {string} userId The user ID. Use * to retrieve hub level views. * * @param {object} [options] Optional Parameters. * @@ -5468,7 +5468,7 @@ export interface Views { * * @param {string} hubName The name of the hub. * - * @param {string} userId The user ID. Use * to retreive hub level views. + * @param {string} userId The user ID. Use * to retrieve hub level views. * * @param {object} [options] Optional Parameters. * @@ -5503,7 +5503,7 @@ export interface Views { /** - * Creates a view or updates an exisiting view in the hub. + * Creates a view or updates an existing view in the hub. * * @param {string} resourceGroupName The name of the resource group. * @@ -5535,7 +5535,7 @@ export interface Views { createOrUpdateWithHttpOperationResponse(resourceGroupName: string, hubName: string, viewName: string, parameters: models.ViewResourceFormat, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Creates a view or updates an exisiting view in the hub. + * Creates a view or updates an existing view in the hub. * * @param {string} resourceGroupName The name of the resource group. * @@ -5594,7 +5594,7 @@ export interface Views { * * @param {string} viewName The name of the view. * - * @param {string} userId The user ID. Use * to retreive hub level view. + * @param {string} userId The user ID. Use * to retrieve hub level view. * * @param {object} [options] Optional Parameters. * @@ -5618,7 +5618,7 @@ export interface Views { * * @param {string} viewName The name of the view. * - * @param {string} userId The user ID. Use * to retreive hub level view. + * @param {string} userId The user ID. Use * to retrieve hub level view. * * @param {object} [options] Optional Parameters. * @@ -5661,7 +5661,7 @@ export interface Views { * * @param {string} viewName The name of the view. * - * @param {string} userId The user ID. Use * to retreive hub level view. + * @param {string} userId The user ID. Use * to retrieve hub level view. * * @param {object} [options] Optional Parameters. * @@ -5685,7 +5685,7 @@ export interface Views { * * @param {string} viewName The name of the view. * - * @param {string} userId The user ID. Use * to retreive hub level view. + * @param {string} userId The user ID. Use * to retrieve hub level view. * * @param {object} [options] Optional Parameters. * @@ -5821,7 +5821,7 @@ export interface Links { * represent the participating profile. * * @param {boolean} [parameters.referenceOnly] Indicating whether the link is - * reference only link. This flag is ingored if the Mappings are defined. If + * reference only link. This flag is ignored if the Mappings are defined. If * the mappings are not defined and it is set to true, links processing will * not create or update profiles. * @@ -5879,7 +5879,7 @@ export interface Links { * represent the participating profile. * * @param {boolean} [parameters.referenceOnly] Indicating whether the link is - * reference only link. This flag is ingored if the Mappings are defined. If + * reference only link. This flag is ignored if the Mappings are defined. If * the mappings are not defined and it is set to true, links processing will * not create or update profiles. * @@ -6140,7 +6140,7 @@ export interface Links { * represent the participating profile. * * @param {boolean} [parameters.referenceOnly] Indicating whether the link is - * reference only link. This flag is ingored if the Mappings are defined. If + * reference only link. This flag is ignored if the Mappings are defined. If * the mappings are not defined and it is set to true, links processing will * not create or update profiles. * @@ -6198,7 +6198,7 @@ export interface Links { * represent the participating profile. * * @param {boolean} [parameters.referenceOnly] Indicating whether the link is - * reference only link. This flag is ingored if the Mappings are defined. If + * reference only link. This flag is ignored if the Mappings are defined. If * the mappings are not defined and it is set to true, links processing will * not create or update profiles. * diff --git a/lib/services/customerInsightsManagement/lib/operations/interactions.js b/lib/services/customerInsightsManagement/lib/operations/interactions.js index 83e69f3827..0087391883 100644 --- a/lib/services/customerInsightsManagement/lib/operations/interactions.js +++ b/lib/services/customerInsightsManagement/lib/operations/interactions.js @@ -48,7 +48,7 @@ const WebResource = msRest.WebResource; * Property or EntityType. * * @param {string} [parameters.apiEntitySetName] The api entity set name. This - * becomes the odata entity set name for the entity Type being refered in this + * becomes the odata entity set name for the entity Type being referred in this * object. * * @param {string} [parameters.entityType] Type of entity. Possible values @@ -655,7 +655,7 @@ function _suggestRelationshipLinks(resourceGroupName, hubName, interactionName, * Property or EntityType. * * @param {string} [parameters.apiEntitySetName] The api entity set name. This - * becomes the odata entity set name for the entity Type being refered in this + * becomes the odata entity set name for the entity Type being referred in this * object. * * @param {string} [parameters.entityType] Type of entity. Possible values @@ -1039,7 +1039,7 @@ class Interactions { * Property or EntityType. * * @param {string} [parameters.apiEntitySetName] The api entity set name. This - * becomes the odata entity set name for the entity Type being refered in this + * becomes the odata entity set name for the entity Type being referred in this * object. * * @param {string} [parameters.entityType] Type of entity. Possible values @@ -1131,7 +1131,7 @@ class Interactions { * Property or EntityType. * * @param {string} [parameters.apiEntitySetName] The api entity set name. This - * becomes the odata entity set name for the entity Type being refered in this + * becomes the odata entity set name for the entity Type being referred in this * object. * * @param {string} [parameters.entityType] Type of entity. Possible values @@ -1526,7 +1526,7 @@ class Interactions { * Property or EntityType. * * @param {string} [parameters.apiEntitySetName] The api entity set name. This - * becomes the odata entity set name for the entity Type being refered in this + * becomes the odata entity set name for the entity Type being referred in this * object. * * @param {string} [parameters.entityType] Type of entity. Possible values @@ -1618,7 +1618,7 @@ class Interactions { * Property or EntityType. * * @param {string} [parameters.apiEntitySetName] The api entity set name. This - * becomes the odata entity set name for the entity Type being refered in this + * becomes the odata entity set name for the entity Type being referred in this * object. * * @param {string} [parameters.entityType] Type of entity. Possible values diff --git a/lib/services/customerInsightsManagement/lib/operations/links.js b/lib/services/customerInsightsManagement/lib/operations/links.js index 07cf6157d0..439a0cacca 100644 --- a/lib/services/customerInsightsManagement/lib/operations/links.js +++ b/lib/services/customerInsightsManagement/lib/operations/links.js @@ -52,7 +52,7 @@ const WebResource = msRest.WebResource; * represent the participating profile. * * @param {boolean} [parameters.referenceOnly] Indicating whether the link is - * reference only link. This flag is ingored if the Mappings are defined. If + * reference only link. This flag is ignored if the Mappings are defined. If * the mappings are not defined and it is set to true, links processing will * not create or update profiles. * @@ -596,7 +596,7 @@ function _listByHub(resourceGroupName, hubName, options, callback) { * represent the participating profile. * * @param {boolean} [parameters.referenceOnly] Indicating whether the link is - * reference only link. This flag is ingored if the Mappings are defined. If + * reference only link. This flag is ignored if the Mappings are defined. If * the mappings are not defined and it is set to true, links processing will * not create or update profiles. * @@ -957,7 +957,7 @@ class Links { * represent the participating profile. * * @param {boolean} [parameters.referenceOnly] Indicating whether the link is - * reference only link. This flag is ingored if the Mappings are defined. If + * reference only link. This flag is ignored if the Mappings are defined. If * the mappings are not defined and it is set to true, links processing will * not create or update profiles. * @@ -1027,7 +1027,7 @@ class Links { * represent the participating profile. * * @param {boolean} [parameters.referenceOnly] Indicating whether the link is - * reference only link. This flag is ingored if the Mappings are defined. If + * reference only link. This flag is ignored if the Mappings are defined. If * the mappings are not defined and it is set to true, links processing will * not create or update profiles. * @@ -1384,7 +1384,7 @@ class Links { * represent the participating profile. * * @param {boolean} [parameters.referenceOnly] Indicating whether the link is - * reference only link. This flag is ingored if the Mappings are defined. If + * reference only link. This flag is ignored if the Mappings are defined. If * the mappings are not defined and it is set to true, links processing will * not create or update profiles. * @@ -1454,7 +1454,7 @@ class Links { * represent the participating profile. * * @param {boolean} [parameters.referenceOnly] Indicating whether the link is - * reference only link. This flag is ingored if the Mappings are defined. If + * reference only link. This flag is ignored if the Mappings are defined. If * the mappings are not defined and it is set to true, links processing will * not create or update profiles. * diff --git a/lib/services/customerInsightsManagement/lib/operations/profiles.js b/lib/services/customerInsightsManagement/lib/operations/profiles.js index 05be916220..a328bdd06a 100644 --- a/lib/services/customerInsightsManagement/lib/operations/profiles.js +++ b/lib/services/customerInsightsManagement/lib/operations/profiles.js @@ -48,7 +48,7 @@ const WebResource = msRest.WebResource; * Property or EntityType. * * @param {string} [parameters.apiEntitySetName] The api entity set name. This - * becomes the odata entity set name for the entity Type being refered in this + * becomes the odata entity set name for the entity Type being referred in this * object. * * @param {string} [parameters.entityType] Type of entity. Possible values @@ -721,7 +721,7 @@ function _getEnrichingKpis(resourceGroupName, hubName, profileName, options, cal * Property or EntityType. * * @param {string} [parameters.apiEntitySetName] The api entity set name. This - * becomes the odata entity set name for the entity Type being refered in this + * becomes the odata entity set name for the entity Type being referred in this * object. * * @param {string} [parameters.entityType] Type of entity. Possible values @@ -1235,7 +1235,7 @@ class Profiles { * Property or EntityType. * * @param {string} [parameters.apiEntitySetName] The api entity set name. This - * becomes the odata entity set name for the entity Type being refered in this + * becomes the odata entity set name for the entity Type being referred in this * object. * * @param {string} [parameters.entityType] Type of entity. Possible values @@ -1313,7 +1313,7 @@ class Profiles { * Property or EntityType. * * @param {string} [parameters.apiEntitySetName] The api entity set name. This - * becomes the odata entity set name for the entity Type being refered in this + * becomes the odata entity set name for the entity Type being referred in this * object. * * @param {string} [parameters.entityType] Type of entity. Possible values @@ -1789,7 +1789,7 @@ class Profiles { * Property or EntityType. * * @param {string} [parameters.apiEntitySetName] The api entity set name. This - * becomes the odata entity set name for the entity Type being refered in this + * becomes the odata entity set name for the entity Type being referred in this * object. * * @param {string} [parameters.entityType] Type of entity. Possible values @@ -1867,7 +1867,7 @@ class Profiles { * Property or EntityType. * * @param {string} [parameters.apiEntitySetName] The api entity set name. This - * becomes the odata entity set name for the entity Type being refered in this + * becomes the odata entity set name for the entity Type being referred in this * object. * * @param {string} [parameters.entityType] Type of entity. Possible values diff --git a/lib/services/customerInsightsManagement/lib/operations/views.js b/lib/services/customerInsightsManagement/lib/operations/views.js index cfa507ecde..05a3006866 100644 --- a/lib/services/customerInsightsManagement/lib/operations/views.js +++ b/lib/services/customerInsightsManagement/lib/operations/views.js @@ -21,7 +21,7 @@ const WebResource = msRest.WebResource; * * @param {string} hubName The name of the hub. * - * @param {string} userId The user ID. Use * to retreive hub level views. + * @param {string} userId The user ID. Use * to retrieve hub level views. * * @param {object} [options] Optional Parameters. * @@ -166,7 +166,7 @@ function _listByHub(resourceGroupName, hubName, userId, options, callback) { } /** - * Creates a view or updates an exisiting view in the hub. + * Creates a view or updates an existing view in the hub. * * @param {string} resourceGroupName The name of the resource group. * @@ -362,7 +362,7 @@ function _createOrUpdate(resourceGroupName, hubName, viewName, parameters, optio * * @param {string} viewName The name of the view. * - * @param {string} userId The user ID. Use * to retreive hub level view. + * @param {string} userId The user ID. Use * to retrieve hub level view. * * @param {object} [options] Optional Parameters. * @@ -519,7 +519,7 @@ function _get(resourceGroupName, hubName, viewName, userId, options, callback) { * * @param {string} viewName The name of the view. * - * @param {string} userId The user ID. Use * to retreive hub level view. + * @param {string} userId The user ID. Use * to retrieve hub level view. * * @param {object} [options] Optional Parameters. * @@ -798,7 +798,7 @@ class Views { * * @param {string} hubName The name of the hub. * - * @param {string} userId The user ID. Use * to retreive hub level views. + * @param {string} userId The user ID. Use * to retrieve hub level views. * * @param {object} [options] Optional Parameters. * @@ -832,7 +832,7 @@ class Views { * * @param {string} hubName The name of the hub. * - * @param {string} userId The user ID. Use * to retreive hub level views. + * @param {string} userId The user ID. Use * to retrieve hub level views. * * @param {object} [options] Optional Parameters. * @@ -882,7 +882,7 @@ class Views { } /** - * Creates a view or updates an exisiting view in the hub. + * Creates a view or updates an existing view in the hub. * * @param {string} resourceGroupName The name of the resource group. * @@ -926,7 +926,7 @@ class Views { } /** - * Creates a view or updates an exisiting view in the hub. + * Creates a view or updates an existing view in the hub. * * @param {string} resourceGroupName The name of the resource group. * @@ -1000,7 +1000,7 @@ class Views { * * @param {string} viewName The name of the view. * - * @param {string} userId The user ID. Use * to retreive hub level view. + * @param {string} userId The user ID. Use * to retrieve hub level view. * * @param {object} [options] Optional Parameters. * @@ -1036,7 +1036,7 @@ class Views { * * @param {string} viewName The name of the view. * - * @param {string} userId The user ID. Use * to retreive hub level view. + * @param {string} userId The user ID. Use * to retrieve hub level view. * * @param {object} [options] Optional Parameters. * @@ -1094,7 +1094,7 @@ class Views { * * @param {string} viewName The name of the view. * - * @param {string} userId The user ID. Use * to retreive hub level view. + * @param {string} userId The user ID. Use * to retrieve hub level view. * * @param {object} [options] Optional Parameters. * @@ -1130,7 +1130,7 @@ class Views { * * @param {string} viewName The name of the view. * - * @param {string} userId The user ID. Use * to retreive hub level view. + * @param {string} userId The user ID. Use * to retrieve hub level view. * * @param {object} [options] Optional Parameters. * diff --git a/lib/services/customerInsightsManagement/package.json b/lib/services/customerInsightsManagement/package.json index 2b99e6ec14..dd32284717 100644 --- a/lib/services/customerInsightsManagement/package.json +++ b/lib/services/customerInsightsManagement/package.json @@ -4,7 +4,7 @@ "description": "CustomerInsightsManagementClient Library with typescript type definitions for node", "version": "3.1.0", "dependencies": { - "ms-rest": "^2.3.2", + "ms-rest": "^2.3.3", "ms-rest-azure": "^2.5.5" }, "keywords": [ @@ -14,12 +14,12 @@ "license": "MIT", "main": "./lib/customerInsightsManagementClient.js", "types": "./lib/customerInsightsManagementClient.d.ts", - "homepage": "http://github.com/azure/azure-sdk-for-node", + "homepage": "https://github.com/azure/azure-sdk-for-node/tree/master/lib/services/customerInsightsManagement", "repository": { "type": "git", "url": "https://github.com/azure/azure-sdk-for-node.git" }, "bugs": { - "url": "http://github.com/Azure/azure-sdk-for-node/issues" + "url": "https://github.com/azure/azure-sdk-for-node/issues" } -} \ No newline at end of file +}