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

     1  # \ReplyAssistantVersionsApi
     2  
     3  All URIs are relative to *https://DOMAIN.api.engagement.dimelo.com/1.0*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateReplyAssistantVersion**](ReplyAssistantVersionsApi.md#CreateReplyAssistantVersion) | **Post** /reply_assistant/versions | Creating a reply assistant version
     8  [**DeleteReplyAssistantVersion**](ReplyAssistantVersionsApi.md#DeleteReplyAssistantVersion) | **Delete** /reply_assistant/versions/{replyAssistantVersionId} | Deleting a reply assistant version
     9  [**GetAllReplyAssistantVersions**](ReplyAssistantVersionsApi.md#GetAllReplyAssistantVersions) | **Get** /reply_assistant/versions | Getting​ a​ll​ reply assistant versions
    10  [**GetReplyAssistantVersion**](ReplyAssistantVersionsApi.md#GetReplyAssistantVersion) | **Get** /reply_assistant/versions/{replyAssistantVersionId} | Getting a reply assistant version from its id
    11  [**UpdateReplyAssistantVersion**](ReplyAssistantVersionsApi.md#UpdateReplyAssistantVersion) | **Put** /reply_assistant/versions/{replyAssistantVersionId} | Updating a reply assistant version
    12  
    13  
    14  
    15  ## CreateReplyAssistantVersion
    16  
    17  > ReplyAssistantVersion CreateReplyAssistantVersion(ctx, body, entryId, optional)
    18  Creating a reply assistant version
    19  
    20  This method creates a reply assistant version. In case of success it renders the version, otherwise, it renders an error (422 HTTP code, 404 if the entry_id is invalid).  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  **body** | **string**| Body of the version | 
    29  **entryId** | **string**| Reply assistant entry id (mandatory) | 
    30   **optional** | ***CreateReplyAssistantVersionOpts** | optional parameters | nil if no parameters
    31  
    32  ### Optional Parameters
    33  
    34  Optional parameters are passed through a pointer to a CreateReplyAssistantVersionOpts struct
    35  
    36  
    37  Name | Type | Description  | Notes
    38  ------------- | ------------- | ------------- | -------------
    39  
    40  
    41   **sourceIds** | [**optional.Interface of []string**](string.md)| Source ids (array) | 
    42   **format** | **optional.String**| Either “text” or “html” | 
    43   **language** | **optional.String**| Language (ex: “fr”) | 
    44  
    45  ### Return type
    46  
    47  [**ReplyAssistantVersion**](ReplyAssistantVersion.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  ## DeleteReplyAssistantVersion
    64  
    65  > ReplyAssistantVersion DeleteReplyAssistantVersion(ctx, replyAssistantVersionId)
    66  Deleting a reply assistant version
    67  
    68  This method destroys an existing version. It renders the version itself. It renders a 404 if id is invalid.  Authorization​: only users that have the right to manage reply assistant.
    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  **replyAssistantVersionId** | **string**|  | 
    77  
    78  ### Return type
    79  
    80  [**ReplyAssistantVersion**](ReplyAssistantVersion.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  ## GetAllReplyAssistantVersions
    97  
    98  > GetAllReplyAssistantVersionsResponse GetAllReplyAssistantVersions(ctx, optional)
    99  Getting​ a​ll​ reply assistant versions
   100  
   101  This method renders all reply assistant versions ordered by creation date (ascending).  Authorization​: only users that have the right to manage reply assistant.
   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** | ***GetAllReplyAssistantVersionsOpts** | optional parameters | nil if no parameters
   110  
   111  ### Optional Parameters
   112  
   113  Optional parameters are passed through a pointer to a GetAllReplyAssistantVersionsOpts 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  [**GetAllReplyAssistantVersionsResponse**](GetAllReplyAssistantVersionsResponse.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  ## GetReplyAssistantVersion
   140  
   141  > ReplyAssistantVersion GetReplyAssistantVersion(ctx, replyAssistantVersionId)
   142  Getting a reply assistant version from its id
   143  
   144  This method renders a version from given id.  Authorization​: only users that have the right to manage reply assistant.
   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  **replyAssistantVersionId** | **string**|  | 
   153  
   154  ### Return type
   155  
   156  [**ReplyAssistantVersion**](ReplyAssistantVersion.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  ## UpdateReplyAssistantVersion
   173  
   174  > ReplyAssistantVersion UpdateReplyAssistantVersion(ctx, replyAssistantVersionId, optional)
   175  Updating a reply assistant version
   176  
   177  This method updates an existing version from given attributes and renders it in case of success.  Authorization​: only users that have the right to manage reply assistant.
   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  **replyAssistantVersionId** | **string**|  | 
   186   **optional** | ***UpdateReplyAssistantVersionOpts** | optional parameters | nil if no parameters
   187  
   188  ### Optional Parameters
   189  
   190  Optional parameters are passed through a pointer to a UpdateReplyAssistantVersionOpts struct
   191  
   192  
   193  Name | Type | Description  | Notes
   194  ------------- | ------------- | ------------- | -------------
   195  
   196   **body** | **optional.String**| Body of the version | 
   197   **entryId** | **optional.String**| Reply assistant entry id. | 
   198   **sourceIds** | [**optional.Interface of []string**](string.md)| Source ids (array) | 
   199   **format** | **optional.String**| Either “text” or “html” | 
   200   **language** | **optional.String**| Language (ex: “fr”) | 
   201  
   202  ### Return type
   203  
   204  [**ReplyAssistantVersion**](ReplyAssistantVersion.md)
   205  
   206  ### Authorization
   207  
   208  No authorization required
   209  
   210  ### HTTP request headers
   211  
   212  - **Content-Type**: Not defined
   213  - **Accept**: application/json
   214  
   215  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   216  [[Back to Model list]](../README.md#documentation-for-models)
   217  [[Back to README]](../README.md)
   218