README.md

Folders

(folders)

Overview

Available Operations

• create - Create a new folder
• list - Retrieve a list of folders
• update - Update a folder
• delete - Delete a folder

create

Create a new folder for the authenticated workspace.

Example Usage

require 'dub'


s = ::OpenApiSDK::Dub.new
s.config_security(
  ::OpenApiSDK::Shared::Security.new(
    token: "DUB_API_KEY",
  )
)


req = ::OpenApiSDK::Operations::CreateFolderRequestBody.new(
  name: "<value>",
)
    
res = s.folders.create(req)

if ! res.folder_schema.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	::OpenApiSDK::Operations::CreateFolderRequestBody	✔️	The request object to use for the request.

Response

T.nilable(::OpenApiSDK::Operations::CreateFolderResponse)

list

Retrieve a list of folders for the authenticated workspace.

Example Usage

require 'dub'


s = ::OpenApiSDK::Dub.new
s.config_security(
  ::OpenApiSDK::Shared::Security.new(
    token: "DUB_API_KEY",
  )
)


req = ::OpenApiSDK::Operations::ListFoldersRequest.new()
    
res = s.folders.list(req)

if ! res.folder_schemas.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	::OpenApiSDK::Operations::ListFoldersRequest	✔️	The request object to use for the request.

Response

T.nilable(::OpenApiSDK::Operations::ListFoldersResponse)

update

Update a folder in the workspace.

Example Usage

require 'dub'


s = ::OpenApiSDK::Dub.new
s.config_security(
  ::OpenApiSDK::Shared::Security.new(
    token: "DUB_API_KEY",
  )
)

    
res = s.folders.update(id="<id>", request_body=::OpenApiSDK::Operations::UpdateFolderRequestBody.new())

if ! res.folder_schema.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
id	::String	✔️	The ID of the folder to update.
request_body	T.nilable(::OpenApiSDK::Operations::UpdateFolderRequestBody)	➖	N/A

Response

T.nilable(::OpenApiSDK::Operations::UpdateFolderResponse)

delete

Delete a folder from the workspace. All existing links will still work, but they will no longer be associated with this folder.

Example Usage

require 'dub'


s = ::OpenApiSDK::Dub.new
s.config_security(
  ::OpenApiSDK::Shared::Security.new(
    token: "DUB_API_KEY",
  )
)

    
res = s.folders.delete(id="<id>")

if ! res.object.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
id	::String	✔️	The ID of the folder to delete.

Response

T.nilable(::OpenApiSDK::Operations::DeleteFolderResponse)