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

     1  # \PresenceStatusApi
     2  
     3  All URIs are relative to *https://DOMAIN.api.engagement.dimelo.com/1.0*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreatePresenceStatus**](PresenceStatusApi.md#CreatePresenceStatus) | **Post** /presence_status | Creating a presence status
     8  [**DeletePresenceStatus**](PresenceStatusApi.md#DeletePresenceStatus) | **Delete** /presence_status/{presenceStatusId} | Deleting a presence status
     9  [**GetAllPresenceStatus**](PresenceStatusApi.md#GetAllPresenceStatus) | **Get** /presence_status | Getting all presence statuses
    10  [**GetPresenceStatus**](PresenceStatusApi.md#GetPresenceStatus) | **Get** /presence_status/{presenceStatusId} | Getting a presence status from its id
    11  [**UpdatePresenceStatus**](PresenceStatusApi.md#UpdatePresenceStatus) | **Put** /presence_status/{presenceStatusId} | Updating a presence status
    12  
    13  
    14  
    15  ## CreatePresenceStatus
    16  
    17  > PresenceStatus CreatePresenceStatus(ctx, name)
    18  Creating a presence status
    19  
    20  This method creates a presence status. In case of success it renders the presence status, otherwise, it renders an error (422 HTTP code).  Authorization​: only users that have the right to monitor the task view.
    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 presence status. | 
    29  
    30  ### Return type
    31  
    32  [**PresenceStatus**](PresenceStatus.md)
    33  
    34  ### Authorization
    35  
    36  No authorization required
    37  
    38  ### HTTP request headers
    39  
    40  - **Content-Type**: Not defined
    41  - **Accept**: application/json
    42  
    43  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    44  [[Back to Model list]](../README.md#documentation-for-models)
    45  [[Back to README]](../README.md)
    46  
    47  
    48  ## DeletePresenceStatus
    49  
    50  > PresenceStatus DeletePresenceStatus(ctx, presenceStatusId)
    51  Deleting a presence status
    52  
    53  This method destroys an existing presence status. It renders presence status itself. It renders a 404 if id is invalid.  Authorization​: only users that have the right to monitor the task view.
    54  
    55  ### Required Parameters
    56  
    57  
    58  Name | Type | Description  | Notes
    59  ------------- | ------------- | ------------- | -------------
    60  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    61  **presenceStatusId** | **string**|  | 
    62  
    63  ### Return type
    64  
    65  [**PresenceStatus**](PresenceStatus.md)
    66  
    67  ### Authorization
    68  
    69  No authorization required
    70  
    71  ### HTTP request headers
    72  
    73  - **Content-Type**: Not defined
    74  - **Accept**: application/json
    75  
    76  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    77  [[Back to Model list]](../README.md#documentation-for-models)
    78  [[Back to README]](../README.md)
    79  
    80  
    81  ## GetAllPresenceStatus
    82  
    83  > GetAllPresenceStatusResponse GetAllPresenceStatus(ctx, optional)
    84  Getting all presence statuses
    85  
    86  This method renders all presence statuses ordered by name (in alphabetical order).
    87  
    88  ### Required Parameters
    89  
    90  
    91  Name | Type | Description  | Notes
    92  ------------- | ------------- | ------------- | -------------
    93  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    94   **optional** | ***GetAllPresenceStatusOpts** | optional parameters | nil if no parameters
    95  
    96  ### Optional Parameters
    97  
    98  Optional parameters are passed through a pointer to a GetAllPresenceStatusOpts struct
    99  
   100  
   101  Name | Type | Description  | Notes
   102  ------------- | ------------- | ------------- | -------------
   103   **offset** | **optional.Int32**| The record index to start. Default value is 0. | 
   104   **limit** | **optional.Int32**| The max number of records to return. Default value is 30, max value is 150. | 
   105  
   106  ### Return type
   107  
   108  [**GetAllPresenceStatusResponse**](GetAllPresenceStatusResponse.md)
   109  
   110  ### Authorization
   111  
   112  No authorization required
   113  
   114  ### HTTP request headers
   115  
   116  - **Content-Type**: Not defined
   117  - **Accept**: application/json
   118  
   119  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   120  [[Back to Model list]](../README.md#documentation-for-models)
   121  [[Back to README]](../README.md)
   122  
   123  
   124  ## GetPresenceStatus
   125  
   126  > PresenceStatus GetPresenceStatus(ctx, presenceStatusId)
   127  Getting a presence status from its id
   128  
   129  This method renders a presence status from given id.  Authorization​: only users that have the right to monitor the task view.
   130  
   131  ### Required Parameters
   132  
   133  
   134  Name | Type | Description  | Notes
   135  ------------- | ------------- | ------------- | -------------
   136  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   137  **presenceStatusId** | **string**|  | 
   138  
   139  ### Return type
   140  
   141  [**PresenceStatus**](PresenceStatus.md)
   142  
   143  ### Authorization
   144  
   145  No authorization required
   146  
   147  ### HTTP request headers
   148  
   149  - **Content-Type**: Not defined
   150  - **Accept**: application/json
   151  
   152  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   153  [[Back to Model list]](../README.md#documentation-for-models)
   154  [[Back to README]](../README.md)
   155  
   156  
   157  ## UpdatePresenceStatus
   158  
   159  > PresenceStatus UpdatePresenceStatus(ctx, presenceStatusId, name)
   160  Updating a presence status
   161  
   162  This method updates an existing presence status from given attributes and renders it in case of success.  Authorization​: only users that have the right to monitor the task view.
   163  
   164  ### Required Parameters
   165  
   166  
   167  Name | Type | Description  | Notes
   168  ------------- | ------------- | ------------- | -------------
   169  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   170  **presenceStatusId** | **string**|  | 
   171  **name** | **string**| The name of the presence status. | 
   172  
   173  ### Return type
   174  
   175  [**PresenceStatus**](PresenceStatus.md)
   176  
   177  ### Authorization
   178  
   179  No authorization required
   180  
   181  ### HTTP request headers
   182  
   183  - **Content-Type**: Not defined
   184  - **Accept**: application/json
   185  
   186  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   187  [[Back to Model list]](../README.md#documentation-for-models)
   188  [[Back to README]](../README.md)
   189