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

     1  # \SourcesApi
     2  
     3  All URIs are relative to *https://DOMAIN.api.engagement.dimelo.com/1.0*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**GetAllSources**](SourcesApi.md#GetAllSources) | **Get** /content_sources | Getting all sources
     8  [**GetSource**](SourcesApi.md#GetSource) | **Get** /content_sources/{sourceId} | Getting a source from its id
     9  [**UpdateSource**](SourcesApi.md#UpdateSource) | **Put** /content_sources/{sourceId} | Updating a source
    10  
    11  
    12  
    13  ## GetAllSources
    14  
    15  > GetAllSourcesResponse GetAllSources(ctx, optional)
    16  Getting all sources
    17  
    18  This method renders sources ordered by creation date (ascending).
    19  
    20  ### Required Parameters
    21  
    22  
    23  Name | Type | Description  | Notes
    24  ------------- | ------------- | ------------- | -------------
    25  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    26   **optional** | ***GetAllSourcesOpts** | optional parameters | nil if no parameters
    27  
    28  ### Optional Parameters
    29  
    30  Optional parameters are passed through a pointer to a GetAllSourcesOpts struct
    31  
    32  
    33  Name | Type | Description  | Notes
    34  ------------- | ------------- | ------------- | -------------
    35   **offset** | **optional.Int32**| The record index to start. Default value is 0. | 
    36   **limit** | **optional.Int32**| The max number of records to return. Default value is 30, max value is 150. | 
    37  
    38  ### Return type
    39  
    40  [**GetAllSourcesResponse**](GetAllSourcesResponse.md)
    41  
    42  ### Authorization
    43  
    44  No authorization required
    45  
    46  ### HTTP request headers
    47  
    48  - **Content-Type**: Not defined
    49  - **Accept**: application/json
    50  
    51  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    52  [[Back to Model list]](../README.md#documentation-for-models)
    53  [[Back to README]](../README.md)
    54  
    55  
    56  ## GetSource
    57  
    58  > Source GetSource(ctx, sourceId)
    59  Getting a source from its id
    60  
    61  This method renders a source from given id.
    62  
    63  ### Required Parameters
    64  
    65  
    66  Name | Type | Description  | Notes
    67  ------------- | ------------- | ------------- | -------------
    68  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    69  **sourceId** | **string**|  | 
    70  
    71  ### Return type
    72  
    73  [**Source**](Source.md)
    74  
    75  ### Authorization
    76  
    77  No authorization required
    78  
    79  ### HTTP request headers
    80  
    81  - **Content-Type**: Not defined
    82  - **Accept**: application/json
    83  
    84  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    85  [[Back to Model list]](../README.md#documentation-for-models)
    86  [[Back to README]](../README.md)
    87  
    88  
    89  ## UpdateSource
    90  
    91  > Source UpdateSource(ctx, sourceId, optional)
    92  Updating a source
    93  
    94  This method updates an existing source from given attributes and renders it in case of success.
    95  
    96  ### Required Parameters
    97  
    98  
    99  Name | Type | Description  | Notes
   100  ------------- | ------------- | ------------- | -------------
   101  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   102  **sourceId** | **string**|  | 
   103   **optional** | ***UpdateSourceOpts** | optional parameters | nil if no parameters
   104  
   105  ### Optional Parameters
   106  
   107  Optional parameters are passed through a pointer to a UpdateSourceOpts struct
   108  
   109  
   110  Name | Type | Description  | Notes
   111  ------------- | ------------- | ------------- | -------------
   112  
   113   **name** | **optional.String**| Source name | 
   114   **active** | **optional.Bool**| Activate/deactivate the source (Boolean) | 
   115   **channelId** | **optional.String**| Channel | 
   116   **color** | **optional.Int32**| Color of the icon (see S​ ource colors​) (Integer) | 
   117   **slaResponse** | **optional.Int32**| Response time (seconds) | 
   118   **slaExpiredStrategy** | **optional.String**| SLA expired strategy (\"max\", \"half\" or \"base\") | 
   119   **interventionMessagesBoost** | **optional.Int32**| Priority boost of messages with intervention (Integer) | 
   120   **transferredTasksBoost** | **optional.Int32**| Priority boost of transferred tasks (Integer) | 
   121   **hiddenFromStats** | **optional.Bool**| Hide from statistics (Boolean) | 
   122   **defaultCategoryIds** | [**optional.Interface of []string**](string.md)| Default categories | 
   123   **userThreadDefaultCategoryIds** | [**optional.Interface of []string**](string.md)| Default categories (agent messages) | 
   124   **defaultContentLanguage** | **optional.String**| Default content language | 
   125   **autoDetectContentLanguage** | **optional.Bool**| Auto-detect content language (Boolean) | 
   126   **contentArchiving** | **optional.Bool**| Automatic archiving of old contents (Boolean) | 
   127   **contentArchivingPeriod** | **optional.Int32**| Archive contents older than (seconds) | 
   128  
   129  ### Return type
   130  
   131  [**Source**](Source.md)
   132  
   133  ### Authorization
   134  
   135  No authorization required
   136  
   137  ### HTTP request headers
   138  
   139  - **Content-Type**: Not defined
   140  - **Accept**: application/json
   141  
   142  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   143  [[Back to Model list]](../README.md#documentation-for-models)
   144  [[Back to README]](../README.md)
   145