Merge pull request #33 from blockchain/remove-receive

tuzzolo · tuzzolo · commit 0b0ecd150f93 · 2016-05-26T14:12:34.000+01:00
Removed RP1 references and updated RP2 references
diff --git a/MANIFEST b/MANIFEST
@@ -6,7 +6,6 @@ blockchain/createwallet.py
 blockchain/exceptions.py
 blockchain/exchangerates.py
 blockchain/pushtx.py
-blockchain/receive.py
 blockchain/statistics.py
 blockchain/util.py
 blockchain/wallet.py
diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@ The module consists of the following sub-modules:
 * `createwallet` ([docs](docs/createwallet.md)) ([api/create_wallet][api2])
 * `exchangerates` ([docs](docs/exchangerates.md)) ([api/exchange\_rates\_api][api3])
 * `pushtx` ([docs](docs/pushtx.md)) ([pushtx][api7])
-* `receive` ([docs](docs/receive.md)) ([api/api_receive][api4])
+* `v2.receive` ([docs](docs/receive.md)) ([api/api_receive][api4])
 * `statistics` ([docs](docs/statistics.md)) ([api/charts_api][api5])
 * `wallet` ([docs](docs/wallet.md)) ([api/blockchain\_wallet\_api][api6])
 
diff --git a/blockchain/receive.py b/blockchain/receive.py
diff --git a/blockchain/v2/receive.py b/blockchain/v2/receive.py
@@ -24,7 +24,7 @@ def __init__(self, callback_url, called_at, raw_response, response_code):
 
 
 def receive(xpub, callback, api_key):
-    """Call the 'api/receive' endpoint and create a forwarding address.
+    """Call the '/v2/receive' endpoint and create a forwarding address.
     
     :param str xpub: extended public key to generate payment address
     :param str callback: callback URI that will be called upon payment
@@ -43,6 +43,12 @@ def receive(xpub, callback, api_key):
 
 
 def callback_log(callback, api_key):
+    """Call the 'v2/receive/callback_log' endpoint and returns the callback log
+    for a given callback URI with parameters.
+    :param callback: callback URI
+    :param api_key: Blockchain.info API V2 key
+    :return: a list of :class:`LogEntry` objects
+    """
     params = {'key': api_key, 'callback': callback}
     resource = 'v2/receive/callback_log?' + util.urlencode(params)
     resp = util.call_api(resource, base_url='https://api.blockchain.info/')
diff --git a/docs/receive.md b/docs/receive.md
@@ -1,30 +1,62 @@
-##`receive` module
+##`v2.receive` module
 
 ####`receive`
-Call the 'api/receive' endpoint and create a forwarding address. Returns a `ReceiveResponse` object.
+Call the 'api.blockchain.info/v2/receive' endpoint and create a forwarding address. Returns a `ReceiveResponse` object.
 
 Params:
 ```
-dest_addr : str
+xpub : str
 callback : str
-api_code : str (optional)
+api_code : str
 ```
 
 Usage:
 ```python
-from blockchain import receive
+from blockchain.v2 import receive
 
-resp = receive.receive('1hNapz1CuH4DhnV1DFHH7hafwDE8FJRheA', 'http://your.url.com')
+resp = receive.receive('1hNapz1CuH4DhnV1DFHH7hafwDE8FJRheA', 'http://your.url.com?invoice=1234465', 'your api key')
 
 ```
 
+
 ###Response object field definitions
 
 ####`ReceiveResponse`
 
 ```
-fee_percent : int
-destination_address : str
-input_address : str
+address : str
+index : int
 callback_url : str
 ```
+
+####`callback_log`
+Call the 'api.blockchain.info/v2/receive/callback_log' endpoint and returns the list of callbacks performed for a given 
+callback URI. 
+Returns a list of `LogEntry` objects.
+
+Params:
+```
+callback : str
+api_code : str
+```
+
+Usage:
+```python
+from blockchain.v2 import receive
+
+logs = receive.callback_log('http://your.url.com?invoice_id=1234465', 'your api key')
+
+```
+
+###Log entry object field definitions
+
+####`LogEntry`
+
+```
+callback_url : str
+callback_at : str
+raw_response : str
+response_code : int
+
+```
+
