[chore] Re-record JSON responses for docs (#120)

- Re-record JSON responses for docs - Add JSON response generation tool - Fix GET requests using query parameters
EasyPost · Jan 25, 2024 · b83bc05 · b83bc05
1 parent 2f162ee
commit b83bc05
Show file tree

Hide file tree

Showing 169 changed files with 7,645 additions and 3,835 deletions.
diff --git a/.gitignore b/.gitignore
@@ -26,3 +26,5 @@ venv
 /.dummy
 /.eslintignore
 *.sw*
+/official/tools/build_doc_json_responses/responses/
+/official/tools/build_doc_json_responses/tests/cassettes/
diff --git a/official/docs/csharp/current/addresses/create-and-verify.cs b/official/docs/csharp/current/addresses/create-and-verify.cs
@@ -18,14 +18,13 @@ public static async Task Main()
 
             Parameters.Address.Create parameters = new()
             {
-                Street1 = "417 Montgomery Street",
-                Street2 = "FL 5",
-                City = "San Francisco",
-                State = "CA",
-                Zip = "94104",
+                Street1 = "000 unknown street",
+                City = "Not A City",
+                State = "ZZ",
+                Zip = "00001",
                 Country = "US",
-                Company = "EasyPost",
-                Phone = "415-123-4567",
+                Email = "test@example.com",
+                Phone = "5555555555",
             };
 
             Address address = await client.Address.CreateAndVerify(parameters);

diff --git a/official/docs/csharp/current/addresses/verify-failure.cs b/official/docs/csharp/current/addresses/verify-failure.cs
@@ -18,14 +18,13 @@ public static async Task Main()
 
             Parameters.Address.Create parameters = new()
             {
-                Street1 = "UNDELIVERABLE ST",
-                Street2 = "FLOOR 5",
-                City = "SAN FRANCISCO",
-                State = "CA",
-                Zip = "94104",
+                Street1 = "000 unknown street",
+                City = "Not A City",
+                State = "ZZ",
+                Zip = "00001",
                 Country = "US",
-                Company = "EasyPost",
-                Phone = "415-123-4567",
+                Email = "test@example.com",
+                Phone = "5555555555",
             };
 
             Address address = await client.Address.Create(parameters);

diff --git a/official/docs/csharp/current/addresses/verify-param.cs b/official/docs/csharp/current/addresses/verify-param.cs
@@ -18,14 +18,13 @@ public static async Task Main()
 
             Parameters.Address.Create parameters = new()
             {
-                Street1 = "417 MONTGOMERY ST",
-                Street2 = "FLOOR 5",
-                City = "SAN FRANCISCO",
-                State = "CA",
-                Zip = "94104",
+                Street1 = "000 unknown street",
+                City = "Not A City",
+                State = "ZZ",
+                Zip = "00001",
                 Country = "US",
-                Company = "EasyPost",
-                Phone = "415-123-4567",
+                Email = "test@example.com",
+                Phone = "5555555555",
                 Verify = true
             };
 

diff --git a/official/docs/csharp/current/addresses/verify-strict-param.cs b/official/docs/csharp/current/addresses/verify-strict-param.cs
@@ -18,14 +18,13 @@ public static async Task Main()
 
             Parameters.Address.Create parameters = new()
             {
-                Street1 = "417 MONTGOMERY ST",
-                Street2 = "FLOOR 5",
-                City = "SAN FRANCISCO",
-                State = "CA",
-                Zip = "94104",
+                Street1 = "000 unknown street",
+                City = "Not A City",
+                State = "ZZ",
+                Zip = "00001",
                 Country = "US",
-                Company = "EasyPost",
-                Phone = "415-123-4567",
+                Email = "test@example.com",
+                Phone = "5555555555",
                 VerifyStrict = true
             };
 

diff --git a/official/docs/curl/current/addresses/create-and-verify.sh b/official/docs/curl/current/addresses/create-and-verify.sh
@@ -3,13 +3,12 @@ curl -X POST https://api.easypost.com/v2/addresses/create_and_verify \
   -H 'Content-Type: application/json' \
   -d '{
     "address": {
-      "street1": "417 Montgomery Street",
-      "street2": "FL 5",
-      "city": "San Francisco",
-      "state": "CA",
-      "zip": "94104",
+      "street1": "000 unknown street",
+      "city": "Not A City",
+      "state": "ZZ",
+      "zip": "00001",
       "country": "US",
-      "company": "EasyPost",
-      "phone": "415-123-4567"
+      "email": "test@example.com",
+      "phone": "5555555555"
     }
   }'
