All URIs are relative to http://localhost:12052
| Method | HTTP request | Description |
|---|---|---|
| AttachmentAddToGroupPost | Post /attachment/add_to_group | Add a new member to a group |
| AttachmentCreateGroupPost | Post /attachment/create_group | Create a new group |
| AttachmentDownloadPost | Post /attachment/download | Download an Attachment |
| AttachmentGetGroupsPost | Post /attachment/get_groups | List the Groups the Wallet has access to |
| AttachmentLeaveGroupPost | Post /attachment/leave_group | Removes an owned Wallet from a Group |
| AttachmentListPost | Post /attachment/list | Lists available Attachments |
| AttachmentUploadPost | Post /attachment/upload | Upload an Attachment and share it with a Group |
AddToGroupResponse AttachmentAddToGroupPost(ctx, addToGroupRequest) Add a new member to a group
Shares with another Wallet the credentials required to either write or both read and write to a Group another Wallet. The Group will be automatically added to any Nodes that have the recipient Wallet stored within them, including Nodes that have viewing-only access to said Wallet.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| addToGroupRequest | AddToGroupRequest |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateGroupResponse AttachmentCreateGroupPost(ctx, createGroupRequest) Create a new group
Groups are cryptographically-secure permission-sets which allow their members to either write or read/write to the Group (there's no read-only permission). When creating a new Group, a new secret is created which can be used to encrypt Attachments. Attachments can be stored (in encrypted form) in Groups, and Group permissions can be shared with other Wallets.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| createGroupRequest | CreateGroupRequest |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AttachmentBody AttachmentDownloadPost(ctx, downloadAttachmentRequest) Download an Attachment
Downloads and decrypts an Attachment given an Attachment ID, and assuming it exists and a Wallet with proper credentials for the relevant Group is used
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| downloadAttachmentRequest | DownloadAttachmentRequest |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetGroupsResponse AttachmentGetGroupsPost(ctx, getGroupsRequest) List the Groups the Wallet has access to
Returns the full list of Groups the Wallet has credentials for (both write-only and read/write).
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| getGroupsRequest | GetGroupsRequest |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
LeaveGroupResponse AttachmentLeaveGroupPost(ctx, leaveGroupRequest) Removes an owned Wallet from a Group
Deletes any credentials and messages that relate to the given Group and are owned by the given Wallet. Does not affect other Wallets in the same Node. Only owners of Wallets can remove their own Wallets from any given Group.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| leaveGroupRequest | LeaveGroupRequest |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListAttachmentsResponse AttachmentListPost(ctx, listAttachmentsRequest) Lists available Attachments
Lists the Attachments available for download for a given Wallet, and filtered by further arguments. Note that Attachments must be filtered by exactly one of th e optional filters (transaction hashes or asset IDs).
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| listAttachmentsRequest | ListAttachmentsRequest |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UploadAttachmentResponse AttachmentUploadPost(ctx, uploadAttachmentRequest) Upload an Attachment and share it with a Group
Encrypts and uploads an Attachment so that it becomes shared with a given Group. Returns a globally-unique identifier for the Attachment to be used in subsequent API calls.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| uploadAttachmentRequest | UploadAttachmentRequest |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]