uipath 2.1.86__py3-none-any.whl → 2.1.88__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of uipath might be problematic. Click here for more details.

@@ -0,0 +1,414 @@
1
+ ## Quick API Reference
2
+
3
+ This section provides a comprehensive reference for all UiPath SDK services and methods. Each service is documented with complete method signatures, including parameter types and return types.
4
+
5
+ ### SDK Initialization
6
+
7
+ Initialize the UiPath SDK client
8
+
9
+ ```python
10
+ from uipath import UiPath
11
+
12
+ # Initialize with environment variables
13
+ sdk = UiPath()
14
+
15
+ # Or with explicit credentials
16
+ sdk = UiPath(base_url="https://cloud.uipath.com/...", secret="your_token")
17
+ ```
18
+
19
+ ### Actions
20
+
21
+ Actions service
22
+
23
+ ```python
24
+ # Creates a new action synchronously.
25
+ sdk.actions.create(title: str, data: Optional[Dict[str, Any]]=None, app_name: Optional[str]=None, app_key: Optional[str]=None, app_folder_path: Optional[str]=None, app_folder_key: Optional[str]=None, app_version: Optional[int]=1, assignee: Optional[str]=None) -> uipath.models.actions.Action
26
+
27
+ # Creates a new action asynchronously.
28
+ sdk.actions.create_async(title: str, data: Optional[Dict[str, Any]]=None, app_name: Optional[str]=None, app_key: Optional[str]=None, app_folder_path: Optional[str]=None, app_folder_key: Optional[str]=None, app_version: Optional[int]=1, assignee: Optional[str]=None) -> uipath.models.actions.Action
29
+
30
+ # Retrieves an action by its key synchronously.
31
+ sdk.actions.retrieve(action_key: str, app_folder_path: str="", app_folder_key: str="") -> uipath.models.actions.Action
32
+
33
+ # Retrieves an action by its key asynchronously.
34
+ sdk.actions.retrieve_async(action_key: str, app_folder_path: str="", app_folder_key: str="") -> uipath.models.actions.Action
35
+
36
+ ```
37
+
38
+ ### Api Client
39
+
40
+ Api Client service
41
+
42
+ ```python
43
+ # Access api_client service methods
44
+ service = sdk.api_client
45
+
46
+ ```
47
+
48
+ ### Assets
49
+
50
+ Assets service
51
+
52
+ ```python
53
+ # Retrieve an asset by its name.
54
+ sdk.assets.retrieve(name: str, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> uipath.models.assets.UserAsset | uipath.models.assets.Asset
55
+
56
+ # Asynchronously retrieve an asset by its name.
57
+ sdk.assets.retrieve_async(name: str, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> uipath.models.assets.UserAsset | uipath.models.assets.Asset
58
+
59
+ # Gets a specified Orchestrator credential.
60
+ sdk.assets.retrieve_credential(name: str, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> typing.Optional[str]
61
+
62
+ # Asynchronously gets a specified Orchestrator credential.
63
+ sdk.assets.retrieve_credential_async(name: str, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> typing.Optional[str]
64
+
65
+ # Update an asset's value.
66
+ sdk.assets.update(robot_asset: uipath.models.assets.UserAsset, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> httpx.Response
67
+
68
+ # Asynchronously update an asset's value.
69
+ sdk.assets.update_async(robot_asset: uipath.models.assets.UserAsset, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> httpx.Response
70
+
71
+ ```
72
+
73
+ ### Attachments
74
+
75
+ Attachments service
76
+
77
+ ```python
78
+ # Delete an attachment.
79
+ sdk.attachments.delete(key: uuid.UUID, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> None
80
+
81
+ # Delete an attachment asynchronously.
82
+ sdk.attachments.delete_async(key: uuid.UUID, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> None
83
+
84
+ # Download an attachment.
85
+ sdk.attachments.download(key: uuid.UUID, destination_path: str, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> str
86
+
87
+ # Download an attachment asynchronously.
88
+ sdk.attachments.download_async(key: uuid.UUID, destination_path: str, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> str
89
+
90
+ # Upload a file or content to UiPath as an attachment.
91
+ sdk.attachments.upload(name: str, content: Union[str, bytes, NoneType]=None, source_path: Optional[str]=None, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> uuid.UUID
92
+
93
+ # Upload a file or content to UiPath as an attachment asynchronously.
94
+ sdk.attachments.upload_async(name: str, content: Union[str, bytes, NoneType]=None, source_path: Optional[str]=None, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> uuid.UUID
95
+
96
+ ```
97
+
98
+ ### Buckets
99
+
100
+ Buckets service
101
+
102
+ ```python
103
+ # Download a file from a bucket.
104
+ sdk.buckets.download(name: Optional[str]=None, key: Optional[str]=None, blob_file_path: str, destination_path: str, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> None
105
+
106
+ # Download a file from a bucket asynchronously.
107
+ sdk.buckets.download_async(name: Optional[str]=None, key: Optional[str]=None, blob_file_path: str, destination_path: str, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> None
108
+
109
+ # Retrieve bucket information by its name.
110
+ sdk.buckets.retrieve(name: Optional[str]=None, key: Optional[str]=None, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> uipath.models.buckets.Bucket
111
+
112
+ # Asynchronously retrieve bucket information by its name.
113
+ sdk.buckets.retrieve_async(name: Optional[str]=None, key: Optional[str]=None, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> uipath.models.buckets.Bucket
114
+
115
+ # Upload a file to a bucket.
116
+ sdk.buckets.upload(key: Optional[str]=None, name: Optional[str]=None, blob_file_path: str, content_type: Optional[str]=None, source_path: Optional[str]=None, content: Union[str, bytes, NoneType]=None, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> None
117
+
118
+ # Upload a file to a bucket asynchronously.
119
+ sdk.buckets.upload_async(key: Optional[str]=None, name: Optional[str]=None, blob_file_path: str, content_type: Optional[str]=None, source_path: Optional[str]=None, content: Union[str, bytes, NoneType]=None, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> None
120
+
121
+ ```
122
+
123
+ ### Connections
124
+
125
+ Connections service
126
+
127
+ ```python
128
+ # Lists all connections with optional filtering.
129
+ sdk.connections.list(name: Optional[str]=None, folder_path: Optional[str]=None, folder_key: Optional[str]=None, connector_key: Optional[str]=None, skip: Optional[int]=None, top: Optional[int]=None) -> typing.List[uipath.models.connections.Connection]
130
+
131
+ # Asynchronously lists all connections with optional filtering.
132
+ sdk.connections.list_async(name: Optional[str]=None, folder_path: Optional[str]=None, folder_key: Optional[str]=None, connector_key: Optional[str]=None, skip: Optional[int]=None, top: Optional[int]=None) -> typing.List[uipath.models.connections.Connection]
133
+
134
+ # Synchronously retrieve connection API metadata.
135
+ sdk.connections.metadata(element_instance_id: int, tool_path: str, schema_mode: bool=True) -> uipath.models.connections.ConnectionMetadata
136
+
137
+ # Asynchronously retrieve connection API metadata.
138
+ sdk.connections.metadata_async(element_instance_id: int, tool_path: str, schema_mode: bool=True) -> uipath.models.connections.ConnectionMetadata
139
+
140
+ # Retrieve connection details by its key.
141
+ sdk.connections.retrieve(key: str) -> uipath.models.connections.Connection
142
+
143
+ # Asynchronously retrieve connection details by its key.
144
+ sdk.connections.retrieve_async(key: str) -> uipath.models.connections.Connection
145
+
146
+ # Retrieve event payload from UiPath Integration Service.
147
+ sdk.connections.retrieve_event_payload(event_args: uipath.models.connections.EventArguments) -> typing.Dict[str, typing.Any]
148
+
149
+ # Retrieve event payload from UiPath Integration Service.
150
+ sdk.connections.retrieve_event_payload_async(event_args: uipath.models.connections.EventArguments) -> typing.Dict[str, typing.Any]
151
+
152
+ # Retrieve an authentication token for a connection.
153
+ sdk.connections.retrieve_token(key: str, token_type: <enum 'ConnectionTokenType="direct") -> uipath.models.connections.ConnectionToken
154
+
155
+ # Asynchronously retrieve an authentication token for a connection.
156
+ sdk.connections.retrieve_token_async(key: str, token_type: <enum 'ConnectionTokenType="direct") -> uipath.models.connections.ConnectionToken
157
+
158
+ ```
159
+
160
+ ### Context Grounding
161
+
162
+ Context Grounding service
163
+
164
+ ```python
165
+ # Add content to the index.
166
+ sdk.context_grounding.add_to_index(name: str, blob_file_path: str, content_type: Optional[str]=None, content: Union[str, bytes, NoneType]=None, source_path: Optional[str]=None, folder_key: Optional[str]=None, folder_path: Optional[str]=None, ingest_data: bool=True) -> None
167
+
168
+ # Asynchronously add content to the index.
169
+ sdk.context_grounding.add_to_index_async(name: str, blob_file_path: str, content_type: Optional[str]=None, content: Union[str, bytes, NoneType]=None, source_path: Optional[str]=None, folder_key: Optional[str]=None, folder_path: Optional[str]=None, ingest_data: bool=True) -> None
170
+
171
+ # Create a new context grounding index.
172
+ sdk.context_grounding.create_index(name: str, source: Dict[str, Any], description: Optional[str]=None, cron_expression: Optional[str]=None, time_zone_id: Optional[str]=None, advanced_ingestion: Optional[bool]=True, preprocessing_request: Optional[str]="#UiPath.Vdbs.Domain.Api.V20Models.LLMV4PreProcessingRequest", folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> uipath.models.context_grounding_index.ContextGroundingIndex
173
+
174
+ # Create a new context grounding index.
175
+ sdk.context_grounding.create_index_async(name: str, source: Dict[str, Any], description: Optional[str]=None, cron_expression: Optional[str]=None, time_zone_id: Optional[str]=None, advanced_ingestion: Optional[bool]=True, preprocessing_request: Optional[str]="#UiPath.Vdbs.Domain.Api.V20Models.LLMV4PreProcessingRequest", folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> uipath.models.context_grounding_index.ContextGroundingIndex
176
+
177
+ # Delete a context grounding index.
178
+ sdk.context_grounding.delete_index(index: uipath.models.context_grounding_index.ContextGroundingIndex, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> None
179
+
180
+ # Asynchronously delete a context grounding index.
181
+ sdk.context_grounding.delete_index_async(index: uipath.models.context_grounding_index.ContextGroundingIndex, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> None
182
+
183
+ # Ingest data into the context grounding index.
184
+ sdk.context_grounding.ingest_data(index: uipath.models.context_grounding_index.ContextGroundingIndex, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> None
185
+
186
+ # Asynchronously ingest data into the context grounding index.
187
+ sdk.context_grounding.ingest_data_async(index: uipath.models.context_grounding_index.ContextGroundingIndex, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> None
188
+
189
+ # Retrieve context grounding index information by its name.
190
+ sdk.context_grounding.retrieve(name: str, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> uipath.models.context_grounding_index.ContextGroundingIndex
191
+
192
+ # Asynchronously retrieve context grounding index information by its name.
193
+ sdk.context_grounding.retrieve_async(name: str, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> uipath.models.context_grounding_index.ContextGroundingIndex
194
+
195
+ # Retrieve context grounding index information by its ID.
196
+ sdk.context_grounding.retrieve_by_id(id: str, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> typing.Any
197
+
198
+ # Retrieve asynchronously context grounding index information by its ID.
199
+ sdk.context_grounding.retrieve_by_id_async(id: str, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> typing.Any
200
+
201
+ # Search for contextual information within a specific index.
202
+ sdk.context_grounding.search(name: str, query: str, number_of_results: int=10, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> typing.List[uipath.models.context_grounding.ContextGroundingQueryResponse]
203
+
204
+ # Search asynchronously for contextual information within a specific index.
205
+ sdk.context_grounding.search_async(name: str, query: str, number_of_results: int=10, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> typing.List[uipath.models.context_grounding.ContextGroundingQueryResponse]
206
+
207
+ ```
208
+
209
+ ### Documents
210
+
211
+ Documents service
212
+
213
+ ```python
214
+ # Create a validation action for a document based on the extraction response. More details about validation actions can be found in the [official documentation](https://docs.uipath.com/ixp/automation-cloud/latest/user-guide/validating-extractions).
215
+ sdk.documents.create_validation_action(action_title: str, action_priority: <enum 'ActionPriority, action_catalog: str, action_folder: str, storage_bucket_name: str, storage_bucket_directory_path: str, extraction_response: uipath.models.documents.ExtractionResponse) -> uipath.models.documents.ValidationAction
216
+
217
+ # Asynchronously create a validation action for a document based on the extraction response.
218
+ sdk.documents.create_validation_action_async(action_title: str, action_priority: <enum 'ActionPriority, action_catalog: str, action_folder: str, storage_bucket_name: str, storage_bucket_directory_path: str, extraction_response: uipath.models.documents.ExtractionResponse) -> uipath.models.documents.ValidationAction
219
+
220
+ # Extract predicted data from a document using an IXP project.
221
+ sdk.documents.extract(project_name: str, tag: str, file: Union[IO[bytes], bytes, str, NoneType]=None, file_path: Optional[str]=None) -> uipath.models.documents.ExtractionResponse
222
+
223
+ # Asynchronously extract predicted data from a document using an IXP project.
224
+ sdk.documents.extract_async(project_name: str, tag: str, file: Union[IO[bytes], bytes, str, NoneType]=None, file_path: Optional[str]=None) -> uipath.models.documents.ExtractionResponse
225
+
226
+ # Get the result of a validation action.
227
+ sdk.documents.get_validation_result(validation_action: uipath.models.documents.ValidationAction) -> uipath.models.documents.ValidatedResult
228
+
229
+ # Asynchronously get the result of a validation action.
230
+ sdk.documents.get_validation_result_async(validation_action: uipath.models.documents.ValidationAction) -> uipath.models.documents.ValidatedResult
231
+
232
+ ```
233
+
234
+ ### Entities
235
+
236
+ Entities service
237
+
238
+ ```python
239
+ # Delete multiple records from an entity in a single batch operation.
240
+ sdk.entities.delete_records(entity_key: str, record_ids: List[str]) -> uipath.models.entities.EntityRecordsBatchResponse
241
+
242
+ # Asynchronously delete multiple records from an entity in a single batch operation.
243
+ sdk.entities.delete_records_async(entity_key: str, record_ids: List[str]) -> uipath.models.entities.EntityRecordsBatchResponse
244
+
245
+ # Insert multiple records into an entity in a single batch operation.
246
+ sdk.entities.insert_records(entity_key: str, records: List[Any], schema: Optional[Type[Any]]=None) -> uipath.models.entities.EntityRecordsBatchResponse
247
+
248
+ # Asynchronously insert multiple records into an entity in a single batch operation.
249
+ sdk.entities.insert_records_async(entity_key: str, records: List[Any], schema: Optional[Type[Any]]=None) -> uipath.models.entities.EntityRecordsBatchResponse
250
+
251
+ # List all entities in the Data Service.
252
+ sdk.entities.list_entities() -> typing.List[uipath.models.entities.Entity]
253
+
254
+ # Asynchronously list all entities in the Data Service.
255
+ sdk.entities.list_entities_async() -> typing.List[uipath.models.entities.Entity]
256
+
257
+ # List records from an entity with optional pagination and schema validation.
258
+ sdk.entities.list_records(entity_key: str, schema: Optional[Type[Any]]=None, start: Optional[int]=None, limit: Optional[int]=None) -> typing.List[uipath.models.entities.EntityRecord]
259
+
260
+ # Asynchronously list records from an entity with optional pagination and schema validation.
261
+ sdk.entities.list_records_async(entity_key: str, schema: Optional[Type[Any]]=None, start: Optional[int]=None, limit: Optional[int]=None) -> typing.List[uipath.models.entities.EntityRecord]
262
+
263
+ # Retrieve an entity by its key.
264
+ sdk.entities.retrieve(entity_key: str) -> uipath.models.entities.Entity
265
+
266
+ # Asynchronously retrieve an entity by its key.
267
+ sdk.entities.retrieve_async(entity_key: str) -> uipath.models.entities.Entity
268
+
269
+ # Update multiple records in an entity in a single batch operation.
270
+ sdk.entities.update_records(entity_key: str, records: List[Any], schema: Optional[Type[Any]]=None) -> uipath.models.entities.EntityRecordsBatchResponse
271
+
272
+ # Asynchronously update multiple records in an entity in a single batch operation.
273
+ sdk.entities.update_records_async(entity_key: str, records: List[Any], schema: Optional[Type[Any]]=None) -> uipath.models.entities.EntityRecordsBatchResponse
274
+
275
+ ```
276
+
277
+ ### Folders
278
+
279
+ Folders service
280
+
281
+ ```python
282
+ # Retrieve the folder key by folder path with pagination support.
283
+ sdk.folders.retrieve_key(folder_path: str) -> typing.Optional[str]
284
+
285
+ ```
286
+
287
+ ### Jobs
288
+
289
+ Jobs service
290
+
291
+ ```python
292
+ # Create and upload an attachment, optionally linking it to a job.
293
+ sdk.jobs.create_attachment(name: str, content: Union[str, bytes, NoneType]=None, source_path: Union[str, pathlib.Path, NoneType]=None, job_key: Union[str, uuid.UUID, NoneType]=None, category: Optional[str]=None, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> uuid.UUID
294
+
295
+ # Create and upload an attachment asynchronously, optionally linking it to a job.
296
+ sdk.jobs.create_attachment_async(name: str, content: Union[str, bytes, NoneType]=None, source_path: Union[str, pathlib.Path, NoneType]=None, job_key: Union[str, uuid.UUID, NoneType]=None, category: Optional[str]=None, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> uuid.UUID
297
+
298
+ # Get the actual output data, downloading from attachment if necessary.
299
+ sdk.jobs.extract_output(job: uipath.models.job.Job) -> typing.Optional[str]
300
+
301
+ # Asynchronously fetch the actual output data, downloading from attachment if necessary.
302
+ sdk.jobs.extract_output_async(job: uipath.models.job.Job) -> typing.Optional[str]
303
+
304
+ # Link an attachment to a job.
305
+ sdk.jobs.link_attachment(attachment_key: uuid.UUID, job_key: uuid.UUID, category: Optional[str]=None, folder_key: Optional[str]=None, folder_path: Optional[str]=None)
306
+
307
+ # Link an attachment to a job asynchronously.
308
+ sdk.jobs.link_attachment_async(attachment_key: uuid.UUID, job_key: uuid.UUID, category: Optional[str]=None, folder_key: Optional[str]=None, folder_path: Optional[str]=None)
309
+
310
+ # List attachments associated with a specific job.
311
+ sdk.jobs.list_attachments(job_key: uuid.UUID, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> typing.List[str]
312
+
313
+ # List attachments associated with a specific job asynchronously.
314
+ sdk.jobs.list_attachments_async(job_key: uuid.UUID, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> typing.List[str]
315
+
316
+ # Sends a payload to resume a paused job waiting for input, identified by its inbox ID.
317
+ sdk.jobs.resume(inbox_id: Optional[str]=None, job_id: Optional[str]=None, folder_key: Optional[str]=None, folder_path: Optional[str]=None, payload: Any) -> None
318
+
319
+ # Asynchronously sends a payload to resume a paused job waiting for input, identified by its inbox ID.
320
+ sdk.jobs.resume_async(inbox_id: Optional[str]=None, job_id: Optional[str]=None, folder_key: Optional[str]=None, folder_path: Optional[str]=None, payload: Any) -> None
321
+
322
+ # Retrieve a job identified by its key.
323
+ sdk.jobs.retrieve(job_key: str, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> uipath.models.job.Job
324
+
325
+ # Fetch payload data for API triggers.
326
+ sdk.jobs.retrieve_api_payload(inbox_id: str) -> typing.Any
327
+
328
+ # Asynchronously fetch payload data for API triggers.
329
+ sdk.jobs.retrieve_api_payload_async(inbox_id: str) -> typing.Any
330
+
331
+ # Asynchronously retrieve a job identified by its key.
332
+ sdk.jobs.retrieve_async(job_key: str, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> uipath.models.job.Job
333
+
334
+ ```
335
+
336
+ ### Llm
337
+
338
+ Llm service
339
+
340
+ ```python
341
+ # Generate chat completions using UiPath's normalized LLM Gateway API.
342
+ sdk.llm.chat_completions(messages: List[Dict[str, str]], model: str="gpt-4o-mini-2024-07-18", max_tokens: int=4096, temperature: float=0, n: int=1, frequency_penalty: float=0, presence_penalty: float=0, top_p: Optional[float]=1, top_k: Optional[int]=None, tools: Optional[List[uipath.models.llm_gateway.ToolDefinition]]=None, tool_choice: Union[uipath.models.llm_gateway.AutoToolChoice, uipath.models.llm_gateway.RequiredToolChoice, uipath.models.llm_gateway.SpecificToolChoice, Literal['auto', 'none'], NoneType]=None, response_format: Union[Dict[str, Any], type[pydantic.main.BaseModel], NoneType]=None, api_version: str="2024-08-01-preview")
343
+
344
+ ```
345
+
346
+ ### Llm Openai
347
+
348
+ Llm Openai service
349
+
350
+ ```python
351
+ # Generate chat completions using UiPath's LLM Gateway service.
352
+ sdk.llm_openai.chat_completions(messages: List[Dict[str, str]], model: str="gpt-4o-mini-2024-07-18", max_tokens: int=4096, temperature: float=0, response_format: Union[Dict[str, Any], type[pydantic.main.BaseModel], NoneType]=None, api_version: str="2024-10-21")
353
+
354
+ # Generate text embeddings using UiPath's LLM Gateway service.
355
+ sdk.llm_openai.embeddings(input: str, embedding_model: str="text-embedding-ada-002", openai_api_version: str="2024-10-21")
356
+
357
+ ```
358
+
359
+ ### Processes
360
+
361
+ Processes service
362
+
363
+ ```python
364
+ # Start execution of a process by its name.
365
+ sdk.processes.invoke(name: str, input_arguments: Optional[Dict[str, Any]]=None, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> uipath.models.job.Job
366
+
367
+ # Asynchronously start execution of a process by its name.
368
+ sdk.processes.invoke_async(name: str, input_arguments: Optional[Dict[str, Any]]=None, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> uipath.models.job.Job
369
+
370
+ ```
371
+
372
+ ### Queues
373
+
374
+ Queues service
375
+
376
+ ```python
377
+ # Completes a transaction item with the specified result.
378
+ sdk.queues.complete_transaction_item(transaction_key: str, result: Union[Dict[str, Any], uipath.models.queues.TransactionItemResult]) -> httpx.Response
379
+
380
+ # Asynchronously completes a transaction item with the specified result.
381
+ sdk.queues.complete_transaction_item_async(transaction_key: str, result: Union[Dict[str, Any], uipath.models.queues.TransactionItemResult]) -> httpx.Response
382
+
383
+ # Creates a new queue item in the Orchestrator.
384
+ sdk.queues.create_item(item: Union[Dict[str, Any], uipath.models.queues.QueueItem]) -> httpx.Response
385
+
386
+ # Asynchronously creates a new queue item in the Orchestrator.
387
+ sdk.queues.create_item_async(item: Union[Dict[str, Any], uipath.models.queues.QueueItem]) -> httpx.Response
388
+
389
+ # Creates multiple queue items in bulk.
390
+ sdk.queues.create_items(items: List[Union[Dict[str, Any], uipath.models.queues.QueueItem]], queue_name: str, commit_type: <enum 'CommitType) -> httpx.Response
391
+
392
+ # Asynchronously creates multiple queue items in bulk.
393
+ sdk.queues.create_items_async(items: List[Union[Dict[str, Any], uipath.models.queues.QueueItem]], queue_name: str, commit_type: <enum 'CommitType) -> httpx.Response
394
+
395
+ # Creates a new transaction item in a queue.
396
+ sdk.queues.create_transaction_item(item: Union[Dict[str, Any], uipath.models.queues.TransactionItem], no_robot: bool=False) -> httpx.Response
397
+
398
+ # Asynchronously creates a new transaction item in a queue.
399
+ sdk.queues.create_transaction_item_async(item: Union[Dict[str, Any], uipath.models.queues.TransactionItem], no_robot: bool=False) -> httpx.Response
400
+
401
+ # Retrieves a list of queue items from the Orchestrator.
402
+ sdk.queues.list_items() -> httpx.Response
403
+
404
+ # Asynchronously retrieves a list of queue items from the Orchestrator.
405
+ sdk.queues.list_items_async() -> httpx.Response
406
+
407
+ # Updates the progress of a transaction item.
408
+ sdk.queues.update_progress_of_transaction_item(transaction_key: str, progress: str) -> httpx.Response
409
+
410
+ # Asynchronously updates the progress of a transaction item.
411
+ sdk.queues.update_progress_of_transaction_item_async(transaction_key: str, progress: str) -> httpx.Response
412
+
413
+ ```
414
+
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: uipath
3
- Version: 2.1.86
3
+ Version: 2.1.88
4
4
  Summary: Python SDK and CLI for UiPath Platform, enabling programmatic interaction with automation services, process management, and deployment tools.
