github.com/grokify/go-ringcentral-client@v0.3.31/engagedigital/v1/client/docs/InterventionsApi.md (about) 1 # \InterventionsApi 2 3 All URIs are relative to *https://DOMAIN.api.engagement.dimelo.com/1.0* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**CancelIntervention**](InterventionsApi.md#CancelIntervention) | **Delete** /interventions/{interventionId}/cancel | Cancelling an intervention 8 [**CategorizeIntervention**](InterventionsApi.md#CategorizeIntervention) | **Put** /interventions/{interventionId}/update_categories | Categorizing an intervention 9 [**CloseIntervention**](InterventionsApi.md#CloseIntervention) | **Put** /interventions/{interventionId}/close | Closing an intervention 10 [**CreateIntervention**](InterventionsApi.md#CreateIntervention) | **Post** /interventions | Creating an intervention 11 [**GetAllInterventions**](InterventionsApi.md#GetAllInterventions) | **Get** /interventions | Getting all interventions 12 [**GetIntervention**](InterventionsApi.md#GetIntervention) | **Get** /interventions/{interventionId} | Getting an intervention from its id 13 [**ReassignIntervention**](InterventionsApi.md#ReassignIntervention) | **Put** /interventions/{interventionId}/reassign | Reassigning an intervention 14 15 16 17 ## CancelIntervention 18 19 > Intervention CancelIntervention(ctx, interventionId) 20 Cancelling an intervention 21 22 This method cancels (destroys) an intervention. It renders intervention itself. If token’s user does not have “read” on intervention’s source a 404 HTTP response will be returned. Caveats: * If the intervention is already being canceled, it will return a 409 error. * To be able to close an intervention, it must meet the following criteria otherwise a 403 will be raised: * Intervention MUST NOT already be closed * Intervention MUST NOT have agent replies * Access-Token agent MUST have read access on the source Authorization: no, but it renders an error if intervention can’t be destroyed (see caveats). 23 24 ### Required Parameters 25 26 27 Name | Type | Description | Notes 28 ------------- | ------------- | ------------- | ------------- 29 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 30 **interventionId** | **string**| | 31 32 ### Return type 33 34 [**Intervention**](Intervention.md) 35 36 ### Authorization 37 38 No authorization required 39 40 ### HTTP request headers 41 42 - **Content-Type**: Not defined 43 - **Accept**: application/json 44 45 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 46 [[Back to Model list]](../README.md#documentation-for-models) 47 [[Back to README]](../README.md) 48 49 50 ## CategorizeIntervention 51 52 > Intervention CategorizeIntervention(ctx, interventionId, categoryIds) 53 Categorizing an intervention 54 55 This method updates the categories of an intervention. If token’s user does not have “read” on the intervention’s source a 404 HTTP response will be returned. Authorization: no. 56 57 ### Required Parameters 58 59 60 Name | Type | Description | Notes 61 ------------- | ------------- | ------------- | ------------- 62 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 63 **interventionId** | **string**| | 64 **categoryIds** | [**[]string**](string.md)| | 65 66 ### Return type 67 68 [**Intervention**](Intervention.md) 69 70 ### Authorization 71 72 No authorization required 73 74 ### HTTP request headers 75 76 - **Content-Type**: Not defined 77 - **Accept**: application/json 78 79 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 80 [[Back to Model list]](../README.md#documentation-for-models) 81 [[Back to README]](../README.md) 82 83 84 ## CloseIntervention 85 86 > Intervention CloseIntervention(ctx, interventionId) 87 Closing an intervention 88 89 This method closes an intervention. Caveats: * If the intervention is already being closed, it will return a 409 error. * To be able to close an intervention, it must meet the following criteria otherwise a 403 will be raised: * Intervention MUST NOT already be closed * Intervention MUST have agent replies * Access-Token agent MUST be the owner of the intervention or have the permission to edit permissions * Access-Token agent MUST have read access on the source Authorization: no, but it renders an error if intervention can’t be closed (see caveats) 90 91 ### Required Parameters 92 93 94 Name | Type | Description | Notes 95 ------------- | ------------- | ------------- | ------------- 96 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 97 **interventionId** | **string**| | 98 99 ### Return type 100 101 [**Intervention**](Intervention.md) 102 103 ### Authorization 104 105 No authorization required 106 107 ### HTTP request headers 108 109 - **Content-Type**: Not defined 110 - **Accept**: application/json 111 112 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 113 [[Back to Model list]](../README.md#documentation-for-models) 114 [[Back to README]](../README.md) 115 116 117 ## CreateIntervention 118 119 > GetAllInterventionsResponse CreateIntervention(ctx, contentId) 120 Creating an intervention 121 122 This method creates a new intervention or reopen it. In case of success it renders the intervention, otherwise, it renders an error (422 HTTP code). This method opens intervention as access token’s user. Authorization: no, but it renders an error if intervention can’t be created or reopened (already opened, etc.). 123 124 ### Required Parameters 125 126 127 Name | Type | Description | Notes 128 ------------- | ------------- | ------------- | ------------- 129 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 130 **contentId** | **string**| The content to create intervention on (mandatory). | 131 132 ### Return type 133 134 [**GetAllInterventionsResponse**](GetAllInterventionsResponse.md) 135 136 ### Authorization 137 138 No authorization required 139 140 ### HTTP request headers 141 142 - **Content-Type**: Not defined 143 - **Accept**: application/json 144 145 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 146 [[Back to Model list]](../README.md#documentation-for-models) 147 [[Back to README]](../README.md) 148 149 150 ## GetAllInterventions 151 152 > GetAllInterventionsResponse GetAllInterventions(ctx, optional) 153 Getting all interventions 154 155 This method renders interventions ordered by creation date (descending). Only interventions in sources where token’s user has “read” permission are returned. Authorization: no. 156 157 ### Required Parameters 158 159 160 Name | Type | Description | Notes 161 ------------- | ------------- | ------------- | ------------- 162 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 163 **optional** | ***GetAllInterventionsOpts** | optional parameters | nil if no parameters 164 165 ### Optional Parameters 166 167 Optional parameters are passed through a pointer to a GetAllInterventionsOpts struct 168 169 170 Name | Type | Description | Notes 171 ------------- | ------------- | ------------- | ------------- 172 **threadId** | **optional.String**| To filter interventions on given thread id. | 173 **userId** | **optional.String**| To filter interventions on given user id. | 174 **identityGroupId** | **optional.String**| To filter interventions on given identity_group_id. This will return interventions associated to any identity in the indentity_group. | 175 **identityId** | [**optional.Interface of []string**](string.md)| To filter interventions on given identity_id(s). Can be a single value or an array. | 176 **sort** | **optional.String**| To change the criteria chosen to sort the interventions. The value can be “created_at” or “updated_at”. | 177 **offset** | **optional.Int32**| The record index to start. Default value is 0. | 178 **limit** | **optional.Int32**| The max number of records to return. Default value is 30, max value is 150. | 179 180 ### Return type 181 182 [**GetAllInterventionsResponse**](GetAllInterventionsResponse.md) 183 184 ### Authorization 185 186 No authorization required 187 188 ### HTTP request headers 189 190 - **Content-Type**: Not defined 191 - **Accept**: application/json 192 193 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 194 [[Back to Model list]](../README.md#documentation-for-models) 195 [[Back to README]](../README.md) 196 197 198 ## GetIntervention 199 200 > Intervention GetIntervention(ctx, interventionId) 201 Getting an intervention from its id 202 203 This method renders an intervention from given id. If token’s user does not have “read” on intervention’s source a 404 HTTP response will be returned. Authorization: no. 204 205 ### Required Parameters 206 207 208 Name | Type | Description | Notes 209 ------------- | ------------- | ------------- | ------------- 210 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 211 **interventionId** | **string**| | 212 213 ### Return type 214 215 [**Intervention**](Intervention.md) 216 217 ### Authorization 218 219 No authorization required 220 221 ### HTTP request headers 222 223 - **Content-Type**: Not defined 224 - **Accept**: application/json 225 226 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 227 [[Back to Model list]](../README.md#documentation-for-models) 228 [[Back to README]](../README.md) 229 230 231 ## ReassignIntervention 232 233 > Intervention ReassignIntervention(ctx, interventionId, userId) 234 Reassigning an intervention 235 236 This method updates the user in charge of the intervention Authorization: Only users who can update interventions. 237 238 ### Required Parameters 239 240 241 Name | Type | Description | Notes 242 ------------- | ------------- | ------------- | ------------- 243 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 244 **interventionId** | **string**| | 245 **userId** | **string**| | 246 247 ### Return type 248 249 [**Intervention**](Intervention.md) 250 251 ### Authorization 252 253 No authorization required 254 255 ### HTTP request headers 256 257 - **Content-Type**: Not defined 258 - **Accept**: application/json 259 260 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 261 [[Back to Model list]](../README.md#documentation-for-models) 262 [[Back to README]](../README.md) 263