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

     1  # \SettingsApi
     2  
     3  All URIs are relative to *https://DOMAIN.api.engagement.dimelo.com/1.0*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**GetAllSettings**](SettingsApi.md#GetAllSettings) | **Get** /settings | Getting all settings
     8  [**UpdateSettings**](SettingsApi.md#UpdateSettings) | **Put** /settings | Updating settings
     9  
    10  
    11  
    12  ## GetAllSettings
    13  
    14  > Settings GetAllSettings(ctx, )
    15  Getting all settings
    16  
    17  This method renders all settings of your domain.  Authorization​: only users that can update settings.
    18  
    19  ### Required Parameters
    20  
    21  This endpoint does not need any parameter.
    22  
    23  ### Return type
    24  
    25  [**Settings**](Settings.md)
    26  
    27  ### Authorization
    28  
    29  No authorization required
    30  
    31  ### HTTP request headers
    32  
    33  - **Content-Type**: Not defined
    34  - **Accept**: application/json
    35  
    36  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    37  [[Back to Model list]](../README.md#documentation-for-models)
    38  [[Back to README]](../README.md)
    39  
    40  
    41  ## UpdateSettings
    42  
    43  > Settings UpdateSettings(ctx, optional)
    44  Updating settings
    45  
    46  This method updates the current domain settings.  Authorization​: only users that can update settings.
    47  
    48  ### Required Parameters
    49  
    50  
    51  Name | Type | Description  | Notes
    52  ------------- | ------------- | ------------- | -------------
    53  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    54   **optional** | ***UpdateSettingsOpts** | optional parameters | nil if no parameters
    55  
    56  ### Optional Parameters
    57  
    58  Optional parameters are passed through a pointer to a UpdateSettingsOpts struct
    59  
    60  
    61  Name | Type | Description  | Notes
    62  ------------- | ------------- | ------------- | -------------
    63   **activityPresenceThreshold** | **optional.Int32**| (in hours). | 
    64   **activityTracking** | **optional.Bool**| ​Enable activity tracking (Boolean) | 
    65   **beginningOfWeek** | **optional.String**| (Day of week) | 
    66   **categoryTagging** | **optional.Bool**| A​ ctivate the forced categorization by source.​ (Boolean) | 
    67   **contentLanguages** | **optional.String**| (See format) | 
    68   **dashboard** | **optional.Bool**| Activate the dashboard (Boolean) | 
    69   **denyIframeIntegration** | **optional.Bool**| Prevent the DD to be embed by other websites (Boolean) | 
    70   **disablePasswordAutocomplete** | **optional.Bool**| (Boolean) | 
    71   **expirePasswordAfter** | **optional.Int32**| password expiration delay (in seconds) | 
    72   **expirePasswordEnabled** | **optional.Bool**| enable password expiration (Boolean) | 
    73   **exportInSeconds** | **optional.Bool**| provide durations in seconds in export (Boolean) | 
    74   **foldUselessContents** | **optional.Bool**| fold archived contents (Boolean) | 
    75   **fteDuration** | **optional.Int32**| FTE data period (in hours) | 
    76   **identityMerge** | **optional.Bool**| enable identity merge (Boolean) | 
    77   **interventionDeferRates** | [**optional.Interface of []int32**](int32.md)| (Array of times in seconds) | 
    78   **interventionDeferThreshold** | **optional.Int32**| (in seconds) | 
    79   **interventionRates** | [**optional.Interface of []int32**](int32.md)| (Array of times in seconds) | 
    80   **locale** | **optional.String**| locale code (String) | 
    81   **multiLang** | **optional.Bool**| activate multi language support for messages (Boolean) | 
    82   **name** | **optional.String**| Name of the Dimelo Digital (String) | 
    83   **passwordArchivableEnabled** | **optional.Bool**| prohibit reusing old passwords (Boolean) | 
    84   **passwordArchivableSize** | **optional.Int32**| number of archived passwords | 
    85   **passwordMinLength** | **optional.Int32**| minimum character length | 
    86   **passwordNonWord** | **optional.Bool**| should contain at least 1 non alphanumeric char (Boolean) | 
    87   **passwordNumbers** | **optional.Bool**| should contain at least 1 number (Boolean) | 
    88   **passwordRecoveryDisabled** | **optional.Bool**| disable password recovery by email (Boolean) | 
    89   **pushEnabled** | **optional.Bool**| Enable push mode (Boolean) | 
    90   **replyAsAnyIdentity** | **optional.Bool**| Enable reply as any identity (Boolean) | 
    91   **rtlSupport** | **optional.Bool**| Enable right to left support (Boolean) | 
    92   **selfApprovalRequired** | **optional.Bool**| ​Allow authors to ask approval of their messages (Boolean) | 
    93   **sessionTimeout** | **optional.Int32**| Session timeout (in minutes) | 
    94   **spellchecking** | **optional.Bool**| Enable spellchecking (Boolean) | 
    95   **style** | **optional.String**| Defines the DD’s design (String) | 
    96   **thirdPartyServicesDisabled** | **optional.Bool**| Disable third-party services (tracking...) (Boolean) | 
    97   **timezone** | **optional.String**| Use the timezone endpoint to get the timezone name (String) | 
    98   **trackJs** | **optional.Bool**| Track JS errors (Boolean) | 
    99   **type_** | **optional.String**| Can be ‘demo’, ‘production’ or ‘archived’ | 
   100   **urgentTaskThreshold** | **optional.Int32**| Chat max response time (in seconds) | 
   101   **useSystemFont** | **optional.Bool**| Experimental (Boolean) | 
   102  
   103  ### Return type
   104  
   105  [**Settings**](Settings.md)
   106  
   107  ### Authorization
   108  
   109  No authorization required
   110  
   111  ### HTTP request headers
   112  
   113  - **Content-Type**: Not defined
   114  - **Accept**: application/json
   115  
   116  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   117  [[Back to Model list]](../README.md#documentation-for-models)
   118  [[Back to README]](../README.md)
   119