diff --git a/official/docs/curl/current/addresses/verify-failure.sh b/official/docs/curl/current/addresses/verify-failure.sh
@@ -3,12 +3,12 @@ curl -X POST https://api.easypost.com/v2/addresses \
   -H 'Content-Type: application/json' \
   -d '{
     "address": {
-      "street1": "UNDELIVERABLE ST",
-      "city": "SAN FRANCISCO",
-      "state": "CA",
-      "zip": "94104",
+      "street1": "000 unknown street",
+      "city": "Not A City",
+      "state": "ZZ",
+      "zip": "00001",
       "country": "US",
-      "company": "EasyPost",
-      "phone": "415-123-4567"
+      "email": "test@example.com",
+      "phone": "5555555555"
     }
   }'
diff --git a/official/docs/curl/current/addresses/verify-param.sh b/official/docs/curl/current/addresses/verify-param.sh
@@ -3,14 +3,13 @@ curl -X POST https://api.easypost.com/v2/addresses \
   -H 'Content-Type: application/json' \
   -d '{
     "address": {
-      "street1": "417 MONTGOMERY ST",
-      "street2": "FLOOR 5",
-      "city": "SAN FRANCISCO",
-      "state": "CA",
-      "zip": "94104",
+      "street1": "000 unknown street",
+      "city": "Not A City",
+      "state": "ZZ",
+      "zip": "00001",
       "country": "US",
-      "company": "EasyPost",
-      "phone": "415-123-4567"
+      "email": "test@example.com",
+      "phone": "5555555555"
     },
     "verify": true
   }'
diff --git a/official/docs/curl/current/addresses/verify-strict-param.sh b/official/docs/curl/current/addresses/verify-strict-param.sh
@@ -3,14 +3,13 @@ curl -X POST https://api.easypost.com/v2/addresses \
   -H 'Content-Type: application/json' \
   -d '{
     "address": {
-      "street1": "417 MONTGOMERY ST",
-      "street2": "FLOOR 5",
-      "city": "SAN FRANCISCO",
-      "state": "CA",
-      "zip": "94104",
+      "street1": "000 unknown street",
+      "city": "Not A City",
+      "state": "ZZ",
+      "zip": "00001",
       "country": "US",
-      "company": "EasyPost",
-      "phone": "415-123-4567"
+      "email": "test@example.com",
+      "phone": "5555555555"
     },
     "verify_strict": true
   }'
diff --git a/official/docs/curl/current/endshipper/list.sh b/official/docs/curl/current/endshipper/list.sh
@@ -1,3 +1,2 @@
 curl -X GET https://api.easypost.com/v2/end_shippers?page_size=5 \
-  -u "$EASYPOST_API_KEY": \
-  -H 'Content-Type: application/json'
+  -u "$EASYPOST_API_KEY":
diff --git a/official/docs/curl/current/endshipper/retrieve.sh b/official/docs/curl/current/endshipper/retrieve.sh
@@ -1,3 +1,2 @@
 curl -X GET https://api.easypost.com/v2/end_shippers/es_... \