5
5
  Project-URL: Homepage, https://uipath.com
6
6
  Project-URL: Repository, https://github.com/UiPath/uipath-python
@@ -5,12 +5,12 @@ uipath/_folder_context.py,sha256=D-bgxdwpwJP4b_QdVKcPODYh15kMDrOar2xNonmMSm4,186
5
5
  uipath/_uipath.py,sha256=mhtdu36-A-2WhPGNFFrTmQWbE07Bn4IV_Vrqgf6kuVM,4900
6
6
  uipath/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
7
7
  uipath/_cli/README.md,sha256=GLtCfbeIKZKNnGTCsfSVqRQ27V1btT1i2bSAyW_xZl4,474
8
- uipath/_cli/__init__.py,sha256=2RUgXYd8uJaYjA67xWb0w4IZuBmZoY8G1ccNmEQk9oM,2343
8
+ uipath/_cli/__init__.py,sha256=9dqPdh8kgKwV-Y2Riz6411ikyKGWhKioMrqwJPQHi8w,2303
9
9
  uipath/_cli/cli_auth.py,sha256=CzetSRqSUvMs02PtI4w5Vi_0fv_ETA307bB2vXalWzY,2628
10
10
  uipath/_cli/cli_deploy.py,sha256=KPCmQ0c_NYD5JofSDao5r6QYxHshVCRxlWDVnQvlp5w,645
