happygapi.docs.documents — happygapi 0.4.8

Google Docs API: documents. Reads and writes Google Docs documents. See: https://developers.google.com/docs/api/reference/rest/v1/documents

batchUpdate$ clj

(batchUpdate$ auth parameters body)

https://developers.google.com/docs/api/reference/rest/v1/documents/batchUpdate

Required parameters: documentId

Optional parameters: none

Body:

{:writeControl {:targetRevisionId string, :requiredRevisionId string}, :requests [{:updateSectionStyle UpdateSectionStyleRequest, :deletePositionedObject DeletePositionedObjectRequest, :createNamedRange CreateNamedRangeRequest, :replaceNamedRangeContent ReplaceNamedRangeContentRequest, :deleteContentRange DeleteContentRangeRequest, :createFooter CreateFooterRequest, :insertTable InsertTableRequest, :deleteTableRow DeleteTableRowRequest, :insertTableColumn InsertTableColumnRequest, :updateTextStyle UpdateTextStyleRequest, :replaceAllText ReplaceAllTextRequest, :updateTableCellStyle UpdateTableCellStyleRequest, :insertInlineImage InsertInlineImageRequest, :updateDocumentStyle UpdateDocumentStyleRequest, :deleteHeader DeleteHeaderRequest, :mergeTableCells MergeTableCellsRequest, :updateTableColumnProperties UpdateTableColumnPropertiesRequest, :createHeader CreateHeaderRequest, :updateTableRowStyle UpdateTableRowStyleRequest, :updateParagraphStyle UpdateParagraphStyleRequest, :replaceImage ReplaceImageRequest, :deleteFooter DeleteFooterRequest, :insertPageBreak InsertPageBreakRequest, :insertText InsertTextRequest, :deleteParagraphBullets DeleteParagraphBulletsRequest, :deleteNamedRange DeleteNamedRangeRequest, :createParagraphBullets CreateParagraphBulletsRequest, :deleteTableColumn DeleteTableColumnRequest, :unmergeTableCells UnmergeTableCellsRequest, :createFootnote CreateFootnoteRequest, :insertTableRow InsertTableRowRequest, :insertSectionBreak InsertSectionBreakRequest}]}

Applies one or more updates to the document. Each request is validated before being applied. If any request is not valid, then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. Other requests do not need to return information; these each return an empty reply. The order of replies matches that of the requests. For example, suppose you call batchUpdate with four updates, and only the third one returns information. The response would have two empty replies, the reply to the third request, and another empty reply, in that order. Because other users may be editing the document, the document might not exactly reflect your changes: your changes may be altered with respect to collaborator changes. If there are no collaborators, the document should reflect your changes. In any case, the updates in your request are guaranteed to be applied together atomically.

create$ clj

(create$ auth parameters body)

https://developers.google.com/docs/api/reference/rest/v1/documents/create

Required parameters: none

Optional parameters: none

Body:

{:suggestedDocumentStyleChanges {}, :footnotes {}, :lists {}, :positionedObjects {}, :footers {}, :inlineObjects {}, :namedRanges {}, :revisionId string, :namedStyles {:styles [NamedStyle]}, :suggestedNamedStylesChanges {}, :documentStyle {:defaultHeaderId string, :marginLeft Dimension, :evenPageFooterId string, :useFirstPageHeaderFooter boolean, :useCustomHeaderFooterMargins boolean, :background Background, :marginTop Dimension, :pageNumberStart integer, :firstPageHeaderId string, :defaultFooterId string, :firstPageFooterId string, :pageSize Size, :evenPageHeaderId string, :marginBottom Dimension, :marginHeader Dimension, :useEvenPageHeaderFooter boolean, :marginFooter Dimension, :marginRight Dimension}, :title string, :suggestionsViewMode string, :headers {}, :documentId string, :body {:content [StructuralElement]}}

Creates a blank document using the title given in the request. Other fields in the request, including any provided content, are ignored. Returns the created document.

get$ clj

(get$ auth parameters)

https://developers.google.com/docs/api/reference/rest/v1/documents/get

Required parameters: documentId

Optional parameters: suggestionsViewMode

Gets the latest version of the specified document.