[TASK] Initial version, with some help from Junie. Copies all files in albums to the local filesystem.
This commit is contained in:
361
generated/immich/openapi_client/docs/PartnersApi.md
Normal file
361
generated/immich/openapi_client/docs/PartnersApi.md
Normal file
@@ -0,0 +1,361 @@
|
||||
# generated.immich.openapi_client.PartnersApi
|
||||
|
||||
All URIs are relative to *https://github.com/api*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create_partner**](PartnersApi.md#create_partner) | **POST** /partners/{id} |
|
||||
[**get_partners**](PartnersApi.md#get_partners) | **GET** /partners |
|
||||
[**remove_partner**](PartnersApi.md#remove_partner) | **DELETE** /partners/{id} |
|
||||
[**update_partner**](PartnersApi.md#update_partner) | **PUT** /partners/{id} |
|
||||
|
||||
|
||||
# **create_partner**
|
||||
> PartnerResponseDto create_partner(id)
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (cookie):
|
||||
* Api Key Authentication (api_key):
|
||||
* Bearer (JWT) Authentication (bearer):
|
||||
|
||||
```python
|
||||
import generated.immich.openapi_client
|
||||
from generated.immich.openapi_client.models.partner_response_dto import PartnerResponseDto
|
||||
from generated.immich.openapi_client.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://github.com/api
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = generated.immich.openapi_client.Configuration(
|
||||
host = "https://github.com/api"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure API key authorization: cookie
|
||||
configuration.api_key['cookie'] = os.environ["API_KEY"]
|
||||
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['cookie'] = 'Bearer'
|
||||
|
||||
# Configure API key authorization: api_key
|
||||
configuration.api_key['api_key'] = os.environ["API_KEY"]
|
||||
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['api_key'] = 'Bearer'
|
||||
|
||||
# Configure Bearer authorization (JWT): bearer
|
||||
configuration = generated.immich.openapi_client.Configuration(
|
||||
access_token = os.environ["BEARER_TOKEN"]
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = generated.immich.openapi_client.PartnersApi(api_client)
|
||||
id = 'id_example' # str |
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_partner(id)
|
||||
print("The response of PartnersApi->create_partner:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling PartnersApi->create_partner: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **str**| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**PartnerResponseDto**](PartnerResponseDto.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**201** | | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **get_partners**
|
||||
> List[PartnerResponseDto] get_partners(direction)
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (cookie):
|
||||
* Api Key Authentication (api_key):
|
||||
* Bearer (JWT) Authentication (bearer):
|
||||
|
||||
```python
|
||||
import generated.immich.openapi_client
|
||||
from generated.immich.openapi_client.models.partner_direction import PartnerDirection
|
||||
from generated.immich.openapi_client.models.partner_response_dto import PartnerResponseDto
|
||||
from generated.immich.openapi_client.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://github.com/api
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = generated.immich.openapi_client.Configuration(
|
||||
host = "https://github.com/api"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure API key authorization: cookie
|
||||
configuration.api_key['cookie'] = os.environ["API_KEY"]
|
||||
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['cookie'] = 'Bearer'
|
||||
|
||||
# Configure API key authorization: api_key
|
||||
configuration.api_key['api_key'] = os.environ["API_KEY"]
|
||||
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['api_key'] = 'Bearer'
|
||||
|
||||
# Configure Bearer authorization (JWT): bearer
|
||||
configuration = generated.immich.openapi_client.Configuration(
|
||||
access_token = os.environ["BEARER_TOKEN"]
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = generated.immich.openapi_client.PartnersApi(api_client)
|
||||
direction = generated.immich.openapi_client.PartnerDirection() # PartnerDirection |
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_partners(direction)
|
||||
print("The response of PartnersApi->get_partners:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling PartnersApi->get_partners: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**direction** | [**PartnerDirection**](.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**List[PartnerResponseDto]**](PartnerResponseDto.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **remove_partner**
|
||||
> remove_partner(id)
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (cookie):
|
||||
* Api Key Authentication (api_key):
|
||||
* Bearer (JWT) Authentication (bearer):
|
||||
|
||||
```python
|
||||
import generated.immich.openapi_client
|
||||
from generated.immich.openapi_client.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://github.com/api
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = generated.immich.openapi_client.Configuration(
|
||||
host = "https://github.com/api"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure API key authorization: cookie
|
||||
configuration.api_key['cookie'] = os.environ["API_KEY"]
|
||||
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['cookie'] = 'Bearer'
|
||||
|
||||
# Configure API key authorization: api_key
|
||||
configuration.api_key['api_key'] = os.environ["API_KEY"]
|
||||
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['api_key'] = 'Bearer'
|
||||
|
||||
# Configure Bearer authorization (JWT): bearer
|
||||
configuration = generated.immich.openapi_client.Configuration(
|
||||
access_token = os.environ["BEARER_TOKEN"]
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = generated.immich.openapi_client.PartnersApi(api_client)
|
||||
id = 'id_example' # str |
|
||||
|
||||
try:
|
||||
api_instance.remove_partner(id)
|
||||
except Exception as e:
|
||||
print("Exception when calling PartnersApi->remove_partner: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **str**| |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **update_partner**
|
||||
> PartnerResponseDto update_partner(id, update_partner_dto)
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (cookie):
|
||||
* Api Key Authentication (api_key):
|
||||
* Bearer (JWT) Authentication (bearer):
|
||||
|
||||
```python
|
||||
import generated.immich.openapi_client
|
||||
from generated.immich.openapi_client.models.partner_response_dto import PartnerResponseDto
|
||||
from generated.immich.openapi_client.models.update_partner_dto import UpdatePartnerDto
|
||||
from generated.immich.openapi_client.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://github.com/api
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = generated.immich.openapi_client.Configuration(
|
||||
host = "https://github.com/api"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure API key authorization: cookie
|
||||
configuration.api_key['cookie'] = os.environ["API_KEY"]
|
||||
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['cookie'] = 'Bearer'
|
||||
|
||||
# Configure API key authorization: api_key
|
||||
configuration.api_key['api_key'] = os.environ["API_KEY"]
|
||||
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['api_key'] = 'Bearer'
|
||||
|
||||
# Configure Bearer authorization (JWT): bearer
|
||||
configuration = generated.immich.openapi_client.Configuration(
|
||||
access_token = os.environ["BEARER_TOKEN"]
|
||||
)
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = generated.immich.openapi_client.PartnersApi(api_client)
|
||||
id = 'id_example' # str |
|
||||
update_partner_dto = generated.immich.openapi_client.UpdatePartnerDto() # UpdatePartnerDto |
|
||||
|
||||
try:
|
||||
api_response = api_instance.update_partner(id, update_partner_dto)
|
||||
print("The response of PartnersApi->update_partner:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling PartnersApi->update_partner: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **str**| |
|
||||
**update_partner_dto** | [**UpdatePartnerDto**](UpdatePartnerDto.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**PartnerResponseDto**](PartnerResponseDto.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | | - |
|
||||
|
||||
[[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)
|
||||
|
||||
Reference in New Issue
Block a user