11
11
  uipath/_cli/cli_dev.py,sha256=nEfpjw1PZ72O6jmufYWVrueVwihFxDPOeJakdvNHdOA,2146
12
12
  uipath/_cli/cli_eval.py,sha256=oOMywGSUrHDQ1W_54ccbekzCeduPf-KHRyu_r0Dezd0,5444
13
- uipath/_cli/cli_init.py,sha256=Ac3-9tIH3rpikIX1ehWTo7InW5tjVNoz_w6fjvgLK4w,7052
13
+ uipath/_cli/cli_init.py,sha256=An6l82fqTpz-7xBK8tq-cYyPl5f5X4wCNhUC3rWI7bM,7474
14
14
  uipath/_cli/cli_invoke.py,sha256=m-te-EjhDpk_fhFDkt-yQFzmjEHGo5lQDGEQWxSXisQ,4395
15
15
  uipath/_cli/cli_new.py,sha256=9378NYUBc9j-qKVXV7oja-jahfJhXBg8zKVyaon7ctY,2102
16
16
  uipath/_cli/cli_pack.py,sha256=NmwZTfwZ2fURiHyiX1BM0juAtBOjPB1Jmcpu-rD7p-4,11025
@@ -73,13 +73,13 @@ uipath/_cli/_templates/.rels.template,sha256=-fTcw7OA1AcymHr0LzBqbMAAtzZTRXLTNa_
73
73
  uipath/_cli/_templates/[Content_Types].xml.template,sha256=bYsKDz31PkIF9QksjgAY_bqm57YC8U_owsZeNZAiBxQ,584
