From 44eda2d4ad07b987f832223026e0a9a2dddeec64 Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Thu, 20 Feb 2020 13:42:43 +0100 Subject: [PATCH] Fix doxygen --- .../comm/propal/class/api_proposals.class.php | 25 ++-- htdocs/commande/class/api_orders.class.php | 51 +++---- .../bank/class/api_bankaccounts.class.php | 8 +- .../facture/class/api_invoices.class.php | 126 ++++++++-------- .../expedition/class/api_shipments.class.php | 21 +-- .../class/api_supplier_invoices.class.php | 38 ++--- htdocs/product/class/api_products.class.php | 136 +++++++++--------- .../societe/class/api_thirdparties.class.php | 85 +++++------ 8 files changed, 245 insertions(+), 245 deletions(-) diff --git a/htdocs/comm/propal/class/api_proposals.class.php b/htdocs/comm/propal/class/api_proposals.class.php index 1337c62da94..d0ce31b5369 100644 --- a/htdocs/comm/propal/class/api_proposals.class.php +++ b/htdocs/comm/propal/class/api_proposals.class.php @@ -377,8 +377,9 @@ class Proposals extends DolibarrApi * @url DELETE {id}/lines/{lineid} * * @return int - * @throws 401 - * @throws 404 + * + * @throws RestException 401 + * @throws RestException 404 */ public function deleteLine($id, $lineid) { @@ -417,8 +418,9 @@ class Proposals extends DolibarrApi * @url POST {id}/contact/{contactid}/{type} * * @return int - * @throws 401 - * @throws 404 + * + * @throws RestException 401 + * @throws RestException 404 */ public function postContact($id, $contactid, $type) { @@ -458,9 +460,10 @@ class Proposals extends DolibarrApi * @url DELETE {id}/contact/{rowid} * * @return int - * @throws 401 - * @throws 404 - * @throws 500 + * + * @throws RestException 401 + * @throws RestException 404 + * @throws RestException 500 */ public function deleteContact($id, $rowid) { @@ -629,10 +632,10 @@ class Proposals extends DolibarrApi * * @url POST {id}/validate * - * @throws 304 - * @throws 401 - * @throws 404 - * @throws 500 + * @throws RestException 304 + * @throws RestException 401 + * @throws RestException 404 + * @throws RestException 500 * * @return array */ diff --git a/htdocs/commande/class/api_orders.class.php b/htdocs/commande/class/api_orders.class.php index 5069135dd88..60c9e23710b 100644 --- a/htdocs/commande/class/api_orders.class.php +++ b/htdocs/commande/class/api_orders.class.php @@ -425,8 +425,9 @@ class Orders extends DolibarrApi * @url DELETE {id}/lines/{lineid} * * @return int - * @throws 401 - * @throws 404 + * + * @throws RestException 401 + * @throws RestException 404 */ public function deleteLine($id, $lineid) { @@ -463,8 +464,9 @@ class Orders extends DolibarrApi * @url POST {id}/contact/{contactid}/{type} * * @return int - * @throws 401 - * @throws 404 + * + * @throws RestException 401 + * @throws RestException 404 */ public function postContact($id, $contactid, $type) { @@ -499,9 +501,10 @@ class Orders extends DolibarrApi * @url DELETE {id}/contact/{rowid} * * @return int - * @throws 401 - * @throws 404 - * @throws 500 + * + * @throws RestException 401 + * @throws RestException 404 + * @throws RestException 500 */ public function deleteContact($id, $rowid) { @@ -617,10 +620,10 @@ class Orders extends DolibarrApi * * @url POST {id}/validate * - * @throws 304 - * @throws 401 - * @throws 404 - * @throws 500 + * @throws RestException 304 + * @throws RestException 401 + * @throws RestException 404 + * @throws RestException 500 * * @return array */ @@ -670,11 +673,11 @@ class Orders extends DolibarrApi * * @return int * - * @throws 304 - * @throws 400 - * @throws 401 - * @throws 404 - * @throws 405 + * @throws RestException 304 + * @throws RestException 400 + * @throws RestException 401 + * @throws RestException 404 + * @throws RestException 405 */ public function reopen($id) { @@ -709,10 +712,10 @@ class Orders extends DolibarrApi * * @return int * - * @throws 400 - * @throws 401 - * @throws 404 - * @throws 405 + * @throws RestException 400 + * @throws RestException 401 + * @throws RestException 404 + * @throws RestException 405 */ public function setinvoiced($id) { @@ -849,10 +852,10 @@ class Orders extends DolibarrApi * @url POST /createfromproposal/{proposalid} * * @return int - * @throws 400 - * @throws 401 - * @throws 404 - * @throws 405 + * @throws RestException 400 + * @throws RestException 401 + * @throws RestException 404 + * @throws RestException 405 */ public function createOrderFromProposal($proposalid) { diff --git a/htdocs/compta/bank/class/api_bankaccounts.class.php b/htdocs/compta/bank/class/api_bankaccounts.class.php index 2ecb59861d9..1272cfcad85 100644 --- a/htdocs/compta/bank/class/api_bankaccounts.class.php +++ b/htdocs/compta/bank/class/api_bankaccounts.class.php @@ -183,10 +183,10 @@ class BankAccounts extends DolibarrApi * * @status 201 * - * @throws 401 Unauthorized: User does not have permission to configure bank accounts - * @throws 404 Not Found: Either the source or the destination bankaccount for the provided id does not exist - * @throws 422 Unprocessable Entity: Refer to detailed exception message for the cause - * @throws 500 Internal Server Error: Error(s) returned by the RDBMS + * @throws RestException 401 Unauthorized: User does not have permission to configure bank accounts + * @throws RestException 404 Not Found: Either the source or the destination bankaccount for the provided id does not exist + * @throws RestException 422 Unprocessable Entity: Refer to detailed exception message for the cause + * @throws RestException 500 Internal Server Error: Error(s) returned by the RDBMS */ public function transfer($bankaccount_from_id = 0, $bankaccount_to_id = 0, $date = null, $description = "", $amount = 0.0, $amount_to = 0.0) { diff --git a/htdocs/compta/facture/class/api_invoices.class.php b/htdocs/compta/facture/class/api_invoices.class.php index 7c7437bfb8e..e68966f4663 100644 --- a/htdocs/compta/facture/class/api_invoices.class.php +++ b/htdocs/compta/facture/class/api_invoices.class.php @@ -242,10 +242,10 @@ class Invoices extends DolibarrApi * @url POST /createfromorder/{orderid} * * @return int - * @throws 400 - * @throws 401 - * @throws 404 - * @throws 405 + * @throws RestException 400 + * @throws RestException 401 + * @throws RestException 404 + * @throws RestException 405 */ public function createInvoiceFromOrder($orderid) { @@ -318,10 +318,9 @@ class Invoices extends DolibarrApi * * @return array * - * @throws 200 - * @throws 304 - * @throws 401 - * @throws 404 + * @throws RestException 304 + * @throws RestException 401 + * @throws RestException 404 Invoice not found */ public function putLine($id, $lineid, $request_data = null) { @@ -383,8 +382,9 @@ class Invoices extends DolibarrApi * @url POST {id}/contact/{contactid}/{type} * * @return int - * @throws 401 - * @throws 404 + * + * @throws RestException 401 + * @throws RestException 404 */ public function postContact($id, $contactid, $type) { @@ -424,9 +424,10 @@ class Invoices extends DolibarrApi * @url DELETE {id}/contact/{rowid} * * @return array - * @throws 401 - * @throws 404 - * @throws 500 + * + * @throws RestException 401 + * @throws RestException 404 + * @throws RestException 500 */ public function deleteContact($id, $rowid) { @@ -463,10 +464,10 @@ class Invoices extends DolibarrApi * * @return array * - * @throws 400 - * @throws 401 - * @throws 404 - * @throws 405 + * @throws RestException 400 + * @throws RestException 401 + * @throws RestException 404 + * @throws RestException 405 */ public function deleteLine($id, $lineid) { @@ -591,10 +592,9 @@ class Invoices extends DolibarrApi * * @return int * - * @throws 200 - * @throws 401 - * @throws 404 - * @throws 400 + * @throws RestException 401 + * @throws RestException 404 + * @throws RestException 400 */ public function postLine($id, $request_data = null) { @@ -673,11 +673,10 @@ class Invoices extends DolibarrApi * * @return array * - * @throws 200 - * @throws 304 - * @throws 401 - * @throws 404 - * @throws 500 + * @throws RestException 304 + * @throws RestException 401 + * @throws RestException 404 + * @throws RestException 500 * */ public function addContact($id, $fk_socpeople, $type_contact, $source, $notrigger = 0) @@ -723,11 +722,10 @@ class Invoices extends DolibarrApi * * @return array * - * @throws 200 - * @throws 304 - * @throws 401 - * @throws 404 - * @throws 500 + * @throws RestException 304 + * @throws RestException 401 + * @throws RestException 404 + * @throws RestException 500 * */ public function settodraft($id, $idwarehouse = -1) @@ -827,11 +825,10 @@ class Invoices extends DolibarrApi * * @return array An invoice object * - * @throws 200 - * @throws 304 - * @throws 401 - * @throws 404 - * @throws 500 + * @throws RestException 304 + * @throws RestException 401 + * @throws RestException 404 + * @throws RestException 500 */ public function settopaid($id, $close_code = '', $close_note = '') { @@ -878,11 +875,10 @@ class Invoices extends DolibarrApi * * @return array An invoice object * - * @throws 200 - * @throws 304 - * @throws 401 - * @throws 404 - * @throws 500 + * @throws RestException 304 + * @throws RestException 401 + * @throws RestException 404 + * @throws RestException 500 */ public function settounpaid($id) { @@ -927,11 +923,10 @@ class Invoices extends DolibarrApi * * @return array An invoice object * - * @throws 200 - * @throws 304 - * @throws 401 - * @throws 404 - * @throws 500 + * @throws RestException 304 + * @throws RestException 401 + * @throws RestException 404 + * @throws RestException 500 */ public function markAsCreditAvailable($id) { @@ -1103,10 +1098,10 @@ class Invoices extends DolibarrApi * @url POST {id}/usediscount/{discountid} * * @return int - * @throws 400 - * @throws 401 - * @throws 404 - * @throws 405 + * @throws RestException 400 + * @throws RestException 401 + * @throws RestException 404 + * @throws RestException 405 */ public function useDiscount($id, $discountid) { @@ -1149,10 +1144,10 @@ class Invoices extends DolibarrApi * @url POST {id}/usecreditnote/{discountid} * * @return int - * @throws 400 - * @throws 401 - * @throws 404 - * @throws 405 + * @throws RestException 400 + * @throws RestException 401 + * @throws RestException 404 + * @throws RestException 405 */ public function useCreditNote($id, $discountid) { @@ -1194,10 +1189,11 @@ class Invoices extends DolibarrApi * @url GET {id}/payments * * @return array - * @throws 400 - * @throws 401 - * @throws 404 - * @throws 405 + * + * @throws RestException 400 + * @throws RestException 401 + * @throws RestException 404 + * @throws RestException 405 */ public function getPayments($id) { @@ -1243,9 +1239,9 @@ class Invoices extends DolibarrApi * @url POST {id}/payments * * @return int Payment ID - * @throws 400 - * @throws 401 - * @throws 404 + * @throws RestException 400 + * @throws RestException 401 + * @throws RestException 404 */ public function addPayment($id, $datepaye, $paiementid, $closepaidinvoices, $accountid, $num_paiement = '', $comment = '', $chqemetteur = '', $chqbank = '') { @@ -1362,10 +1358,10 @@ class Invoices extends DolibarrApi * @url POST /paymentsdistributed * * @return int Payment ID - * @throws 400 - * @throws 401 - * @throws 403 - * @throws 404 + * @throws RestException 400 + * @throws RestException 401 + * @throws RestException 403 + * @throws RestException 404 */ public function addPaymentDistributed($arrayofamounts, $datepaye, $paiementid, $closepaidinvoices, $accountid, $num_paiement = '', $comment = '', $chqemetteur = '', $chqbank = '') { diff --git a/htdocs/expedition/class/api_shipments.class.php b/htdocs/expedition/class/api_shipments.class.php index 5aca14fb28d..8526f0c9610 100644 --- a/htdocs/expedition/class/api_shipments.class.php +++ b/htdocs/expedition/class/api_shipments.class.php @@ -373,8 +373,9 @@ class Shipments extends DolibarrApi * @url DELETE {id}/lines/{lineid} * * @return int - * @throws 401 - * @throws 404 + * + * @throws RestException 401 + * @throws RestException 404 */ public function deleteLine($id, $lineid) { @@ -537,10 +538,10 @@ class Shipments extends DolibarrApi // * // * @return int // * - // * @throws 400 - // * @throws 401 - // * @throws 404 - // * @throws 405 + // * @throws RestException 400 + // * @throws RestException 401 + // * @throws RestException 404 + // * @throws RestException 405 // */ /* public function setinvoiced($id) @@ -574,10 +575,10 @@ class Shipments extends DolibarrApi // * @url POST /createfromorder/{orderid} // * // * @return int - // * @throws 400 - // * @throws 401 - // * @throws 404 - // * @throws 405 + // * @throws RestException 400 + // * @throws RestException 401 + // * @throws RestException 404 + // * @throws RestException 405 // */ /* public function createShipmentFromOrder($orderid) diff --git a/htdocs/fourn/class/api_supplier_invoices.class.php b/htdocs/fourn/class/api_supplier_invoices.class.php index 21e5e82c13b..204471bc9e7 100644 --- a/htdocs/fourn/class/api_supplier_invoices.class.php +++ b/htdocs/fourn/class/api_supplier_invoices.class.php @@ -194,8 +194,8 @@ class SupplierInvoices extends DolibarrApi * * @return int ID of supplier invoice * - * @throws 401 - * @throws 500 + * @throws RestException 401 + * @throws RestException 500 */ public function post($request_data = null) { @@ -226,8 +226,8 @@ class SupplierInvoices extends DolibarrApi * * @return int * - * @throws 401 - * @throws 404 + * @throws RestException 401 + * @throws RestException 404 */ public function put($id, $request_data = null) { @@ -262,9 +262,9 @@ class SupplierInvoices extends DolibarrApi * * @return array * - * @throws 401 - * @throws 404 - * @throws 500 + * @throws RestException 401 + * @throws RestException 404 + * @throws RestException 500 */ public function delete($id) { @@ -304,11 +304,11 @@ class SupplierInvoices extends DolibarrApi * * @return array * - * @throws 304 - * @throws 401 - * @throws 404 - * @throws 405 - * @throws 500 + * @throws RestException 304 + * @throws RestException 401 + * @throws RestException 404 + * @throws RestException 405 + * @throws RestException 500 */ public function validate($id, $idwarehouse = 0, $notrigger = 0) { @@ -348,10 +348,10 @@ class SupplierInvoices extends DolibarrApi * @url GET {id}/payments * * @return array - * @throws 400 - * @throws 401 - * @throws 404 - * @throws 405 + * @throws RestException 400 + * @throws RestException 401 + * @throws RestException 404 + * @throws RestException 405 */ public function getPayments($id) { @@ -396,9 +396,9 @@ class SupplierInvoices extends DolibarrApi * @url POST {id}/payments * * @return int Payment ID - * @throws 400 - * @throws 401 - * @throws 404 + * @throws RestException 400 + * @throws RestException 401 + * @throws RestException 404 */ public function addPayment($id, $datepaye, $paiementid, $closepaidinvoices, $accountid, $num_paiement = '', $comment = '', $chqemetteur = '', $chqbank = '') { diff --git a/htdocs/product/class/api_products.class.php b/htdocs/product/class/api_products.class.php index 1e189026366..dc4d2e79481 100644 --- a/htdocs/product/class/api_products.class.php +++ b/htdocs/product/class/api_products.class.php @@ -73,9 +73,9 @@ class Products extends DolibarrApi * @param bool $includesubproducts Load information about subproducts * @return array|mixed Data without useless information * - * @throws 401 - * @throws 403 - * @throws 404 + * @throws RestException 401 + * @throws RestException 403 + * @throws RestException 404 */ public function get($id, $includestockdata = 0, $includesubproducts = false) { @@ -95,9 +95,9 @@ class Products extends DolibarrApi * * @url GET ref/{ref} * - * @throws 401 - * @throws 403 - * @throws 404 + * @throws RestException 401 + * @throws RestException 403 + * @throws RestException 404 */ public function getByRef($ref, $includestockdata = 0, $includesubproducts = false) { @@ -117,9 +117,9 @@ class Products extends DolibarrApi * * @url GET ref_ext/{ref_ext} * - * @throws 401 - * @throws 403 - * @throws 404 + * @throws RestException 401 + * @throws RestException 403 + * @throws RestException 404 */ public function getByRefExt($ref_ext, $includestockdata = 0, $includesubproducts = false) { @@ -139,9 +139,9 @@ class Products extends DolibarrApi * * @url GET barcode/{barcode} * - * @throws 401 - * @throws 403 - * @throws 404 + * @throws RestException 401 + * @throws RestException 403 + * @throws RestException 404 */ public function getByBarcode($barcode, $includestockdata = 0, $includesubproducts = false) { @@ -263,9 +263,8 @@ class Products extends DolibarrApi * @param array $request_data Datas * @return int * - * @throws RestException - * @throws 401 - * @throws 404 + * @throws RestException 401 + * @throws RestException 404 */ public function put($id, $request_data = null) { @@ -385,8 +384,8 @@ class Products extends DolibarrApi * @return array * * @throws RestException - * @throws 401 - * @throws 404 + * @throws RestException 401 + * @throws RestException 404 * * @url GET {id}/subproducts */ @@ -423,8 +422,8 @@ class Products extends DolibarrApi * @return int * * @throws RestException - * @throws 401 - * @throws 404 + * @throws RestException 401 + * @throws RestException 404 * * @url POST {id}/subproducts/add */ @@ -454,9 +453,8 @@ class Products extends DolibarrApi * @param int $subproduct_id Id of child product/service * @return int * - * @throws RestException - * @throws 401 - * @throws 404 + * @throws RestException 401 + * @throws RestException 404 * * @url DELETE {id}/subproducts/remove */ @@ -642,8 +640,8 @@ class Products extends DolibarrApi * * @return int * - * @throws 401 - * @throws 404 + * @throws RestException 401 + * @throws RestException 404 * */ public function deletePurchasePrice($id, $priceid) @@ -769,9 +767,9 @@ class Products extends DolibarrApi * * @url GET {id}/purchase_prices * - * @throws 401 - * @throws 403 - * @throws 404 + * @throws RestException 401 + * @throws RestException 403 + * @throws RestException 404 * */ public function getPurchasePrices($id, $ref = '', $ref_ext = '', $barcode = '') @@ -829,8 +827,8 @@ class Products extends DolibarrApi * @return array * * @throws RestException - * @throws 401 - * @throws 404 + * @throws RestException 401 + * @throws RestException 404 * * @url GET attributes/{id} */ @@ -856,8 +854,8 @@ class Products extends DolibarrApi * @param string $ref Reference of Attribute * @return array * - * @throws RestException - * @throws 401 + * @throws RestException 500 + * @throws RestException 401 * * @url GET attributes/ref/{ref} */ @@ -893,8 +891,8 @@ class Products extends DolibarrApi * @param string $label Label of Attribute * @return int * - * @throws RestException - * @throws 401 + * @throws RestException 500 + * @throws RestException 401 * * @url POST attributes */ @@ -923,8 +921,8 @@ class Products extends DolibarrApi * @return array * * @throws RestException - * @throws 401 - * @throws 404 + * @throws RestException 401 + * @throws RestException 404 * * @url PUT attributes/{id} */ @@ -968,8 +966,8 @@ class Products extends DolibarrApi * @param int $id ID of Attribute * @return int Result of deletion * - * @throws RestException - * @throws 401 + * @throws RestException 500 + * @throws RestException 401 * * @url DELETE attributes/{id} */ @@ -996,8 +994,8 @@ class Products extends DolibarrApi * @param int $id ID of Attribute value * @return array * - * @throws RestException - * @throws 401 + * @throws RestException 500 + * @throws RestException 401 * * @url GET attributes/values/{id} */ @@ -1037,8 +1035,8 @@ class Products extends DolibarrApi * @param string $ref Ref of Attribute value * @return array * - * @throws RestException - * @throws 401 + * @throws RestException 500 + * @throws RestException 401 * * @url GET attributes/{id}/values/ref/{ref} */ @@ -1078,8 +1076,7 @@ class Products extends DolibarrApi * @param string $ref Ref of Attribute value * @return int * - * @throws RestException - * @throws 401 + * @throws RestException 401 * * @url DELETE attributes/{id}/values/ref/{ref} */ @@ -1104,8 +1101,8 @@ class Products extends DolibarrApi * @param int $id ID of an Attribute * @return array * - * @throws RestException - * @throws 401 + * @throws RestException 401 + * @throws RestException 500 * * @url GET attributes/{id}/values */ @@ -1125,8 +1122,7 @@ class Products extends DolibarrApi * @param string $ref Ref of an Attribute * @return array * - * @throws RestException - * @throws 401 + * @throws RestException 401 * * @url GET attributes/ref/{ref}/values */ @@ -1165,8 +1161,8 @@ class Products extends DolibarrApi * @param string $value Value of Attribute value * @return int * - * @throws RestException - * @throws 401 + * @throws RestException 500 + * @throws RestException 401 * * @url POST attributes/{id}/values */ @@ -1198,8 +1194,8 @@ class Products extends DolibarrApi * @param array $request_data Datas * @return array * - * @throws RestException - * @throws 401 + * @throws RestException 401 + * @throws RestException 500 * * @url PUT attributes/values/{id} */ @@ -1243,8 +1239,8 @@ class Products extends DolibarrApi * @param int $id ID of Attribute value * @return int * - * @throws RestException - * @throws 401 + * @throws RestException 500 + * @throws RestException 401 * * @url DELETE attributes/values/{id} */ @@ -1269,8 +1265,8 @@ class Products extends DolibarrApi * @param int $id ID of Product * @return array * - * @throws RestException - * @throws 401 + * @throws RestException 500 + * @throws RestException 401 * * @url GET {id}/variants */ @@ -1297,8 +1293,8 @@ class Products extends DolibarrApi * @param string $ref Ref of Product * @return array * - * @throws RestException - * @throws 401 + * @throws RestException 500 + * @throws RestException 401 * * @url GET ref/{ref}/variants */ @@ -1336,9 +1332,9 @@ class Products extends DolibarrApi * @param array $features List of attributes pairs id_attribute->id_value. Example: array(id_color=>id_Blue, id_size=>id_small, id_option=>id_val_a, ...) * @return int * - * @throws RestException - * @throws 401 - * @throws 404 + * @throws RestException 500 + * @throws RestException 401 + * @throws RestException 404 * * @url POST {id}/variants */ @@ -1398,9 +1394,9 @@ class Products extends DolibarrApi * @param array $features List of attributes pairs id_attribute->id_value. Example: array(id_color=>id_Blue, id_size=>id_small, id_option=>id_val_a, ...) * @return int * - * @throws RestException - * @throws 401 - * @throws 404 + * @throws RestException 500 + * @throws RestException 401 + * @throws RestException 404 * * @url POST ref/{ref}/variants */ @@ -1455,8 +1451,8 @@ class Products extends DolibarrApi * @param array $request_data Datas * @return int * - * @throws RestException - * @throws 401 + * @throws RestException 500 + * @throws RestException 401 * * @url PUT variants/{id} */ @@ -1489,8 +1485,8 @@ class Products extends DolibarrApi * @param int $id ID of Variant * @return int Result of deletion * - * @throws RestException - * @throws 401 + * @throws RestException 500 + * @throws RestException 401 * * @url DELETE variants/{id} */ @@ -1570,9 +1566,9 @@ class Products extends DolibarrApi * @param bool $includesubproducts Load information about subproducts * @return array|mixed Data without useless information * - * @throws 401 - * @throws 403 - * @throws 404 + * @throws RestException 401 + * @throws RestException 403 + * @throws RestException 404 */ private function _fetch($id, $ref = '', $ref_ext = '', $barcode = '', $includestockdata = 0, $includesubproducts = false) { diff --git a/htdocs/societe/class/api_thirdparties.class.php b/htdocs/societe/class/api_thirdparties.class.php index 07dd2ba6031..e055026910d 100644 --- a/htdocs/societe/class/api_thirdparties.class.php +++ b/htdocs/societe/class/api_thirdparties.class.php @@ -731,9 +731,9 @@ class Thirdparties extends DolibarrApi * * @return array List of outstandings proposals of thirdparty * - * @throws 400 - * @throws 401 - * @throws 404 + * @throws RestException 400 + * @throws RestException 401 + * @throws RestException 404 */ public function getOutStandingProposals($id, $mode = 'customer') { @@ -775,9 +775,9 @@ class Thirdparties extends DolibarrApi * * @return array List of outstandings orders of thirdparty * - * @throws 400 - * @throws 401 - * @throws 404 + * @throws RestException 400 + * @throws RestException 401 + * @throws RestException 404 */ public function getOutStandingOrder($id, $mode = 'customer') { @@ -818,9 +818,9 @@ class Thirdparties extends DolibarrApi * * @return array List of outstandings invoices of thirdparty * - * @throws 400 - * @throws 401 - * @throws 404 + * @throws RestException 400 + * @throws RestException 401 + * @throws RestException 404 */ public function getOutStandingInvoices($id, $mode = 'customer') { @@ -861,9 +861,9 @@ class Thirdparties extends DolibarrApi * * @return array List of representatives of thirdparty * - * @throws 400 - * @throws 401 - * @throws 404 + * @throws RestException 400 + * @throws RestException 401 + * @throws RestException 404 */ public function getSalesRepresentatives($id, $mode = 0) { @@ -903,10 +903,10 @@ class Thirdparties extends DolibarrApi * * @return array List of fixed discount of thirdparty * - * @throws 400 - * @throws 401 - * @throws 404 - * @throws 503 + * @throws RestException 400 + * @throws RestException 401 + * @throws RestException 404 + * @throws RestException 503 */ public function getFixedAmountDiscounts($id, $filter = "none", $sortfield = "f.type", $sortorder = 'ASC') { @@ -961,10 +961,10 @@ class Thirdparties extends DolibarrApi * @url GET {id}/getinvoicesqualifiedforreplacement * * @return array - * @throws 400 - * @throws 401 - * @throws 404 - * @throws 405 + * @throws RestException 400 + * @throws RestException 401 + * @throws RestException 404 + * @throws RestException 405 */ public function getInvoicesQualifiedForReplacement($id) { @@ -1003,10 +1003,11 @@ class Thirdparties extends DolibarrApi * @url GET {id}/getinvoicesqualifiedforcreditnote * * @return array - * @throws 400 - * @throws 401 - * @throws 404 - * @throws 405 + * + * @throws RestException 400 + * @throws RestException 401 + * @throws RestException 404 + * @throws RestException 405 */ public function getInvoicesQualifiedForCreditNote($id) { @@ -1313,8 +1314,8 @@ class Thirdparties extends DolibarrApi * @param string $site Site key * * @return SocieteAccount[] - * @throws 401 Unauthorized: User does not have permission to read thirdparties - * @throws 404 Not Found: Specified thirdparty ID does not belongs to an existing thirdparty + * @throws RestException 401 Unauthorized: User does not have permission to read thirdparties + * @throws RestException 404 Not Found: Specified thirdparty ID does not belongs to an existing thirdparty * * @url GET {id}/gateways/ */ @@ -1387,11 +1388,11 @@ class Thirdparties extends DolibarrApi * @param array $request_data Request data * * @return SocieteAccount - * @throws 401 Unauthorized: User does not have permission to read thirdparties - * @throws 409 Conflict: A SocieteAccount entity (gateway) already exists for this company and site. - * @throws 422 Unprocessable Entity: You must pass the site attribute in your request data ! - * @throws 500 Internal Server Error: Error creating SocieteAccount account - * @status 201 + * @throws RestException 401 Unauthorized: User does not have permission to read thirdparties + * @throws RestException 409 Conflict: A SocieteAccount entity (gateway) already exists for this company and site. + * @throws RestException 422 Unprocessable Entity: You must pass the site attribute in your request data ! + * @throws RestException 500 Internal Server Error: Error creating SocieteAccount account + * @status RestException 201 * * @url POST {id}/gateways */ @@ -1447,11 +1448,11 @@ class Thirdparties extends DolibarrApi * @param array $request_data Request data * * @return SocieteAccount - * @throws 401 Unauthorized: User does not have permission to read thirdparties - * @throws 422 Unprocessable Entity: You must pass the site attribute in your request data ! - * @throws 500 Internal Server Error: Error updating SocieteAccount entity * - * @throws RestException + * @throws RestException 401 Unauthorized: User does not have permission to read thirdparties + * @throws RestException 422 Unprocessable Entity: You must pass the site attribute in your request data ! + * @throws RestException 500 Internal Server Error: Error updating SocieteAccount entity + * * @url PUT {id}/gateways/{site} */ public function putSocieteAccount($id, $site, $request_data = null) @@ -1529,10 +1530,10 @@ class Thirdparties extends DolibarrApi * @param array $request_data Request data * * @return SocieteAccount - * @throws 401 Unauthorized: User does not have permission to read thirdparties - * @throws 404 Not Found: Specified thirdparty ID does not belongs to an existing thirdparty - * @throws 409 Conflict: Another SocieteAccount entity already exists for this thirdparty with this site key. - * @throws 500 Internal Server Error: Error updating SocieteAccount entity + * @throws RestException 401 Unauthorized: User does not have permission to read thirdparties + * @throws RestException 404 Not Found: Specified thirdparty ID does not belongs to an existing thirdparty + * @throws RestException 409 Conflict: Another SocieteAccount entity already exists for this thirdparty with this site key. + * @throws RestException 500 Internal Server Error: Error updating SocieteAccount entity * * @url PATCH {id}/gateways/{site} */ @@ -1583,9 +1584,9 @@ class Thirdparties extends DolibarrApi * @param int $site Site key * * @return void - * @throws 401 Unauthorized: User does not have permission to delete thirdparties gateways - * @throws 404 Not Found: Specified thirdparty ID does not belongs to an existing thirdparty - * @throws 500 Internal Server Error: Error deleting SocieteAccount entity + * @throws RestException 401 Unauthorized: User does not have permission to delete thirdparties gateways + * @throws RestException 404 Not Found: Specified thirdparty ID does not belongs to an existing thirdparty + * @throws RestException 500 Internal Server Error: Error deleting SocieteAccount entity * * @url DELETE {id}/gateways/{site} */