class Nylas::Folders

Nylas Folder API

Public Instance Methods

create(identifier:, request_body:) click to toggle source

Create a folder.

@param identifier [String] Grant ID or email account in which to create the object. @param request_body [Hash] The values to create the folder with. @return [Array(Hash, String)] The created folder and API Request ID.

# File lib/nylas/resources/folders.rb, line 44
def create(identifier:, request_body:)
  post(
    path: "#{api_uri}/v3/grants/#{identifier}/folders",
    request_body: request_body
  )
end
destroy(identifier:, folder_id:) click to toggle source

Delete a folder.

@param identifier [String] Grant ID or email account from which to delete an object. @param folder_id [String] The id of the folder to delete. @return [Array(TrueClass, String)] True and the API Request ID for the delete operation.

# File lib/nylas/resources/folders.rb, line 69
def destroy(identifier:, folder_id:)
  _, request_id = delete(
    path: "#{api_uri}/v3/grants/#{identifier}/folders/#{folder_id}"
  )

  [true, request_id]
end
find(identifier:, folder_id:, query_params: nil) click to toggle source

Return a folder.

@param identifier [String] Grant ID or email account to query. @param folder_id [String] The id of the folder to return. @param query_params [Hash, nil] Query params to pass to the request. @return [Array(Hash, String)] The folder and API request ID.

# File lib/nylas/resources/folders.rb, line 32
def find(identifier:, folder_id:, query_params: nil)
  get(
    path: "#{api_uri}/v3/grants/#{identifier}/folders/#{folder_id}",
    query_params: query_params
  )
end
list(identifier:, query_params: nil) click to toggle source

Return all folders.

@param identifier [String] Grant ID or email account to query. @param query_params [Hash, nil] Query params to pass to the request. @return [Array(Array(Hash), String, String)] The list of folders, API Request ID, and next cursor.

# File lib/nylas/resources/folders.rb, line 19
def list(identifier:, query_params: nil)
  get_list(
    path: "#{api_uri}/v3/grants/#{identifier}/folders",
    query_params: query_params
  )
end
update(identifier:, folder_id:, request_body:) click to toggle source

Update a folder.

@param identifier [String] Grant ID or email account in which to update an object. @param folder_id [String] The id of the folder to update. @param request_body [Hash] The values to update the folder with @return [Array(Hash, String)] The updated folder and API Request ID.

# File lib/nylas/resources/folders.rb, line 57
def update(identifier:, folder_id:, request_body:)
  put(
    path: "#{api_uri}/v3/grants/#{identifier}/folders/#{folder_id}",
    request_body: request_body
  )
end