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

     1  # \ReplyAssistantGroupsApi
     2  
     3  All URIs are relative to *https://DOMAIN.api.engagement.dimelo.com/1.0*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateReplyAssistantGroup**](ReplyAssistantGroupsApi.md#CreateReplyAssistantGroup) | **Post** /reply_assistant/groups | Creating a reply assistant group
     8  [**DeleteReplyAssistantGroup**](ReplyAssistantGroupsApi.md#DeleteReplyAssistantGroup) | **Delete** /reply_assistant/groups/{replyAssistantGroupId} | Deleting a reply assistant group
     9  [**GetAllReplyAssistantGroups**](ReplyAssistantGroupsApi.md#GetAllReplyAssistantGroups) | **Get** /reply_assistant/groups | Getting​ a​ll​ reply assistant groups
    10  [**GetReplyAssistantGroup**](ReplyAssistantGroupsApi.md#GetReplyAssistantGroup) | **Get** /reply_assistant/groups/{replyAssistantGroupId} | Getting a reply assistant group from its id
    11  [**UpdateReplyAssistantGroup**](ReplyAssistantGroupsApi.md#UpdateReplyAssistantGroup) | **Put** /reply_assistant/groups/{replyAssistantGroupId} | Updating a reply assistant group
    12  
    13  
    14  
    15  ## CreateReplyAssistantGroup
    16  
    17  > ReplyAssistantGroup CreateReplyAssistantGroup(ctx, name, optional)
    18  Creating a reply assistant group
    19  
    20  This method creates an entry group. In case of success it renders the group, 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  **name** | **string**| The name of the group. | 
    29   **optional** | ***CreateReplyAssistantGroupOpts** | optional parameters | nil if no parameters
    30  
    31  ### Optional Parameters
    32  
    33  Optional parameters are passed through a pointer to a CreateReplyAssistantGroupOpts struct
    34  
    35  
    36  Name | Type | Description  | Notes
    37  ------------- | ------------- | ------------- | -------------
    38  
    39   **entryIds** | [**optional.Interface of []string**](string.md)| List of the reply assistant entries in this group. | 
    40   **autocomplete** | **optional.Bool**| Used for autocompletion in chat. | 
    41   **position** | **optional.Int32**| Used to determine the order of the groups in the interface, in ascending order. | 
    42  
    43  ### Return type
    44  
    45  [**ReplyAssistantGroup**](ReplyAssistantGroup.md)
    46  
    47  ### Authorization
    48  
    49  No authorization required
    50  
    51  ### HTTP request headers
    52  
    53  - **Content-Type**: Not defined
    54  - **Accept**: application/json
    55  
    56  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    57  [[Back to Model list]](../README.md#documentation-for-models)
    58  [[Back to README]](../README.md)
    59  
    60  
    61  ## DeleteReplyAssistantGroup
    62  
    63  > ReplyAssistantGroup DeleteReplyAssistantGroup(ctx, replyAssistantGroupId)
    64  Deleting a reply assistant group
    65  
    66  This method destroys an existing group. It renders the group itself. It renders a 404 if id is invalid.  Authorization​: only users that have the right to manage reply assistant.
    67  
    68  ### Required Parameters
    69  
    70  
    71  Name | Type | Description  | Notes
    72  ------------- | ------------- | ------------- | -------------
    73  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    74  **replyAssistantGroupId** | **string**|  | 
    75  
    76  ### Return type
    77  
    78  [**ReplyAssistantGroup**](ReplyAssistantGroup.md)
    79  
    80  ### Authorization
    81  
    82  No authorization required
    83  
    84  ### HTTP request headers
    85  
    86  - **Content-Type**: Not defined
    87  - **Accept**: application/json
    88  
    89  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    90  [[Back to Model list]](../README.md#documentation-for-models)
    91  [[Back to README]](../README.md)
    92  
    93  
    94  ## GetAllReplyAssistantGroups
    95  
    96  > GetAllReplyAssistantGroupsResponse GetAllReplyAssistantGroups(ctx, optional)
    97  Getting​ a​ll​ reply assistant groups
    98  
    99  This method renders all groups ordered by creation date (ascending).  Authorization​: only users that have the right to manage reply assistant.
   100  
   101  ### Required Parameters
   102  
   103  
   104  Name | Type | Description  | Notes
   105  ------------- | ------------- | ------------- | -------------
   106  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   107   **optional** | ***GetAllReplyAssistantGroupsOpts** | optional parameters | nil if no parameters
   108  
   109  ### Optional Parameters
   110  
   111  Optional parameters are passed through a pointer to a GetAllReplyAssistantGroupsOpts struct
   112  
   113  
   114  Name | Type | Description  | Notes
   115  ------------- | ------------- | ------------- | -------------
   116   **offset** | **optional.Int32**| The record index to start. Default value is 0. | 
   117   **limit** | **optional.Int32**| The max number of records to return. Default value is 30, max value is 150. | 
   118  
   119  ### Return type
   120  
   121  [**GetAllReplyAssistantGroupsResponse**](GetAllReplyAssistantGroupsResponse.md)
   122  
   123  ### Authorization
   124  
   125  No authorization required
   126  
   127  ### HTTP request headers
   128  
   129  - **Content-Type**: Not defined
   130  - **Accept**: application/json
   131  
   132  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   133  [[Back to Model list]](../README.md#documentation-for-models)
   134  [[Back to README]](../README.md)
   135  
   136  
   137  ## GetReplyAssistantGroup
   138  
   139  > ReplyAssistantGroup GetReplyAssistantGroup(ctx, replyAssistantGroupId)
   140  Getting a reply assistant group from its id
   141  
   142  This method renders an entry group from given id.  Authorization​: only users that have the right to manage reply assistant.
   143  
   144  ### Required Parameters
   145  
   146  
   147  Name | Type | Description  | Notes
   148  ------------- | ------------- | ------------- | -------------
   149  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   150  **replyAssistantGroupId** | **string**|  | 
   151  
   152  ### Return type
   153  
   154  [**ReplyAssistantGroup**](ReplyAssistantGroup.md)
   155  
   156  ### Authorization
   157  
   158  No authorization required
   159  
   160  ### HTTP request headers
   161  
   162  - **Content-Type**: Not defined
   163  - **Accept**: application/json
   164  
   165  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   166  [[Back to Model list]](../README.md#documentation-for-models)
   167  [[Back to README]](../README.md)
   168  
   169  
   170  ## UpdateReplyAssistantGroup
   171  
   172  > ReplyAssistantGroup UpdateReplyAssistantGroup(ctx, replyAssistantGroupId, optional)
   173  Updating a reply assistant group
   174  
   175  This method updates an existing group from given attributes and renders it in case of success.  Authorization​: only users that have the right to manage reply assistant.
   176  
   177  ### Required Parameters
   178  
   179  
   180  Name | Type | Description  | Notes
   181  ------------- | ------------- | ------------- | -------------
   182  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   183  **replyAssistantGroupId** | **string**|  | 
   184   **optional** | ***UpdateReplyAssistantGroupOpts** | optional parameters | nil if no parameters
   185  
   186  ### Optional Parameters
   187  
   188  Optional parameters are passed through a pointer to a UpdateReplyAssistantGroupOpts struct
   189  
   190  
   191  Name | Type | Description  | Notes
   192  ------------- | ------------- | ------------- | -------------
   193  
   194   **name** | **optional.String**| The name of the group. | 
   195   **entryIds** | [**optional.Interface of []string**](string.md)| List of the reply assistant entries in this group. | 
   196   **autocomplete** | **optional.Bool**| Used for autocompletion in chat. | 
   197   **position** | **optional.Int32**| Used to determine the order of the groups in the interface, in ascending order. | 
   198  
   199  ### Return type
   200  
   201  [**ReplyAssistantGroup**](ReplyAssistantGroup.md)
   202  
   203  ### Authorization
   204  
   205  No authorization required
   206  
   207  ### HTTP request headers
   208  
   209  - **Content-Type**: Not defined
   210  - **Accept**: application/json
   211  
   212  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   213  [[Back to Model list]](../README.md#documentation-for-models)
   214  [[Back to README]](../README.md)
   215