@azure/arm-customerinsights package

Classes

CustomerInsightsManagementClient

Interfaces

AssignmentPrincipal

The AssignmentPrincipal

AuthorizationPolicies

Interface representing a AuthorizationPolicies.

AuthorizationPoliciesCreateOrUpdateOptionalParams

Optional parameters.

AuthorizationPoliciesGetOptionalParams

Optional parameters.

AuthorizationPoliciesListByHubNextOptionalParams

Optional parameters.

AuthorizationPoliciesListByHubOptionalParams

Optional parameters.

AuthorizationPoliciesRegeneratePrimaryKeyOptionalParams

Optional parameters.

AuthorizationPoliciesRegenerateSecondaryKeyOptionalParams

Optional parameters.

AuthorizationPolicy

The authorization policy.

AuthorizationPolicyListResult

The response of list authorization policy operation.

AuthorizationPolicyResourceFormat

The authorization policy resource format.

AzureBlobConnectorProperties

The Azure Blob connector properties.

CanonicalProfileDefinition

Definition of canonical profile.

CanonicalProfileDefinitionPropertiesItem

The definition of a canonical profile property.

ConnectorListResult

The response of list connector operation.

ConnectorMappingAvailability

Connector mapping property availability.

ConnectorMappingCompleteOperation

The complete operation.

ConnectorMappingErrorManagement

The error management.

ConnectorMappingFormat

Connector mapping property format.

ConnectorMappingListResult

The response of list connector mapping operation.

ConnectorMappingProperties

The connector mapping properties.

ConnectorMappingResourceFormat

The connector mapping resource format.

ConnectorMappingStructure

Connector mapping property structure.

ConnectorMappings

Interface representing a ConnectorMappings.

ConnectorMappingsCreateOrUpdateOptionalParams

Optional parameters.

ConnectorMappingsDeleteOptionalParams

Optional parameters.

ConnectorMappingsGetOptionalParams

Optional parameters.

ConnectorMappingsListByConnectorNextOptionalParams

Optional parameters.

ConnectorMappingsListByConnectorOptionalParams

Optional parameters.

ConnectorResourceFormat

The connector resource format.

Connectors

Interface representing a Connectors.

ConnectorsCreateOrUpdateOptionalParams

Optional parameters.

ConnectorsDeleteOptionalParams

Optional parameters.

ConnectorsGetOptionalParams

Optional parameters.

ConnectorsListByHubNextOptionalParams

Optional parameters.

ConnectorsListByHubOptionalParams

Optional parameters.

CrmConnectorEntities

The CRM connector entities.

CrmConnectorProperties

The CRM connector properties.

CustomerInsightsManagementClientOptionalParams

Optional parameters.

DataSourcePrecedence

The data source precedence is a way to know the precedence of each data source.

EnrichingKpi

The enriching KPI definition.

EntityTypeDefinition

Describes an entity.

GetImageUploadUrlInput

Input type for getting image upload url.

Hub

Hub resource.

HubBillingInfoFormat

Hub billing info.

HubListResult

Response of list hub operation.

Hubs

Interface representing a Hubs.

HubsCreateOrUpdateOptionalParams

Optional parameters.

HubsDeleteOptionalParams

Optional parameters.

HubsGetOptionalParams

Optional parameters.

HubsListByResourceGroupNextOptionalParams

Optional parameters.

HubsListByResourceGroupOptionalParams

Optional parameters.

HubsListNextOptionalParams

Optional parameters.

HubsListOptionalParams

Optional parameters.

HubsUpdateOptionalParams

Optional parameters.

ImageDefinition

The image definition.

Images

Interface representing a Images.

ImagesGetUploadUrlForDataOptionalParams

Optional parameters.

ImagesGetUploadUrlForEntityTypeOptionalParams

Optional parameters.

InteractionListResult

The response of list interaction operation.

InteractionResourceFormat

The interaction resource format.

InteractionTypeDefinition

The Interaction Type Definition

Interactions

Interface representing a Interactions.

InteractionsCreateOrUpdateOptionalParams

Optional parameters.

InteractionsGetOptionalParams

Optional parameters.

InteractionsListByHubNextOptionalParams

Optional parameters.

InteractionsListByHubOptionalParams

Optional parameters.

InteractionsSuggestRelationshipLinksOptionalParams

Optional parameters.

Kpi

Interface representing a Kpi.

KpiAlias

The KPI alias.

KpiCreateOrUpdateOptionalParams

Optional parameters.

KpiDefinition

Defines the KPI Threshold limits.

KpiDeleteOptionalParams

Optional parameters.

KpiExtract

The KPI extract.

KpiGetOptionalParams

Optional parameters.

KpiGroupByMetadata

The KPI GroupBy field metadata.

