artifact-keeper-client 1.2.1

Rust client for the Artifact Keeper REST API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

# \EmailSubscriptionsApi

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_subscription**](EmailSubscriptionsApi.md#create_subscription) | **POST** /api/v1/repositories/{key}/email-subscriptions | Create an email subscription scoped to a repository.
[**delete_subscription**](EmailSubscriptionsApi.md#delete_subscription) | **DELETE** /api/v1/repositories/{key}/email-subscriptions/{subscription_id} | Delete an email subscription by id.
[**list_subscriptions**](EmailSubscriptionsApi.md#list_subscriptions) | **GET** /api/v1/repositories/{key}/email-subscriptions | List the email subscriptions configured on a repository.



## create_subscription

> models::EmailSubscriptionResponse create_subscription(key, create_email_subscription_request)
Create an email subscription scoped to a repository.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**key** | **String** | Repository key | [required] |
**create_email_subscription_request** | [**CreateEmailSubscriptionRequest**](CreateEmailSubscriptionRequest.md) |  | [required] |

### Return type

[**models::EmailSubscriptionResponse**](EmailSubscriptionResponse.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[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)


## delete_subscription

> delete_subscription(key, subscription_id)
Delete an email subscription by id.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**key** | **String** | Repository key | [required] |
**subscription_id** | **uuid::Uuid** | Subscription ID | [required] |

### Return type

 (empty response body)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[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)


## list_subscriptions

> models::EmailSubscriptionListResponse list_subscriptions(key)
List the email subscriptions configured on a repository.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**key** | **String** | Repository key | [required] |

### Return type

[**models::EmailSubscriptionListResponse**](EmailSubscriptionListResponse.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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)