Creating Database entries

[sinbad-sailor]

Potentially associated with #218

I'm making a notion database that I need to push a lot of data in different properties/formats. I've used code examples/discussion solutions, but can't seem to get past errors similar to those in discussion/issue #218 - one of my issues (color) is a select property for the page that I couldn't get to work.

I'm not sure if this is all an API issue/if that's been fixed since it was first raised, or just incorrect code on my part. I'd appreciate any thoughts and feedback!

Database Creation Code (functional, no errors):

def create_database(parent_id: str, db_name: str) -> dict:
    """
    parent_id(str): ID of the parent page
    db_name(str): Title of the database
    """
    print(f"\n\nCreate database '{db_name}' in page {parent_id}...")
    properties = {
        "Title": {"title": {}},
        # This is a required property

        "Keep ID": {"rich_text": {}},
        "Keep Color": {
            "select": {
                "options": [
                    {"name": "Blue", "color": "blue"},
                    {"name": "Brown", "color": "brown"},
                    {"name": "Cerulean", "color": "blue"}, #no cerulean option in notion
                    {"name": "Gray", "color": "gray"},
                    {"name": "Green", "color": "green"},
                    {"name": "Orange", "color": "orange"},
                    {"name": "Pink", "color": "pink"},
                    {"name": "Purple", "color": "purple"},
                    {"name": "Red", "color": "red"},
                    {"name": "Teal", "color": "blue"}, #no teal option in notion
                    {"name": "Default", "color": "default"},
                    {"name": "Yellow", "color": "yellow"}
                ]
            }
        },

        "Keep URL": {"url": {}},
        #Use the Keep ID to generate direct URLs to the notes in question. This will break for deleted notes
        
        "Content": {"rich_text": {}},
        #keep.text here

        "Notion Identifier": {"rich_text": {}},
        #plug the notion identifier for the row here? if possible

        "Archived": {"checkbox": {}},
        #True or False; checking will archive

        "Pinned": {"checkbox": {}},
        #True or False; checking will mark as pinned

        "Keep Created Timestamp": {"date": {}},
        "Keep Deleted Timestamp": {"date": {}},
        "Keep Trashed Timestamp": {"date": {}},
        "Keep Updated Timestamp": {"date": {}},
        "Keep Edited Timestamp": {"date": {}},

        "Labels": {
            "type": "multi_select",
            "multi_select": {
                "options": [
                    {"name": "Sample Label 1", "color": "gray"},
                    {"name": "Sample Label 2", "color": "gray"},
                    {"name": "Sample Label 3", "color": "gray"},
                    {"name": "Sample Label 4", "color": "gray"},
                ]
            },
        },

        "People Referenced": {"people": {}},
        #will become a link to Dex contacts eventually; sync into the notes there.

        "Keep List": {"checkbox": {}},
        #True or False; checking will mark as List = True

        "Keep Drawings": {"checkbox": {}},
        #True or False; checking will mark as Drawings = True

        "Keep Images": {"checkbox": {}},
        #True or False; checking will mark as Images = True

        "Keep Audio": {"checkbox": {}},
        #True or False; checking will mark as Audio = True

        "Keep Drawing Extracted Text": {"rich_text": {}},
        #Content of DrawingText

        "Keep Image Extracted Text": {"rich_text": {}},
        #Content of ImageText

        "Attached Media": {"files": {}},
        #Keep now allows multiple types of media to be attached to a message; will need to account for this.
    }
    title = [{"type": "text", "text": {"content": db_name}}]
    icon = {"type": "emoji", "emoji": "📝"}
    parent = {"type": "page_id", "page_id": parent_id}

    return notion.databases.create(
        parent=parent, title=title, properties=properties, icon=icon
    )

Page creation code (the commented out sections are marked as functional/nonfunctional - this is the source of errors):

