1454a73c9c6dad6c6383f69ffae3c62df1b7b7bb
[asterisk/asterisk.git] / res / ari / resource_endpoints.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_endpoints.c
23  *
24  * Endpoint 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_ENDPOINTS_H
38 #define _ASTERISK_RESOURCE_ENDPOINTS_H
39
40 #include "asterisk/ari.h"
41
42 /*! \brief Argument struct for ast_ari_endpoints_list() */
43 struct ast_ari_endpoints_list_args {
44 };
45 /*!
46  * \brief List all endpoints.
47  *
48  * \param headers HTTP headers
49  * \param args Swagger parameters
50  * \param[out] response HTTP response
51  */
52 void ast_ari_endpoints_list(struct ast_variable *headers, struct ast_ari_endpoints_list_args *args, struct ast_ari_response *response);
53 /*! \brief Argument struct for ast_ari_endpoints_list_by_tech() */
54 struct ast_ari_endpoints_list_by_tech_args {
55         /*! \brief Technology of the endpoints (sip,iax2,...) */
56         const char *tech;
57 };
58 /*!
59  * \brief List available endoints for a given endpoint technology.
60  *
61  * \param headers HTTP headers
62  * \param args Swagger parameters
63  * \param[out] response HTTP response
64  */
65 void ast_ari_endpoints_list_by_tech(struct ast_variable *headers, struct ast_ari_endpoints_list_by_tech_args *args, struct ast_ari_response *response);
66 /*! \brief Argument struct for ast_ari_endpoints_get() */
67 struct ast_ari_endpoints_get_args {
68         /*! \brief Technology of the endpoint */
69         const char *tech;
70         /*! \brief ID of the endpoint */
71         const char *resource;
72 };
73 /*!
74  * \brief Details for an endpoint.
75  *
76  * \param headers HTTP headers
77  * \param args Swagger parameters
78  * \param[out] response HTTP response
79  */
80 void ast_ari_endpoints_get(struct ast_variable *headers, struct ast_ari_endpoints_get_args *args, struct ast_ari_response *response);
81
82 #endif /* _ASTERISK_RESOURCE_ENDPOINTS_H */