KpiListByHubNextOptionalParams

Optional parameters.

KpiListByHubOptionalParams

Optional parameters.

KpiListResult

The response of list KPI operation.

KpiParticipantProfilesMetadata

The KPI participant profile metadata.

KpiReprocessOptionalParams

Optional parameters.

KpiResourceFormat

The KPI resource format.

KpiThresholds

Defines the KPI Threshold limits.

LinkListResult

The response of list link operation.

LinkResourceFormat

The link resource format.

Links

Interface representing a Links.

LinksCreateOrUpdateOptionalParams

Optional parameters.

LinksDeleteOptionalParams

Optional parameters.

LinksGetOptionalParams

Optional parameters.

LinksListByHubNextOptionalParams

Optional parameters.

LinksListByHubOptionalParams

Optional parameters.

MetadataDefinitionBase

The Metadata definition base.

Operation

A Customer Insights REST API operation

OperationDisplay

The object that represents the operation.

OperationListResult

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.

Operations

Interface representing a Operations.

OperationsListNextOptionalParams

Optional parameters.

OperationsListOptionalParams

Optional parameters.

Participant

Describes a profile type participating in an interaction.

ParticipantProfilePropertyReference

The participant profile property reference.

ParticipantPropertyReference

The participant property reference.

PredictionDistributionDefinition

The definition of the prediction distribution.

PredictionDistributionDefinitionDistributionsItem

The definition of a prediction distribution.

PredictionGradesItem

The definition of a prediction grade.

PredictionListResult

The response of list predictions operation.

PredictionMappings

Definition of the link mapping of prediction.

PredictionModelStatus

The prediction model status.

PredictionResourceFormat

The prediction resource format.

PredictionSystemGeneratedEntities

System generated entities.

PredictionTrainingResults

The training results of the prediction.

Predictions

Interface representing a Predictions.

PredictionsCreateOrUpdateOptionalParams

Optional parameters.

PredictionsDeleteOptionalParams

Optional parameters.

PredictionsGetModelStatusOptionalParams

Optional parameters.

PredictionsGetOptionalParams

Optional parameters.

PredictionsGetTrainingResultsOptionalParams

Optional parameters.

PredictionsListByHubNextOptionalParams

Optional parameters.

PredictionsListByHubOptionalParams

Optional parameters.

PredictionsModelStatusOptionalParams

Optional parameters.

ProfileEnumValidValuesFormat

Valid enum values in case of an enum property.

ProfileListResult

The response of list profile operation.

ProfileResourceFormat

The profile resource format.

ProfileTypeDefinition

The profile type definition.

Profiles

Interface representing a Profiles.

ProfilesCreateOrUpdateOptionalParams

Optional parameters.

ProfilesDeleteOptionalParams

Optional parameters.

ProfilesGetEnrichingKpisOptionalParams

Optional parameters.

ProfilesGetOptionalParams

Optional parameters.

ProfilesListByHubNextOptionalParams

Optional parameters.

ProfilesListByHubOptionalParams

Optional parameters.

PropertyDefinition

Property definition.

ProxyResource

Common properties of proxy resource.

RelationshipLinkFieldMapping

The fields mapping for Relationships.

RelationshipLinkListResult

The response of list relationship link operation.

RelationshipLinkResourceFormat

The relationship link resource format.

RelationshipLinks

Interface representing a RelationshipLinks.

RelationshipLinksCreateOrUpdateOptionalParams

Optional parameters.

RelationshipLinksDeleteOptionalParams

Optional parameters.

RelationshipLinksGetOptionalParams

Optional parameters.

RelationshipLinksListByHubNextOptionalParams

Optional parameters.

RelationshipLinksListByHubOptionalParams

Optional parameters.

RelationshipListResult

The response of list relationship operation.

RelationshipResourceFormat

The relationship resource format.

RelationshipTypeFieldMapping

Map a field of profile to its corresponding StrongId in Related Profile.

RelationshipTypeMapping

Maps fields in Profile to their corresponding StrongIds in Related Profile.

Relationships

Interface representing a Relationships.

RelationshipsCreateOrUpdateOptionalParams

Optional parameters.

RelationshipsDeleteOptionalParams

Optional parameters.

RelationshipsGetOptionalParams

Optional parameters.

RelationshipsListByHubNextOptionalParams

Optional parameters.

RelationshipsListByHubOptionalParams

Optional parameters.

RelationshipsLookup

The definition of suggested relationship for the type.

Resource

Common properties of Azure resource.

ResourceSetDescription

The resource set description.

RoleAssignmentListResult

The response of list role assignment operation.

RoleAssignmentResourceFormat

The Role Assignment resource format.

RoleAssignments

Interface representing a RoleAssignments.

RoleAssignmentsCreateOrUpdateOptionalParams

