res/ari/resource_mailboxes.h

   1 /*
   2  * Asterisk -- An open source telephony toolkit.
   3  *
   4  * Copyright (C) 2013, Digium, Inc.
   5  *
   6  * Jonathan Rose <jrose@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_mailboxes.c
  23  *
  24  * Mailboxes resources
  25  *
  26  * \author Jonathan Rose <jrose@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_MAILBOXES_H
  38 #define _ASTERISK_RESOURCE_MAILBOXES_H
  39
  40 #include "asterisk/ari.h"
  41
  42 /*! \brief Argument struct for ast_ari_mailboxes_list() */
  43 struct ast_ari_mailboxes_list_args {
  44 };
  45 /*!
  46  * \brief List all mailboxes.
  47  *
  48  * \param headers HTTP headers
  49  * \param args Swagger parameters
  50  * \param[out] response HTTP response
  51  */
  52 void ast_ari_mailboxes_list(struct ast_variable *headers, struct ast_ari_mailboxes_list_args *args, struct ast_ari_response *response);
  53 /*! \brief Argument struct for ast_ari_mailboxes_get() */
  54 struct ast_ari_mailboxes_get_args {
  55         /*! \brief Name of the mailbox */
  56         const char *mailbox_name;
  57 };
  58 /*!
  59  * \brief Retrieve the current state of a mailbox.
  60  *
  61  * \param headers HTTP headers
  62  * \param args Swagger parameters
  63  * \param[out] response HTTP response
  64  */
  65 void ast_ari_mailboxes_get(struct ast_variable *headers, struct ast_ari_mailboxes_get_args *args, struct ast_ari_response *response);
  66 /*! \brief Argument struct for ast_ari_mailboxes_update() */
  67 struct ast_ari_mailboxes_update_args {
  68         /*! \brief Name of the mailbox */
  69         const char *mailbox_name;
  70         /*! \brief Count of old messages in the mailbox */
  71         int old_messages;
  72         /*! \brief Count of new messages in the mailbox */
  73         int new_messages;
  74 };
  75 /*!
  76  * \brief Change the state of a mailbox. (Note - implicitly creates the mailbox).
  77  *
  78  * \param headers HTTP headers
  79  * \param args Swagger parameters
  80  * \param[out] response HTTP response
  81  */
  82 void ast_ari_mailboxes_update(struct ast_variable *headers, struct ast_ari_mailboxes_update_args *args, struct ast_ari_response *response);
  83 /*! \brief Argument struct for ast_ari_mailboxes_delete() */
  84 struct ast_ari_mailboxes_delete_args {
  85         /*! \brief Name of the mailbox */
  86         const char *mailbox_name;
  87 };
  88 /*!
  89  * \brief Destroy a mailbox.
  90  *
  91  * \param headers HTTP headers
  92  * \param args Swagger parameters
  93  * \param[out] response HTTP response
  94  */
  95 void ast_ari_mailboxes_delete(struct ast_variable *headers, struct ast_ari_mailboxes_delete_args *args, struct ast_ari_response *response);
  96
  97 #endif /* _ASTERISK_RESOURCE_MAILBOXES_H */