74
74
  uipath/_cli/_templates/main.py.template,sha256=QB62qX5HKDbW4lFskxj7h9uuxBITnTWqu_DE6asCwcU,476
75
75
  uipath/_cli/_templates/package.nuspec.template,sha256=YZyLc-u_EsmIoKf42JsLQ55OGeFmb8VkIU2VF7DFbtw,359
76
- uipath/_cli/_utils/_common.py,sha256=bYgqIdlxxlB_4s8BlZsfGbSdbfm93MFtOj5ydptbkPI,3344
76
+ uipath/_cli/_utils/_common.py,sha256=fSZkps1sjOXRyWn8GqmQfGqYAZ_tVua6dgT18Lpscds,3467
77
77
  uipath/_cli/_utils/_console.py,sha256=scvnrrFoFX6CE451K-PXKV7UN0DUkInbOtDZ5jAdPP0,10070
78
78
  uipath/_cli/_utils/_constants.py,sha256=rS8lQ5Nzull8ytajK6lBsz398qiCp1REoAwlHtyBwF0,1415
79
79
  uipath/_cli/_utils/_debug.py,sha256=zamzIR4VgbdKADAE4gbmjxDsbgF7wvdr7C5Dqp744Oc,1739
80
80
  uipath/_cli/_utils/_eval_set.py,sha256=4aP8yAC-jMrNYaC62Yj8fHD2hNlotGwy63bciQrpdc4,2766
