2013-04-22 14:58:53 +00:00
/*
* Asterisk - - An open source telephony toolkit .
*
* Copyright ( C ) 2012 - 2013 , Digium , Inc .
*
* David M . Lee , II < dlee @ digium . com >
*
* See http : //www.asterisk.org for more information about
* the Asterisk project . Please do not directly contact
* any of the maintainers of this project for assistance ;
* the project provides a web site , mailing lists and IRC
* channels for your use .
*
* This program is free software , distributed under the terms of
* the GNU General Public License Version 2. See the LICENSE file
* at the top of the source tree .
*/
/*! \file
*
* \ brief Generated file - declares stubs to be implemented in
2013-07-27 23:11:02 +00:00
* res / ari / resource_asterisk . c
2013-04-22 14:58:53 +00:00
*
* Asterisk resources
*
* \ author David M . Lee , II < dlee @ digium . com >
*/
/*
* ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! !
* ! ! ! ! ! DO NOT EDIT ! ! ! ! !
* ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! !
* This file is generated by a mustache template . Please see the original
2013-07-27 23:11:02 +00:00
* template in rest - api - templates / ari_resource . h . mustache
2013-04-22 14:58:53 +00:00
*/
# ifndef _ASTERISK_RESOURCE_ASTERISK_H
# define _ASTERISK_RESOURCE_ASTERISK_H
2013-07-27 23:11:02 +00:00
# include "asterisk/ari.h"
2013-04-22 14:58:53 +00:00
2015-07-08 16:39:35 -05:00
/*! Argument struct for ast_ari_asterisk_get_object() */
struct ast_ari_asterisk_get_object_args {
/*! The configuration class containing dynamic configuration objects. */
const char * config_class ;
/*! The type of configuration object to retrieve. */
const char * object_type ;
/*! The unique identifier of the object to retrieve. */
const char * id ;
} ;
/*!
* \ brief Retrieve a dynamic configuration object .
*
* \ param headers HTTP headers
* \ param args Swagger parameters
* \ param [ out ] response HTTP response
*/
void ast_ari_asterisk_get_object ( struct ast_variable * headers , struct ast_ari_asterisk_get_object_args * args , struct ast_ari_response * response ) ;
/*! Argument struct for ast_ari_asterisk_update_object() */
struct ast_ari_asterisk_update_object_args {
/*! The configuration class containing dynamic configuration objects. */
const char * config_class ;
/*! The type of configuration object to create or update. */
const char * object_type ;
/*! The unique identifier of the object to create or update. */
const char * id ;
/*! The body object should have a value that is a list of ConfigTuples, which provide the fields to update. Ex. [ { "attribute": "directmedia", "value": "false" } ] */
struct ast_json * fields ;
} ;
/*!
* \ brief Body parsing function for / asterisk / config / dynamic / { configClass } / { objectType } / { id } .
* \ param body The JSON body from which to parse parameters .
* \ param [ out ] args The args structure to parse into .
* \ retval zero on success
* \ retval non - zero on failure
*/
int ast_ari_asterisk_update_object_parse_body (
struct ast_json * body ,
struct ast_ari_asterisk_update_object_args * args ) ;
/*!
* \ brief Create or update a dynamic configuration object .
*
* \ param headers HTTP headers
* \ param args Swagger parameters
* \ param [ out ] response HTTP response
*/
void ast_ari_asterisk_update_object ( struct ast_variable * headers , struct ast_ari_asterisk_update_object_args * args , struct ast_ari_response * response ) ;
/*! Argument struct for ast_ari_asterisk_delete_object() */
struct ast_ari_asterisk_delete_object_args {
/*! The configuration class containing dynamic configuration objects. */
const char * config_class ;
/*! The type of configuration object to delete. */
const char * object_type ;
/*! The unique identifier of the object to delete. */
const char * id ;
} ;
/*!
* \ brief Delete a dynamic configuration object .
*
* \ param headers HTTP headers
* \ param args Swagger parameters
* \ param [ out ] response HTTP response
*/
void ast_ari_asterisk_delete_object ( struct ast_variable * headers , struct ast_ari_asterisk_delete_object_args * args , struct ast_ari_response * response ) ;
2014-07-02 21:13:46 +00:00
/*! Argument struct for ast_ari_asterisk_get_info() */
2013-11-07 21:10:31 +00:00
struct ast_ari_asterisk_get_info_args {
2014-07-02 21:13:46 +00:00
/*! Array of Filter information returned */
2013-08-02 14:36:32 +00:00
const char * * only ;
2014-07-02 21:13:46 +00:00
/*! Length of only array. */
2013-08-02 14:36:32 +00:00
size_t only_count ;
2014-07-02 21:13:46 +00:00
/*! Parsing context for only. */
2013-08-02 14:36:32 +00:00
char * only_parse ;
2013-04-22 14:58:53 +00:00
} ;
2014-01-21 14:27:21 +00:00
/*!
* \ brief Body parsing function for / asterisk / info .
* \ param body The JSON body from which to parse parameters .
* \ param [ out ] args The args structure to parse into .
* \ retval zero on success
* \ retval non - zero on failure
*/
int ast_ari_asterisk_get_info_parse_body (
struct ast_json * body ,
struct ast_ari_asterisk_get_info_args * args ) ;
2013-04-22 14:58:53 +00:00
/*!
* \ brief Gets Asterisk system information .
*
* \ param headers HTTP headers
* \ param args Swagger parameters
* \ param [ out ] response HTTP response
*/
2013-11-07 21:10:31 +00:00
void ast_ari_asterisk_get_info ( struct ast_variable * headers , struct ast_ari_asterisk_get_info_args * args , struct ast_ari_response * response ) ;
2019-01-29 00:21:28 +01:00
/*! Argument struct for ast_ari_asterisk_ping() */
struct ast_ari_asterisk_ping_args {
} ;
/*!
* \ brief Response pong message .
*
* \ param headers HTTP headers
* \ param args Swagger parameters
* \ param [ out ] response HTTP response
*/
void ast_ari_asterisk_ping ( struct ast_variable * headers , struct ast_ari_asterisk_ping_args * args , struct ast_ari_response * response ) ;
2015-06-26 10:57:15 -05:00
/*! Argument struct for ast_ari_asterisk_list_modules() */
struct ast_ari_asterisk_list_modules_args {
} ;
/*!
* \ brief List Asterisk modules .
*
* \ param headers HTTP headers
* \ param args Swagger parameters
* \ param [ out ] response HTTP response
*/
void ast_ari_asterisk_list_modules ( struct ast_variable * headers , struct ast_ari_asterisk_list_modules_args * args , struct ast_ari_response * response ) ;
2015-07-13 10:54:51 -05:00
/*! Argument struct for ast_ari_asterisk_get_module() */
struct ast_ari_asterisk_get_module_args {
/*! Module's name */
const char * module_name ;
} ;
/*!
* \ brief Get Asterisk module information .
*
* \ param headers HTTP headers
* \ param args Swagger parameters
* \ param [ out ] response HTTP response
*/
void ast_ari_asterisk_get_module ( struct ast_variable * headers , struct ast_ari_asterisk_get_module_args * args , struct ast_ari_response * response ) ;
2015-07-13 16:00:19 -05:00
/*! Argument struct for ast_ari_asterisk_load_module() */
struct ast_ari_asterisk_load_module_args {
/*! Module's name */
const char * module_name ;
} ;
/*!
* \ brief Load an Asterisk module .
*
* \ param headers HTTP headers
* \ param args Swagger parameters
* \ param [ out ] response HTTP response
*/
void ast_ari_asterisk_load_module ( struct ast_variable * headers , struct ast_ari_asterisk_load_module_args * args , struct ast_ari_response * response ) ;
2015-07-14 08:55:14 -05:00
/*! Argument struct for ast_ari_asterisk_unload_module() */
struct ast_ari_asterisk_unload_module_args {
/*! Module's name */
const char * module_name ;
} ;
/*!
* \ brief Unload an Asterisk module .
*
* \ param headers HTTP headers
* \ param args Swagger parameters
* \ param [ out ] response HTTP response
*/
void ast_ari_asterisk_unload_module ( struct ast_variable * headers , struct ast_ari_asterisk_unload_module_args * args , struct ast_ari_response * response ) ;
2015-07-14 13:12:32 -05:00
/*! Argument struct for ast_ari_asterisk_reload_module() */
struct ast_ari_asterisk_reload_module_args {
/*! Module's name */
const char * module_name ;
} ;
/*!
* \ brief Reload an Asterisk module .
*
* \ param headers HTTP headers
* \ param args Swagger parameters
* \ param [ out ] response HTTP response
*/
void ast_ari_asterisk_reload_module ( struct ast_variable * headers , struct ast_ari_asterisk_reload_module_args * args , struct ast_ari_response * response ) ;
2015-08-07 14:20:29 -05:00
/*! Argument struct for ast_ari_asterisk_list_log_channels() */
struct ast_ari_asterisk_list_log_channels_args {
} ;
/*!
* \ brief Gets Asterisk log channel information .
*
* \ param headers HTTP headers
* \ param args Swagger parameters
* \ param [ out ] response HTTP response
*/
void ast_ari_asterisk_list_log_channels ( struct ast_variable * headers , struct ast_ari_asterisk_list_log_channels_args * args , struct ast_ari_response * response ) ;
2015-08-07 11:14:06 -05:00
/*! Argument struct for ast_ari_asterisk_add_log() */
struct ast_ari_asterisk_add_log_args {
/*! The log channel to add */
const char * log_channel_name ;
/*! levels of the log channel */
const char * configuration ;
} ;
/*!
* \ brief Body parsing function for / asterisk / logging / { logChannelName } .
* \ param body The JSON body from which to parse parameters .
* \ param [ out ] args The args structure to parse into .
* \ retval zero on success
* \ retval non - zero on failure
*/
int ast_ari_asterisk_add_log_parse_body (
struct ast_json * body ,
struct ast_ari_asterisk_add_log_args * args ) ;
/*!
* \ brief Adds a log channel .
*
* \ param headers HTTP headers
* \ param args Swagger parameters
* \ param [ out ] response HTTP response
*/
void ast_ari_asterisk_add_log ( struct ast_variable * headers , struct ast_ari_asterisk_add_log_args * args , struct ast_ari_response * response ) ;
2015-08-06 15:18:04 -05:00
/*! Argument struct for ast_ari_asterisk_delete_log() */
struct ast_ari_asterisk_delete_log_args {
/*! Log channels name */
const char * log_channel_name ;
} ;
/*!
* \ brief Deletes a log channel .
*
* \ param headers HTTP headers
* \ param args Swagger parameters
* \ param [ out ] response HTTP response
*/
void ast_ari_asterisk_delete_log ( struct ast_variable * headers , struct ast_ari_asterisk_delete_log_args * args , struct ast_ari_response * response ) ;
2015-07-29 14:17:09 -05:00
/*! Argument struct for ast_ari_asterisk_rotate_log() */
struct ast_ari_asterisk_rotate_log_args {
/*! Log channel's name */
const char * log_channel_name ;
} ;
/*!
* \ brief Rotates a log channel .
*
* \ param headers HTTP headers
* \ param args Swagger parameters
* \ param [ out ] response HTTP response
*/
void ast_ari_asterisk_rotate_log ( struct ast_variable * headers , struct ast_ari_asterisk_rotate_log_args * args , struct ast_ari_response * response ) ;
2014-07-02 21:13:46 +00:00
/*! Argument struct for ast_ari_asterisk_get_global_var() */
2013-11-07 21:10:31 +00:00
struct ast_ari_asterisk_get_global_var_args {
2014-07-02 21:13:46 +00:00
/*! The variable to get */
2013-07-08 14:46:20 +00:00
const char * variable ;
} ;
2014-01-21 14:27:21 +00:00
/*!
* \ brief Body parsing function for / asterisk / variable .
* \ param body The JSON body from which to parse parameters .
* \ param [ out ] args The args structure to parse into .
* \ retval zero on success
* \ retval non - zero on failure
*/
int ast_ari_asterisk_get_global_var_parse_body (
struct ast_json * body ,
struct ast_ari_asterisk_get_global_var_args * args ) ;
2013-07-08 14:46:20 +00:00
/*!
* \ brief Get the value of a global variable .
*
* \ param headers HTTP headers
* \ param args Swagger parameters
* \ param [ out ] response HTTP response
*/
2013-11-07 21:10:31 +00:00
void ast_ari_asterisk_get_global_var ( struct ast_variable * headers , struct ast_ari_asterisk_get_global_var_args * args , struct ast_ari_response * response ) ;
2014-07-02 21:13:46 +00:00
/*! Argument struct for ast_ari_asterisk_set_global_var() */
2013-11-07 21:10:31 +00:00
struct ast_ari_asterisk_set_global_var_args {
2014-07-02 21:13:46 +00:00
/*! The variable to set */
2013-07-08 14:46:20 +00:00
const char * variable ;
2014-07-02 21:13:46 +00:00
/*! The value to set the variable to */
2013-07-08 14:46:20 +00:00
const char * value ;
} ;
2014-01-21 14:27:21 +00:00
/*!
* \ brief Body parsing function for / asterisk / variable .
* \ param body The JSON body from which to parse parameters .
* \ param [ out ] args The args structure to parse into .
* \ retval zero on success
* \ retval non - zero on failure
*/
int ast_ari_asterisk_set_global_var_parse_body (
struct ast_json * body ,
struct ast_ari_asterisk_set_global_var_args * args ) ;
2013-07-08 14:46:20 +00:00
/*!
* \ brief Set the value of a global variable .
*
* \ param headers HTTP headers
* \ param args Swagger parameters
* \ param [ out ] response HTTP response
*/
2013-11-07 21:10:31 +00:00
void ast_ari_asterisk_set_global_var ( struct ast_variable * headers , struct ast_ari_asterisk_set_global_var_args * args , struct ast_ari_response * response ) ;
2013-04-22 14:58:53 +00:00
# endif /* _ASTERISK_RESOURCE_ASTERISK_H */