def create_page(k_title: str, 
                k_id: str, 
                k_col: str, 
                k_url: str, 
                k_cont: str, 
                n_id: str, 
                k_archive: bool, 
                k_pinned: bool, 
                kt_created: str, 
                kt_deleted: str, 
                kt_trashed: str, 
                kt_updated: str,
                kt_edited: str, 
                k_labels: list, 
                peop_ref: list, 
                k_list: bool,
                k_drawings: bool,
                k_images: bool,
                k_audio: bool,
                kd_text: str,
                ki_text: str,
                attached_media: str
                ) -> dict:
    """
    Despite notation, k does not necessarily mean the keep value.
    """
    temp_prop = {
        "Title": {"title": [{"text": {"content": k_title}}]},
        # This is a required property
        
        "Keep ID": {"rich_text": [{"type": "text", "text": {"content": k_id}}]},
        #uncertain if all of the rich_text definitions here are needed, but I'll keep for now.

        ################# PROPERTY BELOW DOES NOT WORK ################
        # "Keep Color": {
        #     "select": {
        #         "options": [{"name": k_col}]
        #             #update this to be functional
        #     }
        # },

        ################# PROPERTY BELOW DOES NOT WORK ################
        # "Keep URL": {"type": "url", "url": [{"type": "text", "text": {"content": k_url}}]},
        #Use the Keep ID to generate direct URLs to the notes in question. This will break for deleted notes
        
        "Content": {"rich_text": [{"type": "text", "text": {"content": k_cont}}]},
        #keep.text here

        "Notion Identifier": {"rich_text": [{"type": "text", "text": {"content": n_id}}]},
        #plug the notion identifier for the row here? if possible

        "Archived": {"checkbox": k_archive},
        #True or False; checking will archive

        "Pinned": {"checkbox": k_pinned},
        #True or False; checking will mark as pinned

        ################# ALL TIME PROPERTIES BELOW DO NOT WORK ################
        #"Keep Created Timestamp": {"date": [{"text": {"content": kt_created}}]},
        # "Keep Deleted Timestamp": {"date": [{"text": {"content": kt_deleted}}]},
        # "Keep Trashed Timestamp": {"date": [{"text": {"content": kt_trashed}}]},
        # "Keep Updated Timestamp": {"date": [{"text": {"content": kt_updated}}]},
        # "Keep Edited Timestamp": {"date": [{"text": {"content": kt_edited}}]},

        ################# PROPERTY BELOW DOES NOT WORK ################
        # "Labels": {
        #     "type": "multi_select",
        #     "multi_select": {
        #         "options": [
        #             k_labels
        #         ]
        #     },
        # },

        ################# PROPERTY BELOW DOES NOT WORK ################
        # "People Referenced": {"people": [{"text": {"content": peop_ref}}]},
        # #will become a link to Dex contacts eventually; sync into the notes there.

        "Keep List": {"checkbox": k_list},
        #True or False; checking will mark as List = True

        "Keep Drawings": {"checkbox": k_drawings},
        #True or False; checking will mark as Drawings = True

        "Keep Images": {"checkbox": k_images},
        #True or False; checking will mark as Images = True

        "Keep Audio": {"checkbox": k_audio},
        #True or False; checking will mark as Audio = True

        "Keep Drawing Extracted Text": {"rich_text": [{"type": "text", "text": {"content": kd_text}}]},
        #Content of DrawingText

        "Keep Image Extracted Text": {"rich_text": [{"type": "text", "text": {"content": ki_text}}]},
        #Content of ImageText

        ################# PROPERTY BELOW DOES NOT WORK ################
        # "Attached Media": {"files": attached_media},
        # #Keep now allows multiple types of media to be attached to a message; will need to account for this.
    }
    notion.pages.create(parent={"database_id": db_id}, properties=temp_prop)
    print("Database page created!") #add in the database name and page title here. Maybe a time counter?

Test variables for page creation code (sample inputs, returns the errors below):

test_title = "titling tester"
t_k_id = "21.2135.51616"
t_k_color = "Pink"
#Color Error reference:
#https://github.com/ramnes/notion-sdk-py/issues/218

t_k_url = "https://google.com"
t_k_cont = "lorem ipsum dolor sit amet yada yada ya"
t_n_id = "ksug 278rt327tr"
t_archive = True
t_pinned = False
t_timestamp = "2021-05-11T11:00:00.000-04:00"
#useful for datetime format:
#https://github.com/ramnes/notion-sdk-py/discussions/129

t_labels = ("Sample Color 2", "Sample Color 3")
t_peop = "G Man"
t_list = True
t_drawings = True
t_images = False
t_audio = False
td_text = "testting td"
ti_text = "blah blah bleh"
t_file = "file link here?"
#I believe file uploads aren't allowed atm, switch this to a drive embed? or link?

create_page(test_title, t_k_id, t_k_color, t_k_url, t_k_cont, t_n_id, t_archive, t_pinned, t_timestamp, t_timestamp, t_timestamp, t_timestamp, t_timestamp, t_labels, t_peop, t_list, t_drawings, t_images, t_audio, td_text, ti_text, t_file)

Resulting errors (just a sample, different but similar body-failed-validation error from each):

APIResponseError: body failed validation. Fix one:
body.properties.Keep Created Timestamp.title should be defined, instead was `undefined`.
body.properties.Keep Created Timestamp.rich_text should be defined, instead was `undefined`.
body.properties.Keep Created Timestamp.number should be defined, instead was `undefined`.
body.properties.Keep Created Timestamp.url should be defined, instead was `undefined`.
body.properties.Keep Created Timestamp.select should be defined, instead was `undefined`.
body.properties.Keep Created Timestamp.multi_select should be defined, instead was `undefined`.
body.properties.Keep Created Timestamp.people should be defined, instead was `undefined`.
body.properties.Keep Created Timestamp.email should be defined, instead was `undefined`.
body.properties.Keep Created Timestamp.phone_number should be defined, instead was `undefined`.
body.properties.Keep Created Timestamp.date should be an object or `null`, instead was `[{"text":{"content":"2021-05-11T11:00:00.000-04:00"}}]`.
body.properties.Keep Created Timestamp.checkbox should be defined, instead was `undefined`.
body.properties.Keep Created Timestamp.relation should be defined, instead was `undefined`.
body.properties.Keep Created Timestamp.files should be defined, instead was `undefined`.
body.properties.Keep Created Timestamp.status should be defined, instead was `undefined`.
body.properties.Title.id should be defined, instead was `undefined`.
body.properties.Title.name should be defined, instead was `undefined`.
body.properties.Title.start should be defined, instead was `undefined`.

Any help would be much appreciated!

[ramnes]

The error is raised by Notion's API (not the Python client), and is quite explicit:

body.properties.Keep Created Timestamp.date should be an object or `null`, instead was `[{"text":{"content":"2021-05-11T11:00:00.000-04:00"}}]`.

The date fields don't expect a list of objects with a text key.

The documentation for this kind of property shows examples of what they're waiting for: https://developers.notion.com/reference/page-property-values#date

IIRC Notion only gives errors for one field at a time. So when you have validation errors with Notion's API:

• check the documentation
• fix the errored field
• try again until the whole request passes.