Skip to content

Commit

Permalink
- Re-record JSON responses for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nwithan8 committed Jan 19, 2024
1 parent 036f84c commit 8a60100
Show file tree
Hide file tree
Showing 88 changed files with 3,620 additions and 2,790 deletions.
24 changes: 5 additions & 19 deletions official/docs/responses/addresses/addresses-create-and-verify.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"address": {
"id": "adr_5e891acf4e3f11edb1a1ac1f6bc7bdc6",
"id": "adr_3d733da6b71311ee835b3cecef1b359e",
"object": "Address",
"created_at": "2022-10-17T17:15:59+00:00",
"updated_at": "2022-10-17T17:15:59+00:00",
"created_at": "2024-01-19T21:39:35+00:00",
"updated_at": "2024-01-19T21:39:35+00:00",
"name": null,
"company": "EASYPOST",
"street1": "417 MONTGOMERY ST FL 5",
Expand All @@ -22,26 +22,12 @@
"verifications": {
"zip4": {
"success": true,
"errors": [
{
"code": "E.SECONDARY_INFORMATION.INVALID",
"field": "street2",
"message": "Invalid secondary information(Apt/Suite#)",
"suggestion": null
}
],
"errors": [],
"details": null
},
"delivery": {
"success": true,
"errors": [
{
"code": "E.SECONDARY_INFORMATION.INVALID",
"field": "street2",
"message": "Invalid secondary information(Apt/Suite#)",
"suggestion": null
}
],
"errors": [],
"details": {
"latitude": 37.79342,
"longitude": -122.40288,
Expand Down
6 changes: 3 additions & 3 deletions official/docs/responses/addresses/addresses-create.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"id": "adr_5dacbea44e3f11ed90f5ac1f6bc72124",
"id": "adr_3d3815d8b71311ee83453cecef1b359e",
"object": "Address",
"created_at": "2022-10-17T17:15:57+00:00",
"updated_at": "2022-10-17T17:15:57+00:00",
"created_at": "2024-01-19T21:39:35+00:00",
"updated_at": "2024-01-19T21:39:35+00:00",
"name": null,
"company": "EasyPost",
"street1": "417 MONTGOMERY ST",
Expand Down
6 changes: 3 additions & 3 deletions official/docs/responses/addresses/addresses-list.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"addresses": [
{
"id": "adr_6039af864e3f11edae1dac1f6b0a0d1e",
"id": "adr_3e80b02eb71311ee83bf3cecef1b359e",
"object": "Address",
"created_at": "2022-10-17T17:16:02+00:00",
"updated_at": "2022-10-17T17:16:02+00:00",
"created_at": "2024-01-19T21:39:37+00:00",
"updated_at": "2024-01-19T21:39:37+00:00",
"name": null,
"company": "EasyPost",
"street1": "417 MONTGOMERY ST",
Expand Down
6 changes: 3 additions & 3 deletions official/docs/responses/addresses/addresses-retrieve.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"id": "adr_6039af864e3f11edae1dac1f6b0a0d1e",
"id": "adr_3e80b02eb71311ee83bf3cecef1b359e",
"object": "Address",
"created_at": "2022-10-17T17:16:02+00:00",
"updated_at": "2022-10-17T17:16:02+00:00",
"created_at": "2024-01-19T21:39:37+00:00",
"updated_at": "2024-01-19T21:39:37+00:00",
"name": null,
"company": "EasyPost",
"street1": "417 MONTGOMERY ST",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"id": "adr_20a96bfd554911ed9551ac1f6bc72124",
"id": "adr_3e55b5d3b71311ee83a83cecef1b359e",
"object": "Address",
"created_at": "2022-10-26T16:13:28+00:00",
"updated_at": "2022-10-26T16:13:28+00:00",
"created_at": "2024-01-19T21:39:37+00:00",
"updated_at": "2024-01-19T21:39:37+00:00",
"name": null,
"company": "EasyPost",
"street1": "UNDELIVERABLE ST",
Expand Down
6 changes: 3 additions & 3 deletions official/docs/responses/addresses/addresses-verify-param.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"id": "adr_5eed63904e3f11eda352ac1f6bc7b362",
"id": "adr_3d9fe04cb71311ee86a0ac1f6bc539ae",
"object": "Address",
"created_at": "2022-10-17T17:16:00+00:00",
"updated_at": "2022-10-17T17:16:00+00:00",
"created_at": "2024-01-19T21:39:36+00:00",
"updated_at": "2024-01-19T21:39:36+00:00",
"name": null,
"company": "EASYPOST",
"street1": "417 MONTGOMERY ST FL 5",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"id": "adr_5f4e008e4e3f11eda36cac1f6bc7b362",
"id": "adr_3dcd27a7b71311ee837b3cecef1b359e",
"object": "Address",
"created_at": "2022-10-17T17:16:00+00:00",
"updated_at": "2022-10-17T17:16:00+00:00",
"created_at": "2024-01-19T21:39:36+00:00",
"updated_at": "2024-01-19T21:39:36+00:00",
"name": null,
"company": "EASYPOST",
"street1": "417 MONTGOMERY ST FL 5",
Expand Down
24 changes: 5 additions & 19 deletions official/docs/responses/addresses/addresses-verify.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"address": {
"id": "adr_5fdd21764e3f11edadebac1f6b0a0d1e",
"id": "adr_3e282aa2b71311ee83973cecef1b359e",
"object": "Address",
"created_at": "2022-10-17T17:16:01+00:00",
"updated_at": "2022-10-17T17:16:01+00:00",
"created_at": "2024-01-19T21:39:37+00:00",
"updated_at": "2024-01-19T21:39:37+00:00",
"name": null,
"company": "EASYPOST",
"street1": "417 MONTGOMERY ST FL 5",
Expand All @@ -22,26 +22,12 @@
"verifications": {
"zip4": {
"success": true,
"errors": [
{
"code": "E.SECONDARY_INFORMATION.INVALID",
"field": "street2",
"message": "Invalid secondary information(Apt/Suite#)",
"suggestion": null
}
],
"errors": [],
"details": null
},
"delivery": {
"success": true,
"errors": [
{
"code": "E.SECONDARY_INFORMATION.INVALID",
"field": "street2",
"message": "Invalid secondary information(Apt/Suite#)",
"suggestion": null
}
],
"errors": [],
"details": {
"latitude": 37.79342,
"longitude": -122.40288,
Expand Down
99 changes: 63 additions & 36 deletions official/docs/responses/api-keys/api-keys-retrieve.json
Original file line number Diff line number Diff line change
@@ -1,44 +1,71 @@
{
"id": "user_060ab38db3c04ffaa60f262e5781a9be",
"keys": [
"id": "user_54356a6b96c940d8913961a3c7b909f2",
"object": "User",
"parent_id": null,
"name": "New Name",
"phone_number": "5555555555",
"verified": true,
"created_at": "2017-03-01T03:01:34Z",
"default_carbon_offset": false,
"has_elevate_access": false,
"balance": "0.00000",
"price_per_shipment": "0.00000",
"recharge_amount": "100.00",
"secondary_recharge_amount": "100.00",
"recharge_threshold": "0.00",
"has_billing_method": false,
"cc_fee_rate": "0.03",
"default_insurance_amount": null,
"insurance_fee_rate": "0.01",
"insurance_fee_minimum": "1.00",
"email": "[email protected]",
"children": [
{
"object": "ApiKey",
"active": true,
"key": "<REDACTED>",
"mode": "test",
"created_at": "2022-10-14T17:23:58Z",
"id": "ak_eb495dfd453647749dc6471290b33685"
"id": "user_584be78af2f141e988b6c60dda9dd8fd",
"object": "User",
"parent_id": "user_54356a6b96c940d8913961a3c7b909f2",
"name": "Test User2",
"phone_number": "8005550100",
"verified": true,
"created_at": "2023-12-11T17:13:38Z",
"default_carbon_offset": false,
"has_elevate_access": false,
"children": []
},
{
"object": "ApiKey",
"active": true,
"key": "<REDACTED>",
"mode": "production",
"created_at": "2022-10-14T17:23:58Z",
"id": "ak_6f4eae3909464f3f807b3af2a687c85b"
}
],
"children": [
"id": "user_437e724f37de412db6df8821968d8d3c",
"object": "User",
"parent_id": "user_54356a6b96c940d8913961a3c7b909f2",
"name": "Test User2",
"phone_number": "8005550100",
"verified": true,
"created_at": "2023-12-11T17:13:43Z",
"default_carbon_offset": false,
"has_elevate_access": false,
"children": []
},
{
"id": "user_2553102e90de43dea0b9fa7f8c8d7e33",
"object": "User",
"parent_id": "user_54356a6b96c940d8913961a3c7b909f2",
"name": "Child Account Name22",
"phone_number": "8005550100",
"verified": true,
"created_at": "2024-01-04T19:56:21Z",
"default_carbon_offset": false,
"has_elevate_access": false,
"children": []
},
{
"id": "user_0ae8cb7000a1438c8598fa5786fdae84",
"keys": [
{
"object": "ApiKey",
"active": true,
"key": "<REDACTED>",
"mode": "test",
"created_at": "2022-10-17T17:28:30Z",
"id": "ak_3b56830ab851496f946c368cb001c3f4"
},
{
"object": "ApiKey",
"active": true,
"key": "<REDACTED>",
"mode": "production",
"created_at": "2022-10-17T17:28:30Z",
"id": "ak_e5020ebb06b84733891c0e0e5ce25b27"
}
],
"id": "user_31754439d4524fbb8867d138de537e12",
"object": "User",
"parent_id": "user_54356a6b96c940d8913961a3c7b909f2",
"name": "Test User",
"phone_number": "8005550100",
"verified": true,
"created_at": "2024-01-19T21:42:21Z",
"default_carbon_offset": false,
"has_elevate_access": false,
"children": []
}
]
Expand Down
10 changes: 5 additions & 5 deletions official/docs/responses/batches/batches-add-shipments.json
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
{
"id": "batch_5781439e197447ac850dc0796e9e8e76",
"id": "batch_64a58d60294943d8ae88db0b5094a907",
"object": "Batch",
"mode": "test",
"state": "created",
"num_shipments": 1,
"reference": null,
"created_at": "2022-10-17T17:16:27Z",
"updated_at": "2022-10-17T17:16:27Z",
"created_at": "2024-01-19T21:40:13Z",
"updated_at": "2024-01-19T21:40:13Z",
"scan_form": null,
"shipments": [
{
"batch_status": "postage_purchased",
"batch_message": null,
"reference": null,
"tracking_code": "9405500106068143632665",
"id": "shp_d8a3856984f84c78b6b0da741f9fea7d"
"tracking_code": "9405500207552010707504",
"id": "shp_8f16c7d5967b4682ad8596a1475d023d"
}
],
"status": {
Expand Down
8 changes: 4 additions & 4 deletions official/docs/responses/batches/batches-buy.json
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
{
"id": "batch_8323a3f140b543fc90a7acdb01912ae7",
"id": "batch_d6251841e1fc4e29979b04f074d03bf4",
"object": "Batch",
"mode": "test",
"state": "created",
"num_shipments": 1,
"reference": null,
"created_at": "2022-10-17T17:16:08Z",
"updated_at": "2022-10-17T17:16:08Z",
"created_at": "2024-01-19T21:39:40Z",
"updated_at": "2024-01-19T21:39:40Z",
"scan_form": null,
"shipments": [
{
"batch_status": "queued_for_purchase",
"batch_message": null,
"reference": null,
"tracking_code": null,
"id": "shp_5188f6665c5b41569530ba4698225e3e"
"id": "shp_a90b4c2282e54465817f806f5ecf3943"
}
],
"status": {
Expand Down
21 changes: 0 additions & 21 deletions official/docs/responses/batches/batches-create-and-buy.json

This file was deleted.

6 changes: 3 additions & 3 deletions official/docs/responses/batches/batches-create.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"id": "batch_35638a505b00489da8feea4209b66c01",
"id": "batch_ab8e9b4b2f10414085045a1e281e5dc9",
"object": "Batch",
"mode": "test",
"state": "creating",
"num_shipments": 1,
"reference": null,
"created_at": "2022-10-17T17:16:05Z",
"updated_at": "2022-10-17T17:16:05Z",
"created_at": "2024-01-19T21:39:38Z",
"updated_at": "2024-01-19T21:39:38Z",
"scan_form": null,
"shipments": [],
"status": {
Expand Down
10 changes: 5 additions & 5 deletions official/docs/responses/batches/batches-label.json
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
{
"id": "batch_6e7c7e6f280b4be396463a49857f5bed",
"id": "batch_df05f9391272462cbd5b0e53e0bcb7e0",
"object": "Batch",
"mode": "test",
"state": "label_generating",
"num_shipments": 1,
"reference": null,
"created_at": "2022-10-17T17:16:31Z",
"updated_at": "2022-10-17T17:16:41Z",
"created_at": "2024-01-19T22:04:08Z",
"updated_at": "2024-01-19T22:04:49Z",
"scan_form": null,
"shipments": [
{
"batch_status": "postage_purchased",
"batch_message": null,
"reference": null,
"tracking_code": "9405500106068143632733",
"id": "shp_e2140993b93146b2bc2d9323811947b9"
"tracking_code": "9405500207552010712409",
"id": "shp_140c001c845348caa3f62fe3c0fa15d0"
}
],
"status": {
Expand Down
6 changes: 3 additions & 3 deletions official/docs/responses/batches/batches-remove-shipments.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"id": "batch_1e08a75fe682484caf66f8382d5b6a11",
"id": "batch_254386e6b4314b419bcb0486ca65fc80",
"object": "Batch",
"mode": "test",
"state": "purchased",
"num_shipments": 0,
"reference": null,
"created_at": "2022-10-17T17:16:29Z",
"updated_at": "2022-10-17T17:16:30Z",
"created_at": "2024-01-19T21:40:15Z",
"updated_at": "2024-01-19T21:40:15Z",
"scan_form": null,
"shipments": [],
"status": {
Expand Down
Loading

0 comments on commit 8a60100

Please sign in to comment.