|
| 1 | +# urlr.FolderApi |
| 2 | + |
| 3 | +All URIs are relative to *https://urlr.me/api* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**folder**](FolderApi.md#folder) | **GET** /folder | Get folders of team |
| 8 | + |
| 9 | + |
| 10 | +# **folder** |
| 11 | +> Folder200Response folder(folder_request=folder_request) |
| 12 | +
|
| 13 | +Get folders of team |
| 14 | + |
| 15 | +### Example |
| 16 | + |
| 17 | +* Bearer (JWT) Authentication (bearerAuth): |
| 18 | + |
| 19 | +```python |
| 20 | +import urlr |
| 21 | +from urlr.models.folder200_response import Folder200Response |
| 22 | +from urlr.models.folder_request import FolderRequest |
| 23 | +from urlr.rest import ApiException |
| 24 | +from pprint import pprint |
| 25 | + |
| 26 | +# Defining the host is optional and defaults to https://urlr.me/api |
| 27 | +# See configuration.py for a list of all supported configuration parameters. |
| 28 | +configuration = urlr.Configuration( |
| 29 | + host = "https://urlr.me/api" |
| 30 | +) |
| 31 | + |
| 32 | +# The client must configure the authentication and authorization parameters |
| 33 | +# in accordance with the API server security policy. |
| 34 | +# Examples for each auth method are provided below, use the example that |
| 35 | +# satisfies your auth use case. |
| 36 | + |
| 37 | +# Configure Bearer authorization (JWT): bearerAuth |
| 38 | +configuration = urlr.Configuration( |
| 39 | + access_token = os.environ["BEARER_TOKEN"] |
| 40 | +) |
| 41 | + |
| 42 | +# Enter a context with an instance of the API client |
| 43 | +with urlr.ApiClient(configuration) as api_client: |
| 44 | + # Create an instance of the API class |
| 45 | + api_instance = urlr.FolderApi(api_client) |
| 46 | + folder_request = urlr.FolderRequest() # FolderRequest | Infos to provide to get folders of team (optional) |
| 47 | + |
| 48 | + try: |
| 49 | + # Get folders of team |
| 50 | + api_response = api_instance.folder(folder_request=folder_request) |
| 51 | + print("The response of FolderApi->folder:\n") |
| 52 | + pprint(api_response) |
| 53 | + except Exception as e: |
| 54 | + print("Exception when calling FolderApi->folder: %s\n" % e) |
| 55 | +``` |
| 56 | + |
| 57 | + |
| 58 | + |
| 59 | +### Parameters |
| 60 | + |
| 61 | + |
| 62 | +Name | Type | Description | Notes |
| 63 | +------------- | ------------- | ------------- | ------------- |
| 64 | + **folder_request** | [**FolderRequest**](FolderRequest.md)| Infos to provide to get folders of team | [optional] |
| 65 | + |
| 66 | +### Return type |
| 67 | + |
| 68 | +[**Folder200Response**](Folder200Response.md) |
| 69 | + |
| 70 | +### Authorization |
| 71 | + |
| 72 | +[bearerAuth](../README.md#bearerAuth) |
| 73 | + |
| 74 | +### HTTP request headers |
| 75 | + |
| 76 | + - **Content-Type**: application/json |
| 77 | + - **Accept**: application/json |
| 78 | + |
| 79 | +### HTTP response details |
| 80 | + |
| 81 | +| Status code | Description | Response headers | |
| 82 | +|-------------|-------------|------------------| |
| 83 | +**200** | Folders of team | - | |
| 84 | + |
| 85 | +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
| 86 | + |
0 commit comments