81
81
  uipath/_cli/_utils/_folders.py,sha256=RsYrXzF0NA1sPxgBoLkLlUY3jDNLg1V-Y8j71Q8a8HY,1357
82
- uipath/_cli/_utils/_input_args.py,sha256=3LGNqVpJItvof75VGm-ZNTUMUH9-c7-YgleM5b2YgRg,5088
82
+ uipath/_cli/_utils/_input_args.py,sha256=AnbQ12D2ACIQFt0QHMaWleRn1ZgRTXuTSTN0ozJiSQg,5766
83
83
  uipath/_cli/_utils/_parse_ast.py,sha256=8Iohz58s6bYQ7rgWtOTjrEInLJ-ETikmOMZzZdIY2Co,20072
84
84
  uipath/_cli/_utils/_processes.py,sha256=q7DfEKHISDWf3pngci5za_z0Pbnf_shWiYEcTOTCiyk,1855
85
85
  uipath/_cli/_utils/_project_files.py,sha256=1DQ0dY1oUyCP_y7i1PbqJv_JcDQmHzzsJy1bKcr3xYk,19671
@@ -89,7 +89,11 @@ uipath/_cli/_utils/_uv_helpers.py,sha256=6SvoLnZPoKIxW0sjMvD1-ENV_HOXDYzH34GjBqw
89
89
  uipath/_events/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
