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.8 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 document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @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 original document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name Original document name. @param documentList DocumentEntryList with a list 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 Apply a style to the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param styleApply Style to apply. @param styledNodePath The path to the node that supports a style. Supported node types: 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 document "build report" operation. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The template name. @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) Result name of the document after the operation. If this parameter is omitted then result of the operation 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 document "build report" online operation. * @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) This file name will be used when resulting document has dynamic field for document file name {filename}. If it is not set, "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 Classifies raw text. * @param ctx context.Context for authentication, logging, tracing, etc. @param text Text to classify. @param optional (nil or map[string]interface{}) with one or more of: @param "bestClassesCount" (string) 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 Classifies document. * @param ctx context.Context for authentication, logging, tracing, etc. @param documentName The document name. @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) Count of the best classes to return. @param "taxonomy" (string) Taxonomy to use for classification return.
@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 document with original document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name Original document name. @param compareData CompareData with a document to compare. @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 document from the request's content to the specified format. * @param ctx context.Context for authentication, logging, tracing, etc. @param document Converting document. @param format Format to convert. @param optional (nil or map[string]interface{}) with one or more of: @param "storage" (string) Original document storage. @param "outPath" (string) Path for saving operation result to the local storage. @param "fileNameFieldValue" (string) This file name will be used when resulting document has dynamic field for document file name {filename}. If it is not set, "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 Copy and insert a new style to the document, returns a copied style. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param styleCopy Style to copy. @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 Creates new document. Document is created with format which is recognized from file extensions. 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 document name. @param "folder" (string) 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 new or update existing document property. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param propertyName The property name. @param property The property with 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 Remove all tab stops. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node which contains paragraph. @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 'nodePath' should refer to paragraph, cell or row. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param borderType Border type. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node with border(node should be paragraph, cell or row). @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 'nodePath' should refer to paragraph, cell or row. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node with borders(node should be paragraph, cell or row). @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 comment from document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param commentIndex The comment 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) DeleteDocumentProperty ¶
func (a *WordsApiService) DeleteDocumentProperty(ctx context.Context, name string, propertyName string, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Deletes document property. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param propertyName The property name. @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 drawing object from document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains collection of drawing objects. @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 Deletes field from document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains collection of fields. @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 section paragraph. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains collection of fields. @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 footnote from document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains collection of footnotes. @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 form field from document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node that contains collection of formfields. @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 Deletes header/footer from document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param sectionPath Path to parent section. @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 Deletes document headers and footers. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param sectionPath Path to parent 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. @param "headersFootersTypes" (string) List of types of headers and footers.
@return
func (*WordsApiService) DeleteMacros ¶
func (a *WordsApiService) DeleteMacros(ctx context.Context, name string, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Removes macros from document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @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 OfficeMath object from document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains collection of OfficeMath objects. @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 paragraph from section. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The file name. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node which contains paragraphs. @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 Delete paragraph list format, returns updated list format properties. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node which contains paragraphs. @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 Remove the i-th tab stop. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param position a tab stop position to remove. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node which contains paragraph. @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 run from document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param paragraphPath Path to parent paragraph. @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 section from document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param sectionIndex Section 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) DeleteTable ¶
func (a *WordsApiService) DeleteTable(ctx context.Context, name string, index int32, localVarOptionals map[string]interface{}) (*http.Response, error)
WordsApiService Deletes a table. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains tables. @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 Deletes a table cell. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param tableRowPath Path to table row. @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 Deletes a table row. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param tablePath Path to table. @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 Deletes watermark (for deleting last watermark from the document). * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @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 document mail merge operation. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The template name. @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) With regions flag. @param "mailMergeDataFile" (string) Mail merge data file. @param "cleanup" (string) Clean up options. @param "useWholeParagraphAsRegion" (bool) Gets or sets a value 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) Result name of the document after the operation. If this parameter is omitted then result of the operation 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 document mail merge 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) With regions flag. @param "cleanup" (string) Clean up options. @param "documentFileName" (string) This file name will be used when resulting document has dynamic field for document file name {filename}. If it is not set, "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 Gets the list of fonts, available for document processing. * @param ctx context.Context for authentication, logging, tracing, etc. @param optional (nil or map[string]interface{}) with one or more of: @param "fontsLocation" (string) Folder in filestorage 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 document bookmark data by its name. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param bookmarkName The bookmark name. @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 document bookmarks common info. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @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 'nodePath' should refer to paragraph, cell or row. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param borderType Border type. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node with border(node should be paragraph, cell or row). @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 'nodePath' should refer to paragraph, cell or row. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node with borders (node should be paragraph, cell or row). @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 Gets comment from document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param commentIndex The comment 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.CommentResponse
func (*WordsApiService) GetComments ¶
func (a *WordsApiService) GetComments(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.CommentsResponse, *http.Response, error)
WordsApiService Gets comments from document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @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 document common info. * @param ctx context.Context for authentication, logging, tracing, etc. @param documentName The document name. @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 document drawing object common info by its index or convert to format specified. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains collection of drawing objects. @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 drawing object image data. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains collection of drawing objects. @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 Gets drawing object OLE data. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains collection of drawing objects. @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 document drawing objects common info. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains collection of drawing objects. @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 document field names. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The template name. @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) 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 document field names. * @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) Use non merge fields or not.
@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 document hyperlink by its index. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param hyperlinkIndex The hyperlink 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.HyperlinkResponse
func (*WordsApiService) GetDocumentHyperlinks ¶
func (a *WordsApiService) GetDocumentHyperlinks(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.HyperlinksResponse, *http.Response, error)
WordsApiService Reads document hyperlinks common info. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @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 info. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document's name. @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 document property info by the property name. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param propertyName The property name. @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 document protection common info. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @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 document name. @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) Support including/excluding comments from the WordCount. Default value is "false". @param "includeFootnotes" (bool) Support including/excluding footnotes from the WordCount. Default value is "false". @param "includeTextInShapes" (bool) Support including/excluding shape's text from the WordCount. 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 Exports the document into the specified format. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @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) Path to save the result. @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 Gets field from document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains collection of fields. @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 Get fields from document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains collection of fields. @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 footnote by index. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains collection of footnotes. @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 Gets footnotes from document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains collection of footnotes. @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 Returns representation of an one of the form field. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node that contains collection of formfields. @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 Gets form fields from document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node containing collection of form fields. @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 Returns a header/footer from the document by index. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param headerFooterIndex Header/footer 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 "filterByType" (string) List of types of headers and footers.
@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 Returns a header/footer from the document section. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param headerFooterIndex Header/footer index. @param sectionIndex Section 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 "filterByType" (string) List of types of headers and footers.
@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 Returns a list of header/footers from the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param sectionPath Path to parent 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) List of types of headers and footers.
@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 This resource represents one of the lists contained in the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param listId List unique identifier. @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 Returns a list of lists that are contained in the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @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 OfficeMath object by index. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains collection of OfficeMath objects. @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 Gets OfficeMath objects from document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains collection of OfficeMath objects. @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 This resource represents one of the paragraphs contained in the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node which contains paragraphs. @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 Represents all the formatting for a paragraph. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node which contains paragraphs. @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 Represents list format for a paragraph. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node which contains paragraphs. @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 Get all tab stops for the paragraph. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node which contains paragraph. @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 Returns a list of paragraphs that are contained in the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node which contains paragraphs. @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 Gets the text from the range. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document. @param rangeStartIdentifier The range start identifier. Identifier is the value of the "nodeId" field, which every document node has, extended with the prefix "id". It looks like "id0.0.7". Also values like "image5" and "table3" can be used as an identifier for images and tables, where the number is an index of the image/table. @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 This resource represents run of text contained in the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param paragraphPath Path to parent paragraph. @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 This resource represents font of run. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param paragraphPath Path to parent paragraph. @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 This resource represents collection of runs in the paragraph. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param paragraphPath Path to parent paragraph. @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 Gets document section by index. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param sectionIndex Section 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.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 Gets page setup of section. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param sectionIndex Section 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.SectionPageSetupResponse
func (*WordsApiService) GetSections ¶
func (a *WordsApiService) GetSections(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.SectionLinkCollectionResponse, *http.Response, error)
WordsApiService Returns a list of sections that are contained in the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @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 This resource represents one of the styles contained in the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param styleName Style name. @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 Gets a style from the document node. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param styledNodePath The path to the node that supports a style. Supported node types: 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 Returns a list of styles contained in the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @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 Returns a table. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains tables. @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 Returns a table cell. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param tableRowPath Path to table row. @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 Returns a table cell format. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param tableRowPath Path to table row. @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 Returns a table properties. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains tables. @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 Returns a table row. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param tablePath Path to table. @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 Returns a table row format. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param tablePath Path to table. @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 Returns a list of tables that are contained in the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains tables. @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 Adds comment to document, returns inserted comment data. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param comment The comment data. @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 Adds drawing object to document, returns added drawing object's data. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @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) Path to the node, which contains collection of drawing objects. @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 Adds field to document, returns inserted field's data. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param field Field data. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains collection of fields. @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) Field will be inserted before node with id="nodeId".
@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 Adds footnote to document, returns added footnote's data. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param footnoteDto Footnote data. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains collection of footnotes. @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 Adds form field to paragraph, returns added form field's data. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param formField From field data. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node that contains collection of formfields. @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) Form field will be inserted before node with index.
@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 to document header or footer. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param headerFooterType Type of header/footer. @param sectionPath Path to parent 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 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 Adds list to document, returns added list's data. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param listInsert List 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.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 Insert or resplace tab stop if a tab stop with the position exists. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param dto Paragraph tab stop. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node which contains paragraph. @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 document page numbers. * @param ctx context.Context for authentication, logging, tracing, etc. @param name A document name. @param pageNumber PageNumber with 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 Adds paragraph to document, returns added paragraph's data. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param paragraph Paragraph data. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node which contains paragraphs. @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) Paragraph will be inserted before node with 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 Adds run to document, returns added paragraph's data. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param paragraphPath Path to parent paragraph. @param run Run data. @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) Paragraph will be inserted before node with index.
@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 Adds a style to the document, returns an added style. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param styleInsert Style 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.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 Adds table to document, returns added table's data. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param table Table parameters/. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains tables. @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 Adds table cell to table, returns added cell's data. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param cell Table cell parameters/. @param tableRowPath Path to table row. @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 Adds table row to table, returns added row's data. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param row Table row parameters/. @param tablePath Path to 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.TableRowResponse
func (*WordsApiService) InsertWatermarkImage ¶
func (a *WordsApiService) InsertWatermarkImage(ctx context.Context, name string, localVarOptionals map[string]interface{}) (models.DocumentResponse, *http.Response, error)
WordsApiService Inserts document watermark image. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @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 watermark rotation angle. @param "image" (string) The image file server full name. If the name is empty the image is expected in 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 document watermark text. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param watermarkText WatermarkText with the watermark data. @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 Loads new document from web into the file with any supported format of data. * @param ctx context.Context for authentication, logging, tracing, etc. @param data Parameters of loading. @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 Allows to optimize the document contents as well as default Aspose.Words behavior to a particular versions of MS Word. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @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 Protects document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param protectionRequest ProtectionRequest with 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 document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @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 the range from the document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document. @param rangeStartIdentifier The range start identifier. Identifier is the value of the "nodeId" field, which every document node has, extended with the prefix "id". It looks like "id0.0.7". Also values like "image5" and "table3" can be used as an identifier for images and tables, where the number is an index of the image/table. @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 drawing object to specified format. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param format The destination format. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains drawing objects. @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 math object to specified format. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param format The destination format. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains office math objects. @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 page to specified format. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param pageIndex Comment index. @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 paragraph to specified format. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param format The destination format. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains paragraphs. @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 table to specified format. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param format The destination format. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains tables. @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 document text. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param replaceText ReplaceTextResponse with the replace operation 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.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 the content in the range. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document. @param rangeStartIdentifier The range start identifier. Identifier is the value of the "nodeId" field, which every document node has, extended with the prefix "id". It looks like "id0.0.7". Also values like "image5" and "table3" can be used as an identifier for images and tables, where the number is an index of the image/table. @param rangeText Model with text for replacement. @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 Resets font's 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 document to destination format with detailed settings and saves result to storage. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param saveOptionsData 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 the selected range as a new document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document. @param rangeStartIdentifier The range start identifier. Identifier is the value of the "nodeId" field, which every document node has, extended with the prefix "id". It looks like "id0.0.7". Also values like "image5" and "table3" can be used as an identifier for images and tables, where the number is an index of the image/table. @param documentParameters 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 document to tiff with detailed settings and saves result to storage. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param saveOptions Tiff 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 "useAntiAliasing" (bool) Use antialiasing flag. @param "useHighQualityRendering" (bool) Use high quality flag. @param "imageBrightness" (float64) Brightness for the generated images. @param "imageColorMode" (string) 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) Number of pages to render. @param "pageIndex" (int32) Page index to start rendering. @param "paperColor" (string) Background image color. @param "pixelFormat" (string) The pixel format of generated images. @param "resolution" (float64) The resolution of generated images. @param "scale" (float64) Zoom factor for generated images. @param "tiffCompression" (string) The compression tipe. @param "dmlRenderingMode" (string) Optional, default is Fallback. @param "dmlEffectsRenderingMode" (string) Optional, default is Simplified. @param "tiffBinarizationMethod" (string) Optional, Tiff binarization method, possible values are: FloydSteinbergDithering, Threshold. @param "zipOutput" (bool) Optional. A value determining zip output or not. @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 in document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @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 document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name Original document name. @param format 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) Start page. @param "to" (int32) End page. @param "zipOutput" (bool) ZipOutput or not. @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 Unprotects document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param protectionRequest ProtectionRequest with 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 document bookmark. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param bookmarkData BookmarkData with new bookmark data. @param bookmarkName The bookmark name. @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 'nodePath' should refer to paragraph, cell or row. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param borderProperties Border properties. @param borderType Border type. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node with border(node should be paragraph, cell or row). @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 the comment, returns updated comment data. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param commentIndex The comment index. @param comment The comment data. @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 drawing object, returns updated drawing object's data. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @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) Path to the node, which contains collection of drawing objects. @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 field's properties, returns updated field's data. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param field Field data. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains collection of fields. @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 Updates (reevaluate) fields in document. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @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 footnote's properties, returns updated run's data. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param footnoteDto Footnote data. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains collection of footnotes. @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 properties of form field, returns updated form field. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param formField From field data. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node that contains collection of formfields. @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 list properties, returns updated list. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param listUpdate List object. @param listId List unique identifier. @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 list level in document list, returns updated list. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param listUpdate List object. @param listId List unique identifier. @param listLevel List level identifier. @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 paragraph format properties, returns updated format properties. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param dto Paragraph format object. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node which contains paragraphs. @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 paragraph list format properties, returns updated list format properties. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param dto Paragraph format object. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node which contains paragraphs. @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 run's properties, returns updated run's data. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param run Run data. @param paragraphPath Path to parent paragraph. @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 font properties, returns updated font data. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param fontDto Font dto object. @param paragraphPath Path to parent paragraph. @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 page setup of section. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param sectionIndex Section index. @param pageSetup Page setup properties dto. @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 style properties, returns an updated style. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param styleUpdate Style properties to update. @param styleName Style name. @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 a table cell format. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param format The properties. @param tableRowPath Path to table row. @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 a table properties. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param properties The properties. @param index Object index. @param optional (nil or map[string]interface{}) with one or more of: @param "nodePath" (string) Path to the node, which contains tables. @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 a table row format. * @param ctx context.Context for authentication, logging, tracing, etc. @param name The document name. @param format Table row format. @param tablePath Path to table. @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