Optional parameters.

RoleAssignmentsDeleteOptionalParams

Optional parameters.

RoleAssignmentsGetOptionalParams

Optional parameters.

RoleAssignmentsListByHubNextOptionalParams

Optional parameters.

RoleAssignmentsListByHubOptionalParams

Optional parameters.

RoleListResult

The response of list role assignment operation.

RoleResourceFormat

The role resource format.

Roles

Interface representing a Roles.

RolesListByHubNextOptionalParams

Optional parameters.

RolesListByHubOptionalParams

Optional parameters.

SalesforceConnectorProperties

The Salesforce connector properties.

SalesforceDiscoverSetting

Salesforce discover setting.

SalesforceTable

Salesforce table.

StrongId

Property/Properties which represent a unique ID.

SuggestRelationshipLinksResponse

The response of suggest relationship links operation.

TypePropertiesMapping

Metadata for a Link's property mapping.

ViewListResult

The response of list view operation.

ViewResourceFormat

The view resource format.

Views

Interface representing a Views.

ViewsCreateOrUpdateOptionalParams

Optional parameters.

ViewsDeleteOptionalParams

Optional parameters.

ViewsGetOptionalParams

Optional parameters.

ViewsListByHubNextOptionalParams

Optional parameters.

ViewsListByHubOptionalParams

Optional parameters.

WidgetTypeListResult

The response of list widget type operation.

WidgetTypeResourceFormat

The WidgetTypeResourceFormat

WidgetTypes

Interface representing a WidgetTypes.

WidgetTypesGetOptionalParams

Optional parameters.

WidgetTypesListByHubNextOptionalParams

Optional parameters.

WidgetTypesListByHubOptionalParams

Optional parameters.

Type Aliases

AuthorizationPoliciesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

AuthorizationPoliciesGetResponse

Contains response data for the get operation.

AuthorizationPoliciesListByHubNextResponse

Contains response data for the listByHubNext operation.

AuthorizationPoliciesListByHubResponse

Contains response data for the listByHub operation.

AuthorizationPoliciesRegeneratePrimaryKeyResponse

Contains response data for the regeneratePrimaryKey operation.

AuthorizationPoliciesRegenerateSecondaryKeyResponse

Contains response data for the regenerateSecondaryKey operation.

CalculationWindowTypes

Defines values for CalculationWindowTypes.

CanonicalPropertyValueType

Defines values for CanonicalPropertyValueType.
KnownCanonicalPropertyValueType can be used interchangeably with CanonicalPropertyValueType, this enum contains the known values that the service supports.

Known values supported by the service

Numeric
Categorical
DerivedCategorical
DerivedNumeric

CardinalityTypes

Defines values for CardinalityTypes.

CompletionOperationTypes

Defines values for CompletionOperationTypes.

ConnectorMappingStates

Defines values for ConnectorMappingStates.

ConnectorMappingsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ConnectorMappingsGetResponse

Contains response data for the get operation.

ConnectorMappingsListByConnectorNextResponse

Contains response data for the listByConnectorNext operation.

ConnectorMappingsListByConnectorResponse

Contains response data for the listByConnector operation.

ConnectorStates

Defines values for ConnectorStates.

ConnectorTypes

Defines values for ConnectorTypes.
KnownConnectorTypes can be used interchangeably with ConnectorTypes, this enum contains the known values that the service supports.

Known values supported by the service

None
CRM
AzureBlob
Salesforce
ExchangeOnline
Outbound

ConnectorsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ConnectorsGetResponse

Contains response data for the get operation.

ConnectorsListByHubNextResponse

Contains response data for the listByHubNext operation.

ConnectorsListByHubResponse

Contains response data for the listByHub operation.

DataSourceType

Defines values for DataSourceType.
KnownDataSourceType can be used interchangeably with DataSourceType, this enum contains the known values that the service supports.

Known values supported by the service

Connector
LinkInteraction
SystemDefault

EntityType

Defines values for EntityType.

EntityTypes

Defines values for EntityTypes.

ErrorManagementTypes

Defines values for ErrorManagementTypes.

FrequencyTypes

Defines values for FrequencyTypes.

HubsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

HubsGetResponse

Contains response data for the get operation.

HubsListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

HubsListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

HubsListNextResponse

Contains response data for the listNext operation.

HubsListResponse

Contains response data for the list operation.

HubsUpdateResponse

Contains response data for the update operation.

ImagesGetUploadUrlForDataResponse

Contains response data for the getUploadUrlForData operation.

ImagesGetUploadUrlForEntityTypeResponse

Contains response data for the getUploadUrlForEntityType operation.

InstanceOperationType

Defines values for InstanceOperationType.

InteractionsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

InteractionsGetResponse

Contains response data for the get operation.

