Documentation ¶
Index ¶
- func CacheExpires(r *http.Response) time.Time
- type APIClient
- type FormParamContainer
- type WordsApiService
- func (a *WordsApiService) AcceptAllRevisions(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.RevisionsModificationResponse, *http.Response, error)
- func (a *WordsApiService) AppendDocument(ctx context.Context, name string, documentList models.IDocumentEntryList, ...) (models.DocumentResponse, *http.Response, error)
- func (a *WordsApiService) ApplyStyleToDocumentElement(ctx context.Context, name string, styleApply models.IStyleApply, ...) (models.WordsResponse, *http.Response, error)
- func (a *WordsApiService) BuildReport(ctx context.Context, name string, data string, ...) (models.DocumentResponse, *http.Response, error)
- func (a *WordsApiService) BuildReportOnline(ctx context.Context, template *os.File, data string, ...) (*http.Response, error)
- func (a *WordsApiService) Classify(ctx context.Context, text string, localVarOptionals map[string]interface{}) (models.ClassificationResponse, *http.Response, error)
- func (a *WordsApiService) ClassifyDocument(ctx context.Context, documentName string, ...) (models.ClassificationResponse, *http.Response, error)
- func (a *WordsApiService) CompareDocument(ctx context.Context, name string, compareData models.ICompareData, ...) (models.DocumentResponse, *http.Response, error)
- func (a *WordsApiService) ConvertDocument(ctx context.Context, document *os.File, format string, ...) (*http.Response, error)
- func (a *WordsApiService) CopyFile(ctx context.Context, destPath string, srcPath string, ...) (*http.Response, error)
- func (a *WordsApiService) CopyFolder(ctx context.Context, destPath string, srcPath string, ...) (*http.Response, error)
- func (a *WordsApiService) CopyStyle(ctx context.Context, name string, styleCopy models.IStyleCopy, ...) (models.StyleResponse, *http.Response, error)
- func (a *WordsApiService) CreateDocument(ctx context.Context, localVarOptionals map[string]interface{}) (models.DocumentResponse, *http.Response, error)
- func (a *WordsApiService) CreateFolder(ctx context.Context, path string, localVarOptionals map[string]interface{}) (*http.Response, error)
- func (a *WordsApiService) CreateOrUpdateDocumentProperty(ctx context.Context, name string, propertyName string, ...) (models.DocumentPropertyResponse, *http.Response, error)
- func (a *WordsApiService) DeleteAllParagraphTabStops(ctx context.Context, name string, index int32, ...) (models.TabStopsResponse, *http.Response, error)
- func (a *WordsApiService) DeleteBorder(ctx context.Context, name string, borderType string, ...) (models.BorderResponse, *http.Response, error)
- func (a *WordsApiService) DeleteBorders(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.BordersResponse, *http.Response, error)
- func (a *WordsApiService) DeleteComment(ctx context.Context, name string, commentIndex int32, ...) (*http.Response, error)
- func (a *WordsApiService) DeleteDocumentProperty(ctx context.Context, name string, propertyName string, ...) (*http.Response, error)
- func (a *WordsApiService) DeleteDrawingObject(ctx context.Context, name string, index int32, ...) (*http.Response, error)
- func (a *WordsApiService) DeleteField(ctx context.Context, name string, index int32, ...) (*http.Response, error)
- func (a *WordsApiService) DeleteFields(ctx context.Context, name string, localVarOptionals map[string]interface{}) (*http.Response, error)
- func (a *WordsApiService) DeleteFile(ctx context.Context, path string, localVarOptionals map[string]interface{}) (*http.Response, error)
- func (a *WordsApiService) DeleteFolder(ctx context.Context, path string, localVarOptionals map[string]interface{}) (*http.Response, error)
- func (a *WordsApiService) DeleteFootnote(ctx context.Context, name string, index int32, ...) (*http.Response, error)
- func (a *WordsApiService) DeleteFormField(ctx context.Context, name string, index int32, ...) (*http.Response, error)
- func (a *WordsApiService) DeleteHeaderFooter(ctx context.Context, name string, sectionPath string, index int32, ...) (*http.Response, error)
- func (a *WordsApiService) DeleteHeadersFooters(ctx context.Context, name string, sectionPath string, ...) (*http.Response, error)
- func (a *WordsApiService) DeleteMacros(ctx context.Context, name string, localVarOptionals map[string]interface{}) (*http.Response, error)
- func (a *WordsApiService) DeleteOfficeMathObject(ctx context.Context, name string, index int32, ...) (*http.Response, error)
- func (a *WordsApiService) DeleteParagraph(ctx context.Context, name string, index int32, ...) (*http.Response, error)
- func (a *WordsApiService) DeleteParagraphListFormat(ctx context.Context, name string, index int32, ...) (models.ParagraphListFormatResponse, *http.Response, error)
- func (a *WordsApiService) DeleteParagraphTabStop(ctx context.Context, name string, position float64, index int32, ...) (models.TabStopsResponse, *http.Response, error)
- func (a *WordsApiService) DeleteRun(ctx context.Context, name string, paragraphPath string, index int32, ...) (*http.Response, error)
- func (a *WordsApiService) DeleteSection(ctx context.Context, name string, sectionIndex int32, ...) (*http.Response, error)
- func (a *WordsApiService) DeleteTable(ctx context.Context, name string, index int32, ...) (*http.Response, error)
- func (a *WordsApiService) DeleteTableCell(ctx context.Context, name string, tableRowPath string, index int32, ...) (*http.Response, error)
- func (a *WordsApiService) DeleteTableRow(ctx context.Context, name string, tablePath string, index int32, ...) (*http.Response, error)
- func (a *WordsApiService) DeleteWatermark(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.DocumentResponse, *http.Response, error)
- func (a *WordsApiService) DownloadFile(ctx context.Context, path string, localVarOptionals map[string]interface{}) (*http.Response, error)
- func (a *WordsApiService) ExecuteMailMerge(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.DocumentResponse, *http.Response, error)
- func (a *WordsApiService) ExecuteMailMergeOnline(ctx context.Context, template *os.File, data *os.File, ...) (*http.Response, error)
- func (a *WordsApiService) GetAvailableFonts(ctx context.Context, localVarOptionals map[string]interface{}) (models.AvailableFontsResponse, *http.Response, error)
- func (a *WordsApiService) GetBookmarkByName(ctx context.Context, name string, bookmarkName string, ...) (models.BookmarkResponse, *http.Response, error)
- func (a *WordsApiService) GetBookmarks(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.BookmarksResponse, *http.Response, error)
- func (a *WordsApiService) GetBorder(ctx context.Context, name string, borderType string, ...) (models.BorderResponse, *http.Response, error)
- func (a *WordsApiService) GetBorders(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.BordersResponse, *http.Response, error)
- func (a *WordsApiService) GetComment(ctx context.Context, name string, commentIndex int32, ...) (models.CommentResponse, *http.Response, error)
- func (a *WordsApiService) GetComments(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.CommentsResponse, *http.Response, error)
- func (a *WordsApiService) GetDocument(ctx context.Context, documentName string, ...) (models.DocumentResponse, *http.Response, error)
- func (a *WordsApiService) GetDocumentDrawingObjectByIndex(ctx context.Context, name string, index int32, ...) (models.DrawingObjectResponse, *http.Response, error)
- func (a *WordsApiService) GetDocumentDrawingObjectImageData(ctx context.Context, name string, index int32, ...) (*http.Response, error)
- func (a *WordsApiService) GetDocumentDrawingObjectOleData(ctx context.Context, name string, index int32, ...) (*http.Response, error)
- func (a *WordsApiService) GetDocumentDrawingObjects(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.DrawingObjectsResponse, *http.Response, error)
- func (a *WordsApiService) GetDocumentFieldNames(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.FieldNamesResponse, *http.Response, error)
- func (a *WordsApiService) GetDocumentFieldNamesOnline(ctx context.Context, template *os.File, ...) (models.FieldNamesResponse, *http.Response, error)
- func (a *WordsApiService) GetDocumentHyperlinkByIndex(ctx context.Context, name string, hyperlinkIndex int32, ...) (models.HyperlinkResponse, *http.Response, error)
- func (a *WordsApiService) GetDocumentHyperlinks(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.HyperlinksResponse, *http.Response, error)
- func (a *WordsApiService) GetDocumentProperties(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.DocumentPropertiesResponse, *http.Response, error)
- func (a *WordsApiService) GetDocumentProperty(ctx context.Context, name string, propertyName string, ...) (models.DocumentPropertyResponse, *http.Response, error)
- func (a *WordsApiService) GetDocumentProtection(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.ProtectionDataResponse, *http.Response, error)
- func (a *WordsApiService) GetDocumentStatistics(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.StatDataResponse, *http.Response, error)
- func (a *WordsApiService) GetDocumentWithFormat(ctx context.Context, name string, format string, ...) (*http.Response, error)
- func (a *WordsApiService) GetField(ctx context.Context, name string, index int32, ...) (models.FieldResponse, *http.Response, error)
- func (a *WordsApiService) GetFields(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.FieldsResponse, *http.Response, error)
- func (a *WordsApiService) GetFilesList(ctx context.Context, path string, localVarOptionals map[string]interface{}) (models.FilesList, *http.Response, error)
- func (a *WordsApiService) GetFootnote(ctx context.Context, name string, index int32, ...) (models.FootnoteResponse, *http.Response, error)
- func (a *WordsApiService) GetFootnotes(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.FootnotesResponse, *http.Response, error)
- func (a *WordsApiService) GetFormField(ctx context.Context, name string, index int32, ...) (models.FormFieldResponse, *http.Response, error)
- func (a *WordsApiService) GetFormFields(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.FormFieldsResponse, *http.Response, error)
- func (a *WordsApiService) GetHeaderFooter(ctx context.Context, name string, headerFooterIndex int32, ...) (models.HeaderFooterResponse, *http.Response, error)
- func (a *WordsApiService) GetHeaderFooterOfSection(ctx context.Context, name string, headerFooterIndex int32, sectionIndex int32, ...) (models.HeaderFooterResponse, *http.Response, error)
- func (a *WordsApiService) GetHeaderFooters(ctx context.Context, name string, sectionPath string, ...) (models.HeaderFootersResponse, *http.Response, error)
- func (a *WordsApiService) GetList(ctx context.Context, name string, listId int32, ...) (models.ListResponse, *http.Response, error)
- func (a *WordsApiService) GetLists(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.ListsResponse, *http.Response, error)
- func (a *WordsApiService) GetOfficeMathObject(ctx context.Context, name string, index int32, ...) (models.OfficeMathObjectResponse, *http.Response, error)
- func (a *WordsApiService) GetOfficeMathObjects(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.OfficeMathObjectsResponse, *http.Response, error)
- func (a *WordsApiService) GetParagraph(ctx context.Context, name string, index int32, ...) (models.ParagraphResponse, *http.Response, error)
- func (a *WordsApiService) GetParagraphFormat(ctx context.Context, name string, index int32, ...) (models.ParagraphFormatResponse, *http.Response, error)
- func (a *WordsApiService) GetParagraphListFormat(ctx context.Context, name string, index int32, ...) (models.ParagraphListFormatResponse, *http.Response, error)
- func (a *WordsApiService) GetParagraphTabStops(ctx context.Context, name string, index int32, ...) (models.TabStopsResponse, *http.Response, error)
- func (a *WordsApiService) GetParagraphs(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.ParagraphLinkCollectionResponse, *http.Response, error)
- func (a *WordsApiService) GetRangeText(ctx context.Context, name string, rangeStartIdentifier string, ...) (models.RangeTextResponse, *http.Response, error)
- func (a *WordsApiService) GetRun(ctx context.Context, name string, paragraphPath string, index int32, ...) (models.RunResponse, *http.Response, error)
- func (a *WordsApiService) GetRunFont(ctx context.Context, name string, paragraphPath string, index int32, ...) (models.FontResponse, *http.Response, error)
- func (a *WordsApiService) GetRuns(ctx context.Context, name string, paragraphPath string, ...) (models.RunsResponse, *http.Response, error)
- func (a *WordsApiService) GetSection(ctx context.Context, name string, sectionIndex int32, ...) (models.SectionResponse, *http.Response, error)
- func (a *WordsApiService) GetSectionPageSetup(ctx context.Context, name string, sectionIndex int32, ...) (models.SectionPageSetupResponse, *http.Response, error)
- func (a *WordsApiService) GetSections(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.SectionLinkCollectionResponse, *http.Response, error)
- func (a *WordsApiService) GetStyle(ctx context.Context, name string, styleName string, ...) (models.StyleResponse, *http.Response, error)
- func (a *WordsApiService) GetStyleFromDocumentElement(ctx context.Context, name string, styledNodePath string, ...) (models.StyleResponse, *http.Response, error)
- func (a *WordsApiService) GetStyles(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.StylesResponse, *http.Response, error)
- func (a *WordsApiService) GetTable(ctx context.Context, name string, index int32, ...) (models.TableResponse, *http.Response, error)
- func (a *WordsApiService) GetTableCell(ctx context.Context, name string, tableRowPath string, index int32, ...) (models.TableCellResponse, *http.Response, error)
- func (a *WordsApiService) GetTableCellFormat(ctx context.Context, name string, tableRowPath string, index int32, ...) (models.TableCellFormatResponse, *http.Response, error)
- func (a *WordsApiService) GetTableProperties(ctx context.Context, name string, index int32, ...) (models.TablePropertiesResponse, *http.Response, error)
- func (a *WordsApiService) GetTableRow(ctx context.Context, name string, tablePath string, index int32, ...) (models.TableRowResponse, *http.Response, error)
- func (a *WordsApiService) GetTableRowFormat(ctx context.Context, name string, tablePath string, index int32, ...) (models.TableRowFormatResponse, *http.Response, error)
- func (a *WordsApiService) GetTables(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.TableLinkCollectionResponse, *http.Response, error)
- func (a *WordsApiService) InsertComment(ctx context.Context, name string, comment models.ICommentInsert, ...) (models.CommentResponse, *http.Response, error)
- func (a *WordsApiService) InsertDrawingObject(ctx context.Context, name string, drawingObject models.IDrawingObjectInsert, ...) (models.DrawingObjectResponse, *http.Response, error)
- func (a *WordsApiService) InsertField(ctx context.Context, name string, field models.IFieldInsert, ...) (models.FieldResponse, *http.Response, error)
- func (a *WordsApiService) InsertFootnote(ctx context.Context, name string, footnoteDto models.IFootnoteInsert, ...) (models.FootnoteResponse, *http.Response, error)
- func (a *WordsApiService) InsertFormField(ctx context.Context, name string, formField models.IFormField, ...) (models.FormFieldResponse, *http.Response, error)
- func (a *WordsApiService) InsertHeaderFooter(ctx context.Context, name string, headerFooterType string, sectionPath string, ...) (models.HeaderFooterResponse, *http.Response, error)
- func (a *WordsApiService) InsertList(ctx context.Context, name string, listInsert models.IListInsert, ...) (models.ListResponse, *http.Response, error)
- func (a *WordsApiService) InsertOrUpdateParagraphTabStop(ctx context.Context, name string, dto models.ITabStopInsert, index int32, ...) (models.TabStopsResponse, *http.Response, error)
- func (a *WordsApiService) InsertPageNumbers(ctx context.Context, name string, pageNumber models.IPageNumber, ...) (models.DocumentResponse, *http.Response, error)
- func (a *WordsApiService) InsertParagraph(ctx context.Context, name string, paragraph models.IParagraphInsert, ...) (models.ParagraphResponse, *http.Response, error)
- func (a *WordsApiService) InsertRun(ctx context.Context, name string, paragraphPath string, run models.IRunInsert, ...) (models.RunResponse, *http.Response, error)
- func (a *WordsApiService) InsertStyle(ctx context.Context, name string, styleInsert models.IStyleInsert, ...) (models.StyleResponse, *http.Response, error)
- func (a *WordsApiService) InsertTable(ctx context.Context, name string, table models.ITableInsert, ...) (models.TableResponse, *http.Response, error)
- func (a *WordsApiService) InsertTableCell(ctx context.Context, name string, cell models.ITableCellInsert, ...) (models.TableCellResponse, *http.Response, error)
- func (a *WordsApiService) InsertTableRow(ctx context.Context, name string, row models.ITableRowInsert, tablePath string, ...) (models.TableRowResponse, *http.Response, error)
- func (a *WordsApiService) InsertWatermarkImage(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.DocumentResponse, *http.Response, error)
- func (a *WordsApiService) InsertWatermarkText(ctx context.Context, name string, watermarkText models.IWatermarkText, ...) (models.DocumentResponse, *http.Response, error)
- func (a *WordsApiService) LoadWebDocument(ctx context.Context, data models.ILoadWebDocumentData, ...) (models.SaveResponse, *http.Response, error)
- func (a *WordsApiService) MoveFile(ctx context.Context, destPath string, srcPath string, ...) (*http.Response, error)
- func (a *WordsApiService) MoveFolder(ctx context.Context, destPath string, srcPath string, ...) (*http.Response, error)
- func (a *WordsApiService) OptimizeDocument(ctx context.Context, name string, options models.IOptimizationOptions, ...) (*http.Response, error)
- func (a *WordsApiService) ProtectDocument(ctx context.Context, name string, protectionRequest models.IProtectionRequest, ...) (models.ProtectionDataResponse, *http.Response, error)
- func (a *WordsApiService) RejectAllRevisions(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.RevisionsModificationResponse, *http.Response, error)
- func (a *WordsApiService) RemoveRange(ctx context.Context, name string, rangeStartIdentifier string, ...) (models.DocumentResponse, *http.Response, error)
- func (a *WordsApiService) RenderDrawingObject(ctx context.Context, name string, format string, index int32, ...) (*http.Response, error)
- func (a *WordsApiService) RenderMathObject(ctx context.Context, name string, format string, index int32, ...) (*http.Response, error)
- func (a *WordsApiService) RenderPage(ctx context.Context, name string, pageIndex int32, format string, ...) (*http.Response, error)
- func (a *WordsApiService) RenderParagraph(ctx context.Context, name string, format string, index int32, ...) (*http.Response, error)
- func (a *WordsApiService) RenderTable(ctx context.Context, name string, format string, index int32, ...) (*http.Response, error)
- func (a *WordsApiService) ReplaceText(ctx context.Context, name string, replaceText models.IReplaceTextParameters, ...) (models.ReplaceTextResponse, *http.Response, error)
- func (a *WordsApiService) ReplaceWithText(ctx context.Context, name string, rangeStartIdentifier string, ...) (models.DocumentResponse, *http.Response, error)
- func (a *WordsApiService) ResetCache(ctx context.Context) (*http.Response, error)
- func (a *WordsApiService) SaveAs(ctx context.Context, name string, saveOptionsData models.ISaveOptionsData, ...) (models.SaveResponse, *http.Response, error)
- func (a *WordsApiService) SaveAsRange(ctx context.Context, name string, rangeStartIdentifier string, ...) (models.DocumentResponse, *http.Response, error)
- func (a *WordsApiService) SaveAsTiff(ctx context.Context, name string, saveOptions models.ITiffSaveOptionsData, ...) (models.SaveResponse, *http.Response, error)
- func (a *WordsApiService) Search(ctx context.Context, name string, pattern string, ...) (models.SearchResponse, *http.Response, error)
- func (a *WordsApiService) SplitDocument(ctx context.Context, name string, format string, ...) (models.SplitDocumentResponse, *http.Response, error)
- func (a *WordsApiService) UnprotectDocument(ctx context.Context, name string, protectionRequest models.IProtectionRequest, ...) (models.ProtectionDataResponse, *http.Response, error)
- func (a *WordsApiService) UpdateBookmark(ctx context.Context, name string, bookmarkData models.IBookmarkData, ...) (models.BookmarkResponse, *http.Response, error)
- func (a *WordsApiService) UpdateBorder(ctx context.Context, name string, borderProperties models.IBorder, ...) (models.BorderResponse, *http.Response, error)
- func (a *WordsApiService) UpdateComment(ctx context.Context, name string, commentIndex int32, ...) (models.CommentResponse, *http.Response, error)
- func (a *WordsApiService) UpdateDrawingObject(ctx context.Context, name string, drawingObject models.IDrawingObjectUpdate, ...) (models.DrawingObjectResponse, *http.Response, error)
- func (a *WordsApiService) UpdateField(ctx context.Context, name string, field models.IFieldUpdate, index int32, ...) (models.FieldResponse, *http.Response, error)
- func (a *WordsApiService) UpdateFields(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.DocumentResponse, *http.Response, error)
- func (a *WordsApiService) UpdateFootnote(ctx context.Context, name string, footnoteDto models.IFootnoteUpdate, ...) (models.FootnoteResponse, *http.Response, error)
- func (a *WordsApiService) UpdateFormField(ctx context.Context, name string, formField models.IFormField, index int32, ...) (models.FormFieldResponse, *http.Response, error)
- func (a *WordsApiService) UpdateList(ctx context.Context, name string, listUpdate models.IListUpdate, listId int32, ...) (models.ListResponse, *http.Response, error)
- func (a *WordsApiService) UpdateListLevel(ctx context.Context, name string, listUpdate models.IListLevelUpdate, ...) (models.ListResponse, *http.Response, error)
- func (a *WordsApiService) UpdateParagraphFormat(ctx context.Context, name string, dto models.IParagraphFormatUpdate, ...) (models.ParagraphFormatResponse, *http.Response, error)
- func (a *WordsApiService) UpdateParagraphListFormat(ctx context.Context, name string, dto models.IListFormatUpdate, index int32, ...) (models.ParagraphListFormatResponse, *http.Response, error)
- func (a *WordsApiService) UpdateRun(ctx context.Context, name string, run models.IRunUpdate, paragraphPath string, ...) (models.RunResponse, *http.Response, error)
- func (a *WordsApiService) UpdateRunFont(ctx context.Context, name string, fontDto models.IFont, paragraphPath string, ...) (models.FontResponse, *http.Response, error)
- func (a *WordsApiService) UpdateSectionPageSetup(ctx context.Context, name string, sectionIndex int32, ...) (models.SectionPageSetupResponse, *http.Response, error)
- func (a *WordsApiService) UpdateStyle(ctx context.Context, name string, styleUpdate models.IStyleUpdate, ...) (models.StyleResponse, *http.Response, error)
- func (a *WordsApiService) UpdateTableCellFormat(ctx context.Context, name string, format models.ITableCellFormat, ...) (models.TableCellFormatResponse, *http.Response, error)
- func (a *WordsApiService) UpdateTableProperties(ctx context.Context, name string, properties models.ITableProperties, ...) (models.TablePropertiesResponse, *http.Response, error)
- func (a *WordsApiService) UpdateTableRowFormat(ctx context.Context, name string, format models.ITableRowFormat, ...) (models.TableRowFormatResponse, *http.Response, error)
- func (a *WordsApiService) UploadFile(ctx context.Context, fileContent *os.File, path string, ...) (models.FilesUploadResult, *http.Response, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type APIClient ¶
type APIClient struct { // API Services WordsApi *WordsApiService // contains filtered or unexported fields }
APIClient manages communication with the Aspose.Words for Cloud API Reference API v20.11 In most cases there should be only one, shared, APIClient.
func NewAPIClient ¶
func NewAPIClient(cfg *models.Configuration) (client *APIClient, err error)
NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.
func (*APIClient) ChangeBasePath ¶
Change base path to allow switching to mocks
type FormParamContainer ¶
type FormParamContainer struct {
// contains filtered or unexported fields
}
func NewFileFormParamContainer ¶
func NewFileFormParamContainer(name string, file []byte) (result FormParamContainer)
func NewTextFormParamContainer ¶
func NewTextFormParamContainer(name string, text string) (result FormParamContainer)
type WordsApiService ¶
type WordsApiService service
func CreateWordsApi ¶
func CreateWordsApi(config *models.Configuration) (wordsApi *WordsApiService, ctxWithToken context.Context, err error)
func (*WordsApiService) AcceptAllRevisions ¶
func (a *WordsApiService) AcceptAllRevisions(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.RevisionsModificationResponse, *http.Response, error)
WordsApiService Accepts all revisions in the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
@return models.RevisionsModificationResponse
func (*WordsApiService) AppendDocument ¶
func (a *WordsApiService) AppendDocument(ctx context.Context, name string, documentList models.IDocumentEntryList, localVarOptionals map[string]interface{}) (models.DocumentResponse, *http.Response, error)
WordsApiService Appends documents to the original document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param documentList The collection of documents to append. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.DocumentResponse
func (*WordsApiService) ApplyStyleToDocumentElement ¶
func (a *WordsApiService) ApplyStyleToDocumentElement(ctx context.Context, name string, styleApply models.IStyleApply, styledNodePath string, localVarOptionals map[string]interface{}) (models.WordsResponse, *http.Response, error)
WordsApiService Applies a style to the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param styleApply The style to apply. @param styledNodePath The path to the node in the document tree, that supports styles: ParagraphFormat, List, ListLevel, Table. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.WordsResponse
func (*WordsApiService) BuildReport ¶
func (a *WordsApiService) BuildReport(ctx context.Context, name string, data string, reportEngineSettings models.IReportEngineSettings, localVarOptionals map[string]interface{}) (models.DocumentResponse, *http.Response, error)
WordsApiService Executes the report generation process using the specified document template and the external data source in XML, JSON or CSV format. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param data A string providing a data to populate the specified template. The string must be of one of the following types: xml, json, csv. @param reportEngineSettings An object providing a settings of report engine. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) The filename of the output document. If this parameter is omitted, the result will be saved with autogenerated name.
@return models.DocumentResponse
func (*WordsApiService) BuildReportOnline ¶
func (a *WordsApiService) BuildReportOnline(ctx context.Context, template *os.File, data string, reportEngineSettings models.IReportEngineSettings, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Executes the report generation process online using the specified document template and the external data source in XML, JSON or CSV format. * @param ctx context.Context for authentication, logging, tracing, etc. @param template File with template. @param data A string providing a data to populate the specified template. The string must be of one of the following types: xml, json, csv. @param reportEngineSettings An object providing a settings of report engine. @param optional (nil or map[string]interface{}) with one or more of: @param "documentFileName" (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.
@return *os.File
func (*WordsApiService) Classify ¶
func (a *WordsApiService) Classify(ctx context.Context, text string, localVarOptionals map[string]interface{}) (models.ClassificationResponse, *http.Response, error)
WordsApiService Runs a multi-class text classification for the specified raw text. * @param ctx context.Context for authentication, logging, tracing, etc. @param text The text to classify. @param optional (nil or map[string]interface{}) with one or more of: @param "bestClassesCount" (string) The number of the best classes to return.
@return models.ClassificationResponse
func (*WordsApiService) ClassifyDocument ¶
func (a *WordsApiService) ClassifyDocument(ctx context.Context, documentName string, localVarOptionals map[string]interface{}) (models.ClassificationResponse, *http.Response, error)
WordsApiService Runs a multi-class text classification for the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param documentName The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "bestClassesCount" (string) The number of the best classes to return. @param "taxonomy" (string) The taxonomy to use.
@return models.ClassificationResponse
func (*WordsApiService) CompareDocument ¶
func (a *WordsApiService) CompareDocument(ctx context.Context, name string, compareData models.ICompareData, localVarOptionals map[string]interface{}) (models.DocumentResponse, *http.Response, error)
WordsApiService Compares two documents. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param compareData The properties of the document to compare with. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
@return models.DocumentResponse
func (*WordsApiService) ConvertDocument ¶
func (a *WordsApiService) ConvertDocument(ctx context.Context, document *os.File, format string, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Converts a document on a local drive to the specified format. * @param ctx context.Context for authentication, logging, tracing, etc. @param document Converting document. @param format The format to convert. @param optional (nil or map[string]interface{}) with one or more of: @param "storage" (string) Original document storage. @param "outPath" (string) The path to the output document on a local storage. @param "fileNameFieldValue" (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 "sourceFilename" will be used instead. @param "fontsLocation" (string) Folder in filestorage with custom fonts.
@return *os.File
func (*WordsApiService) CopyFile ¶
func (a *WordsApiService) CopyFile(ctx context.Context, destPath string, srcPath string, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Copy file. * @param ctx context.Context for authentication, logging, tracing, etc. @param destPath Destination file path. @param srcPath Source file's path e.g. '/Folder 1/file.ext' or '/Bucket/Folder 1/file.ext'. @param optional (nil or map[string]interface{}) with one or more of: @param "srcStorageName" (string) Source storage name. @param "destStorageName" (string) Destination storage name. @param "versionId" (string) File version ID to copy.
@return
func (*WordsApiService) CopyFolder ¶
func (a *WordsApiService) CopyFolder(ctx context.Context, destPath string, srcPath string, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Copy folder. * @param ctx context.Context for authentication, logging, tracing, etc. @param destPath Destination folder path e.g. '/dst'. @param srcPath Source folder path e.g. /Folder1. @param optional (nil or map[string]interface{}) with one or more of: @param "srcStorageName" (string) Source storage name. @param "destStorageName" (string) Destination storage name.
@return
func (*WordsApiService) CopyStyle ¶
func (a *WordsApiService) CopyStyle(ctx context.Context, name string, styleCopy models.IStyleCopy, localVarOptionals map[string]interface{}) (models.StyleResponse, *http.Response, error)
WordsApiService Makes a copy of the style in the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param styleCopy The properties of the style. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.StyleResponse
func (*WordsApiService) CreateDocument ¶
func (a *WordsApiService) CreateDocument(ctx context.Context, localVarOptionals map[string]interface{}) (models.DocumentResponse, *http.Response, error)
WordsApiService Supported extensions: ".doc", ".docx", ".docm", ".dot", ".dotm", ".dotx", ".flatopc", ".fopc", ".flatopc_macro", ".fopc_macro", ".flatopc_template", ".fopc_template", ".flatopc_template_macro", ".fopc_template_macro", ".wordml", ".wml", ".rtf". * @param ctx context.Context for authentication, logging, tracing, etc. @param optional (nil or map[string]interface{}) with one or more of: @param "storage" (string) Original document storage. @param "fileName" (string) The filename of the document. @param "folder" (string) The path to the document folder.
@return models.DocumentResponse
func (*WordsApiService) CreateFolder ¶
func (a *WordsApiService) CreateFolder(ctx context.Context, path string, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Create the folder. * @param ctx context.Context for authentication, logging, tracing, etc. @param path Target folder's path e.g. Folder1/Folder2/. The folders will be created recursively. @param optional (nil or map[string]interface{}) with one or more of: @param "storageName" (string) Storage name.
@return
func (*WordsApiService) CreateOrUpdateDocumentProperty ¶
func (a *WordsApiService) CreateOrUpdateDocumentProperty(ctx context.Context, name string, propertyName string, property models.IDocumentPropertyCreateOrUpdate, localVarOptionals map[string]interface{}) (models.DocumentPropertyResponse, *http.Response, error)
WordsApiService Adds a new or updates an existing document property. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param propertyName The name of the property. @param property The property with a new value. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.DocumentPropertyResponse
func (*WordsApiService) DeleteAllParagraphTabStops ¶
func (a *WordsApiService) DeleteAllParagraphTabStops(ctx context.Context, name string, index int32, localVarOptionals map[string]interface{}) (models.TabStopsResponse, *http.Response, error)
WordsApiService Removes paragraph tab stops from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
@return models.TabStopsResponse
func (*WordsApiService) DeleteBorder ¶
func (a *WordsApiService) DeleteBorder(ctx context.Context, name string, borderType string, localVarOptionals map[string]interface{}) (models.BorderResponse, *http.Response, error)
WordsApiService The 'nodePath' parameter should refer to a paragraph, a cell or a row. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param borderType Border type. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.BorderResponse
func (*WordsApiService) DeleteBorders ¶
func (a *WordsApiService) DeleteBorders(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.BordersResponse, *http.Response, error)
WordsApiService The 'nodePath' parameter should refer to a paragraph, a cell or a row. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.BordersResponse
func (*WordsApiService) DeleteComment ¶
func (a *WordsApiService) DeleteComment(ctx context.Context, name string, commentIndex int32, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Removes a comment from the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param commentIndex The index of the comment. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return
func (*WordsApiService) DeleteDocumentProperty ¶
func (a *WordsApiService) DeleteDocumentProperty(ctx context.Context, name string, propertyName string, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Removes a document property. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param propertyName The name of the property. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return
func (*WordsApiService) DeleteDrawingObject ¶
func (a *WordsApiService) DeleteDrawingObject(ctx context.Context, name string, index int32, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Removes a DrawingObject from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return
func (*WordsApiService) DeleteField ¶
func (a *WordsApiService) DeleteField(ctx context.Context, name string, index int32, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Removes a field from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return
func (*WordsApiService) DeleteFields ¶
func (a *WordsApiService) DeleteFields(ctx context.Context, name string, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Removes fields from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return
func (*WordsApiService) DeleteFile ¶
func (a *WordsApiService) DeleteFile(ctx context.Context, path string, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Delete file. * @param ctx context.Context for authentication, logging, tracing, etc. @param path Path of the file including file name and extension e.g. /Folder1/file.ext. @param optional (nil or map[string]interface{}) with one or more of: @param "storageName" (string) Storage name. @param "versionId" (string) File version ID to delete.
@return
func (*WordsApiService) DeleteFolder ¶
func (a *WordsApiService) DeleteFolder(ctx context.Context, path string, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Delete folder. * @param ctx context.Context for authentication, logging, tracing, etc. @param path Folder path e.g. /Folder1s. @param optional (nil or map[string]interface{}) with one or more of: @param "storageName" (string) Storage name. @param "recursive" (bool) Enable to delete folders, subfolders and files.
@return
func (*WordsApiService) DeleteFootnote ¶
func (a *WordsApiService) DeleteFootnote(ctx context.Context, name string, index int32, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Removes a footnote from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return
func (*WordsApiService) DeleteFormField ¶
func (a *WordsApiService) DeleteFormField(ctx context.Context, name string, index int32, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Removes a form field from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return
func (*WordsApiService) DeleteHeaderFooter ¶
func (a *WordsApiService) DeleteHeaderFooter(ctx context.Context, name string, sectionPath string, index int32, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Removes a HeaderFooter object from the document section. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param sectionPath The path to the section in the document tree. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return
func (*WordsApiService) DeleteHeadersFooters ¶
func (a *WordsApiService) DeleteHeadersFooters(ctx context.Context, name string, sectionPath string, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Removes HeaderFooter objects from the document section. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param sectionPath The path to the section in the document tree. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions. @param "headersFootersTypes" (string) The list of HeaderFooter types.
@return
func (*WordsApiService) DeleteMacros ¶
func (a *WordsApiService) DeleteMacros(ctx context.Context, name string, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Removes macros from the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return
func (*WordsApiService) DeleteOfficeMathObject ¶
func (a *WordsApiService) DeleteOfficeMathObject(ctx context.Context, name string, index int32, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Removes an OfficeMath object from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return
func (*WordsApiService) DeleteParagraph ¶
func (a *WordsApiService) DeleteParagraph(ctx context.Context, name string, index int32, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Removes a paragraph from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return
func (*WordsApiService) DeleteParagraphListFormat ¶
func (a *WordsApiService) DeleteParagraphListFormat(ctx context.Context, name string, index int32, localVarOptionals map[string]interface{}) (models.ParagraphListFormatResponse, *http.Response, error)
WordsApiService Removes the formatting properties of a paragraph list from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.ParagraphListFormatResponse
func (*WordsApiService) DeleteParagraphTabStop ¶
func (a *WordsApiService) DeleteParagraphTabStop(ctx context.Context, name string, position float64, index int32, localVarOptionals map[string]interface{}) (models.TabStopsResponse, *http.Response, error)
WordsApiService Removes a paragraph tab stop from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param position The position of a tab stop to remove. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
@return models.TabStopsResponse
func (*WordsApiService) DeleteRun ¶
func (a *WordsApiService) DeleteRun(ctx context.Context, name string, paragraphPath string, index int32, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Removes a Run object from the paragraph. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param paragraphPath The path to the paragraph in the document tree. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return
func (*WordsApiService) DeleteSection ¶
func (a *WordsApiService) DeleteSection(ctx context.Context, name string, sectionIndex int32, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Removes a section from the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param sectionIndex The index of the section. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return
func (*WordsApiService) DeleteTable ¶
func (a *WordsApiService) DeleteTable(ctx context.Context, name string, index int32, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Removes a table from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return
func (*WordsApiService) DeleteTableCell ¶
func (a *WordsApiService) DeleteTableCell(ctx context.Context, name string, tableRowPath string, index int32, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Removes a cell from the table row. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param tableRowPath The path to the table row in the document tree. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return
func (*WordsApiService) DeleteTableRow ¶
func (a *WordsApiService) DeleteTableRow(ctx context.Context, name string, tablePath string, index int32, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Removes a row from the table. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param tablePath The path to the table in the document tree. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return
func (*WordsApiService) DeleteWatermark ¶
func (a *WordsApiService) DeleteWatermark(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.DocumentResponse, *http.Response, error)
WordsApiService Removes a watermark from the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.DocumentResponse
func (*WordsApiService) DownloadFile ¶
func (a *WordsApiService) DownloadFile(ctx context.Context, path string, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Download file. * @param ctx context.Context for authentication, logging, tracing, etc. @param path Path of the file including the file name and extension e.g. /folder1/file.ext. @param optional (nil or map[string]interface{}) with one or more of: @param "storageName" (string) Storage name. @param "versionId" (string) File version ID to download.
@return *os.File
func (*WordsApiService) ExecuteMailMerge ¶
func (a *WordsApiService) ExecuteMailMerge(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.DocumentResponse, *http.Response, error)
WordsApiService Executes a Mail Merge operation. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "data" (string) Mail merge data. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "withRegions" (bool) The flag indicating whether to execute Mail Merge operation with regions. @param "mailMergeDataFile" (string) The data file. @param "cleanup" (string) The cleanup options. @param "useWholeParagraphAsRegion" (bool) The flag indicating whether paragraph with TableStart or TableEnd field should be fully included into mail merge region or particular range between TableStart and TableEnd fields. The default value is true. @param "destFileName" (string) The filename of the output document. If this parameter is omitted, the result will be saved with autogenerated name.
@return models.DocumentResponse
func (*WordsApiService) ExecuteMailMergeOnline ¶
func (a *WordsApiService) ExecuteMailMergeOnline(ctx context.Context, template *os.File, data *os.File, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Executes a Mail Merge operation online. * @param ctx context.Context for authentication, logging, tracing, etc. @param template File with template. @param data File with mailmerge data. @param optional (nil or map[string]interface{}) with one or more of: @param "withRegions" (bool) The flag indicating whether to execute Mail Merge operation with regions. @param "cleanup" (string) The cleanup options. @param "documentFileName" (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.
@return *os.File
func (*WordsApiService) GetAvailableFonts ¶
func (a *WordsApiService) GetAvailableFonts(ctx context.Context, localVarOptionals map[string]interface{}) (models.AvailableFontsResponse, *http.Response, error)
WordsApiService Reads available fonts from the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param optional (nil or map[string]interface{}) with one or more of: @param "fontsLocation" (string) The folder in cloud storage with custom fonts.
@return models.AvailableFontsResponse
func (*WordsApiService) GetBookmarkByName ¶
func (a *WordsApiService) GetBookmarkByName(ctx context.Context, name string, bookmarkName string, localVarOptionals map[string]interface{}) (models.BookmarkResponse, *http.Response, error)
WordsApiService Reads a bookmark, specified by name, from the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param bookmarkName The name of the bookmark. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.BookmarkResponse
func (*WordsApiService) GetBookmarks ¶
func (a *WordsApiService) GetBookmarks(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.BookmarksResponse, *http.Response, error)
WordsApiService Reads bookmarks from the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.BookmarksResponse
func (*WordsApiService) GetBorder ¶
func (a *WordsApiService) GetBorder(ctx context.Context, name string, borderType string, localVarOptionals map[string]interface{}) (models.BorderResponse, *http.Response, error)
WordsApiService The 'nodePath' parameter should refer to a paragraph, a cell or a row. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param borderType Border type. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.BorderResponse
func (*WordsApiService) GetBorders ¶
func (a *WordsApiService) GetBorders(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.BordersResponse, *http.Response, error)
WordsApiService Reads borders from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.BordersResponse
func (*WordsApiService) GetComment ¶
func (a *WordsApiService) GetComment(ctx context.Context, name string, commentIndex int32, localVarOptionals map[string]interface{}) (models.CommentResponse, *http.Response, error)
WordsApiService Reads a comment from the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param commentIndex The index of the comment. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.CommentResponse
func (*WordsApiService) GetComments ¶
func (a *WordsApiService) GetComments(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.CommentsResponse, *http.Response, error)
WordsApiService Reads comments from the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.CommentsResponse
func (*WordsApiService) GetDocument ¶
func (a *WordsApiService) GetDocument(ctx context.Context, documentName string, localVarOptionals map[string]interface{}) (models.DocumentResponse, *http.Response, error)
WordsApiService Reads common information from the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param documentName The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.DocumentResponse
func (*WordsApiService) GetDocumentDrawingObjectByIndex ¶
func (a *WordsApiService) GetDocumentDrawingObjectByIndex(ctx context.Context, name string, index int32, localVarOptionals map[string]interface{}) (models.DrawingObjectResponse, *http.Response, error)
WordsApiService Reads a DrawingObject from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.DrawingObjectResponse
func (*WordsApiService) GetDocumentDrawingObjectImageData ¶
func (a *WordsApiService) GetDocumentDrawingObjectImageData(ctx context.Context, name string, index int32, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Reads image data of a DrawingObject from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return *os.File
func (*WordsApiService) GetDocumentDrawingObjectOleData ¶
func (a *WordsApiService) GetDocumentDrawingObjectOleData(ctx context.Context, name string, index int32, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Reads OLE data of a DrawingObject from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return *os.File
func (*WordsApiService) GetDocumentDrawingObjects ¶
func (a *WordsApiService) GetDocumentDrawingObjects(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.DrawingObjectsResponse, *http.Response, error)
WordsApiService Reads DrawingObjects from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.DrawingObjectsResponse
func (*WordsApiService) GetDocumentFieldNames ¶
func (a *WordsApiService) GetDocumentFieldNames(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.FieldNamesResponse, *http.Response, error)
WordsApiService Reads merge field names from the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "useNonMergeFields" (bool) The flag indicating whether to use non merge fields. If true, result includes "mustache" field names.
@return models.FieldNamesResponse
func (*WordsApiService) GetDocumentFieldNamesOnline ¶
func (a *WordsApiService) GetDocumentFieldNamesOnline(ctx context.Context, template *os.File, localVarOptionals map[string]interface{}) (models.FieldNamesResponse, *http.Response, error)
WordsApiService Reads merge field names from the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param template File with template. @param optional (nil or map[string]interface{}) with one or more of: @param "useNonMergeFields" (bool) The flag indicating whether to use non merge fields. If true, result includes "mustache" field names.
@return models.FieldNamesResponse
func (*WordsApiService) GetDocumentHyperlinkByIndex ¶
func (a *WordsApiService) GetDocumentHyperlinkByIndex(ctx context.Context, name string, hyperlinkIndex int32, localVarOptionals map[string]interface{}) (models.HyperlinkResponse, *http.Response, error)
WordsApiService Reads a hyperlink from the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param hyperlinkIndex The index of the hyperlink. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.HyperlinkResponse
func (*WordsApiService) GetDocumentHyperlinks ¶
func (a *WordsApiService) GetDocumentHyperlinks(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.HyperlinksResponse, *http.Response, error)
WordsApiService Reads hyperlinks from the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.HyperlinksResponse
func (*WordsApiService) GetDocumentProperties ¶
func (a *WordsApiService) GetDocumentProperties(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.DocumentPropertiesResponse, *http.Response, error)
WordsApiService Reads document properties. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.DocumentPropertiesResponse
func (*WordsApiService) GetDocumentProperty ¶
func (a *WordsApiService) GetDocumentProperty(ctx context.Context, name string, propertyName string, localVarOptionals map[string]interface{}) (models.DocumentPropertyResponse, *http.Response, error)
WordsApiService Reads a document property. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param propertyName The name of the property. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.DocumentPropertyResponse
func (*WordsApiService) GetDocumentProtection ¶
func (a *WordsApiService) GetDocumentProtection(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.ProtectionDataResponse, *http.Response, error)
WordsApiService Reads protection properties from the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.ProtectionDataResponse
func (*WordsApiService) GetDocumentStatistics ¶
func (a *WordsApiService) GetDocumentStatistics(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.StatDataResponse, *http.Response, error)
WordsApiService Reads document statistics. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "includeComments" (bool) The flag indicating whether to include comments from the WordCount. The default value is "false". @param "includeFootnotes" (bool) The flag indicating whether to include footnotes from the WordCount. The default value is "false". @param "includeTextInShapes" (bool) The flag indicating whether to include shape's text from the WordCount. The default value is "false".
@return models.StatDataResponse
func (*WordsApiService) GetDocumentWithFormat ¶
func (a *WordsApiService) GetDocumentWithFormat(ctx context.Context, name string, format string, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Converts a document in cloud storage to the specified format. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param format The destination format. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "outPath" (string) The path to the output document. @param "fontsLocation" (string) Folder in filestorage with custom fonts.
@return *os.File
func (*WordsApiService) GetField ¶
func (a *WordsApiService) GetField(ctx context.Context, name string, index int32, localVarOptionals map[string]interface{}) (models.FieldResponse, *http.Response, error)
WordsApiService Reads a field from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.FieldResponse
func (*WordsApiService) GetFields ¶
func (a *WordsApiService) GetFields(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.FieldsResponse, *http.Response, error)
WordsApiService Reads fields from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.FieldsResponse
func (*WordsApiService) GetFilesList ¶
func (a *WordsApiService) GetFilesList(ctx context.Context, path string, localVarOptionals map[string]interface{}) (models.FilesList, *http.Response, error)
WordsApiService Get all files and folders within a folder. * @param ctx context.Context for authentication, logging, tracing, etc. @param path Folder path e.g. /Folder1. @param optional (nil or map[string]interface{}) with one or more of: @param "storageName" (string) Storage name.
@return models.FilesList
func (*WordsApiService) GetFootnote ¶
func (a *WordsApiService) GetFootnote(ctx context.Context, name string, index int32, localVarOptionals map[string]interface{}) (models.FootnoteResponse, *http.Response, error)
WordsApiService Reads a footnote from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.FootnoteResponse
func (*WordsApiService) GetFootnotes ¶
func (a *WordsApiService) GetFootnotes(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.FootnotesResponse, *http.Response, error)
WordsApiService Reads footnotes from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.FootnotesResponse
func (*WordsApiService) GetFormField ¶
func (a *WordsApiService) GetFormField(ctx context.Context, name string, index int32, localVarOptionals map[string]interface{}) (models.FormFieldResponse, *http.Response, error)
WordsApiService Reads a form field from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.FormFieldResponse
func (*WordsApiService) GetFormFields ¶
func (a *WordsApiService) GetFormFields(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.FormFieldsResponse, *http.Response, error)
WordsApiService Reads form fields from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.FormFieldsResponse
func (*WordsApiService) GetHeaderFooter ¶
func (a *WordsApiService) GetHeaderFooter(ctx context.Context, name string, headerFooterIndex int32, localVarOptionals map[string]interface{}) (models.HeaderFooterResponse, *http.Response, error)
WordsApiService Reads a HeaderFooter object from the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param headerFooterIndex The index of the HeaderFooter object. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "filterByType" (string) The list of HeaderFooter types.
@return models.HeaderFooterResponse
func (*WordsApiService) GetHeaderFooterOfSection ¶
func (a *WordsApiService) GetHeaderFooterOfSection(ctx context.Context, name string, headerFooterIndex int32, sectionIndex int32, localVarOptionals map[string]interface{}) (models.HeaderFooterResponse, *http.Response, error)
WordsApiService Reads a HeaderFooter object from the document section. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param headerFooterIndex The index of the HeaderFooter object. @param sectionIndex The index of the section. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "filterByType" (string) The list of HeaderFooter types.
@return models.HeaderFooterResponse
func (*WordsApiService) GetHeaderFooters ¶
func (a *WordsApiService) GetHeaderFooters(ctx context.Context, name string, sectionPath string, localVarOptionals map[string]interface{}) (models.HeaderFootersResponse, *http.Response, error)
WordsApiService Reads HeaderFooter objects from the document section. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param sectionPath The path to the section in the document tree. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "filterByType" (string) The list of HeaderFooter types.
@return models.HeaderFootersResponse
func (*WordsApiService) GetList ¶
func (a *WordsApiService) GetList(ctx context.Context, name string, listId int32, localVarOptionals map[string]interface{}) (models.ListResponse, *http.Response, error)
WordsApiService Reads a list from the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param listId The list Id. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.ListResponse
func (*WordsApiService) GetLists ¶
func (a *WordsApiService) GetLists(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.ListsResponse, *http.Response, error)
WordsApiService Reads lists from the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.ListsResponse
func (*WordsApiService) GetOfficeMathObject ¶
func (a *WordsApiService) GetOfficeMathObject(ctx context.Context, name string, index int32, localVarOptionals map[string]interface{}) (models.OfficeMathObjectResponse, *http.Response, error)
WordsApiService Reads an OfficeMath object from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.OfficeMathObjectResponse
func (*WordsApiService) GetOfficeMathObjects ¶
func (a *WordsApiService) GetOfficeMathObjects(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.OfficeMathObjectsResponse, *http.Response, error)
WordsApiService Reads OfficeMath objects from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.OfficeMathObjectsResponse
func (*WordsApiService) GetParagraph ¶
func (a *WordsApiService) GetParagraph(ctx context.Context, name string, index int32, localVarOptionals map[string]interface{}) (models.ParagraphResponse, *http.Response, error)
WordsApiService Reads a paragraph from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.ParagraphResponse
func (*WordsApiService) GetParagraphFormat ¶
func (a *WordsApiService) GetParagraphFormat(ctx context.Context, name string, index int32, localVarOptionals map[string]interface{}) (models.ParagraphFormatResponse, *http.Response, error)
WordsApiService Reads the formatting properties of a paragraph from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.ParagraphFormatResponse
func (*WordsApiService) GetParagraphListFormat ¶
func (a *WordsApiService) GetParagraphListFormat(ctx context.Context, name string, index int32, localVarOptionals map[string]interface{}) (models.ParagraphListFormatResponse, *http.Response, error)
WordsApiService Reads the formatting properties of a paragraph list from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.ParagraphListFormatResponse
func (*WordsApiService) GetParagraphTabStops ¶
func (a *WordsApiService) GetParagraphTabStops(ctx context.Context, name string, index int32, localVarOptionals map[string]interface{}) (models.TabStopsResponse, *http.Response, error)
WordsApiService Reads paragraph tab stops from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.TabStopsResponse
func (*WordsApiService) GetParagraphs ¶
func (a *WordsApiService) GetParagraphs(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.ParagraphLinkCollectionResponse, *http.Response, error)
WordsApiService Reads paragraphs from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.ParagraphLinkCollectionResponse
func (*WordsApiService) GetRangeText ¶
func (a *WordsApiService) GetRangeText(ctx context.Context, name string, rangeStartIdentifier string, localVarOptionals map[string]interface{}) (models.RangeTextResponse, *http.Response, error)
WordsApiService Reads range text from the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param rangeStartIdentifier The range start identifier. @param optional (nil or map[string]interface{}) with one or more of: @param "rangeEndIdentifier" (string) The range end identifier. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.RangeTextResponse
func (*WordsApiService) GetRun ¶
func (a *WordsApiService) GetRun(ctx context.Context, name string, paragraphPath string, index int32, localVarOptionals map[string]interface{}) (models.RunResponse, *http.Response, error)
WordsApiService Reads a Run object from the paragraph. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param paragraphPath The path to the paragraph in the document tree. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.RunResponse
func (*WordsApiService) GetRunFont ¶
func (a *WordsApiService) GetRunFont(ctx context.Context, name string, paragraphPath string, index int32, localVarOptionals map[string]interface{}) (models.FontResponse, *http.Response, error)
WordsApiService Reads the font properties of a Run object from the paragraph. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param paragraphPath The path to the paragraph in the document tree. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.FontResponse
func (*WordsApiService) GetRuns ¶
func (a *WordsApiService) GetRuns(ctx context.Context, name string, paragraphPath string, localVarOptionals map[string]interface{}) (models.RunsResponse, *http.Response, error)
WordsApiService Reads Run objects from the paragraph. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param paragraphPath The path to the paragraph in the document tree. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.RunsResponse
func (*WordsApiService) GetSection ¶
func (a *WordsApiService) GetSection(ctx context.Context, name string, sectionIndex int32, localVarOptionals map[string]interface{}) (models.SectionResponse, *http.Response, error)
WordsApiService Reads a section from the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param sectionIndex The index of the section. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.SectionResponse
func (*WordsApiService) GetSectionPageSetup ¶
func (a *WordsApiService) GetSectionPageSetup(ctx context.Context, name string, sectionIndex int32, localVarOptionals map[string]interface{}) (models.SectionPageSetupResponse, *http.Response, error)
WordsApiService Reads the page setup of a section from the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param sectionIndex The index of the section. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.SectionPageSetupResponse
func (*WordsApiService) GetSections ¶
func (a *WordsApiService) GetSections(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.SectionLinkCollectionResponse, *http.Response, error)
WordsApiService Reads sections from the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.SectionLinkCollectionResponse
func (*WordsApiService) GetStyle ¶
func (a *WordsApiService) GetStyle(ctx context.Context, name string, styleName string, localVarOptionals map[string]interface{}) (models.StyleResponse, *http.Response, error)
WordsApiService Reads a style from the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param styleName The name of the style. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.StyleResponse
func (*WordsApiService) GetStyleFromDocumentElement ¶
func (a *WordsApiService) GetStyleFromDocumentElement(ctx context.Context, name string, styledNodePath string, localVarOptionals map[string]interface{}) (models.StyleResponse, *http.Response, error)
WordsApiService Reads a style from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param styledNodePath The path to the node in the document tree, that supports styles: ParagraphFormat, List, ListLevel, Table. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.StyleResponse
func (*WordsApiService) GetStyles ¶
func (a *WordsApiService) GetStyles(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.StylesResponse, *http.Response, error)
WordsApiService Reads styles from the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.StylesResponse
func (*WordsApiService) GetTable ¶
func (a *WordsApiService) GetTable(ctx context.Context, name string, index int32, localVarOptionals map[string]interface{}) (models.TableResponse, *http.Response, error)
WordsApiService Reads a table from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.TableResponse
func (*WordsApiService) GetTableCell ¶
func (a *WordsApiService) GetTableCell(ctx context.Context, name string, tableRowPath string, index int32, localVarOptionals map[string]interface{}) (models.TableCellResponse, *http.Response, error)
WordsApiService Reads a cell from the table row. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param tableRowPath The path to the table row in the document tree. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.TableCellResponse
func (*WordsApiService) GetTableCellFormat ¶
func (a *WordsApiService) GetTableCellFormat(ctx context.Context, name string, tableRowPath string, index int32, localVarOptionals map[string]interface{}) (models.TableCellFormatResponse, *http.Response, error)
WordsApiService Reads the formatting properties of a table cell. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param tableRowPath The path to the table row in the document tree. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.TableCellFormatResponse
func (*WordsApiService) GetTableProperties ¶
func (a *WordsApiService) GetTableProperties(ctx context.Context, name string, index int32, localVarOptionals map[string]interface{}) (models.TablePropertiesResponse, *http.Response, error)
WordsApiService Reads properties of a table from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.TablePropertiesResponse
func (*WordsApiService) GetTableRow ¶
func (a *WordsApiService) GetTableRow(ctx context.Context, name string, tablePath string, index int32, localVarOptionals map[string]interface{}) (models.TableRowResponse, *http.Response, error)
WordsApiService Reads a row from the table. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param tablePath The path to the table in the document tree. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.TableRowResponse
func (*WordsApiService) GetTableRowFormat ¶
func (a *WordsApiService) GetTableRowFormat(ctx context.Context, name string, tablePath string, index int32, localVarOptionals map[string]interface{}) (models.TableRowFormatResponse, *http.Response, error)
WordsApiService Reads the formatting properties of a table row. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param tablePath The path to the table in the document tree. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.TableRowFormatResponse
func (*WordsApiService) GetTables ¶
func (a *WordsApiService) GetTables(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.TableLinkCollectionResponse, *http.Response, error)
WordsApiService Reads tables from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.TableLinkCollectionResponse
func (*WordsApiService) InsertComment ¶
func (a *WordsApiService) InsertComment(ctx context.Context, name string, comment models.ICommentInsert, localVarOptionals map[string]interface{}) (models.CommentResponse, *http.Response, error)
WordsApiService Inserts a new comment to the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param comment The properties of the comment. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.CommentResponse
func (*WordsApiService) InsertDrawingObject ¶
func (a *WordsApiService) InsertDrawingObject(ctx context.Context, name string, drawingObject models.IDrawingObjectInsert, imageFile *os.File, localVarOptionals map[string]interface{}) (models.DrawingObjectResponse, *http.Response, error)
WordsApiService Inserts a new DrawingObject to the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param drawingObject Drawing object parameters. @param imageFile File with image. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.DrawingObjectResponse
func (*WordsApiService) InsertField ¶
func (a *WordsApiService) InsertField(ctx context.Context, name string, field models.IFieldInsert, localVarOptionals map[string]interface{}) (models.FieldResponse, *http.Response, error)
WordsApiService Inserts a new field to the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param field The properties of the field. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions. @param "insertBeforeNode" (string) The index of the node. A new field will be inserted before the node with the specified node Id.
@return models.FieldResponse
func (*WordsApiService) InsertFootnote ¶
func (a *WordsApiService) InsertFootnote(ctx context.Context, name string, footnoteDto models.IFootnoteInsert, localVarOptionals map[string]interface{}) (models.FootnoteResponse, *http.Response, error)
WordsApiService Inserts a new footnote to the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param footnoteDto The properties of the footnote. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.FootnoteResponse
func (*WordsApiService) InsertFormField ¶
func (a *WordsApiService) InsertFormField(ctx context.Context, name string, formField models.IFormField, localVarOptionals map[string]interface{}) (models.FormFieldResponse, *http.Response, error)
WordsApiService Inserts a new form field to the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param formField The properties of the form field. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions. @param "insertBeforeNode" (string) The index of the node. A new form field will be inserted before the node with the specified node Id.
@return models.FormFieldResponse
func (*WordsApiService) InsertHeaderFooter ¶
func (a *WordsApiService) InsertHeaderFooter(ctx context.Context, name string, headerFooterType string, sectionPath string, localVarOptionals map[string]interface{}) (models.HeaderFooterResponse, *http.Response, error)
WordsApiService Inserts a new HeaderFooter object to the document section. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param headerFooterType The type of a HeaderFooter object. @param sectionPath The path to the section in the document tree. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.HeaderFooterResponse
func (*WordsApiService) InsertList ¶
func (a *WordsApiService) InsertList(ctx context.Context, name string, listInsert models.IListInsert, localVarOptionals map[string]interface{}) (models.ListResponse, *http.Response, error)
WordsApiService Inserts a new list to the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param listInsert The properties of the list. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.ListResponse
func (*WordsApiService) InsertOrUpdateParagraphTabStop ¶
func (a *WordsApiService) InsertOrUpdateParagraphTabStop(ctx context.Context, name string, dto models.ITabStopInsert, index int32, localVarOptionals map[string]interface{}) (models.TabStopsResponse, *http.Response, error)
WordsApiService Inserts a new or updates an existing paragraph tab stop in the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param dto The properties of the paragraph tab stop. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
@return models.TabStopsResponse
func (*WordsApiService) InsertPageNumbers ¶
func (a *WordsApiService) InsertPageNumbers(ctx context.Context, name string, pageNumber models.IPageNumber, localVarOptionals map[string]interface{}) (models.DocumentResponse, *http.Response, error)
WordsApiService Inserts page numbers to the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param pageNumber The page numbers settings. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.DocumentResponse
func (*WordsApiService) InsertParagraph ¶
func (a *WordsApiService) InsertParagraph(ctx context.Context, name string, paragraph models.IParagraphInsert, localVarOptionals map[string]interface{}) (models.ParagraphResponse, *http.Response, error)
WordsApiService Inserts a new paragraph to the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param paragraph The properties of the paragraph. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions. @param "insertBeforeNode" (string) The index of the node. A new paragraph will be inserted before the node with the specified index.
@return models.ParagraphResponse
func (*WordsApiService) InsertRun ¶
func (a *WordsApiService) InsertRun(ctx context.Context, name string, paragraphPath string, run models.IRunInsert, localVarOptionals map[string]interface{}) (models.RunResponse, *http.Response, error)
WordsApiService Inserts a new Run object to the paragraph. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param paragraphPath The path to the paragraph in the document tree. @param run The properties of the Run object. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions. @param "insertBeforeNode" (string) The index of the node. A new Run object will be inserted before the node with the specified node Id.
@return models.RunResponse
func (*WordsApiService) InsertStyle ¶
func (a *WordsApiService) InsertStyle(ctx context.Context, name string, styleInsert models.IStyleInsert, localVarOptionals map[string]interface{}) (models.StyleResponse, *http.Response, error)
WordsApiService Inserts a new style to the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param styleInsert The properties of the style. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.StyleResponse
func (*WordsApiService) InsertTable ¶
func (a *WordsApiService) InsertTable(ctx context.Context, name string, table models.ITableInsert, localVarOptionals map[string]interface{}) (models.TableResponse, *http.Response, error)
WordsApiService Inserts a new table to the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param table The properties of the table. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.TableResponse
func (*WordsApiService) InsertTableCell ¶
func (a *WordsApiService) InsertTableCell(ctx context.Context, name string, cell models.ITableCellInsert, tableRowPath string, localVarOptionals map[string]interface{}) (models.TableCellResponse, *http.Response, error)
WordsApiService Inserts a new cell to the table row. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param cell The properties of the cell. @param tableRowPath The path to the table row in the document tree. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.TableCellResponse
func (*WordsApiService) InsertTableRow ¶
func (a *WordsApiService) InsertTableRow(ctx context.Context, name string, row models.ITableRowInsert, tablePath string, localVarOptionals map[string]interface{}) (models.TableRowResponse, *http.Response, error)
WordsApiService Inserts a new row to the table. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param row The properties of the row. @param tablePath The path to the table in the document tree. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.TableRowResponse
func (*WordsApiService) InsertWatermarkImage ¶
func (a *WordsApiService) InsertWatermarkImage(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.DocumentResponse, *http.Response, error)
WordsApiService Inserts a new watermark image to the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "imageFile" (*os.File) File with image. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions. @param "rotationAngle" (float64) The rotation angle of the watermark. @param "image" (string) The filename of the image. If the parameter value is missing — the image data is expected in the request content.
@return models.DocumentResponse
func (*WordsApiService) InsertWatermarkText ¶
func (a *WordsApiService) InsertWatermarkText(ctx context.Context, name string, watermarkText models.IWatermarkText, localVarOptionals map[string]interface{}) (models.DocumentResponse, *http.Response, error)
WordsApiService Inserts a new watermark text to the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param watermarkText The watermark text to insert. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.DocumentResponse
func (*WordsApiService) LoadWebDocument ¶
func (a *WordsApiService) LoadWebDocument(ctx context.Context, data models.ILoadWebDocumentData, localVarOptionals map[string]interface{}) (models.SaveResponse, *http.Response, error)
WordsApiService Downloads a document from the Web using URL and saves it to cloud storage in the specified format. * @param ctx context.Context for authentication, logging, tracing, etc. @param data The properties of data downloading. @param optional (nil or map[string]interface{}) with one or more of: @param "storage" (string) Original document storage.
@return models.SaveResponse
func (*WordsApiService) MoveFile ¶
func (a *WordsApiService) MoveFile(ctx context.Context, destPath string, srcPath string, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Move file. * @param ctx context.Context for authentication, logging, tracing, etc. @param destPath Destination file path e.g. '/dest.ext'. @param srcPath Source file's path e.g. '/Folder 1/file.ext' or '/Bucket/Folder 1/file.ext'. @param optional (nil or map[string]interface{}) with one or more of: @param "srcStorageName" (string) Source storage name. @param "destStorageName" (string) Destination storage name. @param "versionId" (string) File version ID to move.
@return
func (*WordsApiService) MoveFolder ¶
func (a *WordsApiService) MoveFolder(ctx context.Context, destPath string, srcPath string, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Move folder. * @param ctx context.Context for authentication, logging, tracing, etc. @param destPath Destination folder path to move to e.g '/dst'. @param srcPath Source folder path e.g. /Folder1. @param optional (nil or map[string]interface{}) with one or more of: @param "srcStorageName" (string) Source storage name. @param "destStorageName" (string) Destination storage name.
@return
func (*WordsApiService) OptimizeDocument ¶
func (a *WordsApiService) OptimizeDocument(ctx context.Context, name string, options models.IOptimizationOptions, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Applies document content optimization options, specific to a particular versions of Microsoft Word. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param options The document optimization options. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return
func (*WordsApiService) ProtectDocument ¶
func (a *WordsApiService) ProtectDocument(ctx context.Context, name string, protectionRequest models.IProtectionRequest, localVarOptionals map[string]interface{}) (models.ProtectionDataResponse, *http.Response, error)
WordsApiService Adds protection to the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param protectionRequest The protection settings. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
@return models.ProtectionDataResponse
func (*WordsApiService) RejectAllRevisions ¶
func (a *WordsApiService) RejectAllRevisions(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.RevisionsModificationResponse, *http.Response, error)
WordsApiService Rejects all revisions in the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
@return models.RevisionsModificationResponse
func (*WordsApiService) RemoveRange ¶
func (a *WordsApiService) RemoveRange(ctx context.Context, name string, rangeStartIdentifier string, localVarOptionals map[string]interface{}) (models.DocumentResponse, *http.Response, error)
WordsApiService Removes a range from the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param rangeStartIdentifier The range start identifier. @param optional (nil or map[string]interface{}) with one or more of: @param "rangeEndIdentifier" (string) The range end identifier. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
@return models.DocumentResponse
func (*WordsApiService) RenderDrawingObject ¶
func (a *WordsApiService) RenderDrawingObject(ctx context.Context, name string, format string, index int32, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Renders a DrawingObject to the specified format. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param format The destination format. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "fontsLocation" (string) Folder in filestorage with custom fonts.
@return *os.File
func (*WordsApiService) RenderMathObject ¶
func (a *WordsApiService) RenderMathObject(ctx context.Context, name string, format string, index int32, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Renders an OfficeMath object to the specified format. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param format The destination format. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "fontsLocation" (string) Folder in filestorage with custom fonts.
@return *os.File
func (*WordsApiService) RenderPage ¶
func (a *WordsApiService) RenderPage(ctx context.Context, name string, pageIndex int32, format string, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Renders a page to the specified format. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param pageIndex The index of the page. @param format The destination format. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "fontsLocation" (string) Folder in filestorage with custom fonts.
@return *os.File
func (*WordsApiService) RenderParagraph ¶
func (a *WordsApiService) RenderParagraph(ctx context.Context, name string, format string, index int32, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Renders a paragraph to the specified format. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param format The destination format. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "fontsLocation" (string) Folder in filestorage with custom fonts.
@return *os.File
func (*WordsApiService) RenderTable ¶
func (a *WordsApiService) RenderTable(ctx context.Context, name string, format string, index int32, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Renders a table to the specified format. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param format The destination format. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "fontsLocation" (string) Folder in filestorage with custom fonts.
@return *os.File
func (*WordsApiService) ReplaceText ¶
func (a *WordsApiService) ReplaceText(ctx context.Context, name string, replaceText models.IReplaceTextParameters, localVarOptionals map[string]interface{}) (models.ReplaceTextResponse, *http.Response, error)
WordsApiService Replaces text in the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param replaceText The text replacement parameters. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.ReplaceTextResponse
func (*WordsApiService) ReplaceWithText ¶
func (a *WordsApiService) ReplaceWithText(ctx context.Context, name string, rangeStartIdentifier string, rangeText models.IReplaceRange, localVarOptionals map[string]interface{}) (models.DocumentResponse, *http.Response, error)
WordsApiService Replaces a range with text in the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param rangeStartIdentifier The range start identifier. @param rangeText The text replacement properties. @param optional (nil or map[string]interface{}) with one or more of: @param "rangeEndIdentifier" (string) The range end identifier. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
@return models.DocumentResponse
func (*WordsApiService) ResetCache ¶
WordsApiService Clears the font cache. * @param ctx context.Context for authentication, logging, tracing, etc.
@return
func (*WordsApiService) SaveAs ¶
func (a *WordsApiService) SaveAs(ctx context.Context, name string, saveOptionsData models.ISaveOptionsData, localVarOptionals map[string]interface{}) (models.SaveResponse, *http.Response, error)
WordsApiService Converts a document in cloud storage to the specified format. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param saveOptionsData The save options. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "fontsLocation" (string) Folder in filestorage with custom fonts.
@return models.SaveResponse
func (*WordsApiService) SaveAsRange ¶
func (a *WordsApiService) SaveAsRange(ctx context.Context, name string, rangeStartIdentifier string, documentParameters models.IRangeDocument, localVarOptionals map[string]interface{}) (models.DocumentResponse, *http.Response, error)
WordsApiService Saves a range as a new document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param rangeStartIdentifier The range start identifier. @param documentParameters The parameters of a new document. @param optional (nil or map[string]interface{}) with one or more of: @param "rangeEndIdentifier" (string) The range end identifier. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.DocumentResponse
func (*WordsApiService) SaveAsTiff ¶
func (a *WordsApiService) SaveAsTiff(ctx context.Context, name string, saveOptions models.ITiffSaveOptionsData, localVarOptionals map[string]interface{}) (models.SaveResponse, *http.Response, error)
WordsApiService Converts a document in cloud storage to TIFF format using detailed conversion settings. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param saveOptions The save options to TIFF format. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "useAntiAliasing" (bool) The flag indicating whether to use antialiasing. @param "useHighQualityRendering" (bool) The flag indicating whether to use high quality. @param "imageBrightness" (float64) The level of brightness for the generated images. @param "imageColorMode" (string) The color mode for the generated images. @param "imageContrast" (float64) The contrast for the generated images. @param "numeralFormat" (string) The images numeral format. @param "pageCount" (int32) The number of pages to render. @param "pageIndex" (int32) The index of the page to start rendering. @param "paperColor" (string) The background image color. @param "pixelFormat" (string) The pixel format of the generated images. @param "resolution" (float64) The resolution of the generated images. @param "scale" (float64) The zoom factor for the generated images. @param "tiffCompression" (string) The compression tipe. @param "dmlRenderingMode" (string) The optional dml rendering mode. The default value is Fallback. @param "dmlEffectsRenderingMode" (string) The optional dml effects rendering mode. The default value is Simplified. @param "tiffBinarizationMethod" (string) The optional TIFF binarization method. Possible values are: FloydSteinbergDithering, Threshold. @param "zipOutput" (bool) The flag indicating whether to ZIP the output. @param "fontsLocation" (string) Folder in filestorage with custom fonts.
@return models.SaveResponse
func (*WordsApiService) Search ¶
func (a *WordsApiService) Search(ctx context.Context, name string, pattern string, localVarOptionals map[string]interface{}) (models.SearchResponse, *http.Response, error)
WordsApiService Searches text, specified by the regular expression, in the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param pattern The regular expression used to find matches. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document.
@return models.SearchResponse
func (*WordsApiService) SplitDocument ¶
func (a *WordsApiService) SplitDocument(ctx context.Context, name string, format string, localVarOptionals map[string]interface{}) (models.SplitDocumentResponse, *http.Response, error)
WordsApiService Splits a document into parts and saves them in the specified format. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param format The format to split. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "from" (int32) The start page. @param "to" (int32) The end page. @param "zipOutput" (bool) The flag indicating whether to ZIP the output. @param "fontsLocation" (string) Folder in filestorage with custom fonts.
@return models.SplitDocumentResponse
func (*WordsApiService) UnprotectDocument ¶
func (a *WordsApiService) UnprotectDocument(ctx context.Context, name string, protectionRequest models.IProtectionRequest, localVarOptionals map[string]interface{}) (models.ProtectionDataResponse, *http.Response, error)
WordsApiService Removes protection from the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param protectionRequest The protection settings. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
@return models.ProtectionDataResponse
func (*WordsApiService) UpdateBookmark ¶
func (a *WordsApiService) UpdateBookmark(ctx context.Context, name string, bookmarkData models.IBookmarkData, bookmarkName string, localVarOptionals map[string]interface{}) (models.BookmarkResponse, *http.Response, error)
WordsApiService Updates a bookmark in the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param bookmarkData The properties of the bookmark. @param bookmarkName The name of the bookmark. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.BookmarkResponse
func (*WordsApiService) UpdateBorder ¶
func (a *WordsApiService) UpdateBorder(ctx context.Context, name string, borderProperties models.IBorder, borderType string, localVarOptionals map[string]interface{}) (models.BorderResponse, *http.Response, error)
WordsApiService The 'nodePath' parameter should refer to a paragraph, a cell or a row. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param borderProperties The new border properties to update. @param borderType Border type. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.BorderResponse
func (*WordsApiService) UpdateComment ¶
func (a *WordsApiService) UpdateComment(ctx context.Context, name string, commentIndex int32, comment models.ICommentUpdate, localVarOptionals map[string]interface{}) (models.CommentResponse, *http.Response, error)
WordsApiService Updates a comment in the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param commentIndex The index of the comment. @param comment The properties of the comment. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.CommentResponse
func (*WordsApiService) UpdateDrawingObject ¶
func (a *WordsApiService) UpdateDrawingObject(ctx context.Context, name string, drawingObject models.IDrawingObjectUpdate, imageFile *os.File, index int32, localVarOptionals map[string]interface{}) (models.DrawingObjectResponse, *http.Response, error)
WordsApiService Updates a DrawingObject in the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param drawingObject Drawing object parameters. @param imageFile File with image. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.DrawingObjectResponse
func (*WordsApiService) UpdateField ¶
func (a *WordsApiService) UpdateField(ctx context.Context, name string, field models.IFieldUpdate, index int32, localVarOptionals map[string]interface{}) (models.FieldResponse, *http.Response, error)
WordsApiService Updates a field in the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param field The properties of the field. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.FieldResponse
func (*WordsApiService) UpdateFields ¶
func (a *WordsApiService) UpdateFields(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.DocumentResponse, *http.Response, error)
WordsApiService Reevaluates field values in the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
@return models.DocumentResponse
func (*WordsApiService) UpdateFootnote ¶
func (a *WordsApiService) UpdateFootnote(ctx context.Context, name string, footnoteDto models.IFootnoteUpdate, index int32, localVarOptionals map[string]interface{}) (models.FootnoteResponse, *http.Response, error)
WordsApiService Updates a footnote in the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param footnoteDto The properties of the footnote. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.FootnoteResponse
func (*WordsApiService) UpdateFormField ¶
func (a *WordsApiService) UpdateFormField(ctx context.Context, name string, formField models.IFormField, index int32, localVarOptionals map[string]interface{}) (models.FormFieldResponse, *http.Response, error)
WordsApiService Updates a form field in the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param formField The new form field properties. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.FormFieldResponse
func (*WordsApiService) UpdateList ¶
func (a *WordsApiService) UpdateList(ctx context.Context, name string, listUpdate models.IListUpdate, listId int32, localVarOptionals map[string]interface{}) (models.ListResponse, *http.Response, error)
WordsApiService Updates a list in the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param listUpdate The properties of the list. @param listId The list Id. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.ListResponse
func (*WordsApiService) UpdateListLevel ¶
func (a *WordsApiService) UpdateListLevel(ctx context.Context, name string, listUpdate models.IListLevelUpdate, listId int32, listLevel int32, localVarOptionals map[string]interface{}) (models.ListResponse, *http.Response, error)
WordsApiService Updates the level of a List element in the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param listUpdate The properties of the List element. @param listId The list Id. @param listLevel The list level. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.ListResponse
func (*WordsApiService) UpdateParagraphFormat ¶
func (a *WordsApiService) UpdateParagraphFormat(ctx context.Context, name string, dto models.IParagraphFormatUpdate, index int32, localVarOptionals map[string]interface{}) (models.ParagraphFormatResponse, *http.Response, error)
WordsApiService Updates the formatting properties of a paragraph in the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param dto The formatting properties of a paragraph. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.ParagraphFormatResponse
func (*WordsApiService) UpdateParagraphListFormat ¶
func (a *WordsApiService) UpdateParagraphListFormat(ctx context.Context, name string, dto models.IListFormatUpdate, index int32, localVarOptionals map[string]interface{}) (models.ParagraphListFormatResponse, *http.Response, error)
WordsApiService Updates the formatting properties of a paragraph list in the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param dto The formatting properties of a paragraph list. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.ParagraphListFormatResponse
func (*WordsApiService) UpdateRun ¶
func (a *WordsApiService) UpdateRun(ctx context.Context, name string, run models.IRunUpdate, paragraphPath string, index int32, localVarOptionals map[string]interface{}) (models.RunResponse, *http.Response, error)
WordsApiService Updates a Run object in the paragraph. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param run The properties of the Run object. @param paragraphPath The path to the paragraph in the document tree. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.RunResponse
func (*WordsApiService) UpdateRunFont ¶
func (a *WordsApiService) UpdateRunFont(ctx context.Context, name string, fontDto models.IFont, paragraphPath string, index int32, localVarOptionals map[string]interface{}) (models.FontResponse, *http.Response, error)
WordsApiService Updates the font properties of a Run object in the paragraph. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param fontDto The font properties of a Run object. @param paragraphPath The path to the paragraph in the document tree. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.FontResponse
func (*WordsApiService) UpdateSectionPageSetup ¶
func (a *WordsApiService) UpdateSectionPageSetup(ctx context.Context, name string, sectionIndex int32, pageSetup models.IPageSetup, localVarOptionals map[string]interface{}) (models.SectionPageSetupResponse, *http.Response, error)
WordsApiService Updates the page setup of a section in the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param sectionIndex The index of the section. @param pageSetup The properties of the page setup. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.SectionPageSetupResponse
func (*WordsApiService) UpdateStyle ¶
func (a *WordsApiService) UpdateStyle(ctx context.Context, name string, styleUpdate models.IStyleUpdate, styleName string, localVarOptionals map[string]interface{}) (models.StyleResponse, *http.Response, error)
WordsApiService Updates a style in the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param styleUpdate The properties of the style. @param styleName The name of the style. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.StyleResponse
func (*WordsApiService) UpdateTableCellFormat ¶
func (a *WordsApiService) UpdateTableCellFormat(ctx context.Context, name string, format models.ITableCellFormat, tableRowPath string, index int32, localVarOptionals map[string]interface{}) (models.TableCellFormatResponse, *http.Response, error)
WordsApiService Updates the formatting properties of a cell in the table row. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param format The cell format. @param tableRowPath The path to the table row in the document tree. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.TableCellFormatResponse
func (*WordsApiService) UpdateTableProperties ¶
func (a *WordsApiService) UpdateTableProperties(ctx context.Context, name string, properties models.ITableProperties, index int32, localVarOptionals map[string]interface{}) (models.TablePropertiesResponse, *http.Response, error)
WordsApiService Updates properties of a table in the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param properties The properties of the table. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) The path to the node in the document tree. @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.TablePropertiesResponse
func (*WordsApiService) UpdateTableRowFormat ¶
func (a *WordsApiService) UpdateTableRowFormat(ctx context.Context, name string, format models.ITableRowFormat, tablePath string, index int32, localVarOptionals map[string]interface{}) (models.TableRowFormatResponse, *http.Response, error)
WordsApiService Updates the formatting properties of a table row. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The filename of the input document. @param format The row format. @param tablePath The path to the table in the document tree. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "folder" (string) Original document folder. @param "storage" (string) Original document storage. @param "loadEncoding" (string) Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param "password" (string) Password for opening an encrypted document. @param "destFileName" (string) Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. @param "revisionAuthor" (string) Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. @param "revisionDateTime" (string) The date and time to use for revisions.
@return models.TableRowFormatResponse
func (*WordsApiService) UploadFile ¶
func (a *WordsApiService) UploadFile(ctx context.Context, fileContent *os.File, path string, localVarOptionals map[string]interface{}) (models.FilesUploadResult, *http.Response, error)
WordsApiService Upload file. * @param ctx context.Context for authentication, logging, tracing, etc. @param fileContent File to upload. @param path Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext If the content is multipart and path does not contains the file name it tries to get them from filename parameter from Content-Disposition header. @param optional (nil or map[string]interface{}) with one or more of: @param "storageName" (string) Storage name.
@return models.FilesUploadResult