90
90
  uipath/_events/_event_bus.py,sha256=4-VzstyX69cr7wT1EY7ywp-Ndyz2CyemD3Wk_-QmRpo,5496
91
91
  uipath/_events/_events.py,sha256=EzDfzpVm-EIH27Onad5mo8Go6-WB3S6_-6zZQ7qV58w,1811
92
- uipath/_resources/AGENTS.md,sha256=YWhWuX9XIbyVhVT3PnPc4Of3_q6bsNJcuzYu3N8f_Ug,25850
92
+ uipath/_resources/AGENTS.md,sha256=Or6QrPw6oI38IR6-17oHbG7FNrhFXblbQOH-GQjK7vg,1652
93
+ uipath/_resources/CLAUDE.md,sha256=kYsckFWTVe948z_fNWLysCHvi9_YpchBXl3s1Ek03lU,10
94
+ uipath/_resources/CLI_REFERENCE.md,sha256=stB6W2aUr0o9UzZ49h7ZXvltaLhnwPUe4_erko4Nr9k,6262
95
+ uipath/_resources/REQUIRED_STRUCTURE.md,sha256=DeR_ux8RtkG1PqgWd8j9osIwGTshL2_cPmqhkM72RAw,2570
96
+ uipath/_resources/SDK_REFERENCE.md,sha256=PWj25Bpdt3aUoM8VSbXQGNP2nEjyz3r-ySsw9FzNa9c,23251
93
97
  uipath/_services/__init__.py,sha256=_LNy4u--VlhVtTO66bULbCoBjyJBTuyh9jnzjWrv-h4,1140