-  -u "$EASYPOST_API_KEY": \
-  -H 'Content-Type: application/json'
+  -u "$EASYPOST_API_KEY":
diff --git a/official/docs/curl/current/shipments/label.sh b/official/docs/curl/current/shipments/label.sh
@@ -1,6 +1,2 @@
-curl -X GET https://api.easypost.com/v2/shipments/shp_.../label \
-  -u "$EASYPOST_API_KEY": \
-  -H 'Content-Type: application/json' \
-  -d '{
-    "file_format": "ZPL"
-  }'
+curl -X GET https://api.easypost.com/v2/shipments/shp_.../label?file_format=ZPL \
+  -u "$EASYPOST_API_KEY":
diff --git a/official/docs/golang/current/addresses/create-and-verify.go b/official/docs/golang/current/addresses/create-and-verify.go
@@ -13,14 +13,13 @@ func main() {
 
 	address, _ := client.CreateAndVerifyAddress(
 		&easypost.Address{
-			Street1: "417 Montgomery Street",
-			Street2: "FL 5",
-			City:    "San Francisco",
-			State:   "CA",
-			Zip:     "94104",
+			Street1: "000 unknown street",
+			City:    "Not A City",
+			State:   "ZZ",
+			Zip:     "00001",
 			Country: "US",
-			Company: "EasyPost",
-			Phone:   "415-123-4567",
+			Email: "test@example.com",
+			Phone:   "5555555555",
 		},
 		&easypost.CreateAddressOptions{},
 	)

diff --git a/official/docs/golang/current/addresses/verify-failure.go b/official/docs/golang/current/addresses/verify-failure.go
@@ -13,13 +13,13 @@ func main() {
 
 	address, _ := client.CreateAddress(
 		&easypost.Address{
-			Street1: "UNDELIVERABLE ST",
-			City:    "SAN FRANCISCO",
-			State:   "CA",
-			Zip:     "94104",
+			Street1: "000 unknown street",
+			City:    "Not A City",
+			State:   "ZZ",
+			Zip:     "00001",
 			Country: "US",
-			Company: "EasyPost",
-			Phone:   "415-123-4567",
+			Email: "test@example.com",
+			Phone:   "5555555555",
 		},
 		&easypost.CreateAddressOptions{},
 	)

diff --git a/official/docs/golang/current/addresses/verify-param.go b/official/docs/golang/current/addresses/verify-param.go
@@ -13,14 +13,13 @@ func main() {
 
 	address, _ := client.CreateAddress(
 		&easypost.Address{
-			Street1: "417 Montgomery Street",
-			Street2: "FLOOR 5",
-			City:    "SAN FRANCISCO",
-			State:   "CA",
-			Zip:     "94104",
+			Street1: "000 unknown street",
+			City:    "Not A City",
+			State:   "ZZ",
+			Zip:     "00001",
 			Country: "US",
-			Company: "EasyPost",
-			Phone:   "415-123-4567",
+			Email: "test@example.com",
+			Phone:   "5555555555",
 		},
 		&easypost.CreateAddressOptions{
 			Verify: []string{"true"},

diff --git a/official/docs/golang/current/addresses/verify-strict-param.go b/official/docs/golang/current/addresses/verify-strict-param.go
@@ -13,14 +13,13 @@ func main() {
 
 	address, _ := client.CreateAddress(
 		&easypost.Address{
-			Street1: "417 MONTGOMERY ST",
-			Street2: "FLOOR 5",
-			City:    "SAN FRANCISCO",
-			State:   "CA",
-			Zip:     "94104",
+			Street1: "000 unknown street",
+			City:    "Not A City",
+			State:   "ZZ",
+			Zip:     "00001",
 			Country: "US",
-			Company: "EasyPost",
-			Phone:   "415-123-4567",
+			Email: "test@example.com",
+			Phone:   "5555555555",
 		},
 		&easypost.CreateAddressOptions{
 			VerifyStrict: []string{"true"},

diff --git a/official/docs/java/current/addresses/create-and-verify.java b/official/docs/java/current/addresses/create-and-verify.java
@@ -12,14 +12,13 @@ public static void main(String[] args) throws EasyPostException {
 
         HashMap<String, Object> params = new HashMap<String, Object>();
 
-        params.put("street1", "417 Montgomery Street");
-        params.put("street2", "FL 5");
-        params.put("city", "San Francisco");
-        params.put("state", "CA");
-        params.put("zip", "94104");
+        params.put("street1", "000 unknown street");
+        params.put("city", "Not A City");
+        params.put("state", "ZZ");
+        params.put("zip", "00001");
         params.put("country", "US");
-        params.put("company", "EasyPost");
-        params.put("phone", "415-123-4567");
+        params.put("email", "test@example.com");
+        params.put("phone", "5555555555");
 
         Address address = client.address.createAndVerify(params);
 

diff --git a/official/docs/java/current/addresses/verify-failure.java b/official/docs/java/current/addresses/verify-failure.java
@@ -12,13 +12,13 @@ public static void main(String[] args) throws EasyPostException {
 
         HashMap<String, Object> params = new HashMap<String, Object>();
 
-        params.put("street1", "UNDELIVERABLE ST");
-        params.put("city", "SAN FRANCISCO");
-        params.put("state", "CA");
-        params.put("zip", "94104");
+        params.put("street1", "000 unknown street");
+        params.put("city", "Not A City");
+        params.put("state", "ZZ");
+        params.put("zip", "00001");
         params.put("country", "US");
-        params.put("company", "EasyPost");
-        params.put("phone", "415-123-4567");
+        params.put("email", "test@example.com");
+        params.put("phone", "5555555555");
 
         Address address = client.address.create(params);
 

diff --git a/official/docs/java/current/addresses/verify-param.java b/official/docs/java/current/addresses/verify-param.java
@@ -12,14 +12,13 @@ public static void main(String[] args) throws EasyPostException {
 
         HashMap<String, Object> params = new HashMap<String, Object>();
 
-        params.put("street1", "417 Montgomery Street");
-        params.put("street2", "5");
-        params.put("city", "SF");
-        params.put("state", "CA");
-        params.put("zip", "94104");
+        params.put("street1", "000 unknown street");
+        params.put("city", "Not A City");
+        params.put("state", "ZZ");
+        params.put("zip", "00001");
         params.put("country", "US");
-        params.put("company", "EasyPost");
-        params.put("phone", "415-123-4567");
+        params.put("email", "test@example.com");
+        params.put("phone", "5555555555");
         params.put("verify", true);
 
         Address address = client.address.create(params);

diff --git a/official/docs/java/current/addresses/verify-strict-param.java b/official/docs/java/current/addresses/verify-strict-param.java
@@ -12,13 +12,13 @@ public static void main(String[] args) throws EasyPostException {
 
         HashMap<String, Object> params = new HashMap<String, Object>();
 
-        params.put("street1", "417 Montgomery Street");
-        params.put("city", "SF");
-        params.put("state", "CA");
-        params.put("zip", "94104");
+        params.put("street1", "000 unknown street");
+        params.put("city", "Not A City");
+        params.put("state", "ZZ");
+        params.put("zip", "00001");
         params.put("country", "US");
-        params.put("company", "EasyPost");
-        params.put("phone", "415-123-4567");
+        params.put("email", "test@example.com");
+        params.put("phone", "5555555555");
         params.put("verify_strict", true);
 
         Address address = client.address.create(params);

diff --git a/official/docs/node/current/addresses/create-and-verify.js b/official/docs/node/current/addresses/create-and-verify.js
@@ -4,14 +4,13 @@ const client = new EasyPostClient(process.env.EASYPOST_API_KEY);
 
 (async () => {
   const address = await client.Address.createAndVerify({
-    street1: '417 montgomery street',
-    street2: 'FL 5',
-    city: 'San Francisco',
-    state: 'CA',
-    zip: '94104',
+    street1: '000 unknown street',
+    city: 'Not A City',
+    state: 'ZZ',
+    zip: '00001',
     country: 'US',
-    company: 'EasyPost',
-    phone: '415-123-4567',
+    email: 'test@example.com',
+    phone: '5555555555',
   });
 
   console.log(address);

diff --git a/official/docs/node/current/addresses/verify-failure.js b/official/docs/node/current/addresses/verify-failure.js
@@ -4,13 +4,13 @@ const client = new EasyPostClient(process.env.EASYPOST_API_KEY);
 
 (async () => {
   const address = await client.Address.create({
-    street1: 'UNDELIVERABLE ST',
-    city: 'SAN FRANCISCO',
-    state: 'CA',
-    zip: '94104',
+    street1: '000 unknown street',
+    city: 'Not A City',
+    state: 'ZZ',
+    zip: '00001',
     country: 'US',
-    company: 'EasyPost',
-    phone: '415-123-4567',
+    email: 'test@example.com',
+    phone: '5555555555',
   });
 
   console.log(address);