Updated doc and setup file

Author: ppatidar2021

GUIDE.md

@@ -37,31 +37,58 @@ For more information about testing, please see https://bitpay.com/docs/testing
 
 ## Installation
 
-You can find and download this package from pip  
-Make sure you have the latest version to avoid implementation and security issues.
+1. Download the package and extract it into a local directory or clone the repo.
+2. cd into the root directory where setup.py is located 
+3. Enter: python setup.py install
+
+
 
 ### Handling your client private key
 
-Each client paired with the BitPay server requires a ECDSA key.  This key provides the security mechanism for all client interaction with the BitPay server. The public key is used to derive the specific client identity that is displayed on your BitPay dashboard.  The public key is also used for securely signing all API requests from the client.  See the [BitPay API](https://bitpay.com/api) for more information.
+Each client paired with the BitPay server requires a ECDSA key. This key provides the security mechanism for all client interaction with the BitPay server. The public key is used to derive the specific client identity that is displayed on your BitPay dashboard. The public key is also used for securely signing all API requests from the client. See the [BitPay API](https://bitpay.com/api/) for more information.
+
+The private key should be stored in the client environment such that it cannot be compromised. If your private key is compromised you should revoke the compromised client identity from the BitPay server and re-pair your client, see the [API tokens](https://bitpay.com/api-tokens) for more information.
+
+To generate the configuration file required to load the SDK:
 
-The private key should be stored in the client environment such that it cannot be compromised.  If your private key is compromised you should revoke the compromised client identity from the BitPay server and re-pair your client, see the [API tokens](https://bitpay.com/api-tokens) for more information.
+The [BitPay Config Generator](setup/bitpay_setup.py) helps to generate the private key, as well as a environment file formatted in JSON or YML which contains all configuration requirements, that should be stored in the client local file system. It is not recommended to transmit the private key over any public or unsecure networks.
 
-The [BitPay.Net Setup utility](https://github.com/bitpay/csharp-bitpay-client/releases/download/v3.1.1912/BitPay.Net_Setup_utility_3.1.1912.zip) helps to generate the private key, as well as a environment file formatted in JSON which contains all configuration requirements, that should be stored in the client local file system. It is not recommended to transmit the private key over any public or unsecure networks.
+The comments in this script will assist you to create the environment file which you will be able to modify it later.
 
-Follow the guide [BitPay.Net Setup utility guide](https://github.com/bitpay/csharp-bitpay-client/blob/master/BitPaySetup/README.md) that assist you to create the environment file which you will be able to modify it, either manually or by using the BitPay.Net Setup utility, later on by asking you to provide the path to your existing JSON file.
+Once the Config Generator has run and generated the Json/Yml correctly, read the console output and follow the instructions in order to pair your new tokens.
+
+```json
+
+{
+  "BitPayConfiguration": {
+    "Environment": "",
+    "EnvConfig": {
+      "Test": {
+        "PrivateKeyPath": "",
+        "PrivateKey": "",
+        "ApiTokens": {
+          "merchant": "",
+          "payout": ""
+        },
+        "proxy": "" 
+      }
+    }
+  }
+}
+```
 
 ### Initializing your BitPay client
 
 Once you have the environment file (JSON previously generated) you can initialize the client in two ways:
 
 ```python
-from bitpay_sdk.client import Client
+from bitpay.client import Client
 
 bitpay = Client(config_file_path)
 ```
 
 ```python
-from bitpay_sdk.client import Client
+from bitpay.client import Client
 
 bitpay = Client(None, environment, private_key_path, tokens)
 ```
@@ -70,8 +97,8 @@ bitpay = Client(None, environment, private_key_path, tokens)
 
 Your client must be paired with the BitPay server. The pairing initializes authentication and authorization for your client to communicate with BitPay for your specific merchant account.
 
-Pairing is accomplished by having the BitPay.Net Setup utility request a pairing code from the BitPay server.
-Meanwhile a new pairing code is generated, the BitPay.Net Setup utility will ask you to activate it in your BitPay account. It will also store the paired token in the environment file.
+Pairing is accomplished by running the bitpay [python Setup]((setup/bitpay_setup.py)) utility request a pairing code from the BitPay server.
+Meanwhile a new pairing code is generated, the python Setup utility will ask you to activate it in your BitPay account. It will also store the paired token in the environment file.
 
 The pairing code is then entered into the BitPay merchant dashboard for the desired merchant.  Your interactive authentication at https://bitpay.com/login provides the authentication needed to create finalize the client-server pairing request.
 

docs/GUIDE.md

@@ -130,7 +130,7 @@ Facade **`MERCHANT`**
 | X-Signature | header is the ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is required when using tokens with higher privileges (merchant facade). When using standard pos facade token directly from the BitPay dashboard (with "Require Authentication" disabled), this header is not needed. | **Mandatory** |
 
 ```python
-get_bill = bitpay.get_bill(create_bill.get_id())
+get_bill = bitpay.get_bill(bill_id)
 ```
 
 ### HTTP Response
@@ -445,6 +445,24 @@ Facade **`MERCHANT`**
 |  token | The resource token for the billId you want to deliver via email. You need to retrieve this token from the bill object itself (see section Retrieve a bill). | `string` | **Mandatory** |
 
 ```python
+items = []
+
+item = Item()
+item.set_price(30.0)
+item.set_quantity(9)
+item.set_description("product-a")
+items.append(item)
+
+item = Item()
+item.set_price(14.0)
+item.set_quantity(16)
+item.set_description("product-b")
+items.append(item)
+
+
+bill = Bill("1001", Currency.USD, "[email protected]")
+bill.set_items(items)
+create_bill = bitpay.create_bill(bill)
 deliver_bill = bitpay.deliver_bill(create_bill.get_id(), create_bill.get_token())
 ```
 

docs/bill.md

@@ -47,18 +47,18 @@ An example code of the create invoice
 // Setting mandatory parameters in invoice i.e price and currency.
 Invoice invoice = new Invoice(100.0, "USD");
 
-// Setting invoice optional parameters
-invoice.setOrderId("98e572ea-910e-415d-b6de-65f5090680f6");
-invoice.setFullNotifications(true);
-invoice.setExtendedNotifications(true);
-invoice.setTransactionSpeed("medium");
-invoice.setNotificationURL("https://hookbin.com/lJnJg9WW7MtG9GZlPVdj");
-invoice.setRedirectURL("https://hookbin.com/lJnJg9WW7MtG9GZlPVdj");
-invoice.setPosData("98e572ea35hj356xft8y8cgh56h5090680f6");
-invoice.setItemDesc("Ab tempora sed ut.");
-invoice.setNotificationEmail("");
-
-// Creating Invoice
+# Setting invoice optional parameters
+invoice.setOrderId("98e572ea-910e-415d-b6de-65f5090680f6")
+invoice.setFullNotifications(True)
+invoice.setExtendedNotifications(True)
+invoice.setTransactionSpeed("medium")
+invoice.setNotificationURL("https://hookbin.com/lJnJg9WW7MtG9GZlPVdj")
+invoice.setRedirectURL("https://hookbin.com/lJnJg9WW7MtG9GZlPVdj")
+invoice.setPosData("98e572ea35hj356xft8y8cgh56h5090680f6")
+invoice.setItemDesc("Ab tempora sed ut.")
+invoice.setNotificationEmail("")
+
+# Creating Invoice
 invoice = Invoice(2.16, "eur")
 invoice.set_order_id("98e572ea-910e-415d-b6de-65f5090680f6")
 invoice.set_full_notifications(True)
@@ -684,7 +684,7 @@ Facade **`POS` `MERCHANT`**
 To get the generated invoice details, pass the Invoice Id with URL parameter
 
 ```python
-retrieve_invoice = bitpay.get_invoice(basic_invoice.get_id())
+retrieve_invoice = bitpay.get_invoice(invoice_id)
 ```
 
 ## Retrieve invoices filtered by query
@@ -717,7 +717,7 @@ Facade **`MERCHANT`**
 To get the generated invoices filtered by query parameters 
 
 ```python
-get_invoices = bitpay.get_invoices('YYYY-MM-DD', 'YYYY-MM-DD', InvoiceStatus.Complete, null, 10); //Always use the included InvoiceStatus model to avoid typos
+get_invoices = bitpay.get_invoices('YYYY-MM-DD', 'YYYY-MM-DD', InvoiceStatus.Complete, None, 10); //Always use the included InvoiceStatus model to avoid typos
 ```
 
 ## Update an invoice
@@ -756,6 +756,7 @@ Facades  **`POS` `MERCHANT`**
 | X-Signature | header is the ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is required when using tokens with higher privileges (merchant facade). When using standard pos facade token directly from the BitPay dashboard (with "Require Authentication" disabled), this header is not needed. | C |
 
 ```python
+retrieved_invoice = bitpay.get_invoice(invoice_id)
 updated_invoice = bitpay.update_invoice(retrieved_invoice.get_id(),
                                                      "[email protected]")
 ```
@@ -788,7 +789,7 @@ Facades  **`POS` `MERCHANT`**
 | X-Signature | header is the ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is required when using tokens with higher privileges (merchant facade). When using standard pos facade token directly from the BitPay dashboard (with "Require Authentication" disabled), this header is not needed. | **Mandatory** |
 
 ```python
-cancel_invoice = bitpay.cancel_invoice(updated_invoice.get_id())
+cancel_invoice = bitpay.cancel_invoice(invoice_id)
 ```
 ### HTTP Response
 
@@ -799,7 +800,7 @@ cancel_invoice = bitpay.cancel_invoice(updated_invoice.get_id())
 ## Request an invoice notification
 
 ```python
-invoice_status = bitpay.request_invoice_notifications(basic_invoice.get_id())
+invoice_status = bitpay.request_invoice_notifications(invoice_id)
 ```
 
 ### Error Scenarios & Format:

docs/invoice.md

@@ -189,7 +189,7 @@ Facades **`PAYOUT`**
 An example code to fetch single payout by `payoutId`
 
 ```python
-batch1 = bitpay.get_payout_batch(submit_batch.get_id())
+batch1 = bitpay.get_payout_batch(payout_batch_id)
 ```
 
 ### HTTP Response
@@ -417,7 +417,7 @@ Headers
 An example code to cancel payout batch
 
 ```python
-cancel_batch = bitpay.cancel_payout_batch(batch1.get_id())
+cancel_batch = bitpay.cancel_payout_batch(payout_batch_id)
 ```
 
 **Response Body Fields**
@@ -472,7 +472,7 @@ Facades **`PAYOUT`**
 An example code to request payout batch notification
 
 ```python
-notify_batch = bitpay.request_payout_batch_notification(batch.get_id())
+notify_batch = bitpay.request_payout_batch_notification(payout_batch_id)
 ```
 
 **Response Body Fields**

docs/payout_batch.md

@@ -152,6 +152,27 @@ Facades **`PAYOUT`**
 An example code to fetch single payout recipient by `recipientId`
 
 ```python
+recipients_list = []
+
+payout_recipient = PayoutRecipient()
+payout_recipient.set_email("[email protected]")
+payout_recipient.set_label("recipient1")
+payout_recipient.set_notification_url("https://hookb.in/QJOPBdMgRkukpp2WO60o")
+recipients_list.append(payout_recipient)
+
+payout_recipient = PayoutRecipient()
+payout_recipient.set_email("[email protected]")
+payout_recipient.set_label("recipient2")
+payout_recipient.set_notification_url("https://hookb.in/QJOPBdMgRkukpp2WO60o")
+recipients_list.append(payout_recipient)
+
+payout_recipient = PayoutRecipient()
+payout_recipient.set_email("[email protected]")
+payout_recipient.set_label("recipient3")
+payout_recipient.set_notification_url("https://hookb.in/QJOPBdMgRkukpp2WO60o")
+recipients_list.append(payout_recipient)
+
+recipients_obj = PayoutRecipients(recipients_list)
 recipients = bitpay.submit_payout_recipients(recipients_obj)
 first_recipient = recipients[0]
 retrieved_recipient = bitpay.get_payout_recipient(first_recipient.get_id())
@@ -280,6 +301,27 @@ Facades **`PAYOUT`**
 An example to update the existing payout recipient details
 
 ```python
+recipients_list = []
+
+payout_recipient = PayoutRecipient()
+payout_recipient.set_email("[email protected]")
+payout_recipient.set_label("recipient1")
+payout_recipient.set_notification_url("https://hookb.in/QJOPBdMgRkukpp2WO60o")
+recipients_list.append(payout_recipient)
+
+payout_recipient = PayoutRecipient()
+payout_recipient.set_email("[email protected]")
+payout_recipient.set_label("recipient2")
+payout_recipient.set_notification_url("https://hookb.in/QJOPBdMgRkukpp2WO60o")
+recipients_list.append(payout_recipient)
+
+payout_recipient = PayoutRecipient()
+payout_recipient.set_email("[email protected]")
+payout_recipient.set_label("recipient3")
+payout_recipient.set_notification_url("https://hookb.in/QJOPBdMgRkukpp2WO60o")
+recipients_list.append(payout_recipient)
+
+recipients_obj = PayoutRecipients(recipients_list)
 recipients = bitpay.submit_payout_recipients(recipients_obj)
 first_recipient = recipients[0]
 retrieved_recipient = bitpay.get_payout_recipient(first_recipient.get_id())
@@ -346,7 +388,7 @@ Facades **`PAYOUT`**
 An example code to delete payout recipient
 
 ```python
-delete_recipient = bitpay.delete_payout_recipient(retrieved_recipient.get_id())
+delete_recipient = bitpay.delete_payout_recipient(recipient_id)
 ```
 
 **HTTP Response**
@@ -390,6 +432,27 @@ Facades **`PAYOUT`**
 An example code to request payout recipient notification
 
 ```python
+recipients_list = []
+
+payout_recipient = PayoutRecipient()
+payout_recipient.set_email("[email protected]")
+payout_recipient.set_label("recipient1")
+payout_recipient.set_notification_url("https://hookb.in/QJOPBdMgRkukpp2WO60o")
+recipients_list.append(payout_recipient)
+
+payout_recipient = PayoutRecipient()
+payout_recipient.set_email("[email protected]")
+payout_recipient.set_label("recipient2")
+payout_recipient.set_notification_url("https://hookb.in/QJOPBdMgRkukpp2WO60o")
+recipients_list.append(payout_recipient)
+
+payout_recipient = PayoutRecipient()
+payout_recipient.set_email("[email protected]")
+payout_recipient.set_label("recipient3")
+payout_recipient.set_notification_url("https://hookb.in/QJOPBdMgRkukpp2WO60o")
+recipients_list.append(payout_recipient)
+
+recipients_obj = PayoutRecipients(recipients_list)
 recipients = bitpay.submit_payout_recipients(recipients_obj)
 first_recipient = recipients[0]
 retrieved_recipient = bitpay.get_payout_recipient(first_recipient.get_id())

docs/payout_recipients.md

@@ -191,7 +191,7 @@ Facades **`PAYOUT`**
 An example code to fetch single payout by `payoutId`
 
 ```python
-retrieved_payout = bitpay.get_payout(submit_payout.get_id())
+retrieved_payout = bitpay.get_payout(payout_id)
 ```
 
 ### HTTP Response
@@ -371,7 +371,7 @@ Facades **`PAYOUT`**
 An example code to cancel payout
 
 ```python
-cancelled_payout = bitpay.cancel_payout(create_payout.get_id())
+cancelled_payout = bitpay.cancel_payout(payout_id)
 ```
 
 **Response Body Fields**
@@ -426,7 +426,7 @@ Facades **`PAYOUT`**
 An example code to request payout recipient notification
 
 ```python
-result = bitpay.request_payout_notification(create_payout.get_id())
+result = bitpay.request_payout_notification(payout_id)
 ```
 
 **Response Body Fields**

docs/payouts.md

@@ -31,7 +31,7 @@ Facades **`MERCHANT`**
 An example code of the create a new refund request
 
 ```python
-create_refund = bitpay.create_refund(invoice.get_id(), 1.0, None, True, False, False)
+create_refund = bitpay.create_refund(invoice_id, 1.0, None, True, False, False)
 ```
 
 **Response Body Fields**
@@ -102,7 +102,7 @@ Facades **`MERCHANT`**
 
 
 ```python
-retieve_refund = bitpay.get_refund(create_refund.get_id())
+retieve_refund = bitpay.get_refund(refund_id)
 ```
 
 **Response Body Fields**
@@ -164,7 +164,7 @@ Facades **`MERCHANT`**
 To get all refund requesta for an invoice, pass the Invoice Id with URL parameter
 
 ```python
-retrieved_refunds = bitpay.get_refunds(invoice.get_id())
+retrieved_refunds = bitpay.get_refunds(invoice_id)
 ```
 
 Response body fields same as `POST /refunds`
@@ -232,7 +232,7 @@ Facades **`MERCHANT`**
 | status | set to ‘created’ in order to confirm the refund request and initiate the flow to send it to shopper | `string` | - |
 
 ```python
-update_refund  = bitpay.update_refund(invoice.get_id(), RefundStatus.Created);
+update_refund  = bitpay.update_refund(refund_id, RefundStatus.Created);
 ```
 
 
@@ -263,7 +263,7 @@ cancel_refund = bitpay.cancel_refund(create_refund.get_id())
 Facades **`MERCHANT`**
 
 ```python
-result = bitpay.request_refund_notification(create_refund.get_id())
+result = bitpay.request_refund_notification(refund_id)
 ```
 
 ### HTTP Response