{"openapi":"3.1.0","info":{"title":"DankProxies Panel Public API","description":"Customer API for proxy resources, retail checkout logs, orders, and package tracking.","version":"1.0.0"},"paths":{"/api/v1/proxies":{"get":{"tags":["reseller-api"],"summary":"List Proxies","operationId":"list_proxies_api_v1_proxies_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ProxyOut"},"type":"array","title":"Response List Proxies Api V1 Proxies Get"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/proxies/{proxy_id}":{"get":{"tags":["reseller-api"],"summary":"Get Proxy","operationId":"get_proxy_api_v1_proxies__proxy_id__get","parameters":[{"name":"proxy_id","in":"path","required":true,"schema":{"type":"integer","title":"Proxy Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/proxies/{proxy_id}/usage":{"get":{"tags":["reseller-api"],"summary":"Get Usage","operationId":"get_usage_api_v1_proxies__proxy_id__usage_get","parameters":[{"name":"proxy_id","in":"path","required":true,"schema":{"type":"integer","title":"Proxy Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/proxies/{proxy_id}/credentials":{"get":{"tags":["reseller-api"],"summary":"Get Credentials","operationId":"get_credentials_api_v1_proxies__proxy_id__credentials_get","parameters":[{"name":"proxy_id","in":"path","required":true,"schema":{"type":"integer","title":"Proxy Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialsOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/proxies/{proxy_id}/rotate":{"post":{"tags":["reseller-api"],"summary":"Rotate Proxy","operationId":"rotate_proxy_api_v1_proxies__proxy_id__rotate_post","parameters":[{"name":"proxy_id","in":"path","required":true,"schema":{"type":"integer","title":"Proxy Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/proxies/{proxy_id}/whitelist":{"post":{"tags":["reseller-api"],"summary":"Whitelist Ip","operationId":"whitelist_ip_api_v1_proxies__proxy_id__whitelist_post","parameters":[{"name":"proxy_id","in":"path","required":true,"schema":{"type":"integer","title":"Proxy Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhitelistIn"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/proxies/regional":{"post":{"tags":["reseller-api"],"summary":"Generate Regional","description":"Generate gateway credentials as `host:port:user:pass` lines.\n\nGeo-featured Regional plans accept state, city, and ISP targeting; standard\nresidential plans stay country-only. Nothing is provisioned per line —\nthese are sessions against the existing plan, so generating costs no\nbandwidth and makes no upstream call.","operationId":"generate_regional_api_v1_proxies_regional_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegionalIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegionalOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/plans":{"get":{"tags":["reseller-api"],"summary":"List Plans","operationId":"list_plans_api_v1_plans_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PlanOut"},"type":"array","title":"Response List Plans Api V1 Plans Get"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/orders/attempts":{"post":{"tags":["order-logs"],"summary":"Ingest Attempt","operationId":"ingest_attempt_api_v1_orders_attempts_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutAttemptIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IngestOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"BearerAuth":[]}]},"get":{"tags":["order-logs"],"summary":"List Attempts","operationId":"list_attempts_api_v1_orders_attempts_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"source","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"}},{"name":"retailer","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Retailer"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AttemptOut"},"title":"Response List Attempts Api V1 Orders Attempts Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/orders":{"get":{"tags":["order-logs"],"summary":"List Orders","operationId":"list_orders_api_v1_orders_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"retailer","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Retailer"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrderOut"},"title":"Response List Orders Api V1 Orders Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/orders/{order_id}":{"get":{"tags":["order-logs"],"summary":"Get Order","operationId":"get_order_api_v1_orders__order_id__get","parameters":[{"name":"order_id","in":"path","required":true,"schema":{"type":"integer","title":"Order Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/orders/{order_id}/status":{"patch":{"tags":["order-logs"],"summary":"Update Order Status","operationId":"update_order_status_api_v1_orders__order_id__status_patch","parameters":[{"name":"order_id","in":"path","required":true,"schema":{"type":"integer","title":"Order Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderStatusIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/orders/{order_id}/items/{item_id}/status":{"patch":{"tags":["order-logs"],"summary":"Update Order Item Status","operationId":"update_order_item_status_api_v1_orders__order_id__items__item_id__status_patch","parameters":[{"name":"order_id","in":"path","required":true,"schema":{"type":"integer","title":"Order Id"}},{"name":"item_id","in":"path","required":true,"schema":{"type":"integer","title":"Item Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderItemStatusIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/shipments":{"get":{"tags":["shipments"],"summary":"List Shipments","operationId":"list_shipments_api_v1_shipments_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"carrier","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Carrier"}},{"name":"order_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","exclusiveMinimum":0},{"type":"null"}],"title":"Order Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ShipmentOut"},"title":"Response List Shipments Api V1 Shipments Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["shipments"],"summary":"Create Shipment","operationId":"create_shipment_api_v1_shipments_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentCreateIn"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/shipments/{shipment_id}":{"get":{"tags":["shipments"],"summary":"Get Shipment","operationId":"get_shipment_api_v1_shipments__shipment_id__get","parameters":[{"name":"shipment_id","in":"path","required":true,"schema":{"type":"integer","title":"Shipment Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/shipments/{shipment_id}/status":{"patch":{"tags":["shipments"],"summary":"Update Shipment Status","operationId":"update_shipment_status_api_v1_shipments__shipment_id__status_patch","parameters":[{"name":"shipment_id","in":"path","required":true,"schema":{"type":"integer","title":"Shipment Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentStatusIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"BearerAuth":[]}]}}},"components":{"schemas":{"AttemptOut":{"properties":{"id":{"type":"integer","title":"Id"},"source":{"type":"string","title":"Source"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"},"retailer":{"type":"string","title":"Retailer"},"profile_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Name"},"status":{"type":"string","title":"Status"},"amount_cents":{"type":"integer","title":"Amount Cents"},"currency":{"type":"string","title":"Currency"},"failure_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Failure Code"},"failure_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Failure Message"},"attempted_at":{"type":"string","format":"date-time","title":"Attempted At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"order_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Order Id"}},"type":"object","required":["id","source","external_id","retailer","profile_name","status","amount_cents","currency","failure_code","failure_message","attempted_at","updated_at","order_id"],"title":"AttemptOut"},"CheckoutAttemptIn":{"properties":{"external_id":{"type":"string","maxLength":128,"minLength":1,"title":"External Id"},"retailer":{"type":"string","maxLength":160,"minLength":1,"title":"Retailer"},"profile_name":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Profile Name"},"status":{"type":"string","title":"Status"},"amount_cents":{"type":"integer","minimum":0.0,"title":"Amount Cents","default":0},"currency":{"type":"string","pattern":"^[A-Za-z]{3}$","title":"Currency","default":"USD"},"failure_code":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Failure Code"},"failure_message":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}],"title":"Failure Message"},"attempted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Attempted At"},"detail":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Detail"},"order":{"anyOf":[{"$ref":"#/components/schemas/OrderIn"},{"type":"null"}]}},"type":"object","required":["external_id","retailer","status"],"title":"CheckoutAttemptIn"},"CredentialsOut":{"properties":{"username":{"type":"string","title":"Username"},"password":{"type":"string","title":"Password"},"endpoints":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Endpoints"},"lines":{"items":{"type":"string"},"type":"array","title":"Lines"}},"type":"object","required":["username","password","endpoints"],"title":"CredentialsOut"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"IngestOut":{"properties":{"attempt":{"$ref":"#/components/schemas/AttemptOut"},"order":{"anyOf":[{"$ref":"#/components/schemas/OrderOut"},{"type":"null"}]},"attempt_created":{"type":"boolean","title":"Attempt Created"},"order_created":{"type":"boolean","title":"Order Created"}},"type":"object","required":["attempt","order","attempt_created","order_created"],"title":"IngestOut"},"OrderIn":{"properties":{"order_number":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Order Number"},"image_url":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}],"title":"Image Url"},"status":{"type":"string","title":"Status","default":"confirmed"},"subtotal_cents":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Subtotal Cents"},"shipping_cents":{"type":"integer","minimum":0.0,"title":"Shipping Cents","default":0},"tax_cents":{"type":"integer","minimum":0.0,"title":"Tax Cents","default":0},"total_cents":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Total Cents"},"items":{"items":{"$ref":"#/components/schemas/OrderItemIn"},"type":"array","title":"Items"},"detail":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Detail"}},"type":"object","title":"OrderIn"},"OrderItemIn":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name"},"sku":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Sku"},"quantity":{"type":"integer","maximum":10000.0,"minimum":1.0,"title":"Quantity","default":1},"unit_price_cents":{"type":"integer","minimum":0.0,"title":"Unit Price Cents","default":0},"status":{"type":"string","title":"Status","default":"active"},"cancelled_quantity":{"type":"integer","minimum":0.0,"title":"Cancelled Quantity","default":0},"cancelled_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Cancelled At"},"cancellation_reason":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}],"title":"Cancellation Reason"},"image_url":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}],"title":"Image Url"},"detail":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Detail"}},"type":"object","required":["name"],"title":"OrderItemIn"},"OrderItemOut":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"sku":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sku"},"quantity":{"type":"integer","title":"Quantity"},"unit_price_cents":{"type":"integer","title":"Unit Price Cents"},"status":{"type":"string","title":"Status"},"cancelled_quantity":{"type":"integer","title":"Cancelled Quantity"},"cancelled_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Cancelled At"},"cancellation_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cancellation Reason"},"image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Url"}},"type":"object","required":["id","name","sku","quantity","unit_price_cents","status","cancelled_quantity","cancelled_at","cancellation_reason","image_url"],"title":"OrderItemOut"},"OrderItemStatusIn":{"properties":{"status":{"type":"string","title":"Status"},"quantity":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Quantity"},"cancellation_reason":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}],"title":"Cancellation Reason"},"cancellation_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cancellation Source"}},"type":"object","required":["status"],"title":"OrderItemStatusIn"},"OrderOut":{"properties":{"id":{"type":"integer","title":"Id"},"checkout_attempt_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Checkout Attempt Id"},"source":{"type":"string","title":"Source"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"},"order_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Number"},"image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Url"},"display_title":{"type":"string","title":"Display Title"},"display_image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Image"},"retailer":{"type":"string","title":"Retailer"},"status":{"type":"string","title":"Status"},"subtotal_cents":{"type":"integer","title":"Subtotal Cents"},"shipping_cents":{"type":"integer","title":"Shipping Cents"},"tax_cents":{"type":"integer","title":"Tax Cents"},"total_cents":{"type":"integer","title":"Total Cents"},"active_total_cents":{"type":"integer","title":"Active Total Cents"},"currency":{"type":"string","title":"Currency"},"cancellation_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cancellation Reason"},"cancellation_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cancellation Source"},"cancelled_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Cancelled At"},"buying_account_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Buying Account Email"},"master_inbox_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Master Inbox Email"},"ship_to_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ship To Name"},"shipping_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Shipping Address"},"address_signature":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Signature"},"house_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"House Id"},"ordered_at":{"type":"string","format":"date-time","title":"Ordered At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"items":{"items":{"$ref":"#/components/schemas/OrderItemOut"},"type":"array","title":"Items"}},"type":"object","required":["id","checkout_attempt_id","source","external_id","order_number","image_url","display_title","display_image","retailer","status","subtotal_cents","shipping_cents","tax_cents","total_cents","active_total_cents","currency","cancellation_reason","cancellation_source","cancelled_at","buying_account_email","master_inbox_email","ship_to_name","shipping_address","address_signature","house_id","ordered_at","updated_at","items"],"title":"OrderOut"},"OrderStatusIn":{"properties":{"status":{"type":"string","title":"Status"},"message":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}],"title":"Message"},"cancellation_reason":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}],"title":"Cancellation Reason"},"cancellation_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cancellation Source"},"detail":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Detail"}},"type":"object","required":["status"],"title":"OrderStatusIn"},"PlanOut":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"proxy_type":{"type":"string","title":"Proxy Type"},"tier":{"type":"string","title":"Tier"},"quota_gb":{"type":"integer","title":"Quota Gb"},"price_cents":{"type":"integer","title":"Price Cents"},"features":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Features"}},"type":"object","required":["id","name","proxy_type","tier","quota_gb","price_cents","features"],"title":"PlanOut"},"ProxyOut":{"properties":{"id":{"type":"integer","title":"Id"},"proxy_type":{"type":"string","title":"Proxy Type"},"status":{"type":"string","title":"Status"},"username":{"type":"string","title":"Username"},"endpoints":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Endpoints"},"quota_bytes":{"type":"integer","title":"Quota Bytes"},"topup_balance_bytes":{"type":"integer","title":"Topup Balance Bytes","default":0},"remaining_bytes":{"type":"integer","title":"Remaining Bytes","default":0},"used_bytes":{"type":"integer","title":"Used Bytes"}},"type":"object","required":["id","proxy_type","status","username","endpoints","quota_bytes","used_bytes"],"title":"ProxyOut"},"RegionalIn":{"properties":{"proxy_id":{"type":"integer","title":"Proxy Id"},"state":{"anyOf":[{"type":"string","maxLength":32,"minLength":2},{"type":"null"}],"title":"State","description":"US state code or name; required only for Regional plans"},"city":{"anyOf":[{"type":"string","maxLength":48},{"type":"null"}],"title":"City"},"country":{"type":"string","maxLength":64,"title":"Country","default":"US"},"isps":{"items":{"type":"string"},"type":"array","title":"Isps","description":"e.g. ['att','spectrum']"},"qty":{"type":"integer","maximum":25000.0,"minimum":1.0,"title":"Qty","default":100},"protocol":{"type":"string","pattern":"^(http|socks5)$","title":"Protocol","default":"http"},"session":{"type":"string","pattern":"^(sticky|rotating)$","title":"Session","default":"sticky"},"city_targeting":{"type":"boolean","title":"City Targeting","description":"Pin each proxy to a verified city within the selected state.","default":false}},"type":"object","required":["proxy_id"],"title":"RegionalIn","description":"Targeting is passed as parameters, never as a shipping address — we\ndeliberately don't ingest our customers' end-customers' PII\n(docs/REGIONAL_STRATEGY.md §4.1). A bare ZIP is fine; a full address is not."},"RegionalOut":{"properties":{"count":{"type":"integer","title":"Count"},"double_rate":{"type":"boolean","title":"Double Rate","description":"Deprecated compatibility field. Regional provider accounting is absorbed upstream and customer usage is never double-counted.","default":false,"deprecated":true},"breakdown":{"additionalProperties":{"type":"integer"},"type":"object","title":"Breakdown"},"proxies":{"items":{"type":"string"},"type":"array","title":"Proxies"}},"type":"object","required":["count","breakdown","proxies"],"title":"RegionalOut"},"ShipmentCreateIn":{"properties":{"order_id":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Order Id"},"tracking_number":{"type":"string","maxLength":64,"minLength":8,"title":"Tracking Number"},"carrier":{"type":"string","title":"Carrier","default":"auto"},"status":{"type":"string","title":"Status","default":"label_created"},"estimated_delivery":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Estimated Delivery"},"friendly_title":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Friendly Title"}},"type":"object","required":["tracking_number"],"title":"ShipmentCreateIn"},"ShipmentEventOut":{"properties":{"id":{"type":"integer","title":"Id"},"status":{"type":"string","title":"Status"},"source":{"type":"string","title":"Source"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"occurred_at":{"type":"string","format":"date-time","title":"Occurred At"}},"type":"object","required":["id","status","source","message","occurred_at"],"title":"ShipmentEventOut"},"ShipmentOut":{"properties":{"id":{"type":"integer","title":"Id"},"order_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Order Id"},"friendly_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Friendly Title"},"source":{"type":"string","title":"Source"},"carrier":{"type":"string","title":"Carrier"},"tracking_number":{"type":"string","title":"Tracking Number"},"status":{"type":"string","title":"Status"},"tracking_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tracking Url"},"estimated_delivery":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Estimated Delivery"},"shipped_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Shipped At"},"delivered_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Delivered At"},"last_activity_at":{"type":"string","format":"date-time","title":"Last Activity At"},"last_checked_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Checked At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"events":{"items":{"$ref":"#/components/schemas/ShipmentEventOut"},"type":"array","title":"Events"}},"type":"object","required":["id","order_id","friendly_title","source","carrier","tracking_number","status","tracking_url","estimated_delivery","shipped_at","delivered_at","last_activity_at","last_checked_at","created_at","events"],"title":"ShipmentOut"},"ShipmentStatusIn":{"properties":{"status":{"type":"string","title":"Status"},"message":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Message"}},"type":"object","required":["status"],"title":"ShipmentStatusIn"},"UsageOut":{"properties":{"proxy_id":{"type":"integer","title":"Proxy Id"},"quota_bytes":{"type":"integer","title":"Quota Bytes"},"topup_balance_bytes":{"type":"integer","title":"Topup Balance Bytes","default":0},"remaining_bytes":{"type":"integer","title":"Remaining Bytes","default":0},"used_bytes":{"type":"integer","title":"Used Bytes"},"used_pct":{"type":"number","title":"Used Pct"}},"type":"object","required":["proxy_id","quota_bytes","used_bytes","used_pct"],"title":"UsageOut"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"WhitelistIn":{"properties":{"ip":{"type":"string","pattern":"^[0-9a-fA-F\\.:]+$","title":"Ip"}},"type":"object","required":["ip"],"title":"WhitelistIn"}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"dk_...","description":"API key created in the DankProxies customer portal."}}}}