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

     1  # \CategoriesApi
     2  
     3  All URIs are relative to *https://DOMAIN.api.engagement.dimelo.com/1.0*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateCategory**](CategoriesApi.md#CreateCategory) | **Post** /categories | Creating a category
     8  [**DeleteCategory**](CategoriesApi.md#DeleteCategory) | **Delete** /categories/{categoryId} | Deleting a category
     9  [**GetAllCategories**](CategoriesApi.md#GetAllCategories) | **Get** /categories | Getting all categories
    10  [**GetCategory**](CategoriesApi.md#GetCategory) | **Get** /categories/{categoryId} | Getting a category from its id
    11  [**UpdateCategory**](CategoriesApi.md#UpdateCategory) | **Put** /categories/{categoryId} | Updating a category
    12  
    13  
    14  
    15  ## CreateCategory
    16  
    17  > Category CreateCategory(ctx, optional)
    18  Creating a category
    19  
    20  This method creates a new team. In case of success it renders the created tag, otherwise, it renders an error (422 HTTP code).  Note: The fields ​`mandatory`,​ `​multiple`,​ ​`post_qualification​`, `s​ource_ids`​ and `u​nselectable​` are accounted for only if the Category has no parent.  Authorization​: only users that can manage teams.
    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   **optional** | ***CreateCategoryOpts** | optional parameters | nil if no parameters
    29  
    30  ### Optional Parameters
    31  
    32  Optional parameters are passed through a pointer to a CreateCategoryOpts struct
    33  
    34  
    35  Name | Type | Description  | Notes
    36  ------------- | ------------- | ------------- | -------------
    37   **name** | **optional.String**| Category name. | 
    38   **parentId** | **optional.String**| ID of parent category. | 
    39   **color** | **optional.Int32**| displayed color for the category, see Category colors.  | 
    40   **mandatory** | **optional.Bool**| mandatory categorization (Boolean). | 
    41   **multiple** | **optional.Bool**| allow to assign multiple child categories (Boolean). | 
    42   **postQualification** | **optional.Bool**| post qualification (Boolean). | 
    43   **unselectable** | **optional.Bool**| root category is unselectable (Boolean). | 
    44   **sourceIds** | [**optional.Interface of []string**](string.md)| List of source id. | 
    45  
    46  ### Return type
    47  
    48  [**Category**](Category.md)
    49  
    50  ### Authorization
    51  
    52  No authorization required
    53  
    54  ### HTTP request headers
    55  
    56  - **Content-Type**: Not defined
    57  - **Accept**: application/json
    58  
    59  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    60  [[Back to Model list]](../README.md#documentation-for-models)
    61  [[Back to README]](../README.md)
    62  
    63  
    64  ## DeleteCategory
    65  
    66  > Category DeleteCategory(ctx, categoryId, optional)
    67  Deleting a category
    68  
    69  This method destroys an existing category. It renders the category itself. It renders a 404 if id is invalid.
    70  
    71  ### Required Parameters
    72  
    73  
    74  Name | Type | Description  | Notes
    75  ------------- | ------------- | ------------- | -------------
    76  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    77  **categoryId** | **string**|  | 
    78   **optional** | ***DeleteCategoryOpts** | optional parameters | nil if no parameters
    79  
    80  ### Optional Parameters
    81  
    82  Optional parameters are passed through a pointer to a DeleteCategoryOpts struct
    83  
    84  
    85  Name | Type | Description  | Notes
    86  ------------- | ------------- | ------------- | -------------
    87  
    88   **takeOverCategoryId** | **optional.String**| ID of a category to recategorize (optional). | 
    89  
    90  ### Return type
    91  
    92  [**Category**](Category.md)
    93  
    94  ### Authorization
    95  
    96  No authorization required
    97  
    98  ### HTTP request headers
    99  
   100  - **Content-Type**: Not defined
   101  - **Accept**: application/json
   102  
   103  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   104  [[Back to Model list]](../README.md#documentation-for-models)
   105  [[Back to README]](../README.md)
   106  
   107  
   108  ## GetAllCategories
   109  
   110  > GetAllCategoriesResponse GetAllCategories(ctx, optional)
   111  Getting all categories
   112  
   113  This method renders categories ordered by creation date (ascending).
   114  
   115  ### Required Parameters
   116  
   117  
   118  Name | Type | Description  | Notes
   119  ------------- | ------------- | ------------- | -------------
   120  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   121   **optional** | ***GetAllCategoriesOpts** | optional parameters | nil if no parameters
   122  
   123  ### Optional Parameters
   124  
   125  Optional parameters are passed through a pointer to a GetAllCategoriesOpts struct
   126  
   127  
   128  Name | Type | Description  | Notes
   129  ------------- | ------------- | ------------- | -------------
   130   **parentId** | **optional.String**| To filter categories on given category parent id. | 
   131   **offset** | **optional.Int32**| The record index to start. Default value is 0. | 
   132   **limit** | **optional.Int32**| The max number of records to return. Default value is 30, max value is 150. | 
   133  
   134  ### Return type
   135  
   136  [**GetAllCategoriesResponse**](GetAllCategoriesResponse.md)
   137  
   138  ### Authorization
   139  
   140  No authorization required
   141  
   142  ### HTTP request headers
   143  
   144  - **Content-Type**: Not defined
   145  - **Accept**: application/json
   146  
   147  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   148  [[Back to Model list]](../README.md#documentation-for-models)
   149  [[Back to README]](../README.md)
   150  
   151  
   152  ## GetCategory
   153  
   154  > Category GetCategory(ctx, categoryId)
   155  Getting a category from its id
   156  
   157  This method renders a category from given id.
   158  
   159  ### Required Parameters
   160  
   161  
   162  Name | Type | Description  | Notes
   163  ------------- | ------------- | ------------- | -------------
   164  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   165  **categoryId** | **string**|  | 
   166  
   167  ### Return type
   168  
   169  [**Category**](Category.md)
   170  
   171  ### Authorization
   172  
   173  No authorization required
   174  
   175  ### HTTP request headers
   176  
   177  - **Content-Type**: Not defined
   178  - **Accept**: application/json
   179  
   180  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   181  [[Back to Model list]](../README.md#documentation-for-models)
   182  [[Back to README]](../README.md)
   183  
   184  
   185  ## UpdateCategory
   186  
   187  > Category UpdateCategory(ctx, categoryId, optional)
   188  Updating a category
   189  
   190  This method creates a new team. In case of success it renders the created tag, otherwise, it renders an error (422 HTTP code).  Note: The fields ​`mandatory`,​ ​`multiple`,​ ​`post_qualification​`, `s​ource_ids​` and `u​nselectable​` are accounted for only if the Category has no parent.  Authorization​: only users that can manage teams.
   191  
   192  ### Required Parameters
   193  
   194  
   195  Name | Type | Description  | Notes
   196  ------------- | ------------- | ------------- | -------------
   197  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   198  **categoryId** | **string**|  | 
   199   **optional** | ***UpdateCategoryOpts** | optional parameters | nil if no parameters
   200  
   201  ### Optional Parameters
   202  
   203  Optional parameters are passed through a pointer to a UpdateCategoryOpts struct
   204  
   205  
   206  Name | Type | Description  | Notes
   207  ------------- | ------------- | ------------- | -------------
   208  
   209   **name** | **optional.String**| Category name. | 
   210   **parentId** | **optional.String**| ID of parent category. | 
   211   **color** | **optional.Int32**| displayed color for the category, see Category colors.  | 
   212   **mandatory** | **optional.Bool**| mandatory categorization (Boolean). | 
   213   **multiple** | **optional.Bool**| allow to assign multiple child categories (Boolean). | 
   214   **postQualification** | **optional.Bool**| post qualification (Boolean). | 
   215   **unselectable** | **optional.Bool**| root category is unselectable (Boolean). | 
   216   **sourceIds** | [**optional.Interface of []string**](string.md)| List of source id. | 
   217  
   218  ### Return type
   219  
   220  [**Category**](Category.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