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

     1  # \ThreadsApi
     2  
     3  All URIs are relative to *https://DOMAIN.api.engagement.dimelo.com/1.0*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**ArchiveThread**](ThreadsApi.md#ArchiveThread) | **Put** /content_threads/{threadId}/ignore | Archiving a thread
     8  [**CategorizeThread**](ThreadsApi.md#CategorizeThread) | **Put** /content_threads/{threadId}/update_categories | Categorizing a thread
     9  [**CloseThread**](ThreadsApi.md#CloseThread) | **Put** /content_threads/{threadId}/close | Close a thread
    10  [**GetAllThreads**](ThreadsApi.md#GetAllThreads) | **Get** /content_threads | Getting all threads
    11  [**GetThread**](ThreadsApi.md#GetThread) | **Get** /content_threads/{threadId} | Getting a thread from its id
    12  [**OpenThread**](ThreadsApi.md#OpenThread) | **Get** /content_threads/{threadId}/open | Open a thread
    13  
    14  
    15  
    16  ## ArchiveThread
    17  
    18  > Thread ArchiveThread(ctx, threadId)
    19  Archiving a thread
    20  
    21  Archives the contents of a thread. If token’s user does not have “read” on thread’s source a 404 HTTP response will be returned.  If the thread is already being archived, a 409 HTTP response will be returned.  Authorization​: no.
    22  
    23  ### Required Parameters
    24  
    25  
    26  Name | Type | Description  | Notes
    27  ------------- | ------------- | ------------- | -------------
    28  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    29  **threadId** | **string**|  | 
    30  
    31  ### Return type
    32  
    33  [**Thread**](Thread.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  ## CategorizeThread
    50  
    51  > Thread CategorizeThread(ctx, threadId, optional)
    52  Categorizing a thread
    53  
    54  This method updates the categories of a thread. If token’s user does not have “read” on thread’s source a 404 HTTP response will be returned.  If the thread is already being categorized, a 409 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  **threadId** | **string**|  | 
    63   **optional** | ***CategorizeThreadOpts** | optional parameters | nil if no parameters
    64  
    65  ### Optional Parameters
    66  
    67  Optional parameters are passed through a pointer to a CategorizeThreadOpts struct
    68  
    69  
    70  Name | Type | Description  | Notes
    71  ------------- | ------------- | ------------- | -------------
    72  
    73   **threadCategoryIds** | [**optional.Interface of []string**](string.md)| An array containing the new categories to set on the thread. | 
    74  
    75  ### Return type
    76  
    77  [**Thread**](Thread.md)
    78  
    79  ### Authorization
    80  
    81  No authorization required
    82  
    83  ### HTTP request headers
    84  
    85  - **Content-Type**: Not defined
    86  - **Accept**: application/json
    87  
    88  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    89  [[Back to Model list]](../README.md#documentation-for-models)
    90  [[Back to README]](../README.md)
    91  
    92  
    93  ## CloseThread
    94  
    95  > Thread CloseThread(ctx, threadId)
    96  Close a thread
    97  
    98  Thread closure/opening is only available for the following sources: * Emails * Answers * Ideas * Facebook Messenger * Google+ * Lithium * Mobile Messaging  Starts a job to close a thread. It returns the thread but as the job is asynchronous, the state of the “close” attribute in the returned object do not is the one when the job started.  If token’s user does not have “read” on thread’s source a 404 HTTP response will be returned. Returns a 403 if the thread cannot be closed or if the user does not have the permission to close a thread.  Authorization​: no.
    99  
   100  ### Required Parameters
   101  
   102  
   103  Name | Type | Description  | Notes
   104  ------------- | ------------- | ------------- | -------------
   105  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   106  **threadId** | **string**|  | 
   107  
   108  ### Return type
   109  
   110  [**Thread**](Thread.md)
   111  
   112  ### Authorization
   113  
   114  No authorization required
   115  
   116  ### HTTP request headers
   117  
   118  - **Content-Type**: Not defined
   119  - **Accept**: application/json
   120  
   121  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   122  [[Back to Model list]](../README.md#documentation-for-models)
   123  [[Back to README]](../README.md)
   124  
   125  
   126  ## GetAllThreads
   127  
   128  > GetAllThreadsResponse GetAllThreads(ctx, optional)
   129  Getting all threads
   130  
   131  This method renders threads ordered by last content date (descending). Only threads in sources where token’s user has “read” permission are returned.  Authorization​: no.
   132  
   133  ### Required Parameters
   134  
   135  
   136  Name | Type | Description  | Notes
   137  ------------- | ------------- | ------------- | -------------
   138  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   139   **optional** | ***GetAllThreadsOpts** | optional parameters | nil if no parameters
   140  
   141  ### Optional Parameters
   142  
   143  Optional parameters are passed through a pointer to a GetAllThreadsOpts struct
   144  
   145  
   146  Name | Type | Description  | Notes
   147  ------------- | ------------- | ------------- | -------------
   148   **q** | **optional.Int32**| A search query to filter threads. Please refer to ​Search & filtering parameters​ for more details. | 
   149   **offset** | **optional.Int32**| The record index to start. Default value is 0. | 
   150   **limit** | **optional.Int32**| The max number of records to return. Default value is 30, max value is 150. | 
   151  
   152  ### Return type
   153  
   154  [**GetAllThreadsResponse**](GetAllThreadsResponse.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  ## GetThread
   171  
   172  > Thread GetThread(ctx, threadId)
   173  Getting a thread from its id
   174  
   175  This method renders a thread from given id. If token’s user does not have “read” on thread’s source a 404 HTTP response will be returned.  Authorization​: no.
   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  **threadId** | **string**|  | 
   184  
   185  ### Return type
   186  
   187  [**Thread**](Thread.md)
   188  
   189  ### Authorization
   190  
   191  No authorization required
   192  
   193  ### HTTP request headers
   194  
   195  - **Content-Type**: Not defined
   196  - **Accept**: application/json
   197  
   198  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   199  [[Back to Model list]](../README.md#documentation-for-models)
   200  [[Back to README]](../README.md)
   201  
   202  
   203  ## OpenThread
   204  
   205  > Thread OpenThread(ctx, threadId)
   206  Open a thread
   207  
   208  Thread closure/opening is only available for the following sources:  * Emails * Answers * Ideas * Facebook Messenger * Google+ * Lithium * Mobile Messaging  Starts a job to open a thread. It returns the thread but as the job is asynchronous, the state of the “close” attribute in the returned object is the one when the job started.  If token’s user does not have “read” on thread’s source a 404 HTTP response will be returned. Returns a 403 if the thread cannot be opened or if the user does not have the permission to open a thread.  Authorization​: no.
   209  
   210  ### Required Parameters
   211  
   212  
   213  Name | Type | Description  | Notes
   214  ------------- | ------------- | ------------- | -------------
   215  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   216  **threadId** | **string**|  | 
   217  
   218  ### Return type
   219  
   220  [**Thread**](Thread.md)
   221  
   222  ### Authorization
   223  
   224  No authorization required
   225  
   226  ### HTTP request headers
   227  
   228  - **Content-Type**: Not defined
   229  - **Accept**: application/json
   230  
   231  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   232  [[Back to Model list]](../README.md#documentation-for-models)
   233  [[Back to README]](../README.md)
   234