Merge remote-tracking branch 'origin/master' into release

package.json

@@ -1,6 +1,6 @@
 {
  "name": "asposewordscloud",
- "version": "23.9.0",
+ "version": "23.10.0",
  "description": "Aspose.Words Cloud SDK for Node.js",
  "homepage": "https://products.aspose.cloud/words/cloud",
  "author": {

src/api.ts

@@ -340,6 +340,7 @@ export class WordsApi implements Encryptor {
  }
 
  /**
+ * Compress and resize images inside the document.
  * The default settings allows to reduce the size of the document without any visible degradation of images quality.
  * @param requestObj contains request parameters
  */
@@ -359,6 +360,7 @@ export class WordsApi implements Encryptor {
 
  /**
  * Compress and resize images inside the document.
+ * The default settings allows to reduce the size of the document without any visible degradation of images quality.
  * @param requestObj contains request parameters
  */
  public async compressDocumentOnline(requestObj: model.CompressDocumentOnlineRequest): Promise< model.WordsIncomingMessage< model.CompressDocumentOnlineResponse > > {
@@ -478,6 +480,7 @@ export class WordsApi implements Encryptor {
  }
 
  /**
+ * Creates a new document in cloud storage in the format, determined by the file extension.
  * Supported all save format extensions.
  * @param requestObj contains request parameters
  */
@@ -649,6 +652,7 @@ export class WordsApi implements Encryptor {
  }
 
  /**
+ * Removes a border from the document node.
  * The 'nodePath' parameter should refer to a paragraph, a cell or a row.
  * @param requestObj contains request parameters
  */
@@ -668,6 +672,7 @@ export class WordsApi implements Encryptor {
 
  /**
  * Removes a border from the document node.
+ * The 'nodePath' parameter should refer to a paragraph, a cell or a row.
  * @param requestObj contains request parameters
  */
  public async deleteBorderOnline(requestObj: model.DeleteBorderOnlineRequest): Promise< model.WordsIncomingMessage< model.DeleteBorderOnlineResponse > > {
@@ -685,6 +690,7 @@ export class WordsApi implements Encryptor {
  }
 
  /**
+ * Removes borders from the document node.
  * The 'nodePath' parameter should refer to a paragraph, a cell or a row.
  * @param requestObj contains request parameters
  */
@@ -704,6 +710,7 @@ export class WordsApi implements Encryptor {
 
  /**
  * Removes borders from the document node.
+ * The 'nodePath' parameter should refer to a paragraph, a cell or a row.
  * @param requestObj contains request parameters
  */
  public async deleteBordersOnline(requestObj: model.DeleteBordersOnlineRequest): Promise< model.WordsIncomingMessage< model.DeleteBordersOnlineResponse > > {
@@ -1696,6 +1703,7 @@ export class WordsApi implements Encryptor {
  }
 
  /**
+ * Reads a border from the document node.
  * The 'nodePath' parameter should refer to a paragraph, a cell or a row.
  * @param requestObj contains request parameters
  */
@@ -1715,6 +1723,7 @@ export class WordsApi implements Encryptor {
 
  /**
  * Reads a border from the document node.
+ * The 'nodePath' parameter should refer to a paragraph, a cell or a row.
  * @param requestObj contains request parameters
  */
  public async getBorderOnline(requestObj: model.GetBorderOnlineRequest): Promise< model.WordsIncomingMessage< model.BorderResponse > > {
@@ -4972,7 +4981,7 @@ export class WordsApi implements Encryptor {
  }
 
  /**
- * Converts a document to the specified format.
+ * Converts a document in cloud storage to the specified format.
  * @param requestObj contains request parameters
  */
  public async saveAsOnline(requestObj: model.SaveAsOnlineRequest): Promise< model.WordsIncomingMessage< model.SaveAsOnlineResponse > > {
@@ -5027,6 +5036,7 @@ export class WordsApi implements Encryptor {
 
  /**
  * Converts a document in cloud storage to TIFF format using detailed conversion settings.
+ * @deprecated This operation will be removed in the future.
  * @param requestObj contains request parameters
  */
  public async saveAsTiff(requestObj: model.SaveAsTiffRequest): Promise< model.WordsIncomingMessage< model.SaveResponse > > {
@@ -5044,7 +5054,8 @@ export class WordsApi implements Encryptor {
  }
 
  /**
- * Converts a document to TIFF format using detailed conversion settings.
+ * Converts a document in cloud storage to TIFF format using detailed conversion settings.
+ * @deprecated This operation will be removed in the future.
  * @param requestObj contains request parameters
  */
  public async saveAsTiffOnline(requestObj: model.SaveAsTiffOnlineRequest): Promise< model.WordsIncomingMessage< model.SaveAsTiffOnlineResponse > > {
@@ -5206,6 +5217,7 @@ export class WordsApi implements Encryptor {
  }
 
  /**
+ * Updates a border in the document node.
  * The 'nodePath' parameter should refer to a paragraph, a cell or a row.
  * @param requestObj contains request parameters
  */
@@ -5225,6 +5237,7 @@ export class WordsApi implements Encryptor {
 
  /**
  * Updates a border in the document node.
+ * The 'nodePath' parameter should refer to a paragraph, a cell or a row.
  * @param requestObj contains request parameters
  */
  public async updateBorderOnline(requestObj: model.UpdateBorderOnlineRequest): Promise< model.WordsIncomingMessage< model.UpdateBorderOnlineResponse > > {

src/internal/requestHelper.ts

@@ -131,7 +131,7 @@ async function invokeApiMethodInternal(requestOptions: request.OptionsWithUri, c
  requestOptions.timeout = 1000 * confguration.timeout;
 
  requestOptions.headers["x-aspose-client"] = "nodejs sdk";
- requestOptions.headers["x-aspose-client-version"] = "23.9";
+ requestOptions.headers["x-aspose-client-version"] = "23.10";
  requestOptions.encoding = null;
 
  requestOptions.uri = encodeURI(requestOptions.uri.toString());

src/model/bookmarkInsert.ts

@@ -44,13 +44,13 @@ export class BookmarkInsert extends BookmarkData {
  */
  public static attributeTypeMap: Array<AttributeInfo> = [
  {
- name: "endRange",
- baseName: "EndRange",
+ name: "startRange",
+ baseName: "StartRange",
  type: "NewDocumentPosition",
  },
  {
- name: "startRange",
- baseName: "StartRange",
+ name: "endRange",
+ baseName: "EndRange",
  type: "NewDocumentPosition",
  }
  ];
@@ -63,14 +63,14 @@ export class BookmarkInsert extends BookmarkData {
  }
 
  /**
- * Gets or sets the link to end bookmark node.
+ * Gets or sets the link to start bookmark node.
  */
- public endRange: NewDocumentPosition;
+ public startRange: NewDocumentPosition;
 
  /**
- * Gets or sets the link to start bookmark node.
+ * Gets or sets the link to end bookmark node.
  */
- public startRange: NewDocumentPosition;
+ public endRange: NewDocumentPosition;
 
  public constructor(init?: Partial< BookmarkInsert >) {
  super(init);

src/model/bookmarkResponse.ts

@@ -37,6 +37,7 @@ export const importsMapBookmarkResponse = {
 
 /**
  * The REST response with a bookmark.
+ * This response should be returned by the service when handling: GET bookmarks/{bookmarkName}.
  */
 export class BookmarkResponse extends WordsResponse {
  /**

src/model/bookmarksResponse.ts

@@ -37,6 +37,7 @@ export const importsMapBookmarksResponse = {
 
 /**
  * The REST response with a collection of bookmarks.
+ * This response should be returned by the service when handling: GET bookmarks.
  */
 export class BookmarksResponse extends WordsResponse {
  /**

src/model/border.ts

@@ -37,6 +37,7 @@ export const importsMapBorder = {
 
 /**
  * Represents a border of an object.
+ * Borders can be applied to various document elements including paragraph, run of text inside a paragraph or a table cell.
  */
 export class Border extends LinkElement {
  /**
@@ -94,21 +95,25 @@ export class Border extends LinkElement {
 
  /**
  * Gets or sets the distance of the border from text or from the page edge in points.
+ * Has no effect and will be automatically reset to zero for borders of table cells.
  */
  public distanceFromText: number;
 
  /**
  * Gets or sets the border style.
+ * If you set line style to none, then line width is automatically changed to zero.
  */
  public lineStyle: Border.LineStyleEnum;
 
  /**
  * Gets or sets the border width in points.
+ * If you set line width greater than zero when line style is none, the line style is automatically changed to single line.
  */
  public lineWidth: number;
 
  /**
  * Gets or sets a value indicating whether the border has a shadow.
+ * In Microsoft Word, for a border to have a shadow, the borders on all four sides (left, top, right and bottom) should be of the same type, width, color and all should have the Shadow property set to true.
  */
  public shadow: boolean;
 

src/model/borderResponse.ts

@@ -37,6 +37,7 @@ export const importsMapBorderResponse = {
 
 /**
  * The REST response with a border.
+ * This response is returned by the Service when handling "GET {nodeWithBorders}/borders" REST API requests.
  */
 export class BorderResponse extends WordsResponse {
  /**

src/model/bordersResponse.ts

@@ -37,6 +37,7 @@ export const importsMapBordersResponse = {
 
 /**
  * The REST response with a collection of borders.
+ * This response is returned by the Service when handling "GET {nodeWithBorders}/borders" REST API requests.
  */
 export class BordersResponse extends WordsResponse {
  /**

src/model/classificationResponse.ts

@@ -37,6 +37,7 @@ export const importsMapClassificationResponse = {
 
 /**
  * The REST response with data on multi-class text classification.
+ * This response is returned by the Service when handling "PUT https://api.aspose.cloud/v4.0/words/classify" REST API requests.
  */
 export class ClassificationResponse extends WordsResponse {
  /**

src/model/comment.ts

@@ -101,11 +101,13 @@ export class Comment extends CommentLink {
 
  /**
  * Gets or sets the author name for a comment.
+ * Cannot be null.Default is empty string.
  */
  public author: string;
 
  /**
  * Gets or sets the initials of the user associated with a specific comment.
+ * Cannot be null.Default is empty string.
  */
  public initial: string;
 
@@ -116,6 +118,7 @@ export class Comment extends CommentLink {
 
  /**
  * Gets or sets text of the comment.
+ * This method allows to quickly set text of a comment from a string. The string can contain paragraph breaks, this will create paragraphs of text in the comment accordingly.
  */
  public text: string;
 

src/model/commentBase.ts

@@ -56,16 +56,16 @@ export abstract class CommentBase implements ModelInterface {
  baseName: "Author",
  type: "string",
  },
- {
- name: "dateTime",
- baseName: "DateTime",
- type: "Date",
- },
  {
  name: "initial",
  baseName: "Initial",
  type: "string",
  },
+ {
+ name: "dateTime",
+ baseName: "DateTime",
+ type: "Date",
+ },
  {
  name: "text",
  baseName: "Text",
@@ -92,21 +92,25 @@ export abstract class CommentBase implements ModelInterface {
 
  /**
  * Gets or sets the author name for a comment.
+ * Cannot be null.Default is empty string.
  */
  public author: string;
 
  /**
- * Gets or sets the date and time that the comment was made.
+ * Gets or sets the initials of the user associated with a specific comment.
+ * Cannot be null.Default is empty string.
  */
- public dateTime: Date;
+ public initial: string;
 
  /**
- * Gets or sets the initials of the user associated with a specific comment.
+ * Gets or sets the date and time that the comment was made.
+ * Default is MinValue03.01.0001.
  */
- public initial: string;
+ public dateTime: Date;
 
  /**
  * Gets or sets text of the comment.
+ * This method allows to quickly set text of a comment from a string. The string can contain paragraph breaks, this will create paragraphs of text in the comment accordingly.
  */
  public text: string;
 

src/model/commentResponse.ts

@@ -37,6 +37,7 @@ export const importsMapCommentResponse = {
 
 /**
  * The REST response with a comment.
+ * This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/comments/0" REST API requests.
  */
 export class CommentResponse extends WordsResponse {
  /**

src/model/commentsResponse.ts

@@ -37,6 +37,7 @@ export const importsMapCommentsResponse = {
 
 /**
  * The REST response with a collection of comments.
+ * This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/comments" REST API requests.
  */
 export class CommentsResponse extends WordsResponse {
  /**

src/model/csvDataLoadOptions.ts

@@ -34,6 +34,7 @@ export const importsMapCsvDataLoadOptions = {
 /**
  * Represents options for parsing CSV data.
  * To learn more, visit the LINQ Reporting Engine documentation article.
+ * An instance of this class can be passed into constructors of CsvDataSource.
  */
 export class CsvDataLoadOptions implements ModelInterface {
  /**
@@ -71,21 +72,25 @@ export class CsvDataLoadOptions implements ModelInterface {
 
  /**
  * Gets or sets the character that is used to comment lines of CSV data.
+ * The default value is '#' (number sign).
  */
  public commentChar: string;
 
  /**
  * Gets or sets the character to be used as a column delimiter.
+ * The default value is ',' (comma).
  */
  public delimiter: string;
 
  /**
  * Gets or sets a value indicating whether the first record of CSV data contains column names.
+ * The default value is false.
  */
  public hasHeaders: boolean;
 
  /**
  * Gets or sets the character that is used to quote field values.
+ * The default value is '"' (quotation mark).Double the character to place it into quoted text.
  */
  public quoteChar: string;
 

src/model/customXmlPart.ts

@@ -62,11 +62,13 @@ export class CustomXmlPart extends CustomXmlPartLink {
 
  /**
  * Gets or sets the custom xml part id.
+ * Cannot be null.
  */
  public id: string;
 
  /**
  * Gets or sets the custom xml part data.
+ * Cannot be null.Default is empty string.
  */
  public data: string;
 

src/model/customXmlPartResponse.ts

@@ -37,6 +37,7 @@ export const importsMapCustomXmlPartResponse = {
 
 /**
  * The REST response with a custom xml part.
+ * This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/customXmlParts/0" REST API requests.
  */
 export class CustomXmlPartResponse extends WordsResponse {
  /**

src/model/customXmlPartsResponse.ts

@@ -37,6 +37,7 @@ export const importsMapCustomXmlPartsResponse = {
 
 /**
  * The REST response with a collection of custom xml parts.
+ * This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/customXmlParts" REST API requests.
  */
 export class CustomXmlPartsResponse extends WordsResponse {
  /**