Class: Vellum::FolderEntitiesClient

Inherits:
Object
  • Object
show all
Defined in:
lib/vellum_ai/folder_entities/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Vellum::FolderEntitiesClient

Parameters:



17
18
19
 
# File 'lib/vellum_ai/folder_entities/client.rb', line 17

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Vellum::RequestClient (readonly)

Returns:



12
13
14
 
# File 'lib/vellum_ai/folder_entities/client.rb', line 12

def request_client
  @request_client
end

Instance Method Details

#add_entity_to_folder(folder_id:, entity_id:, request_options: nil) ⇒ Object

api.folder_entities.add_entity_to_folder(folder_id: “folder_id”, entity_id: “entity_id”)



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/vellum_ai/folder_entities/client.rb', line 90

def add_entity_to_folder(folder_id:, entity_id:, request_options: nil)
  response = @request_client.conn.post do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  req.body = { **(request_options&.additional_body_parameters || {}), entity_id: entity_id }.compact
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/folders/#{folder_id}/add-entity"
end
end

#list(entity_status: nil, limit: nil, offset: nil, ordering: nil, parent_folder_id:, request_options: nil) ⇒ Object

api.folder_entities.list(parent_folder_id: “parent_folder_id”)



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/vellum_ai/folder_entities/client.rb', line 47

def list(entity_status: nil, limit: nil, offset: nil, ordering: nil, parent_folder_id:, request_options: nil)
  response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  req.params = { **(request_options&.additional_query_parameters || {}), "entity_status": entity_status, "limit": limit, "offset": offset, "ordering": ordering, "parent_folder_id": parent_folder_id }.compact
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/folder-entities"
end
  Vellum::PaginatedFolderEntityList.from_json(json_object: response.body)
end