summaryrefslogtreecommitdiff
path: root/src/lib
diff options
context:
space:
mode:
authorMS <ms@taler.net>2020-10-13 16:12:42 +0200
committerMS <ms@taler.net>2020-10-13 16:12:42 +0200
commit82358a9d6ce23eca4548caaedb66dc6c981f1f06 (patch)
tree4f13b5d64c853b0e5cf9541a49dc2c78a6da79a9 /src/lib
parent60092876f45ad3b0657adab1e07eb3364c5b4709 (diff)
downloadmerchant-82358a9d6ce23eca4548caaedb66dc6c981f1f06.tar.gz
merchant-82358a9d6ce23eca4548caaedb66dc6c981f1f06.tar.bz2
merchant-82358a9d6ce23eca4548caaedb66dc6c981f1f06.zip
Doxygen fixes
Diffstat (limited to 'src/lib')
-rw-r--r--src/lib/merchant_api_get_orders.c18
-rw-r--r--src/lib/merchant_api_get_product.c6
-rw-r--r--src/lib/merchant_api_get_products.c9
-rw-r--r--src/lib/merchant_api_get_reserve.c5
-rw-r--r--src/lib/merchant_api_get_tips.c27
-rw-r--r--src/lib/merchant_api_lock_product.c14
-rw-r--r--src/lib/merchant_api_merchant_get_order.c19
-rw-r--r--src/lib/merchant_api_merchant_get_tip.c11
-rw-r--r--src/lib/merchant_api_patch_product.c35
-rw-r--r--src/lib/merchant_api_post_orders.c33
-rw-r--r--src/lib/merchant_api_post_products.c24
-rw-r--r--src/lib/merchant_api_post_transfers.c6
-rw-r--r--src/lib/merchant_api_wallet_get_order.c28
-rw-r--r--src/lib/merchant_api_wallet_get_tip.c17
14 files changed, 0 insertions, 252 deletions
diff --git a/src/lib/merchant_api_get_orders.c b/src/lib/merchant_api_get_orders.c
index 2399cb45..11be14d9 100644
--- a/src/lib/merchant_api_get_orders.c
+++ b/src/lib/merchant_api_get_orders.c
@@ -231,24 +231,6 @@ TALER_MERCHANT_orders_get (
}
-/**
- * Make a GET /orders request with filters.
- *
- * @param ctx the context
- * @param backend_url HTTP base URL for the backend
- * @param paid filter on payment status
- * @param refunded filter on refund status
- * @param wired filter on wire transfer status
- * @param date range limit by date
- * @param start_row range limit by order table row
- * @param delta range from which @a date and @a start_row apply, positive
- * to return delta items after the given limit(s), negative to
- * return delta items before the given limit(s)
- * @param timeout how long to wait (long polling) of zero results match the query
- * @param cb function to call with the backend's inventory information
- * @param cb_cls closure for @a cb
- * @return the request handle; NULL upon error
- */
struct TALER_MERCHANT_OrdersGetHandle *
TALER_MERCHANT_orders_get2 (
struct GNUNET_CURL_Context *ctx,
diff --git a/src/lib/merchant_api_get_product.c b/src/lib/merchant_api_get_product.c
index be54d083..e1c50168 100644
--- a/src/lib/merchant_api_get_product.c
+++ b/src/lib/merchant_api_get_product.c
@@ -249,12 +249,6 @@ TALER_MERCHANT_product_get (
}
-/**
- * Cancel GET /product/$ID request. Must not be called by clients after
- * the callback was invoked.
- *
- * @param pgh request to cancel.
- */
void
TALER_MERCHANT_product_get_cancel (
struct TALER_MERCHANT_ProductGetHandle *pgh)
diff --git a/src/lib/merchant_api_get_products.c b/src/lib/merchant_api_get_products.c
index 02e4aba3..36da7a59 100644
--- a/src/lib/merchant_api_get_products.c
+++ b/src/lib/merchant_api_get_products.c
@@ -198,15 +198,6 @@ handle_get_products_finished (void *cls,
}
-/**
- * Make a GET /products request.
- *
- * @param ctx the context
- * @param backend_url HTTP base URL for the backend
- * @param cb function to call with the backend's inventory information
- * @param cb_cls closure for @a cb
- * @return the request handle; NULL upon error
- */
struct TALER_MERCHANT_ProductsGetHandle *
TALER_MERCHANT_products_get (
struct GNUNET_CURL_Context *ctx,
diff --git a/src/lib/merchant_api_get_reserve.c b/src/lib/merchant_api_get_reserve.c
index 8167d2a5..1145d57a 100644
--- a/src/lib/merchant_api_get_reserve.c
+++ b/src/lib/merchant_api_get_reserve.c
@@ -294,11 +294,6 @@ TALER_MERCHANT_reserve_get (struct GNUNET_CURL_Context *ctx,
}
-/**
- * Cancel a GET /reserves/$RESERVE_ID request.
- *
- * @param rgh handle to the request to be canceled
- */
void
TALER_MERCHANT_reserve_get_cancel (
struct TALER_MERCHANT_ReserveGetHandle *rgh)
diff --git a/src/lib/merchant_api_get_tips.c b/src/lib/merchant_api_get_tips.c
index f80dd295..eb174f0b 100644
--- a/src/lib/merchant_api_get_tips.c
+++ b/src/lib/merchant_api_get_tips.c
@@ -202,15 +202,6 @@ handle_get_tips_finished (void *cls,
}
-/**
- * Make a GET /private/tips request.
- *
- * @param ctx the context
- * @param backend_url HTTP base URL for the backend
- * @param cb function to call with the backend's tip information
- * @param cb_cls closure for @a cb
- * @return the request handle; NULL upon error
- */
struct TALER_MERCHANT_TipsGetHandle *
TALER_MERCHANT_tips_get (
struct GNUNET_CURL_Context *ctx,
@@ -228,18 +219,6 @@ TALER_MERCHANT_tips_get (
}
-/**
- * Issue a GET /private/tips request with filters to the backend.
- *
- * @param ctx execution context
- * @param backend_url base URL of the merchant backend
- * @param include_expired whether to return all tips or only unexpired tips
- * @param limit number of results to return, negative for descending row id, positive for ascending
- * @param offset row id to start returning results from
- * @param cb function to call with the result
- * @param cb_cls closure for @a cb
- * @return handle for this operation, NULL upon errors
- */
struct TALER_MERCHANT_TipsGetHandle *
TALER_MERCHANT_tips_get2 (struct GNUNET_CURL_Context *ctx,
const char *backend_url,
@@ -315,12 +294,6 @@ TALER_MERCHANT_tips_get2 (struct GNUNET_CURL_Context *ctx,
}
-/**
- * Cancel GET /private/tips request. Must not be called by clients after
- * the callback was invoked.
- *
- * @param ogh request to cancel.
- */
void
TALER_MERCHANT_tips_get_cancel (
struct TALER_MERCHANT_TipsGetHandle *tgh)
diff --git a/src/lib/merchant_api_lock_product.c b/src/lib/merchant_api_lock_product.c
index 8205d8c0..eb6b9c19 100644
--- a/src/lib/merchant_api_lock_product.c
+++ b/src/lib/merchant_api_lock_product.c
@@ -149,20 +149,6 @@ handle_lock_product_finished (void *cls,
}
-/**
- * Make a POST /products/$ID/lock request to reserve a certain
- * amount of product in inventory to a reservation UUID.
- *
- * @param ctx the context
- * @param backend_url HTTP base URL for the backend
- * @param product_id identifier of the product
- * @param uuid UUID that identifies the client holding the lock
- * @param duration how long should the lock be held
- * @param quantity how much product should be locked
- * @param cb function to call with the backend's lock status
- * @param cb_cls closure for @a cb
- * @return the request handle; NULL upon error
- */
struct TALER_MERCHANT_ProductLockHandle *
TALER_MERCHANT_product_lock (
struct GNUNET_CURL_Context *ctx,
diff --git a/src/lib/merchant_api_merchant_get_order.c b/src/lib/merchant_api_merchant_get_order.c
index e70a82cd..e0ffe03a 100644
--- a/src/lib/merchant_api_merchant_get_order.c
+++ b/src/lib/merchant_api_merchant_get_order.c
@@ -441,25 +441,6 @@ handle_merchant_order_get_finished (void *cls,
}
-/**
- * Checks the status of a payment. Issue a GET /private/orders/$ID request to
- * the backend.
- *
- * @param ctx execution context
- * @param backend_url base URL of the merchant backend
- * @param order_id order id to identify the payment
- * @param session_id sesion id for the payment (or NULL if the check is not
- * bound to a session)
- * @param transfer if true, obtain the wire transfer status from the exhcange.
- * Otherwise, the wire transfer status MAY be returned if it is available.
- * @param timeout timeout to use in long polling (how long may the server wait to reply
- * before generating an unpaid response). Note that this is just provided to
- * the server, we as client will block until the response comes back or until
- * #TALER_MERCHANT_order_get_cancel() is called.
- * @param cb callback which will work the response gotten from the backend
- * @param cb_cls closure to pass to @a cb
- * @return handle for this operation, NULL upon errors
- */
struct TALER_MERCHANT_OrderMerchantGetHandle *
TALER_MERCHANT_merchant_order_get (struct GNUNET_CURL_Context *ctx,
const char *backend_url,
diff --git a/src/lib/merchant_api_merchant_get_tip.c b/src/lib/merchant_api_merchant_get_tip.c
index 025a7834..6efa1e54 100644
--- a/src/lib/merchant_api_merchant_get_tip.c
+++ b/src/lib/merchant_api_merchant_get_tip.c
@@ -248,17 +248,6 @@ handle_merchant_tip_get_finished (void *cls,
}
-/**
- * Issue a GET /private/tips/$TIP_ID (private variant) request to the backend.
- * Returns information needed to pick up a tip.
- *
- * @param ctx execution context
- * @param backend_url base URL of the merchant backend
- * @param tip_id which tip should we query
- * @param cb function to call with the result
- * @param cb_cls closure for @a cb
- * @return handle for this operation, NULL upon errors
- */
struct TALER_MERCHANT_TipMerchantGetHandle *
TALER_MERCHANT_merchant_tip_get (struct GNUNET_CURL_Context *ctx,
const char *backend_url,
diff --git a/src/lib/merchant_api_patch_product.c b/src/lib/merchant_api_patch_product.c
index 74a89fff..3a9be15a 100644
--- a/src/lib/merchant_api_patch_product.c
+++ b/src/lib/merchant_api_patch_product.c
@@ -149,35 +149,6 @@ handle_patch_product_finished (void *cls,
}
-/**
- * Make a PATCH /products request to update product details in the
- * inventory.
- *
- * @param ctx the context
- * @param backend_url HTTP base URL for the backend
- * @param product_id identifier to use for the product; the product must exist,
- * or the transaction will fail with a #MHD_HTTP_NOT_FOUND
- * HTTP status code
- * @param description description of the product
- * @param description_i18n Map from IETF BCP 47 language tags to localized descriptions
- * @param unit unit in which the product is measured (liters, kilograms, packages, etc.)
- * @param price the price for one @a unit of the product, zero is used to imply that
- * this product is not sold separately or that the price is not fixed and
- * must be supplied by the front-end. If non-zero, price must include
- * applicable taxes.
- * @param image base64-encoded product image
- * @param taxes list of taxes paid by the merchant
- * @param total_stock in @a units, -1 to indicate "infinite" (i.e. electronic books),
- * must be larger than previous values
- * @param total_lost in @a units, must be larger than previous values, and may
- * not exceed total_stock minus total_sold; if it does, the transaction
- * will fail with a #MHD_HTTP_CONFLICT HTTP status code
- * @param location where the product is in stock
- * @param next_restock when the next restocking is expected to happen
- * @param cb function to call with the backend's result
- * @param cb_cls closure for @a cb
- * @return the request handle; NULL upon error
- */
struct TALER_MERCHANT_ProductPatchHandle *
TALER_MERCHANT_product_patch (
struct GNUNET_CURL_Context *ctx,
@@ -284,12 +255,6 @@ TALER_MERCHANT_product_patch (
}
-/**
- * Cancel PATCH /products/$ID request. Must not be called by clients after
- * the callback was invoked.
- *
- * @param pph request to cancel.
- */
void
TALER_MERCHANT_product_patch_cancel (
struct TALER_MERCHANT_ProductPatchHandle *pph)
diff --git a/src/lib/merchant_api_post_orders.c b/src/lib/merchant_api_post_orders.c
index 7553dfa2..587a0592 100644
--- a/src/lib/merchant_api_post_orders.c
+++ b/src/lib/merchant_api_post_orders.c
@@ -180,20 +180,6 @@ handle_post_order_finished (void *cls,
}
-/**
- * POST an order to the backend and receives the related proposal.
- *
- * @param ctx execution context
- * @param backend_url URL of the backend
- * @param order basic information about this purchase,
- * to be extended by the backend
- * @param refund_delay how long can refunds happen for this order; 0 to use
- * absolute value from contract (or not allow refunds).
- * @param cb the callback to call when a reply
- * for this request is available
- * @param cb_cls closure for @a proposal_cb
- * @return a handle for this request, NULL on error
- */
struct TALER_MERCHANT_PostOrdersOperation *
TALER_MERCHANT_orders_post (struct GNUNET_CURL_Context *ctx,
const char *backend_url,
@@ -217,25 +203,6 @@ TALER_MERCHANT_orders_post (struct GNUNET_CURL_Context *ctx,
}
-/**
- * POST to /orders at the backend to setup an order and obtain
- * the order ID (which may have been set by the front-end).
- *
- * @param ctx execution context
- * @param backend_url URL of the backend
- * @param order basic information about this purchase, to be extended by the backend
- * @param refund_delay how long can refunds happen for this order; 0 to use
- * absolute value from contract (or not allow refunds).
- * @param payment_target desired payment target identifier (to select merchant bank details)
- * @param inventory_products_length length of the @a inventory_products array
- * @param inventory_products products to add to the order from the inventory
- * @param lock_uuids_length length of the @a uuids array
- * @param uuids array of UUIDs with locks on @a inventory_products
- * @param create_token whether to create a claim token
- * @param cb the callback to call when a reply for this request is available
- * @param cb_cls closure for @a cb
- * @return a handle for this request, NULL on error
- */
struct TALER_MERCHANT_PostOrdersOperation *
TALER_MERCHANT_orders_post2 (
struct GNUNET_CURL_Context *ctx,
diff --git a/src/lib/merchant_api_post_products.c b/src/lib/merchant_api_post_products.c
index c3666ec2..32d11b3e 100644
--- a/src/lib/merchant_api_post_products.c
+++ b/src/lib/merchant_api_post_products.c
@@ -151,30 +151,6 @@ handle_post_products_finished (void *cls,
}
-/**
- * Make a POST /products request to add a product to the
- * inventory.
- *
- * @param ctx the context
- * @param backend_url HTTP base URL for the backend
- * @param product_id identifier to use for the product
- * @param description description of the product
- * @param description_i18n Map from IETF BCP 47 language tags to localized descriptions
- * @param unit unit in which the product is measured (liters, kilograms, packages, etc.)
- * @param price the price for one @a unit of the product, zero is used to imply that
- * this product is not sold separately or that the price is not fixed and
- * must be supplied by the front-end. If non-zero, price must include
- * applicable taxes.
- * @param image base64-encoded product image
- * @param taxes list of taxes paid by the merchant
- * @param total_stock in @a units, -1 to indicate "infinite" (i.e. electronic books)
- * @param address where the product is in stock
- * @param next_restock when the next restocking is expected to happen, 0 for unknown,
- * #GNUNET_TIME_UNIT_FOREVER_ABS for 'never'.
- * @param cb function to call with the backend's result
- * @param cb_cls closure for @a cb
- * @return the request handle; NULL upon error
- */
struct TALER_MERCHANT_ProductsPostHandle *
TALER_MERCHANT_products_post (
struct GNUNET_CURL_Context *ctx,
diff --git a/src/lib/merchant_api_post_transfers.c b/src/lib/merchant_api_post_transfers.c
index c621b4ce..b8b5accb 100644
--- a/src/lib/merchant_api_post_transfers.c
+++ b/src/lib/merchant_api_post_transfers.c
@@ -302,12 +302,6 @@ TALER_MERCHANT_transfers_post (
}
-/**
- * Cancel a POST /transfers request. This function cannot be used
- * on a request handle if a response is already served for it.
- *
- * @param pth handle to the tracking operation being cancelled
- */
void
TALER_MERCHANT_transfers_post_cancel (
struct TALER_MERCHANT_PostTransfersHandle *pth)
diff --git a/src/lib/merchant_api_wallet_get_order.c b/src/lib/merchant_api_wallet_get_order.c
index bc3ba8c8..3e115850 100644
--- a/src/lib/merchant_api_wallet_get_order.c
+++ b/src/lib/merchant_api_wallet_get_order.c
@@ -214,29 +214,6 @@ handle_wallet_get_order_finished (void *cls,
}
-/**
- * Checks the status of a payment. Issue a GET /orders/$ID request to the
- * backend. The @a h_contract serves as identification of the wallet and is
- * used to authorize the request.
- *
- * @param ctx execution context
- * @param backend_url base URL of the merchant backend
- * @param order_id order id to identify the payment
- * @param h_contract hash of the contract to authenticate the wallet
- * @param timeout timeout to use in long polling (how long may the server wait to reply
- * before generating an unpaid response). Note that this is just provided to
- * the server, we as client will block until the response comes back or until
- * #TALER_MERCHANT_order_get_cancel() is called.
- * @param session_id for which session should the payment status be checked
- * @param min_refund long poll for the service to approve a refund exceeding this value;
- * use NULL to not wait for any refund (only for payment). Only makes sense
- * with a non-zero @a timeout. Can be NULL.
- * @param await_refund_obtained long poll for the order's refunds to be
- * picked up by the wallet.
- * @param cb callback which will work the response gotten from the backend
- * @param cb_cls closure to pass to @a cb
- * @return handle for this operation, NULL upon errors
- */
struct TALER_MERCHANT_OrderWalletGetHandle *
TALER_MERCHANT_wallet_order_get (struct GNUNET_CURL_Context *ctx,
const char *backend_url,
@@ -367,11 +344,6 @@ TALER_MERCHANT_wallet_order_get (struct GNUNET_CURL_Context *ctx,
}
-/**
- * Cancel a GET /orders/$ID request.
- *
- * @param owgh handle to the request to be canceled
- */
void
TALER_MERCHANT_wallet_order_get_cancel (
struct TALER_MERCHANT_OrderWalletGetHandle *owgh)
diff --git a/src/lib/merchant_api_wallet_get_tip.c b/src/lib/merchant_api_wallet_get_tip.c
index a6035dc2..0b953963 100644
--- a/src/lib/merchant_api_wallet_get_tip.c
+++ b/src/lib/merchant_api_wallet_get_tip.c
@@ -155,17 +155,6 @@ handle_wallet_tip_get_finished (void *cls,
}
-/**
- * Issue a GET /tips/$TIP_ID request to the backend. Informs the backend
- * that a customer wants to pick up a tip.
- *
- * @param ctx execution context
- * @param backend_url base URL of the merchant backend
- * @param tip_id which tip should we query
- * @param cb function to call with the result
- * @param cb_cls closure for @a cb
- * @return handle for this operation, NULL upon errors
- */
struct TALER_MERCHANT_TipWalletGetHandle *
TALER_MERCHANT_wallet_tip_get (struct GNUNET_CURL_Context *ctx,
const char *backend_url,
@@ -225,12 +214,6 @@ TALER_MERCHANT_wallet_tip_get (struct GNUNET_CURL_Context *ctx,
}
-/**
- * Cancel a GET /tips/$TIP_ID request. This function cannot be used
- * on a request handle if a response is already served for it.
- *
- * @param tqo handle to the operation being cancelled
- */
void
TALER_MERCHANT_wallet_tip_get_cancel (
struct TALER_MERCHANT_TipWalletGetHandle *tgh)