github.com/grokify/go-ringcentral-client@v0.3.31/engagedigital/v1/client/docs/InterventionCommentsApi.md (about)

     1  # \InterventionCommentsApi
     2  
     3  All URIs are relative to *https://DOMAIN.api.engagement.dimelo.com/1.0*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateInterventionComment**](InterventionCommentsApi.md#CreateInterventionComment) | **Post** /intervention_comments | Creating an intervention comment
     8  [**DeleteInterventionComment**](InterventionCommentsApi.md#DeleteInterventionComment) | **Delete** /intervention_comments/{interventionCommentId} | Deleting an intervention comment
     9  [**GetAllInterventionComments**](InterventionCommentsApi.md#GetAllInterventionComments) | **Get** /intervention_comments | Getting all intervention comments
    10  [**GetInterventionComment**](InterventionCommentsApi.md#GetInterventionComment) | **Get** /intervention_comments/{interventionCommentId} | Getting an intervention comment from its id
    11  
    12  
    13  
    14  ## CreateInterventionComment
    15  
    16  > InterventionComment CreateInterventionComment(ctx, body, interventionId, userId)
    17  Creating an intervention comment
    18  
    19  This method creates a new intervention comment. In case of success it renders the created comment, otherwise, it renders an error (422 HTTP code). It creates comment as token’s user. If token’s user does not have “read” on given intervention’s source a 404 HTTP response will be returned.
    20  
    21  ### Required Parameters
    22  
    23  
    24  Name | Type | Description  | Notes
    25  ------------- | ------------- | ------------- | -------------
    26  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    27  **body** | **string**| The comment body (mandatory). | 
    28  **interventionId** | **string**| The comment intervention id (mandatory). | 
    29  **userId** | **string**| The comment user id (mandatory). | 
    30  
    31  ### Return type
    32  
    33  [**InterventionComment**](InterventionComment.md)
    34  
    35  ### Authorization
    36  
    37  No authorization required
    38  
    39  ### HTTP request headers
    40  
    41  - **Content-Type**: Not defined
    42  - **Accept**: application/json
    43  
    44  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    45  [[Back to Model list]](../README.md#documentation-for-models)
    46  [[Back to README]](../README.md)
    47  
    48  
    49  ## DeleteInterventionComment
    50  
    51  > InterventionComment DeleteInterventionComment(ctx, interventionCommentId)
    52  Deleting an intervention comment
    53  
    54  This method destroys an intervention comment. It renders comment itself. If token’s user does not have “read” on comment’s source a 404 HTTP response will be returned.  Authorization​: no.
    55  
    56  ### Required Parameters
    57  
    58  
    59  Name | Type | Description  | Notes
    60  ------------- | ------------- | ------------- | -------------
    61  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    62  **interventionCommentId** | **string**|  | 
    63  
    64  ### Return type
    65  
    66  [**InterventionComment**](InterventionComment.md)
    67  
    68  ### Authorization
    69  
    70  No authorization required
    71  
    72  ### HTTP request headers
    73  
    74  - **Content-Type**: Not defined
    75  - **Accept**: application/json
    76  
    77  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    78  [[Back to Model list]](../README.md#documentation-for-models)
    79  [[Back to README]](../README.md)
    80  
    81  
    82  ## GetAllInterventionComments
    83  
    84  > GetAllInterventionCommentsResponse GetAllInterventionComments(ctx, optional)
    85  Getting all intervention comments
    86  
    87  This method renders interventions comments ordered by creation date (descending). Only comments in sources where token’s user has “read” permission are returned.  Authorization​: no.
    88  
    89  ### Required Parameters
    90  
    91  
    92  Name | Type | Description  | Notes
    93  ------------- | ------------- | ------------- | -------------
    94  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    95   **optional** | ***GetAllInterventionCommentsOpts** | optional parameters | nil if no parameters
    96  
    97  ### Optional Parameters
    98  
    99  Optional parameters are passed through a pointer to a GetAllInterventionCommentsOpts struct
   100  
   101  
   102  Name | Type | Description  | Notes
   103  ------------- | ------------- | ------------- | -------------
   104   **interventionId** | **optional.String**| To filter comments on given intervention id. | 
   105   **threadId** | **optional.String**| To filter comments on given thread id. | 
   106   **userId** | **optional.String**| To filter comments on given user id. | 
   107   **identityId** | **optional.String**| To filter comments on given identity id. | 
   108   **offset** | **optional.Int32**| The record index to start. Default value is 0. | 
   109   **limit** | **optional.Int32**| The max number of records to return. Default value is 30, max value is 150. | 
   110  
   111  ### Return type
   112  
   113  [**GetAllInterventionCommentsResponse**](GetAllInterventionCommentsResponse.md)
   114  
   115  ### Authorization
   116  
   117  No authorization required
   118  
   119  ### HTTP request headers
   120  
   121  - **Content-Type**: Not defined
   122  - **Accept**: application/json
   123  
   124  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   125  [[Back to Model list]](../README.md#documentation-for-models)
   126  [[Back to README]](../README.md)
   127  
   128  
   129  ## GetInterventionComment
   130  
   131  > InterventionComment GetInterventionComment(ctx, interventionCommentId)
   132  Getting an intervention comment from its id
   133  
   134  This method renders an intervention comment from given id. If token’s user does not have “read” on comment’s source a 404 HTTP response will be returned.
   135  
   136  ### Required Parameters
   137  
   138  
   139  Name | Type | Description  | Notes
   140  ------------- | ------------- | ------------- | -------------
   141  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   142  **interventionCommentId** | **string**|  | 
   143  
   144  ### Return type
   145  
   146  [**InterventionComment**](InterventionComment.md)
   147  
   148  ### Authorization
   149  
   150  No authorization required
   151  
   152  ### HTTP request headers
   153  
   154  - **Content-Type**: Not defined
   155  - **Accept**: application/json
   156  
   157  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   158  [[Back to Model list]](../README.md#documentation-for-models)
   159  [[Back to README]](../README.md)
   160