ARI: Remove unnecessary \briefs from automatically generated documentation
[asterisk/asterisk.git] / res / ari / resource_recordings.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2012 - 2013, Digium, Inc.
5  *
6  * David M. Lee, II <dlee@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Generated file - declares stubs to be implemented in
22  * res/ari/resource_recordings.c
23  *
24  * Recording resources
25  *
26  * \author David M. Lee, II <dlee@digium.com>
27  */
28
29 /*
30  * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
31  * !!!!!                               DO NOT EDIT                        !!!!!
32  * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
33  * This file is generated by a mustache template. Please see the original
34  * template in rest-api-templates/ari_resource.h.mustache
35  */
36
37 #ifndef _ASTERISK_RESOURCE_RECORDINGS_H
38 #define _ASTERISK_RESOURCE_RECORDINGS_H
39
40 #include "asterisk/ari.h"
41
42 /*! Argument struct for ast_ari_recordings_list_stored() */
43 struct ast_ari_recordings_list_stored_args {
44 };
45 /*!
46  * \brief List recordings that are complete.
47  *
48  * \param headers HTTP headers
49  * \param args Swagger parameters
50  * \param[out] response HTTP response
51  */
52 void ast_ari_recordings_list_stored(struct ast_variable *headers, struct ast_ari_recordings_list_stored_args *args, struct ast_ari_response *response);
53 /*! Argument struct for ast_ari_recordings_get_stored() */
54 struct ast_ari_recordings_get_stored_args {
55         /*! The name of the recording */
56         const char *recording_name;
57 };
58 /*!
59  * \brief Get a stored recording's details.
60  *
61  * \param headers HTTP headers
62  * \param args Swagger parameters
63  * \param[out] response HTTP response
64  */
65 void ast_ari_recordings_get_stored(struct ast_variable *headers, struct ast_ari_recordings_get_stored_args *args, struct ast_ari_response *response);
66 /*! Argument struct for ast_ari_recordings_delete_stored() */
67 struct ast_ari_recordings_delete_stored_args {
68         /*! The name of the recording */
69         const char *recording_name;
70 };
71 /*!
72  * \brief Delete a stored recording.
73  *
74  * \param headers HTTP headers
75  * \param args Swagger parameters
76  * \param[out] response HTTP response
77  */
78 void ast_ari_recordings_delete_stored(struct ast_variable *headers, struct ast_ari_recordings_delete_stored_args *args, struct ast_ari_response *response);
79 /*! Argument struct for ast_ari_recordings_get_live() */
80 struct ast_ari_recordings_get_live_args {
81         /*! The name of the recording */
82         const char *recording_name;
83 };
84 /*!
85  * \brief List live recordings.
86  *
87  * \param headers HTTP headers
88  * \param args Swagger parameters
89  * \param[out] response HTTP response
90  */
91 void ast_ari_recordings_get_live(struct ast_variable *headers, struct ast_ari_recordings_get_live_args *args, struct ast_ari_response *response);
92 /*! Argument struct for ast_ari_recordings_cancel() */
93 struct ast_ari_recordings_cancel_args {
94         /*! The name of the recording */
95         const char *recording_name;
96 };
97 /*!
98  * \brief Stop a live recording and discard it.
99  *
100  * \param headers HTTP headers
101  * \param args Swagger parameters
102  * \param[out] response HTTP response
103  */
104 void ast_ari_recordings_cancel(struct ast_variable *headers, struct ast_ari_recordings_cancel_args *args, struct ast_ari_response *response);
105 /*! Argument struct for ast_ari_recordings_stop() */
106 struct ast_ari_recordings_stop_args {
107         /*! The name of the recording */
108         const char *recording_name;
109 };
110 /*!
111  * \brief Stop a live recording and store it.
112  *
113  * \param headers HTTP headers
114  * \param args Swagger parameters
115  * \param[out] response HTTP response
116  */
117 void ast_ari_recordings_stop(struct ast_variable *headers, struct ast_ari_recordings_stop_args *args, struct ast_ari_response *response);
118 /*! Argument struct for ast_ari_recordings_pause() */
119 struct ast_ari_recordings_pause_args {
120         /*! The name of the recording */
121         const char *recording_name;
122 };
123 /*!
124  * \brief Pause a live recording.
125  *
126  * Pausing a recording suspends silence detection, which will be restarted when the recording is unpaused. Paused time is not included in the accounting for maxDurationSeconds.
127  *
128  * \param headers HTTP headers
129  * \param args Swagger parameters
130  * \param[out] response HTTP response
131  */
132 void ast_ari_recordings_pause(struct ast_variable *headers, struct ast_ari_recordings_pause_args *args, struct ast_ari_response *response);
133 /*! Argument struct for ast_ari_recordings_unpause() */
134 struct ast_ari_recordings_unpause_args {
135         /*! The name of the recording */
136         const char *recording_name;
137 };
138 /*!
139  * \brief Unpause a live recording.
140  *
141  * \param headers HTTP headers
142  * \param args Swagger parameters
143  * \param[out] response HTTP response
144  */
145 void ast_ari_recordings_unpause(struct ast_variable *headers, struct ast_ari_recordings_unpause_args *args, struct ast_ari_response *response);
146 /*! Argument struct for ast_ari_recordings_mute() */
147 struct ast_ari_recordings_mute_args {
148         /*! The name of the recording */
149         const char *recording_name;
150 };
151 /*!
152  * \brief Mute a live recording.
153  *
154  * Muting a recording suspends silence detection, which will be restarted when the recording is unmuted.
155  *
156  * \param headers HTTP headers
157  * \param args Swagger parameters
158  * \param[out] response HTTP response
159  */
160 void ast_ari_recordings_mute(struct ast_variable *headers, struct ast_ari_recordings_mute_args *args, struct ast_ari_response *response);
161 /*! Argument struct for ast_ari_recordings_unmute() */
162 struct ast_ari_recordings_unmute_args {
163         /*! The name of the recording */
164         const char *recording_name;
165 };
166 /*!
167  * \brief Unmute a live recording.
168  *
169  * \param headers HTTP headers
170  * \param args Swagger parameters
171  * \param[out] response HTTP response
172  */
173 void ast_ari_recordings_unmute(struct ast_variable *headers, struct ast_ari_recordings_unmute_args *args, struct ast_ari_response *response);
174
175 #endif /* _ASTERISK_RESOURCE_RECORDINGS_H */