diff --git a/dev/build_doc_json_responses/tests/test_carrier_metadata.py b/dev/build_doc_json_responses/tests/test_carrier_metadata.py index 76e83fb2..ad1be986 100644 --- a/dev/build_doc_json_responses/tests/test_carrier_metadata.py +++ b/dev/build_doc_json_responses/tests/test_carrier_metadata.py @@ -5,8 +5,7 @@ @pytest.mark.vcr() def test_carrier_metadata_retrieve(test_client): test_client.carrier_metadata.retrieve( - carriers=["usps"], - types=["service_levels", "predefined_packages"], + carriers=["uspsbyoca"], ) build_response_snippet() diff --git a/docs/responses/carrier-metadata/retrieve.json b/docs/responses/carrier-metadata/retrieve.json index 08fa57a8..69af444f 100644 --- a/docs/responses/carrier-metadata/retrieve.json +++ b/docs/responses/carrier-metadata/retrieve.json @@ -2,10 +2,10 @@ "carriers": [ { "human_readable": "USPS BYOCA", - "name": "usps", + "name": "uspsbyoca", "predefined_packages": [ { - "carrier": "usps", + "carrier": "uspsbyoca", "description": null, "dimensions": [ "6in x 4.5in x 0.016in" @@ -15,7 +15,7 @@ "name": "Card" }, { - "carrier": "usps", + "carrier": "uspsbyoca", "description": null, "dimensions": [ "11.5in x 6.125in x 0.25in" @@ -25,7 +25,7 @@ "name": "Letter" }, { - "carrier": "usps", + "carrier": "uspsbyoca", "description": null, "dimensions": [ "11.5in x 6.125in x 0.75in" @@ -35,7 +35,7 @@ "name": "Flat" }, { - "carrier": "usps", + "carrier": "uspsbyoca", "description": null, "dimensions": [ "12.5in x 9.5in" @@ -45,7 +45,7 @@ "name": "FlatRateEnvelope" }, { - "carrier": "usps", + "carrier": "uspsbyoca", "description": null, "dimensions": [ "15in x 9.5in" @@ -55,7 +55,7 @@ "name": "FlatRateLegalEnvelope" }, { - "carrier": "usps", + "carrier": "uspsbyoca", "description": null, "dimensions": [ "12.5in x 9.5in" @@ -65,7 +65,7 @@ "name": "FlatRatePaddedEnvelope" }, { - "carrier": "usps", + "carrier": "uspsbyoca", "description": null, "dimensions": [ "10in x 5in", @@ -76,7 +76,7 @@ "name": "FlatRateWindowEnvelope" }, { - "carrier": "usps", + "carrier": "uspsbyoca", "description": null, "dimensions": [ "12.5in x 9.5in" @@ -86,7 +86,7 @@ "name": "FlatRateCardboardEnvelope" }, { - "carrier": "usps", + "carrier": "uspsbyoca", "description": null, "dimensions": [ "10in x 6in" @@ -96,7 +96,7 @@ "name": "SmallFlatRateEnvelope" }, { - "carrier": "usps", + "carrier": "uspsbyoca", "description": null, "dimensions": [ "Varies based on service level" @@ -106,7 +106,7 @@ "name": "Parcel" }, { - "carrier": "usps", + "carrier": "uspsbyoca", "description": null, "dimensions": [ "Varies based on service level" @@ -116,7 +116,7 @@ "name": "SoftPack" }, { - "carrier": "usps", + "carrier": "uspsbyoca", "description": null, "dimensions": [ "8.6875in x 5.4375in x 1.75in" @@ -126,7 +126,7 @@ "name": "SmallFlatRateBox" }, { - "carrier": "usps", + "carrier": "uspsbyoca", "description": null, "dimensions": [ "11.25in x 8.75in x 6in", @@ -137,7 +137,7 @@ "name": "MediumFlatRateBox" }, { - "carrier": "usps", + "carrier": "uspsbyoca", "description": null, "dimensions": [ "12.25in x 12in x 6in" @@ -147,7 +147,7 @@ "name": "LargeFlatRateBox" }, { - "carrier": "usps", + "carrier": "uspsbyoca", "description": null, "dimensions": [ "12.25in x 12.25in x 6in" @@ -157,7 +157,7 @@ "name": "LargeFlatRateBoxAPOFPO" }, { - "carrier": "usps", + "carrier": "uspsbyoca", "description": null, "dimensions": [], "human_readable": null, @@ -165,7 +165,7 @@ "name": "FlatTubTrayBox" }, { - "carrier": "usps", + "carrier": "uspsbyoca", "description": null, "dimensions": [], "human_readable": null, @@ -173,7 +173,7 @@ "name": "EMMTrayBox" }, { - "carrier": "usps", + "carrier": "uspsbyoca", "description": null, "dimensions": [], "human_readable": null, @@ -181,7 +181,7 @@ "name": "FullTrayBox" }, { - "carrier": "usps", + "carrier": "uspsbyoca", "description": null, "dimensions": [], "human_readable": null, @@ -189,7 +189,7 @@ "name": "HalfTrayBox" }, { - "carrier": "usps", + "carrier": "uspsbyoca", "description": null, "dimensions": [], "human_readable": null, @@ -199,7 +199,7 @@ ], "service_levels": [ { - "carrier": "usps", + "carrier": "uspsbyoca", "description": "1-5 business days", "dimensions": [ "Cards, Letters and Flats only (no Parcels)", @@ -210,7 +210,7 @@ "name": "First" }, { - "carrier": "usps", + "carrier": "uspsbyoca", "description": "1-3 business days", "dimensions": [ "Combined Length and Girth < 108in" @@ -220,7 +220,7 @@ "name": "Priority" }, { - "carrier": "usps", + "carrier": "uspsbyoca", "description": "1-2 days", "dimensions": [ "Combined Length and Girth < 108in" @@ -230,7 +230,7 @@ "name": "Express" }, { - "carrier": "usps", + "carrier": "uspsbyoca", "description": "2-5 days", "dimensions": [ "Combined Length and Girth < 130in" @@ -240,7 +240,7 @@ "name": "GroundAdvantage" }, { - "carrier": "usps", + "carrier": "uspsbyoca", "description": "2-8 business days", "dimensions": [ "Combined Length and Girth < 108in" @@ -250,7 +250,7 @@ "name": "LibraryMail" }, { - "carrier": "usps", + "carrier": "uspsbyoca", "description": "2-8 business days", "dimensions": [ "Combined Length and Girth < 108in" @@ -260,7 +260,7 @@ "name": "MediaMail" }, { - "carrier": "usps", + "carrier": "uspsbyoca", "description": null, "dimensions": [ "Must be rectangular, otherwise an additional charge may apply." @@ -270,7 +270,7 @@ "name": "FirstClassMailInternational" }, { - "carrier": "usps", + "carrier": "uspsbyoca", "description": "7-21 days", "dimensions": [ "Packages (Other Than Rolls): Combined Length and Girth < 108in", @@ -282,7 +282,7 @@ "name": "FirstClassPackageInternationalService" }, { - "carrier": "usps", + "carrier": "uspsbyoca", "description": "6-10 business days", "dimensions": [ "Combined Length and Girth < 108in" @@ -292,7 +292,7 @@ "name": "PriorityMailInternational" }, { - "carrier": "usps", + "carrier": "uspsbyoca", "description": "3-5 business days", "dimensions": [ "Combined Length and Girth < 108in" @@ -302,6 +302,378 @@ "name": "ExpressMailInternational" } ], + "shipment_options": [ + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Additional Handling", + "name": "additional_handling", + "type": "boolean" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Auto Manifest", + "name": "auto_manifest", + "type": "boolean" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Carrier Insurance Amount", + "name": "carrier_insurance_amount", + "type": "float" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Certificate Number", + "name": "certificate_number", + "type": "string" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Certified Mail", + "name": "certified_mail", + "type": "boolean" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Container", + "name": "container", + "type": "map" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Content Description", + "name": "content_description", + "type": "string" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Currency", + "name": "currency", + "type": "string" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Customs Include Shipping", + "name": "customs_include_shipping", + "type": "boolean" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Dangerous Goods", + "name": "dangerous_goods", + "type": "map" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Delivery Confirmation", + "name": "delivery_confirmation", + "type": "string" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Delivery Date", + "name": "delivery_date", + "type": "datetime" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Delivery Max Datetime", + "name": "delivery_max_datetime", + "type": "datetime" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Delivery Min Datetime", + "name": "delivery_min_datetime", + "type": "datetime" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Entry", + "name": "entry", + "type": "string" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Handling Instructions", + "name": "handling_instructions", + "type": "string" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Hazmat", + "name": "hazmat", + "type": "enum" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Image Format", + "name": "image_format", + "type": "string" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Import Control Description", + "name": "import_control_description", + "type": "string" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Import Control", + "name": "import_control", + "type": "enum" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Import Federal Tax Id", + "name": "import_federal_tax_id", + "type": "string" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Importer Reference", + "name": "importer_reference", + "type": "string" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Invoice Number", + "name": "invoice_number", + "type": "string" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Label Date", + "name": "label_date", + "type": "datetime" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Label Format", + "name": "label_format", + "type": "string" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Label Size", + "name": "label_size", + "type": "string" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "License Number", + "name": "license_number", + "type": "string" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Live Animal", + "name": "live_animal", + "type": "boolean" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Machinable", + "name": "machinable", + "type": "boolean" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Po Sort", + "name": "po_sort", + "type": "string" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Print Custom", + "name": "print_custom", + "type": "array" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Registered Mail Amount", + "name": "registered_mail_amount", + "type": "float" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Registered Mail", + "name": "registered_mail", + "type": "boolean" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Return Receipt", + "name": "return_receipt", + "type": "boolean" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Return Service", + "name": "return_service", + "type": "string" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Saturday Delivery", + "name": "saturday_delivery", + "type": "boolean" + }, + { + "carrier": "uspsbyoca", + "deprecated": false, + "description": null, + "human_readable": "Special Rates Eligibility", + "name": "special_rates_eligibility", + "type": "string" + } + ], + "supported_features": [ + { + "carrier": "uspsbyoca", + "description": null, + "name": "bill_on_delivery", + "supported": true + }, + { + "carrier": "uspsbyoca", + "description": null, + "name": "bill_on_label_purchase", + "supported": true + }, + { + "carrier": "uspsbyoca", + "description": null, + "name": "commercial_invoices", + "supported": true + }, + { + "carrier": "uspsbyoca", + "description": null, + "name": "delivers_to_po_box", + "supported": true + }, + { + "carrier": "uspsbyoca", + "description": null, + "name": "labels", + "supported": true + }, + { + "carrier": "uspsbyoca", + "description": null, + "name": "pickups", + "supported": true + }, + { + "carrier": "uspsbyoca", + "description": null, + "name": "rating", + "supported": true + }, + { + "carrier": "uspsbyoca", + "description": null, + "name": "refunds", + "supported": true + }, + { + "carrier": "uspsbyoca", + "description": null, + "name": "returns", + "supported": true + }, + { + "carrier": "uspsbyoca", + "description": null, + "name": "scanforms", + "supported": true + }, + { + "carrier": "uspsbyoca", + "description": null, + "name": "test_environment", + "supported": true + }, + { + "carrier": "uspsbyoca", + "description": null, + "name": "tracking", + "supported": true + } + ], "type": "UspsAccount" } ]