docs: [6/x] Return All Payment Info Header (#408)

* refactor: todos/comments/error messages

* refactor+tests: media types

* lint: drop explicit typing on some variables

* test: use deepStrictEqual

* lint: drop comment

* feat: return multiple addresses header

* test: fix tests

* chore: drop unused file

* refactor: paymentInfo -> addressInfo

* refactor: acceptHeaders -> headers

* chore: package lock fix

* fix: merge markers

* fix: string cast-

* fix: compiler errors, return null on no environment

* refactor: clean up tests

* refactor: re-organize utils

* fix: return null for no environment

* tests: getPreferredAddressInfo, getDetailsType, formatPaymentInfo

* fix: make environment optional

* fix: tests

* refactor: code comments + rename acceptType

* fix: make environment optional value

* nit: renaming fields

* nit: const names

* fix: append memo

* nit: test spacing

* merge: pre merge cleanup

* nit: rename

* fix: test names, environment is optional

* docs: update README

* refactor: export parseAcceptHeader helper and use in unit tests

* Update src/utils/basePayId.ts

Co-authored-by: Hans Bergren <hansbergren@gmail.com>

* fix: optional memo injection

* fix: comments

* fix: test failing

* fix: memo ref

* fix: merge error

Co-authored-by: Hans Bergren <hansbergren@gmail.com>

Author: Dino Rodriguez

readme.md

@@ -48,10 +48,11 @@ The PayID protocol is designed to be simple, general, open, and universal. This
 - [8. Use Xpring SDK with PayID](#8-use-xpring-sdk-with-payid)
   - [8.1. Demo](#81-demo)
 - [9. Headers for GET requests for PayID Public API](#9-headers-for-get-requests-for-payid-public-api)
-  - [9.1. Headers for XRP](#91-headers-for-xrp)
-  - [9.2. Headers for ACH](#92-headers-for-ach)
-  - [9.3. Headers for BTC](#93-headers-for-btc)
-  - [9.4. Headers for ETH](#94-headers-for-eth)
+  - [9.1. Header for All Addresses](#91-headers-for-all-addresses)
+  - [9.2. Headers for XRP](#92-headers-for-xrp)
+  - [9.3. Headers for ACH](#93-headers-for-ach)
+  - [9.4. Headers for BTC](#94-headers-for-btc)
+  - [9.5. Headers for ETH](#95-headers-for-eth)
 
 ## 1. Web standards
 
@@ -697,11 +698,11 @@ The "Send payment proof" method does not accept any query parameters.
 
 **Send payment proof Object Data Fields**
 
-| Field                   | Type   | Description                |
+| Field                   | Type   |                Description |
 | ----------------------- | :----- | -------------------------: |
 | paymentSetupDetailsHash | string | Payment setup details hash |
-| transactionConfirmation | UUID   | Transaction ID             |
-| memo                    | string | Optional metadata          |
+| transactionConfirmation | UUID   |             Transaction ID |
+| memo                    | string |          Optional metadata |
 
 ### Response format <!-- omit in toc -->
 
@@ -778,10 +779,16 @@ A [PaymentInformation](#71-paymentinformation-type) PaymentInformation type) obj
 
 ```json
 {
-  "addressDetailsType": "CryptoAddressDetails",
-  "addressDetails": {
-    "address": "TVnGpXXZZ3xAZfhT42ntuCR4Uh3Rv9LE4BcZJeH1zds2CQ1"
-  },
+  "addresses": [
+    {
+      "paymentNetwork": "XRP",
+      "addressDetailsType": "CryptoAddressDetails",
+      "addressDetails": {
+        "address": "TVnGpXXZZ3xAZfhT42ntuCR4Uh3Rv9LE4BcZJeH1zds2CQ1"
+      }
+    }
+  ],
+  "payId": "alice$example.com",
   "memo": "this is an XRP testnet address"
 }
 ```
@@ -938,6 +945,7 @@ The different header options are shown here, with example values.
 | BTC      | application/btc+json          | { <br>address: '1BvBMSEYstWetAu4m4GFg7xJaNVN2'<br> }                   |
 | XRP      | application/xrpl-mainnet+json | { <br>address: 'XV5sbjUmgPpvXv4ixFWZ5ptAYZ6PD28Sq49uo34VyjnmK5H'<br> } |
 | ACH      | application/ach+json          | { <br> account: '363023456079',<br>routing: '011302838'<br>}           |
+| All      | application/payid+json        | Variable depending on the contents of each address                     |
 
 ## 6. Code examples
 
@@ -1038,28 +1046,34 @@ View [index-payid.js](https://github.com/xpring-eng/Xpring-SDK-Demo/blob/master/
 
 This launch of PayID includes those headers specific to the Xpring ecosystem. Each payment network is free to establish its own standard headers. These headers should be submitted with every GET request, but not POST.
 
-### 9.1. Headers for XRP
+### 9.1. Header for All Addresses
+
+|     Accept header      |            Description            |
+| :--------------------: | :-------------------------------: |
+| application/payid+json | Returns all addresses for a PayID |
+
+### 9.2. Headers for XRP
 
 |         Accept header         |       Description        |
 | :---------------------------: | :----------------------: |
 | application/xrpl-mainnet+json | Returns mainnet xAddress |
 | application/xrpl-testnet+json | Returns testnet xAddress |
 | application/xrpl-devnet+json  | Returns devnet xAddress  |
 
-### 9.2. Headers for ACH
+### 9.3. Headers for ACH
 
 |    Accept header     |            Description             |
 | :------------------: | :--------------------------------: |
 | application/ach+json | Returns account and routing number |
 
-### 9.3. Headers for BTC
+### 9.4. Headers for BTC
 
 |        Accept header         |       Description       |
 | :--------------------------: | :---------------------: |
 | application/btc-mainnet+json | Returns mainnet address |
 | application/btc-testnet+json | Returns testnet address |
 
-### 9.4. Headers for ETH
+### 9.5. Headers for ETH
 
 <table>
 <tr>

test/unit/basePayId.test.ts

@@ -106,7 +106,6 @@ describe('Base PayID - formatPaymentInfo()', function (): void {
         },
       },
     ]
-
     const expectedPaymentInfo = {
       addresses: [
         {