Struct DocCreate

pub struct DocCreate {
    pub folder_id: Option<String>,
    pub initial_page: Option<DocCreateInitialPage>,
    pub source_doc: Option<String>,
    pub timezone: Option<String>,
    pub title: Option<String>,
}

Payload for creating a new doc.

JSON schema

{
 "description": "Payload for creating a new doc.",
 "type": "object",
 "properties": {
   "folderId": {
     "description": "The ID of the folder within which to create this
doc. Defaults to your \"My docs\" folder in the oldest workspace you
joined; this is subject to change. You can get this ID by opening the
folder in the docs list on your computer and grabbing the `folderId`
query parameter.\n",
     "examples": [
       "fl-ABcdEFgHJi"
     ],
     "type": "string"
   },
   "initialPage": {
     "allOf": [
       {
         "description": "The contents of the initial page of the doc.",
         "type": "object",
         "additionalProperties": false
       },
       {
         "$ref": "#/components/schemas/PageCreate"
       }
     ]
   },
   "sourceDoc": {
     "description": "An optional doc ID from which to create a copy.",
     "examples": [
       "iJKlm_noPq"
     ],
     "type": "string"
   },
   "timezone": {
     "description": "The timezone to use for the newly created doc.",
     "examples": [
       "America/Los_Angeles"
     ],
     "type": "string"
   },
   "title": {
     "description": "Title of the new doc. Defaults to 'Untitled'.",
     "examples": [
       "Project Tracker"
     ],
     "type": "string"
   }
 },
 "additionalProperties": false,
 "x-schema-name": "DocCreate"
}

Fields

folder_id: Option<String>

The ID of the folder within which to create this doc. Defaults to your “My docs” folder in the oldest workspace you joined; this is subject to change. You can get this ID by opening the folder in the docs list on your computer and grabbing the folderId query parameter.

initial_page: Option<DocCreateInitialPage>

source_doc: Option<String>

An optional doc ID from which to create a copy.

timezone: Option<String>

The timezone to use for the newly created doc.

title: Option<String>

Title of the new doc. Defaults to ‘Untitled’.

Trait Implementations

impl Clone for DocCreate

fn clone(&self) -> DocCreate

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DocCreate

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DocCreate

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DocCreate

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&DocCreate> for DocCreate

fn from(value: &DocCreate) -> Self

Converts to this type from the input type.

impl Serialize for DocCreate

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.