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

     1  # \TeamsApi
     2  
     3  All URIs are relative to *https://DOMAIN.api.engagement.dimelo.com/1.0*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateTeam**](TeamsApi.md#CreateTeam) | **Post** /teams | Creating a team
     8  [**DeleteTeam**](TeamsApi.md#DeleteTeam) | **Delete** /teams/{teamId} | Deleting a team
     9  [**GetAllTeams**](TeamsApi.md#GetAllTeams) | **Get** /teams | Getting all teams
    10  [**GetTeam**](TeamsApi.md#GetTeam) | **Get** /teams/{teamId} | Getting a team from its id
    11  [**UpdateTeam**](TeamsApi.md#UpdateTeam) | **Put** /teams/{teamId} | Updating a team
    12  
    13  
    14  
    15  ## CreateTeam
    16  
    17  > Team CreateTeam(ctx, optional)
    18  Creating a team
    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).
    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** | ***CreateTeamOpts** | optional parameters | nil if no parameters
    29  
    30  ### Optional Parameters
    31  
    32  Optional parameters are passed through a pointer to a CreateTeamOpts struct
    33  
    34  
    35  Name | Type | Description  | Notes
    36  ------------- | ------------- | ------------- | -------------
    37   **name** | **optional.String**| Team name. | 
    38   **leaderIds** | [**optional.Interface of []string**](string.md)| List of user id as leaders | 
    39   **userIds** | [**optional.Interface of []string**](string.md)| List of user id as team members. | 
    40  
    41  ### Return type
    42  
    43  [**Team**](Team.md)
    44  
    45  ### Authorization
    46  
    47  No authorization required
    48  
    49  ### HTTP request headers
    50  
    51  - **Content-Type**: Not defined
    52  - **Accept**: application/json
    53  
    54  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    55  [[Back to Model list]](../README.md#documentation-for-models)
    56  [[Back to README]](../README.md)
    57  
    58  
    59  ## DeleteTeam
    60  
    61  > Team DeleteTeam(ctx, teamId, optional)
    62  Deleting a team
    63  
    64  This method destroys an existing team. It renders the team itself. It renders a 404 if id is invalid.
    65  
    66  ### Required Parameters
    67  
    68  
    69  Name | Type | Description  | Notes
    70  ------------- | ------------- | ------------- | -------------
    71  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    72  **teamId** | **string**|  | 
    73   **optional** | ***DeleteTeamOpts** | optional parameters | nil if no parameters
    74  
    75  ### Optional Parameters
    76  
    77  Optional parameters are passed through a pointer to a DeleteTeamOpts struct
    78  
    79  
    80  Name | Type | Description  | Notes
    81  ------------- | ------------- | ------------- | -------------
    82  
    83   **takeOverCategoryId** | **optional.String**| ID of a category to recategorize (optional). | 
    84  
    85  ### Return type
    86  
    87  [**Team**](Team.md)
    88  
    89  ### Authorization
    90  
    91  No authorization required
    92  
    93  ### HTTP request headers
    94  
    95  - **Content-Type**: Not defined
    96  - **Accept**: application/json
    97  
    98  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    99  [[Back to Model list]](../README.md#documentation-for-models)
   100  [[Back to README]](../README.md)
   101  
   102  
   103  ## GetAllTeams
   104  
   105  > GetAllTeamsResponse GetAllTeams(ctx, optional)
   106  Getting all teams
   107  
   108  This method renders teams ordered by creation date (ascending).
   109  
   110  ### Required Parameters
   111  
   112  
   113  Name | Type | Description  | Notes
   114  ------------- | ------------- | ------------- | -------------
   115  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   116   **optional** | ***GetAllTeamsOpts** | optional parameters | nil if no parameters
   117  
   118  ### Optional Parameters
   119  
   120  Optional parameters are passed through a pointer to a GetAllTeamsOpts struct
   121  
   122  
   123  Name | Type | Description  | Notes
   124  ------------- | ------------- | ------------- | -------------
   125   **offset** | **optional.Int32**| The record index to start. Default value is 0. | 
   126   **limit** | **optional.Int32**| The max number of records to return. Default value is 30, max value is 150. | 
   127  
   128  ### Return type
   129  
   130  [**GetAllTeamsResponse**](GetAllTeamsResponse.md)
   131  
   132  ### Authorization
   133  
   134  No authorization required
   135  
   136  ### HTTP request headers
   137  
   138  - **Content-Type**: Not defined
   139  - **Accept**: application/json
   140  
   141  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   142  [[Back to Model list]](../README.md#documentation-for-models)
   143  [[Back to README]](../README.md)
   144  
   145  
   146  ## GetTeam
   147  
   148  > Team GetTeam(ctx, teamId)
   149  Getting a team from its id
   150  
   151  This method renders a team from given id.
   152  
   153  ### Required Parameters
   154  
   155  
   156  Name | Type | Description  | Notes
   157  ------------- | ------------- | ------------- | -------------
   158  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   159  **teamId** | **string**|  | 
   160  
   161  ### Return type
   162  
   163  [**Team**](Team.md)
   164  
   165  ### Authorization
   166  
   167  No authorization required
   168  
   169  ### HTTP request headers
   170  
   171  - **Content-Type**: Not defined
   172  - **Accept**: application/json
   173  
   174  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   175  [[Back to Model list]](../README.md#documentation-for-models)
   176  [[Back to README]](../README.md)
   177  
   178  
   179  ## UpdateTeam
   180  
   181  > Team UpdateTeam(ctx, teamId, optional)
   182  Updating a team
   183  
   184  This method updates an existing team from given attributes and renders it in case of success.
   185  
   186  ### Required Parameters
   187  
   188  
   189  Name | Type | Description  | Notes
   190  ------------- | ------------- | ------------- | -------------
   191  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   192  **teamId** | **string**|  | 
   193   **optional** | ***UpdateTeamOpts** | optional parameters | nil if no parameters
   194  
   195  ### Optional Parameters
   196  
   197  Optional parameters are passed through a pointer to a UpdateTeamOpts struct
   198  
   199  
   200  Name | Type | Description  | Notes
   201  ------------- | ------------- | ------------- | -------------
   202  
   203   **name** | **optional.String**| Team name. | 
   204   **leaderIds** | [**optional.Interface of []string**](string.md)| List of user id as leaders | 
   205   **userIds** | [**optional.Interface of []string**](string.md)| List of user id as team members. | 
   206  
   207  ### Return type
   208  
   209  [**Team**](Team.md)
   210  
   211  ### Authorization
   212  
   213  No authorization required
   214  
   215  ### HTTP request headers
   216  
   217  - **Content-Type**: Not defined
   218  - **Accept**: application/json
   219  
   220  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   221  [[Back to Model list]](../README.md#documentation-for-models)
   222  [[Back to README]](../README.md)
   223