/// <summary>
/// Updates a document in a document list.
/// <example>
/// <code>
/// var result = DocumentFactory.UpdateDocument(handler : handler, document : document, documentListName : documentListName, documentId : documentId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode);
/// var optionalCasting = ConvertClass<Document/>(result);
/// return optionalCasting;
/// </code>
/// </example>
/// </summary>
public static Mozu.Api.Contracts.Content.Document UpdateDocument(ServiceClientMessageHandler handler,
Mozu.Api.Contracts.Content.Document document, string documentListName, string documentId, 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.Content.Documentlists.DocumentClient.UpdateDocumentClient(
document: document, documentListName: documentListName, documentId: documentId, responseFields: responseFields);
try
{
apiClient.WithContext(handler.ApiContext).Execute();
}
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);
}
public virtual Mozu.Api.Contracts.Content.Document UpdateDocument(Mozu.Api.Contracts.Content.Document document, string documentListName, string documentId, string responseFields = null)
{
MozuClient <Mozu.Api.Contracts.Content.Document> response;
var client = Mozu.Api.Clients.Content.Documentlists.DocumentClient.UpdateDocumentClient(document, documentListName, documentId, responseFields);
client.WithContext(_apiContext);
response = client.Execute();
return(response.Result());
}
/// <summary>
/// Updates a document in a document list.
/// </summary>
/// <param name="documentId">Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants.</param>
/// <param name="documentListName">Name of content documentListName to delete</param>
/// <param name="responseFields">Use this field to include those fields which are not included by default.</param>
/// <param name="document">The document properties that define the content used by the content management system (CMS).</param>
/// <returns>
/// <see cref="Mozu.Api.Contracts.Content.Document"/>
/// </returns>
/// <example>
/// <code>
/// var document = new Document();
/// var document = await document.UpdateDocumentAsync( document, documentListName, documentId, responseFields);
/// </code>
/// </example>
public virtual async Task <Mozu.Api.Contracts.Content.Document> UpdateDocumentAsync(Mozu.Api.Contracts.Content.Document document, string documentListName, string documentId, string responseFields = null)
{
MozuClient <Mozu.Api.Contracts.Content.Document> response;
var client = Mozu.Api.Clients.Content.Documentlists.DocumentClient.UpdateDocumentClient(document, documentListName, documentId, responseFields);
client.WithContext(_apiContext);
response = await client.ExecuteAsync();
return(await response.ResultAsync());
}
/// <summary>
/// Updates a document in a document list.
/// </summary>
/// <param name="documentId">Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants.</param>
/// <param name="documentListName">Name of content documentListName to delete</param>
/// <param name="responseFields">Use this field to include those fields which are not included by default.</param>
/// <param name="document">The document properties that define the content used by the content management system (CMS).</param>
/// <returns>
/// <see cref="Mozu.Api.MozuClient" />{<see cref="Mozu.Api.Contracts.Content.Document"/>}
/// </returns>
/// <example>
/// <code>
/// var mozuClient=UpdateDocument( document, documentListName, documentId, responseFields);
/// var documentClient = mozuClient.WithBaseAddress(url).Execute().Result();
/// </code>
/// </example>
public static MozuClient <Mozu.Api.Contracts.Content.Document> UpdateDocumentClient(Mozu.Api.Contracts.Content.Document document, string documentListName, string documentId, string responseFields = null)
{
var url = Mozu.Api.Urls.Content.Documentlists.DocumentUrl.UpdateDocumentUrl(documentListName, documentId, responseFields);
const string verb = "PUT";
var mozuClient = new MozuClient <Mozu.Api.Contracts.Content.Document>()
.WithVerb(verb).WithResourceUrl(url)
.WithBody <Mozu.Api.Contracts.Content.Document>(document);
return(mozuClient);
}
/// <summary>
/// Creates a new document in an defined document list.
/// </summary>
/// <param name="documentListName">Name of content documentListName to delete</param>
/// <param name="responseFields">Use this field to include those fields which are not included by default.</param>
/// <param name="document">The document properties that define the content used by the content management system (CMS).</param>
/// <returns>
/// <see cref="Mozu.Api.MozuClient" />{<see cref="Mozu.Api.Contracts.Content.Document"/>}
/// </returns>
/// <example>
/// <code>
/// var mozuClient=CreateDocument(dataViewMode, document, documentListName, responseFields);
/// var documentClient = mozuClient.WithBaseAddress(url).Execute().Result();
/// </code>
/// </example>
public static MozuClient <Mozu.Api.Contracts.Content.Document> CreateDocumentClient(DataViewMode dataViewMode, Mozu.Api.Contracts.Content.Document document, string documentListName, string responseFields = null)
{
var url = Mozu.Api.Urls.Content.Documentlists.DocumentUrl.CreateDocumentUrl(documentListName, responseFields);
const string verb = "POST";
var mozuClient = new MozuClient <Mozu.Api.Contracts.Content.Document>()
.WithVerb(verb).WithResourceUrl(url)
.WithBody <Mozu.Api.Contracts.Content.Document>(document).WithHeader(Headers.X_VOL_DATAVIEW_MODE, dataViewMode.ToString())
;
return(mozuClient);
}
/// <summary>
///
/// </summary>
/// <param name="documentId">Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants.</param>
/// <param name="documentListName">Name of content documentListName to delete</param>
/// <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="document">The document properties that define the content used by the content management system (CMS).</param>
/// <returns>
/// <see cref="Mozu.Api.Contracts.Content.Document"/>
/// </returns>
/// <example>
/// <code>
/// var document = new Document();
/// var document = await document.UpdateDocumentAsync( document, documentListName, documentId, responseFields);
/// </code>
/// </example>
public virtual async Task <Mozu.Api.Contracts.Content.Document> UpdateDocumentAsync(Mozu.Api.Contracts.Content.Document document, string documentListName, string documentId, string responseFields = null, CancellationToken ct = default(CancellationToken))
{
MozuClient <Mozu.Api.Contracts.Content.Document> response;
var client = Mozu.Api.Clients.Content.Documentlists.DocumentClient.UpdateDocumentClient(document, documentListName, documentId, responseFields);
client.WithContext(_apiContext);
response = await client.ExecuteAsync(ct).ConfigureAwait(false);
return(await response.ResultAsync());
}