94
98
  uipath/_services/_base_service.py,sha256=x9-9jhPzn9Z16KRdFHhJNvV-FZHvTniMsDfxlS4Cutk,5782
95
99
  uipath/_services/actions_service.py,sha256=2RPMR-hFMsOlqEyjIf3aF7-lrf57jdrSD0pBjj0Kyko,16040
@@ -173,8 +177,8 @@ uipath/tracing/_utils.py,sha256=X-LFsyIxDeNOGuHPvkb6T5o9Y8ElYhr_rP3CEBJSu4s,1383
173
177
  uipath/utils/__init__.py,sha256=VD-KXFpF_oWexFg6zyiWMkxl2HM4hYJMIUDZ1UEtGx0,105
174
178
  uipath/utils/_endpoints_manager.py,sha256=iRTl5Q0XAm_YgcnMcJOXtj-8052sr6jpWuPNz6CgT0Q,8408
175
179
  uipath/utils/dynamic_schema.py,sha256=w0u_54MoeIAB-mf3GmwX1A_X8_HDrRy6p998PvX9evY,3839
176
- uipath-2.1.86.dist-info/METADATA,sha256=G_FdE5vnRC3-2kjfKVvUdE_W8-SiIDzcsNSj2bTowXs,6593
177
- uipath-2.1.86.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
178
- uipath-2.1.86.dist-info/entry_points.txt,sha256=9C2_29U6Oq1ExFu7usihR-dnfIVNSKc-0EFbh0rskB4,43
179
- uipath-2.1.86.dist-info/licenses/LICENSE,sha256=-KBavWXepyDjimmzH5fVAsi-6jNVpIKFc2kZs0Ri4ng,1058
180
- uipath-2.1.86.dist-info/RECORD,,
180
+ uipath-2.1.88.dist-info/METADATA,sha256=JX0yF1aAsV4X2lENrcJ-Qa8I7QmghlGa-vNk57RerKc,6593
181
+ uipath-2.1.88.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
182
+ uipath-2.1.88.dist-info/entry_points.txt,sha256=9C2_29U6Oq1ExFu7usihR-dnfIVNSKc-0EFbh0rskB4,43
183
+ uipath-2.1.88.dist-info/licenses/LICENSE,sha256=-KBavWXepyDjimmzH5fVAsi-6jNVpIKFc2kZs0Ri4ng,1058
184
+ uipath-2.1.88.dist-info/RECORD,,