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

Author: dynabic-billing-team

README.md

@@ -16,6 +16,12 @@ Feel free to explore the [Developer's Guide](https://docs.aspose.cloud/display/w
 - Add & remove watermarks and protection.
 - Read & write access to Document Object Model.
 
+## Enhancements in Version 21.12
+
+- Added FieldOptions parameter to mail merge operations
+- Added timeout parameter to api configuration
+
+
 ## Enhancements in Version 21.11
 
 
@@ -208,35 +214,27 @@ Config.json file:
 Go code:
 
 ```
-    // Start README example
-
-    // init words cloud api
-    config, _ := models.NewConfiguration(configFilePath)
-    wordsApi, ctx, _ := api.CreateWordsApi(config)
-
-    // upload test.docx to a cloud
-    // remote.docx is a name in the cloud
-        file, _ := os.Open(localFilePath)
-    uploadRequest := &models.UploadFileRequest{
-        FileContent: file,
-        Path: &remotePath,
-    }
-    wordsApi.UploadFile(ctx, uploadRequest)
-
-    // get a text for the first paragraph of the first section
-    options := map[string]interface{}{
-        "folder": remoteFolder,
-    }
-    request := &models.GetParagraphsRequest{
-        Name: &remoteName,
-        Optionals: options,
-    }
-
-    result, _, _ := wordsApi.GetParagraphs(ctx, request)
-
-    fmt.Println(result.Paragraphs.ParagraphLinkList[0].Text)
-
-    // End README example
+	// Start README example
+
+	// init words cloud api
+	config, _ := models.NewConfiguration(configFilePath)
+	wordsApi, ctx, _ := api.CreateWordsApi(config)
+
+	// upload test.docx to a cloud
+	// remote.docx is a name in the cloud
+	file, _ := os.Open(localFilePath)
+	wordsApi.UploadFile(ctx, file, remotePath, nil)
+
+	// get a text for the first paragraph of the first section
+	options := map[string]interface{}{
+		"folder": remoteFolder,
+	}
+
+	result, _, _ := wordsApi.GetParagraphs(ctx, remoteName, options)
+
+	fmt.Println(result.Paragraphs.ParagraphLinkList[0].Text)
+
+	// End README example
 ```
 
 [Product Page](https://products.aspose.cloud/words/go) | [Documentation](https://docs.aspose.cloud/display/wordscloud/Home) | [API Reference](https://apireference.aspose.cloud/words/) | [Code Samples](https://github.com/aspose-words-cloud/aspose-words-cloud-go) | [Blog](https://blog.aspose.cloud/category/words/) | [Free Support](https://forum.aspose.cloud/c/words) | [Free Trial](https://dashboard.aspose.cloud/#/apps)

Scripts/RunTestsStandalone.bat

@@ -1,3 +1,3 @@
 cd dev
 go get -u github.com/jstemmer/go-junit-report
-go test ./tests/... -v -timeout 20m 2>&1 | go-junit-report > ../testReport.xml
+go test ./tests/... -v -timeout 1h 2>&1 | go-junit-report > ../testReport.xml

dev/api/api_client.go

@@ -65,7 +65,7 @@ var (
     xmlCheck = regexp.MustCompile("(?i:[application|text]/xml)")
 )
 
-// APIClient manages communication with the Aspose.Words for Cloud API Reference API v21.11
+// APIClient manages communication with the Aspose.Words for Cloud API Reference API v21.12
 // In most cases there should be only one, shared, APIClient.
 type APIClient struct {
     cfg 	*models.Configuration
@@ -90,6 +90,10 @@ func NewAPIClient(cfg *models.Configuration) (client *APIClient, err error) {
         return nil, errors.New("ClientId must be non-empty string")
     }
 
+	if cfg.Timeout == 0 {
+		cfg.HttpClient.Timeout = cfg.Timeout
+	}
+
     if cfg.ClientSecret == "" {
         return nil, errors.New("ClientSecret must be non-empty string")
     }

dev/api/models/configuration.go

@@ -33,6 +33,7 @@ import (
 	"net/http"
 	"net/url"
 	"path"
+    "time"
 )
 
 // contextKeys are used to identify the type of value in the context.
@@ -81,6 +82,7 @@ type Configuration struct {
 	DebugMode     bool              `json:"DebugMode,omitempty"`
 	DefaultHeader map[string]string `json:"DefaultHeader,omitempty"`
 	HttpClient    *http.Client
+    Timeout       time.Duration
 }
 
 func NewConfiguration(configFilePath string) (pConfig *Configuration, err error) {
@@ -94,7 +96,7 @@ func NewConfiguration(configFilePath string) (pConfig *Configuration, err error)
 	cfg := Configuration{
 		BaseUrl:       "https://api.aspose.cloud",
 		DebugMode:     false,
-		DefaultHeader: map[string]string{"x-aspose-client": "go sdk", "x-aspose-client-version": "21.11"},
+		DefaultHeader: map[string]string{"x-aspose-client": "go sdk", "x-aspose-client-version": "21.12"},
 	}
 	err = json.Unmarshal(data, &cfg)
 

dev/api/models/execute_mail_merge_online_request.go

@@ -41,6 +41,7 @@ type ExecuteMailMergeOnlineRequest struct {
         // File with mailmerge data.
         Data io.ReadCloser
     /* optional (nil or map[string]interface{}) with one or more of key / value pairs:
+        key: "options" value: (IFieldOptions) Field options.
         key: "withRegions" value: (*bool) The flag indicating whether to execute Mail Merge operation with regions.
         key: "cleanup" value: (*string) The cleanup options.
         key: "documentFileName" value: (*string) The filename of the output document, that will be used when the resulting document has a dynamic field {filename}. If it is not set, the "template" will be used instead. */
@@ -128,6 +129,11 @@ func (data *ExecuteMailMergeOnlineRequest) CreateRequestData() (RequestData, err
     }
 
 
+    if localVarTempParam, localVarOk := data.Optionals["options"].(FieldOptions); localVarOk {
+        result.FormParams = append(result.FormParams, NewTextFormParamContainer("Options", parameterToString(localVarTempParam, "")))
+    }
+
+
 
     return result, nil
 }

dev/api/models/execute_mail_merge_request.go

@@ -41,6 +41,7 @@ type ExecuteMailMergeRequest struct {
         Name *string
     /* optional (nil or map[string]interface{}) with one or more of key / value pairs:
         key: "data" value: (*string) Mail merge data.
+        key: "options" value: (IFieldOptions) Field options.
         key: "folder" value: (*string) Original document folder.
         key: "storage" value: (*string) Original document storage.
         key: "loadEncoding" value: (*string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
@@ -175,6 +176,11 @@ func (data *ExecuteMailMergeRequest) CreateRequestData() (RequestData, error) {
     }
 
 
+    if localVarTempParam, localVarOk := data.Optionals["options"].(FieldOptions); localVarOk {
+        result.FormParams = append(result.FormParams, NewTextFormParamContainer("Options", parameterToString(localVarTempParam, "")))
+    }
+
+
 
     return result, nil
 }

dev/api/models/field_options.go

@@ -0,0 +1,114 @@
+/*
+ * --------------------------------------------------------------------------------
+ * <copyright company="Aspose" file="field_options.go">
+ *   Copyright (c) 2021 Aspose.Words for Cloud
+ * </copyright>
+ * <summary>
+ *   Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ * 
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ * 
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ * </summary>
+ * --------------------------------------------------------------------------------
+ */
+
+package models
+
+// DTO for field options.
+type FieldOptionsResult struct {
+    // DTO for field options.
+    BuiltInTemplatesPaths []string `json:"BuiltInTemplatesPaths,omitempty"`
+
+    // DTO for field options.
+    CurrentUser UserInformationResult `json:"CurrentUser,omitempty"`
+
+    // DTO for field options.
+    CustomTocStyleSeparator string `json:"CustomTocStyleSeparator,omitempty"`
+
+    // DTO for field options.
+    DefaultDocumentAuthor string `json:"DefaultDocumentAuthor,omitempty"`
+
+    // DTO for field options.
+    FieldIndexFormat string `json:"FieldIndexFormat,omitempty"`
+
+    // DTO for field options.
+    FieldUpdateCultureSource string `json:"FieldUpdateCultureSource,omitempty"`
+
+    // DTO for field options.
+    FileName string `json:"FileName,omitempty"`
+
+    // DTO for field options.
+    IsBidiTextSupportedOnUpdate bool `json:"IsBidiTextSupportedOnUpdate,omitempty"`
+
+    // DTO for field options.
+    LegacyNumberFormat bool `json:"LegacyNumberFormat,omitempty"`
+
+    // DTO for field options.
+    PreProcessCultureName string `json:"PreProcessCultureName,omitempty"`
+
+    // DTO for field options.
+    TemplateName string `json:"TemplateName,omitempty"`
+
+    // DTO for field options.
+    UseInvariantCultureNumberFormat bool `json:"UseInvariantCultureNumberFormat,omitempty"`
+}
+
+type FieldOptions struct {
+    // DTO for field options.
+    BuiltInTemplatesPaths []string `json:"BuiltInTemplatesPaths,omitempty"`
+
+    // DTO for field options.
+    CurrentUser IUserInformation `json:"CurrentUser,omitempty"`
+
+    // DTO for field options.
+    CustomTocStyleSeparator *string `json:"CustomTocStyleSeparator,omitempty"`
+
+    // DTO for field options.
+    DefaultDocumentAuthor *string `json:"DefaultDocumentAuthor,omitempty"`
+
+    // DTO for field options.
+    FieldIndexFormat *string `json:"FieldIndexFormat,omitempty"`
+
+    // DTO for field options.
+    FieldUpdateCultureSource *string `json:"FieldUpdateCultureSource,omitempty"`
+
+    // DTO for field options.
+    FileName *string `json:"FileName,omitempty"`
+
+    // DTO for field options.
+    IsBidiTextSupportedOnUpdate *bool `json:"IsBidiTextSupportedOnUpdate,omitempty"`
+
+    // DTO for field options.
+    LegacyNumberFormat *bool `json:"LegacyNumberFormat,omitempty"`
+
+    // DTO for field options.
+    PreProcessCultureName *string `json:"PreProcessCultureName,omitempty"`
+
+    // DTO for field options.
+    TemplateName *string `json:"TemplateName,omitempty"`
+
+    // DTO for field options.
+    UseInvariantCultureNumberFormat *bool `json:"UseInvariantCultureNumberFormat,omitempty"`
+}
+
+type IFieldOptions interface {
+    IsFieldOptions() bool
+}
+func (FieldOptions) IsFieldOptions() bool {
+    return true
+}
+
+

dev/api/models/get_info_request.go

@@ -0,0 +1,94 @@
+/*
+ * --------------------------------------------------------------------------------
+ * <copyright company="Aspose" file="get_info_request.go">
+ *   Copyright (c) 2021 Aspose.Words for Cloud
+ * </copyright>
+ * <summary>
+ *   Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ * 
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ * 
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ * </summary>
+ * --------------------------------------------------------------------------------
+ */
+
+package models
+
+import (
+	"net/url"
+	"strings"
+    "io"
+    "encoding/json"
+)
+
+// GetInfoRequest contains request data for WordsApiService.GetInfo method.
+type GetInfoRequest struct {
+}
+
+
+func (data *GetInfoRequest) CreateRequestData() (RequestData, error) {
+
+    var result RequestData
+
+    result.Method = strings.ToUpper("get")
+
+    // create path and map variables
+    result.Path = "/words/info"
+
+    result.Path = strings.Replace(result.Path, "/<nil>", "", -1)
+    result.Path = strings.Replace(result.Path, "//", "/", -1)
+
+    result.HeaderParams = make(map[string]string)
+    result.QueryParams = url.Values{}
+    result.FormParams = make([]FormParamContainer, 0)
+
+
+
+    // to determine the Content-Type header
+    localVarHttpContentTypes := []string{ "application/xml", "application/json", }
+
+    // set Content-Type header
+    localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes)
+    if localVarHttpContentType != "" {
+        result.HeaderParams["Content-Type"] = localVarHttpContentType
+    }
+
+    // to determine the Accept header
+    localVarHttpHeaderAccepts := []string{
+        "application/xml",
+        "application/json",
+    }
+
+    // set Accept header
+    localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
+    if localVarHttpHeaderAccept != "" {
+        result.HeaderParams["Accept"] = localVarHttpHeaderAccept
+    }
+
+
+
+
+    return result, nil
+}
+
+func (data *GetInfoRequest) CreateResponse(reader io.Reader, boundary string) (response interface{}, err error) {
+            var successPayload InfoResponse
+            if err = json.NewDecoder(reader).Decode(&successPayload); err != nil {
+                return nil, err
+            }
+
+            return successPayload, err
+}