/// <summary>
/// Updates the details of a synonym definition.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms.
/// </summary>
/// <param name="responseFields">Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss.</param>
/// <param name="synonymId">The unique identifier of the synonym definition.</param>
/// <param name="synonymDefinition">The updated synonym definition details.</param>
/// <returns>
/// <see cref="Mozu.Api.MozuClient" />{<see cref="Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition"/>}
/// </returns>
/// <example>
/// <code>
/// var mozuClient=UpdateSynonymDefinition( synonymDefinition, synonymId, responseFields);
/// var synonymDefinitionClient = mozuClient.WithBaseAddress(url).Execute().Result();
/// </code>
/// </example>
public static MozuClient <Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition> UpdateSynonymDefinitionClient(Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition synonymDefinition, int synonymId, string responseFields = null)
{
var url = Mozu.Api.Urls.Commerce.Catalog.Admin.SearchUrl.UpdateSynonymDefinitionUrl(synonymId, responseFields);
const string verb = "PUT";
var mozuClient = new MozuClient <Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition>()
.WithVerb(verb).WithResourceUrl(url)
.WithBody <Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition>(synonymDefinition);
return(mozuClient);
}
/// <summary>
///
/// <example>
/// <code>
/// var result = SearchFactory.UpdateSynonymDefinition(handler : handler, synonymDefinition : synonymDefinition, synonymId : synonymId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode);
/// var optionalCasting = ConvertClass<SynonymDefinition/>(result);
/// return optionalCasting;
/// </code>
/// </example>
/// </summary>
public static Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition UpdateSynonymDefinition(ServiceClientMessageHandler handler,
Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition synonymDefinition, int synonymId, string responseFields = null,
HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK)
{
SetSdKparameters();
var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name;
var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name;
Debug.WriteLine(currentMethodName + '.' + currentMethodName);
var apiClient = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.UpdateSynonymDefinitionClient(
synonymDefinition: synonymDefinition, synonymId: synonymId, responseFields: responseFields);
try
{
apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait();
}
catch (ApiException ex)
{
// Custom error handling for test cases can be placed here
Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode);
if (customException != null)
{
throw customException;
}
return(null);
}
return(ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode)
? (apiClient.Result())
: null);
}
/// <summary>
///
/// </summary>
/// <param name="responseFields">Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss.</param>
/// <param name="synonymId">The unique identifier of the synonym definition.</param>
/// <param name="synonymDefinition">The updated synonym definition details.</param>
/// <returns>
/// <see cref="Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition"/>
/// </returns>
/// <example>
/// <code>
/// var search = new Search();
/// var synonymDefinition = await search.UpdateSynonymDefinitionAsync( synonymDefinition, synonymId, responseFields);
/// </code>
/// </example>
public virtual async Task <Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition> UpdateSynonymDefinitionAsync(Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition synonymDefinition, int synonymId, string responseFields = null, CancellationToken ct = default(CancellationToken))
{
MozuClient <Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition> response;
var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.UpdateSynonymDefinitionClient(synonymDefinition, synonymId, responseFields);
client.WithContext(_apiContext);
response = await client.ExecuteAsync(ct).ConfigureAwait(false);
return(await response.ResultAsync());
}