InteractionsListByHubNextResponse

Contains response data for the listByHubNext operation.

InteractionsListByHubResponse

Contains response data for the listByHub operation.

InteractionsSuggestRelationshipLinksResponse

Contains response data for the suggestRelationshipLinks operation.

KpiCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

KpiFunctions

Defines values for KpiFunctions.

KpiGetResponse

Contains response data for the get operation.

KpiListByHubNextResponse

Contains response data for the listByHubNext operation.

KpiListByHubResponse

Contains response data for the listByHub operation.

LinkTypes

Defines values for LinkTypes.

LinksCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

LinksGetResponse

Contains response data for the get operation.

LinksListByHubNextResponse

Contains response data for the listByHubNext operation.

LinksListByHubResponse

Contains response data for the listByHub operation.

OperationsListNextResponse

Contains response data for the listNext operation.

OperationsListResponse

Contains response data for the list operation.

PermissionTypes

Defines values for PermissionTypes.

PredictionModelLifeCycle

Defines values for PredictionModelLifeCycle.
KnownPredictionModelLifeCycle can be used interchangeably with PredictionModelLifeCycle, this enum contains the known values that the service supports.

Known values supported by the service

New
Provisioning
ProvisioningFailed
PendingDiscovering
Discovering
PendingFeaturing
Featuring
FeaturingFailed
PendingTraining
Training
TrainingFailed
Evaluating
EvaluatingFailed
PendingModelConfirmation
Active
Deleted
HumanIntervention
Failed

PredictionsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

PredictionsGetModelStatusResponse

Contains response data for the getModelStatus operation.

PredictionsGetResponse

Contains response data for the get operation.

PredictionsGetTrainingResultsResponse

Contains response data for the getTrainingResults operation.

PredictionsListByHubNextResponse

Contains response data for the listByHubNext operation.

PredictionsListByHubResponse

Contains response data for the listByHub operation.

ProfilesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ProfilesGetEnrichingKpisResponse

Contains response data for the getEnrichingKpis operation.

ProfilesGetResponse

Contains response data for the get operation.

ProfilesListByHubNextResponse

Contains response data for the listByHubNext operation.

ProfilesListByHubResponse

Contains response data for the listByHub operation.

ProvisioningStates

Defines values for ProvisioningStates.
KnownProvisioningStates can be used interchangeably with ProvisioningStates, this enum contains the known values that the service supports.

Known values supported by the service

Provisioning
Succeeded
Expiring
Deleting
HumanIntervention
Failed

RelationshipLinksCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

RelationshipLinksGetResponse

Contains response data for the get operation.

RelationshipLinksListByHubNextResponse

Contains response data for the listByHubNext operation.

RelationshipLinksListByHubResponse

Contains response data for the listByHub operation.

RelationshipsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

RelationshipsGetResponse

Contains response data for the get operation.

RelationshipsListByHubNextResponse

Contains response data for the listByHubNext operation.

RelationshipsListByHubResponse

Contains response data for the listByHub operation.

RoleAssignmentsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

RoleAssignmentsGetResponse

Contains response data for the get operation.

RoleAssignmentsListByHubNextResponse

Contains response data for the listByHubNext operation.

RoleAssignmentsListByHubResponse

Contains response data for the listByHub operation.

RoleTypes

Defines values for RoleTypes.

RolesListByHubNextResponse

Contains response data for the listByHubNext operation.

RolesListByHubResponse

Contains response data for the listByHub operation.

Status

Defines values for Status.
KnownStatus can be used interchangeably with Status, this enum contains the known values that the service supports.

Known values supported by the service

None
Active
Deleted

ViewsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ViewsGetResponse

Contains response data for the get operation.

ViewsListByHubNextResponse

Contains response data for the listByHubNext operation.

ViewsListByHubResponse

Contains response data for the listByHub operation.

WidgetTypesGetResponse

Contains response data for the get operation.

WidgetTypesListByHubNextResponse

Contains response data for the listByHubNext operation.

WidgetTypesListByHubResponse

Contains response data for the listByHub operation.

Enums

KnownCanonicalPropertyValueType

Known values of CanonicalPropertyValueType that the service accepts.

KnownConnectorTypes

Known values of ConnectorTypes that the service accepts.

KnownDataSourceType

Known values of DataSourceType that the service accepts.

KnownPredictionModelLifeCycle

Known values of PredictionModelLifeCycle that the service accepts.

KnownProvisioningStates

Known values of ProvisioningStates that the service accepts.

KnownStatus

Known values of Status that the service accepts.

Functions

getContinuationToken(unknown)

Given a result page from a pageable operation, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given a result page from a pageable operation, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

A result object from calling .byPage() on a paged operation.

Returns

string | undefined

The continuation token that can be passed into byPage().