Class: Utils::CollectionViewComponents

Inherits:

Object

• Object
• Utils::CollectionViewComponents

Defined in:

lib/notion_api/utils.rb

Class Method Summary

• .add_collection_property(collection_id, args) ⇒ Object
• .add_new_row(new_block_id) ⇒ Object
• .create_collection_view(new_block_id, collection_id, view_ids) ⇒ Object
• .insert_data(block_id, column, value) ⇒ Object
• .query_collection(collection_id, view_id, search_query = '') ⇒ Object
• .set_collection_blocks_alive(new_block_id, collection_id) ⇒ Object
• .set_collection_columns(collection_id, new_block_id, data) ⇒ Object
• .set_collection_title(collection_title, collection_id) ⇒ Object
• .set_view_config(new_block_id, view_id, children_ids) ⇒ Object

Class Method Details

.add_collection_property(collection_id, args) ⇒ Object

# File 'lib/notion_api/utils.rb', line 484

def self.add_collection_property(collection_id, args)
  # ! payload for adding a column to the table.
  # ! collection_id -> the collection ID : ``str``
  # ! args -> the definition of the column : ``str``
  {
    id: collection_id,
    table: 'collection',
    path: [],
    command: 'update',
    args: args
  }
end

.add_new_row(new_block_id) ⇒ Object

# File 'lib/notion_api/utils.rb', line 442

def self.add_new_row(new_block_id)
  # ! payload for adding a new row to the table.
  # ! new_block_id -> the ID of the new row : ``str``
  table = 'block'
  path = []
  command = 'set'
  type = 'page'

  {
    id: new_block_id,
    table: table,
    path: path,
    command: command,
    args: {
      type: type,
      id: new_block_id,
      version: 1
    }
  }
end

.create_collection_view(new_block_id, collection_id, view_ids) ⇒ Object

# File 'lib/notion_api/utils.rb', line 280

def self.create_collection_view(new_block_id, collection_id, view_ids)
  # ! payload for creating a collection view
  # ! new_block_id -> id of the new block
  # ! collection_id -> ID of the collection.
  # ! view_ids -> id of the view
  table = 'block'
  command = 'update'
  path = []
  type = 'collection_view'
  properties = {}
  timestamp = DateTime.now.strftime('%Q')

  {
    id: new_block_id,
    table: table,
    path: path,
    command: command,
    args: {
      id: new_block_id,
      type: type,
      collection_id: collection_id,
      view_ids: [
        view_ids
      ],
      properties: properties,
      created_time: timestamp,
      last_edited_time: timestamp
    }
  }
end

.insert_data(block_id, column, value) ⇒ Object

# File 'lib/notion_api/utils.rb', line 421

def self.insert_data(block_id, column, value)
  # ! payload for inserting data into the table.
  # ! block_id -> the ID of the block : ``str``
  # ! column -> the name of the column to insert data into.
  # ! value -> the value to insert into the column.
  table = 'block'
  path = [
    'properties',
    column
  ]
  command = 'set'

  {
    id: block_id,
    table: table,
    path: path,
    command: command,
    args: [[value]]
  }
end

.query_collection(collection_id, view_id, search_query = '') ⇒ Object

# File 'lib/notion_api/utils.rb', line 463

def self.query_collection(collection_id, view_id, search_query = '')
  # ! payload for querying the table for data.
  # ! collection_id -> the collection ID : ``str``
  # ! view_id -> the view ID : ``str``
  # ! search_query -> the query for searching the table : ``str``
  query = {}
  loader = {
    type: 'table',
    limit: 100,
    searchQuery: search_query,
    loadContentCover: true
  }

  {
    collectionId: collection_id,
    collectionViewId: view_id,
    query: query,
    loader: loader
  }
end

.set_collection_blocks_alive(new_block_id, collection_id) ⇒ Object

# File 'lib/notion_api/utils.rb', line 311

def self.set_collection_blocks_alive(new_block_id, collection_id)
  # ! payload for setting the collection blocks to alive.
  # ! new_block_id -> id of the new block
  # ! collection_id -> ID of the collection.
  table = 'block'
  path = []
  command = 'update'
  parent_table = 'collection'
  alive = true
  type = 'page'
  properties = {}
  timestamp = DateTime.now.strftime('%Q')

  {
    id: new_block_id,
    table: table,
    path: path,
    command: command,
    args: {
      id: new_block_id,
      type: type,
      parent_id: collection_id,
      parent_table: parent_table,
      alive: alive,
      properties: properties,
      created_time: timestamp,
      last_edited_time: timestamp
    }
  }
end

.set_collection_columns(collection_id, new_block_id, data) ⇒ Object

# File 'lib/notion_api/utils.rb', line 374

def self.set_collection_columns(collection_id, new_block_id, data)
  # ! payload for setting the columns of the table.
  # ! collection_id -> ID of the collection.
  # ! new_block_id -> id of the new block
  # ! data -> json data to insert into table.
  col_names = data[0].keys

  schema_conf = {}
  col_names.each_with_index do |_name, i|
    if i.zero?
      schema_conf[:title] = { name: col_names[i], type: 'title' }
    else
      schema_conf[col_names[i]] = { name: col_names[i], type: 'text' }
    end
  end
  {
    id: collection_id,
    table: 'collection',
    path: [],
    command: 'update',
    args: {
      id: collection_id,
      schema: schema_conf,
      parent_id: new_block_id,
      parent_table: 'block',
      alive: true
    }
  }
end

.set_collection_title(collection_title, collection_id) ⇒ Object

# File 'lib/notion_api/utils.rb', line 404

def self.set_collection_title(collection_title, collection_id)
  # ! payload for setting the title of the collection.
  # ! collection_title -> title of the collection.
  # ! collection_id -> ID of the collection.
  table = 'collection'
  path = ['name']
  command = 'set'

  {
    id: collection_id,
    table: table,
    path: path,
    command: command,
    args: [[collection_title]]
  }
end

.set_view_config(new_block_id, view_id, children_ids) ⇒ Object

# File 'lib/notion_api/utils.rb', line 342

def self.set_view_config(new_block_id, view_id, children_ids)
  # ! payload for setting the configurations of the view.
  # ! new_block_id -> id of the new block
  # ! view_id -> id of the view
  # ! children_ids -> IDs for the children of the collection.
  table = 'collection_view'
  path = []
  command = 'update'
  version = 0
  type = 'table'
  name = 'Default View'
  parent_table = 'block'
  alive = true

  {
    id: view_id,
    table: table,
    path: path,
    command: command,
    args: {
      id: view_id,
      version: version,
      type: type,
      name: name,
      page_sort: children_ids,
      parent_id: new_block_id,
      parent_table: parent_table,
      alive: alive
    }
  }
end