github.com/grokify/go-ringcentral-client@v0.3.31/engagedigital/v1/client/docs/FoldersApi.md (about) 1 # \FoldersApi 2 3 All URIs are relative to *https://DOMAIN.api.engagement.dimelo.com/1.0* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**CreateFolder**](FoldersApi.md#CreateFolder) | **Post** /folders | Creating a folder 8 [**DeleteFolder**](FoldersApi.md#DeleteFolder) | **Delete** /folders/{folderId} | Deleting a folder 9 [**GetAllFolders**](FoldersApi.md#GetAllFolders) | **Get** /folders | Getting all folders 10 [**GetFolder**](FoldersApi.md#GetFolder) | **Get** /folders/{folderId} | Getting a folder from its id 11 [**UpdateFolder**](FoldersApi.md#UpdateFolder) | **Put** /folders/{folderId} | Updating a folder 12 13 14 15 ## CreateFolder 16 17 > Folder CreateFolder(ctx, optional) 18 Creating a folder 19 20 This method creates a new folder. In case of success it renders the created folder, otherwise an error (422 HTTP code). 21 22 ### Required Parameters 23 24 25 Name | Type | Description | Notes 26 ------------- | ------------- | ------------- | ------------- 27 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 28 **optional** | ***CreateFolderOpts** | optional parameters | nil if no parameters 29 30 ### Optional Parameters 31 32 Optional parameters are passed through a pointer to a CreateFolderOpts struct 33 34 35 Name | Type | Description | Notes 36 ------------- | ------------- | ------------- | ------------- 37 **label** | **optional.String**| Folder’s label (mandatory). | 38 **parentId** | **optional.String**| ID of the parent folder. | 39 **position** | **optional.Int32**| position of the folder. | 40 **query** | **optional.String**| query of the folder as described in Search API documentation.\\n\\nExample: “active_and_assigned_to_me:true” | 41 **renderThreadsCount** | **optional.Bool**| boolean describing display of the number of threads. | 42 **roleRestrictionOnly** | [**optional.Interface of []string**](string.md)| list of roles allowed to see this folder. This parameter has to be a hash otherwise it will raise a 400 error. The key should be \"only\". For example: `&role_restriction[only][]=4e5596cdae70f677b5000002` | 43 **teamRestrictionOnly** | [**optional.Interface of []string**](string.md)| list of teams allowed to see this folder. Same thing as role_restriction: team_restriction parameter has to be a hash with the key \"only\". | 44 45 ### Return type 46 47 [**Folder**](Folder.md) 48 49 ### Authorization 50 51 No authorization required 52 53 ### HTTP request headers 54 55 - **Content-Type**: Not defined 56 - **Accept**: application/json 57 58 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 59 [[Back to Model list]](../README.md#documentation-for-models) 60 [[Back to README]](../README.md) 61 62 63 ## DeleteFolder 64 65 > Folder DeleteFolder(ctx, folderId) 66 Deleting a folder 67 68 This method destroys an existing folder. It renders the folder itself. It renders a 404 if id is invalid. 69 70 ### Required Parameters 71 72 73 Name | Type | Description | Notes 74 ------------- | ------------- | ------------- | ------------- 75 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 76 **folderId** | **string**| | 77 78 ### Return type 79 80 [**Folder**](Folder.md) 81 82 ### Authorization 83 84 No authorization required 85 86 ### HTTP request headers 87 88 - **Content-Type**: Not defined 89 - **Accept**: application/json 90 91 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 92 [[Back to Model list]](../README.md#documentation-for-models) 93 [[Back to README]](../README.md) 94 95 96 ## GetAllFolders 97 98 > GetAllFoldersResponse GetAllFolders(ctx, optional) 99 Getting all folders 100 101 This method renders folders. 102 103 ### Required Parameters 104 105 106 Name | Type | Description | Notes 107 ------------- | ------------- | ------------- | ------------- 108 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 109 **optional** | ***GetAllFoldersOpts** | optional parameters | nil if no parameters 110 111 ### Optional Parameters 112 113 Optional parameters are passed through a pointer to a GetAllFoldersOpts struct 114 115 116 Name | Type | Description | Notes 117 ------------- | ------------- | ------------- | ------------- 118 **offset** | **optional.Int32**| The record index to start. Default value is 0. | 119 **limit** | **optional.Int32**| The max number of records to return. Default value is 30, max value is 150. | 120 121 ### Return type 122 123 [**GetAllFoldersResponse**](GetAllFoldersResponse.md) 124 125 ### Authorization 126 127 No authorization required 128 129 ### HTTP request headers 130 131 - **Content-Type**: Not defined 132 - **Accept**: application/json 133 134 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 135 [[Back to Model list]](../README.md#documentation-for-models) 136 [[Back to README]](../README.md) 137 138 139 ## GetFolder 140 141 > Folder GetFolder(ctx, folderId) 142 Getting a folder from its id 143 144 This method renders a folder from given id. 145 146 ### Required Parameters 147 148 149 Name | Type | Description | Notes 150 ------------- | ------------- | ------------- | ------------- 151 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 152 **folderId** | **string**| | 153 154 ### Return type 155 156 [**Folder**](Folder.md) 157 158 ### Authorization 159 160 No authorization required 161 162 ### HTTP request headers 163 164 - **Content-Type**: Not defined 165 - **Accept**: application/json 166 167 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 168 [[Back to Model list]](../README.md#documentation-for-models) 169 [[Back to README]](../README.md) 170 171 172 ## UpdateFolder 173 174 > Folder UpdateFolder(ctx, folderId, optional) 175 Updating a folder 176 177 This method updates an existing folder from given attributes and renders it in case of success. 178 179 ### Required Parameters 180 181 182 Name | Type | Description | Notes 183 ------------- | ------------- | ------------- | ------------- 184 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 185 **folderId** | **string**| | 186 **optional** | ***UpdateFolderOpts** | optional parameters | nil if no parameters 187 188 ### Optional Parameters 189 190 Optional parameters are passed through a pointer to a UpdateFolderOpts struct 191 192 193 Name | Type | Description | Notes 194 ------------- | ------------- | ------------- | ------------- 195 196 **label** | **optional.String**| Folder’s label (mandatory). | 197 **parentId** | **optional.String**| ID of the parent folder. | 198 **position** | **optional.Int32**| position of the folder. | 199 **query** | **optional.String**| query of the folder as described in Search API documentation.\\n\\nExample: “active_and_assigned_to_me:true” | 200 **renderThreadsCount** | **optional.Bool**| boolean describing display of the number of threads. | 201 **roleRestrictionOnly** | [**optional.Interface of []string**](string.md)| list of roles allowed to see this folder. This parameter has to be a hash otherwise it will raise a 400 error. The key should be \"only\". For example: `&role_restriction[only][]=4e5596cdae70f677b5000002` | 202 **teamRestrictionOnly** | [**optional.Interface of []string**](string.md)| list of teams allowed to see this folder. Same thing as role_restriction: team_restriction parameter has to be a hash with the key \"only\". | 203 204 ### Return type 205 206 [**Folder**](Folder.md) 207 208 ### Authorization 209 210 No authorization required 211 212 ### HTTP request headers 213 214 - **Content-Type**: Not defined 215 - **Accept**: application/json 216 217 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 218 [[Back to Model list]](../README.md#documentation-for-models) 219 [[Back to README]](../README.md) 220