Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Searches for profiles within a specific domain using one or more
predefined search keys (e.g., _fullName, _phone, _email, _account, etc.)
and/or custom-defined search keys. A search key is a data type pair
that consists of a KeyName
and Values
list.
This operation supports searching for profiles with a minimum of 1
key-value(s) pair and up to 5 key-value(s) pairs using either AND
or
OR
logic.
Synopsis
- data SearchProfiles = SearchProfiles' {}
- newSearchProfiles :: Text -> Text -> SearchProfiles
- searchProfiles_additionalSearchKeys :: Lens' SearchProfiles (Maybe (NonEmpty AdditionalSearchKey))
- searchProfiles_logicalOperator :: Lens' SearchProfiles (Maybe LogicalOperator)
- searchProfiles_maxResults :: Lens' SearchProfiles (Maybe Natural)
- searchProfiles_nextToken :: Lens' SearchProfiles (Maybe Text)
- searchProfiles_domainName :: Lens' SearchProfiles Text
- searchProfiles_keyName :: Lens' SearchProfiles Text
- searchProfiles_values :: Lens' SearchProfiles [Text]
- data SearchProfilesResponse = SearchProfilesResponse' {}
- newSearchProfilesResponse :: Int -> SearchProfilesResponse
- searchProfilesResponse_items :: Lens' SearchProfilesResponse (Maybe [Profile])
- searchProfilesResponse_nextToken :: Lens' SearchProfilesResponse (Maybe Text)
- searchProfilesResponse_httpStatus :: Lens' SearchProfilesResponse Int
Creating a Request
data SearchProfiles Source #
See: newSearchProfiles
smart constructor.
SearchProfiles' | |
|
Instances
Create a value of SearchProfiles
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:additionalSearchKeys:SearchProfiles'
, searchProfiles_additionalSearchKeys
- A list of AdditionalSearchKey
objects that are each searchable
identifiers of a profile. Each AdditionalSearchKey
object contains a
KeyName
and a list of Values
associated with that specific key
(i.e., a key-value(s) pair). These additional search keys will be used
in conjunction with the LogicalOperator
and the required KeyName
and
Values
parameters to search for profiles that satisfy the search
criteria.
$sel:logicalOperator:SearchProfiles'
, searchProfiles_logicalOperator
- Relationship between all specified search keys that will be used to
search for profiles. This includes the required KeyName
and Values
parameters as well as any key-value(s) pairs specified in the
AdditionalSearchKeys
list.
This parameter influences which profiles will be returned in the response in the following manner:
AND
- The response only includes profiles that match all of the search keys.OR
- The response includes profiles that match at least one of the search keys.
The OR
relationship is the default behavior if this parameter is not
included in the request.
$sel:maxResults:SearchProfiles'
, searchProfiles_maxResults
- The maximum number of objects returned per page.
The default is 20 if this parameter is not included in the request.
SearchProfiles
, searchProfiles_nextToken
- The pagination token from the previous SearchProfiles API call.
SearchProfiles
, searchProfiles_domainName
- The unique name of the domain.
SearchProfiles
, searchProfiles_keyName
- A searchable identifier of a customer profile. The predefined keys you
can use to search include: _account, _profileId, _assetId, _caseId,
_orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId,
_salesforceAccountId, _salesforceContactId, _salesforceAssetId,
_zendeskUserId, _zendeskExternalId, _zendeskTicketId,
_serviceNowSystemId, _serviceNowIncidentId, _segmentUserId,
_shopifyCustomerId, _shopifyOrderId.
SearchProfiles
, searchProfiles_values
- A list of key values.
Request Lenses
searchProfiles_additionalSearchKeys :: Lens' SearchProfiles (Maybe (NonEmpty AdditionalSearchKey)) Source #
A list of AdditionalSearchKey
objects that are each searchable
identifiers of a profile. Each AdditionalSearchKey
object contains a
KeyName
and a list of Values
associated with that specific key
(i.e., a key-value(s) pair). These additional search keys will be used
in conjunction with the LogicalOperator
and the required KeyName
and
Values
parameters to search for profiles that satisfy the search
criteria.
searchProfiles_logicalOperator :: Lens' SearchProfiles (Maybe LogicalOperator) Source #
Relationship between all specified search keys that will be used to
search for profiles. This includes the required KeyName
and Values
parameters as well as any key-value(s) pairs specified in the
AdditionalSearchKeys
list.
This parameter influences which profiles will be returned in the response in the following manner:
AND
- The response only includes profiles that match all of the search keys.OR
- The response includes profiles that match at least one of the search keys.
The OR
relationship is the default behavior if this parameter is not
included in the request.
searchProfiles_maxResults :: Lens' SearchProfiles (Maybe Natural) Source #
The maximum number of objects returned per page.
The default is 20 if this parameter is not included in the request.
searchProfiles_nextToken :: Lens' SearchProfiles (Maybe Text) Source #
The pagination token from the previous SearchProfiles API call.
searchProfiles_domainName :: Lens' SearchProfiles Text Source #
The unique name of the domain.
searchProfiles_keyName :: Lens' SearchProfiles Text Source #
A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.
searchProfiles_values :: Lens' SearchProfiles [Text] Source #
A list of key values.
Destructuring the Response
data SearchProfilesResponse Source #
See: newSearchProfilesResponse
smart constructor.
Instances
newSearchProfilesResponse Source #
Create a value of SearchProfilesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:items:SearchProfilesResponse'
, searchProfilesResponse_items
- The list of Profiles matching the search criteria.
SearchProfiles
, searchProfilesResponse_nextToken
- The pagination token from the previous SearchProfiles API call.
$sel:httpStatus:SearchProfilesResponse'
, searchProfilesResponse_httpStatus
- The response's http status code.
Response Lenses
searchProfilesResponse_items :: Lens' SearchProfilesResponse (Maybe [Profile]) Source #
The list of Profiles matching the search criteria.
searchProfilesResponse_nextToken :: Lens' SearchProfilesResponse (Maybe Text) Source #
The pagination token from the previous SearchProfiles API call.
searchProfilesResponse_httpStatus :: Lens' SearchProfilesResponse Int Source #
The response's http status code.