Skip to content

Commit

Permalink
merge Develop into branch
Browse files Browse the repository at this point in the history
  • Loading branch information
BryanFauble committed Jan 29, 2025
2 parents b18580c + cd8820a commit 8b9471d
Show file tree
Hide file tree
Showing 39 changed files with 4,540 additions and 287 deletions.
24 changes: 24 additions & 0 deletions docs/reference/experimental/async/activity.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Activity

Contained within this file are experimental interfaces for working with the Synapse Python
Client. Unless otherwise noted these interfaces are subject to change at any time. Use
at your own risk.

## API Reference

::: synapseclient.models.Activity
options:
members:
- from_parent_async
- store_async
- delete_async
---
::: synapseclient.models.UsedEntity
options:
filters:
- "!"
---
::: synapseclient.models.UsedURL
options:
filters:
- "!"
32 changes: 32 additions & 0 deletions docs/reference/experimental/async/agent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Agent

Contained within this file are experimental interfaces for working with the Synapse Python
Client. Unless otherwise noted these interfaces are subject to change at any time. Use
at your own risk.

## API reference

::: synapseclient.models.Agent
options:
members:
- register_async
- get_async
- start_session_async
- get_session_async
- prompt_async
- get_chat_history
---
::: synapseclient.models.AgentSession
options:
members:
- start_async
- get_async
- update_async
- prompt_async
---
::: synapseclient.models.AgentPrompt
options:
inherited_members: true
members:
- send_job_and_wait_async
---
27 changes: 27 additions & 0 deletions docs/reference/experimental/async/file.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# File

Contained within this file are experimental interfaces for working with the Synapse Python
Client. Unless otherwise noted these interfaces are subject to change at any time. Use
at your own risk.

## API Reference

::: synapseclient.models.File
options:
inherited_members: true
members:
- get_async
- store_async
- copy_async
- delete_async
- from_id_async
- from_path_async
- change_metadata_async
- get_permissions_async
- get_acl_async
- set_permissions_async
---
::: synapseclient.models.file.FileHandle
options:
filters:
- "!"
20 changes: 20 additions & 0 deletions docs/reference/experimental/async/folder.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Folder

Contained within this file are experimental interfaces for working with the Synapse Python
Client. Unless otherwise noted these interfaces are subject to change at any time. Use
at your own risk.

## API Reference

::: synapseclient.models.Folder
options:
inherited_members: true
members:
- get_async
- store_async
- delete_async
- copy_async
- sync_from_synapse_async
- get_permissions_async
- get_acl_async
- set_permissions_async
19 changes: 19 additions & 0 deletions docs/reference/experimental/async/project.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Project

Contained within this file are experimental interfaces for working with the Synapse Python
Client. Unless otherwise noted these interfaces are subject to change at any time. Use
at your own risk.

## API reference

::: synapseclient.models.Project
options:
inherited_members: true
members:
- get_async
- store_async
- delete_async
- sync_from_synapse_async
- get_permissions_async
- get_acl_async
- set_permissions_async
21 changes: 21 additions & 0 deletions docs/reference/experimental/async/table.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Table

Contained within this file are experimental interfaces for working with the Synapse Python
Client. Unless otherwise noted these interfaces are subject to change at any time. Use
at your own risk.

## API Reference

::: synapseclient.models.Table
options:
inherited_members: true
members:
- get_async
- store_schema_async
- store_rows_from_csv_async
- delete_rows_async
- query_async
- delete_async
- get_permissions_async
- get_acl_async
- set_permissions_async
19 changes: 19 additions & 0 deletions docs/reference/experimental/async/team.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Team

Contained within this file are experimental interfaces for working with the Synapse Python
Client. Unless otherwise noted these interfaces are subject to change at any time. Use
at your own risk.

## API Reference

::: synapseclient.models.Team
options:
members:
- create_async
- delete_async
- from_id_async
- from_name_async
- members_async
- invite_async
- open_invitations_async
---
19 changes: 19 additions & 0 deletions docs/reference/experimental/async/user_profile.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# UserProfile

Contained within this file are experimental interfaces for working with the Synapse Python
Client. Unless otherwise noted these interfaces are subject to change at any time. Use
at your own risk.

## API Reference

