github.com/grokify/go-ringcentral-client@v0.3.31/engagedigital/v1/client/docs/ReplyAssistantEntriesApi.md (about) 1 # \ReplyAssistantEntriesApi 2 3 All URIs are relative to *https://DOMAIN.api.engagement.dimelo.com/1.0* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**CreateReplyAssistantEntry**](ReplyAssistantEntriesApi.md#CreateReplyAssistantEntry) | **Post** /reply_assistant/entries | Creating an entry 8 [**DeleteReplyAssistantEntry**](ReplyAssistantEntriesApi.md#DeleteReplyAssistantEntry) | **Delete** /reply_assistant/entries/{replyAssistantEntryId} | Deleting a reply assistant entry 9 [**GetAllReplyAssistantEntries**](ReplyAssistantEntriesApi.md#GetAllReplyAssistantEntries) | **Get** /reply_assistant/entries | Getting all reply assistant entries 10 [**GetReplyAssistantEntry**](ReplyAssistantEntriesApi.md#GetReplyAssistantEntry) | **Get** /reply_assistant/entries/{replyAssistantEntryId} | Getting a reply assistant entry from its id 11 [**UpdateReplyAssistantEntry**](ReplyAssistantEntriesApi.md#UpdateReplyAssistantEntry) | **Put** /reply_assistant/entries/{replyAssistantEntryId} | Updating a reply assistant entry 12 13 14 15 ## CreateReplyAssistantEntry 16 17 > ReplyAssistantEntry CreateReplyAssistantEntry(ctx, label) 18 Creating an entry 19 20 This method creates a reply assistant entry. In case of success it renders the entry, otherwise, it renders an error (422 HTTP code). Authorization: only users that have the right to manage reply assistant. 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 **label** | **string**| The name of the entry. | 29 30 ### Return type 31 32 [**ReplyAssistantEntry**](ReplyAssistantEntry.md) 33 34 ### Authorization 35 36 No authorization required 37 38 ### HTTP request headers 39 40 - **Content-Type**: Not defined 41 - **Accept**: application/json 42 43 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 44 [[Back to Model list]](../README.md#documentation-for-models) 45 [[Back to README]](../README.md) 46 47 48 ## DeleteReplyAssistantEntry 49 50 > ReplyAssistantEntry DeleteReplyAssistantEntry(ctx, replyAssistantEntryId) 51 Deleting a reply assistant entry 52 53 This method destroys an existing entry. It renders the entry itself. It renders a 404 if id is invalid. Authorization: only users that have the right to manage reply assistant. 54 55 ### Required Parameters 56 57 58 Name | Type | Description | Notes 59 ------------- | ------------- | ------------- | ------------- 60 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 61 **replyAssistantEntryId** | **string**| | 62 63 ### Return type 64 65 [**ReplyAssistantEntry**](ReplyAssistantEntry.md) 66 67 ### Authorization 68 69 No authorization required 70 71 ### HTTP request headers 72 73 - **Content-Type**: Not defined 74 - **Accept**: application/json 75 76 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 77 [[Back to Model list]](../README.md#documentation-for-models) 78 [[Back to README]](../README.md) 79 80 81 ## GetAllReplyAssistantEntries 82 83 > GetAllReplyAssistantEntriesResponse GetAllReplyAssistantEntries(ctx, optional) 84 Getting all reply assistant entries 85 86 This method renders all entries ordered by creation date (ascending). Authorization: only users that have the right to manage reply assistant. 87 88 ### Required Parameters 89 90 91 Name | Type | Description | Notes 92 ------------- | ------------- | ------------- | ------------- 93 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 94 **optional** | ***GetAllReplyAssistantEntriesOpts** | optional parameters | nil if no parameters 95 96 ### Optional Parameters 97 98 Optional parameters are passed through a pointer to a GetAllReplyAssistantEntriesOpts struct 99 100 101 Name | Type | Description | Notes 102 ------------- | ------------- | ------------- | ------------- 103 **offset** | **optional.Int32**| The record index to start. Default value is 0. | 104 **limit** | **optional.Int32**| The max number of records to return. Default value is 30, max value is 150. | 105 106 ### Return type 107 108 [**GetAllReplyAssistantEntriesResponse**](GetAllReplyAssistantEntriesResponse.md) 109 110 ### Authorization 111 112 No authorization required 113 114 ### HTTP request headers 115 116 - **Content-Type**: Not defined 117 - **Accept**: application/json 118 119 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 120 [[Back to Model list]](../README.md#documentation-for-models) 121 [[Back to README]](../README.md) 122 123 124 ## GetReplyAssistantEntry 125 126 > ReplyAssistantEntry GetReplyAssistantEntry(ctx, replyAssistantEntryId) 127 Getting a reply assistant entry from its id 128 129 This method renders an entry from given id. Authorization: only users that have the right to manage reply assistant. 130 131 ### Required Parameters 132 133 134 Name | Type | Description | Notes 135 ------------- | ------------- | ------------- | ------------- 136 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 137 **replyAssistantEntryId** | **string**| | 138 139 ### Return type 140 141 [**ReplyAssistantEntry**](ReplyAssistantEntry.md) 142 143 ### Authorization 144 145 No authorization required 146 147 ### HTTP request headers 148 149 - **Content-Type**: Not defined 150 - **Accept**: application/json 151 152 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 153 [[Back to Model list]](../README.md#documentation-for-models) 154 [[Back to README]](../README.md) 155 156 157 ## UpdateReplyAssistantEntry 158 159 > ReplyAssistantEntry UpdateReplyAssistantEntry(ctx, replyAssistantEntryId, optional) 160 Updating a reply assistant entry 161 162 This method updates an existing entry from given attributes and renders it in case of success. Authorization: only users that have the right to manage reply assistant. 163 164 ### Required Parameters 165 166 167 Name | Type | Description | Notes 168 ------------- | ------------- | ------------- | ------------- 169 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 170 **replyAssistantEntryId** | **string**| | 171 **optional** | ***UpdateReplyAssistantEntryOpts** | optional parameters | nil if no parameters 172 173 ### Optional Parameters 174 175 Optional parameters are passed through a pointer to a UpdateReplyAssistantEntryOpts struct 176 177 178 Name | Type | Description | Notes 179 ------------- | ------------- | ------------- | ------------- 180 181 **label** | **optional.String**| The name of the entry. | 182 **foreignId** | **optional.String**| The internal/company id of the entry. This is used to match Engage Digital entry’s id with the company one. Example: KB042. | 183 **categoryIds** | [**optional.Interface of []string**](string.md)| To restrict the entry to a set of Engage Digital categories. Then, KB entries that do not match message’s categories to which you are replying will not be suggested. | 184 **shortcuts** | [**optional.Interface of []string**](string.md)| entry shortcuts | 185 **entryGroupId** | **optional.String**| Entry group id. | 186 **sourceIds** | [**optional.Interface of []string**](string.md)| Source ids (array) | 187 188 ### Return type 189 190 [**ReplyAssistantEntry**](ReplyAssistantEntry.md) 191 192 ### Authorization 193 194 No authorization required 195 196 ### HTTP request headers 197 198 - **Content-Type**: Not defined 199 - **Accept**: application/json 200 201 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 202 [[Back to Model list]](../README.md#documentation-for-models) 203 [[Back to README]](../README.md) 204