::: synapseclient.models.UserProfile
options:
inherited_members: true
members:
- get_async
- from_id_async
- from_username_async
- is_certified_async
---
::: synapseclient.models.UserPreference
---
3 changes: 3 additions & 0 deletions docs/reference/experimental/mixins/access_controllable.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# AccessControllable

::: synapseclient.models.mixins.AccessControllable
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# AsynchronousCommunicator

::: synapseclient.models.mixins.AsynchronousCommunicator
3 changes: 3 additions & 0 deletions docs/reference/experimental/mixins/failure_strategy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# FailureStrategy

::: synapseclient.models.FailureStrategy
3 changes: 3 additions & 0 deletions docs/reference/experimental/mixins/storable_container.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# StorableContainer

::: synapseclient.models.mixins.StorableContainer
35 changes: 35 additions & 0 deletions docs/reference/experimental/sync/activity.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Activity

Contained within this file are experimental interfaces for working with the Synapse Python
Client. Unless otherwise noted these interfaces are subject to change at any time. Use
at your own risk.

## Example Script

<details class="quote">
<summary>Working with activities</summary>

```python
{!docs/scripts/object_orientated_programming_poc/oop_poc_activity.py!}
```
</details>

## API Reference

::: synapseclient.models.Activity
options:
inherited_members: true
members:
- from_parent
- store
- delete
---
::: synapseclient.models.UsedEntity
options:
filters:
- "!"
---
::: synapseclient.models.UsedURL
options:
filters:
- "!"
42 changes: 42 additions & 0 deletions docs/reference/experimental/sync/agent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Agent

Contained within this file are experimental interfaces for working with the Synapse Python
Client. Unless otherwise noted these interfaces are subject to change at any time. Use
at your own risk.

## Example Script:

<details class="quote">
<summary>Working with Synapse agents</summary>

```python
{!docs/scripts/object_orientated_programming_poc/oop_poc_agent.py!}
```
</details>

## API Reference

::: synapseclient.models.Agent
options:
inherited_members: true
members:
- register
- get
- start_session
- get_session
- prompt
- get_chat_history
---
::: synapseclient.models.AgentSession
options:
inherited_members: true
members:
- start
- get
- update
- prompt
---
::: synapseclient.models.AgentPrompt
options:
inherited_members: true
---
37 changes: 37 additions & 0 deletions docs/reference/experimental/sync/file.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# File

Contained within this file are experimental interfaces for working with the Synapse Python
Client. Unless otherwise noted these interfaces are subject to change at any time. Use
at your own risk.

## Example Script

<details class="quote">
<summary>Working with files</summary>

```python
{!docs/scripts/object_orientated_programming_poc/oop_poc_file.py!}
```
</details>

## API Reference

::: synapseclient.models.File
options:
inherited_members: true
members:
- get
- store
- copy
- delete
- from_id
- from_path
- change_metadata
- get_permissions
- get_acl
- set_permissions
---
::: synapseclient.models.file.FileHandle
options:
filters:
- "!"
30 changes: 30 additions & 0 deletions docs/reference/experimental/sync/folder.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Folder

Contained within this file are experimental interfaces for working with the Synapse Python
Client. Unless otherwise noted these interfaces are subject to change at any time. Use
at your own risk.

## Example Script

<details class="quote">
<summary>Working with folders</summary>

```python
{!docs/scripts/object_orientated_programming_poc/oop_poc_folder.py!}
```
</details>

## API Reference

::: synapseclient.models.Folder
options:
inherited_members: true
members:
- get
- store
- delete
- copy
- sync_from_synapse
- get_permissions
- get_acl
- set_permissions
29 changes: 29 additions & 0 deletions docs/reference/experimental/sync/project.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Project

Contained within this file are experimental interfaces for working with the Synapse Python
Client. Unless otherwise noted these interfaces are subject to change at any time. Use
at your own risk.

## Example Script

<details class="quote">
<summary>Working with a project</summary>

```python
{!docs/scripts/object_orientated_programming_poc/oop_poc_project.py!}
```
</details>

## API reference

::: synapseclient.models.Project
options:
inherited_members: true
members:
- get
- store
- delete
- sync_from_synapse
- get_permissions
- get_acl
- set_permissions
Loading

0 comments on commit 8b9471d

Please sign in to comment.