diff --git a/spec.json b/spec.json index 6db68cb..660b7dd 100644 --- a/spec.json +++ b/spec.json @@ -211,6 +211,29 @@ ], "type": "object" }, + "Angle": { + "description": "An angle, with a specific unit.", + "properties": { + "unit": { + "allOf": [ + { + "$ref": "#/components/schemas/UnitAngle" + } + ], + "description": "What unit is the measurement?" + }, + "value": { + "description": "The size of the angle, measured in the chosen unit.", + "format": "double", + "type": "number" + } + }, + "required": [ + "unit", + "value" + ], + "type": "object" + }, "AnnotationLineEnd": { "description": "Annotation line end type", "enum": [ @@ -546,8 +569,9 @@ "description": "The price of the API call.", "format": "money-usd", "nullable": true, - "title": "Number", - "type": "number" + "pattern": "^-?[0-9]+(\\.[0-9]+)?$", + "title": "Decimal", + "type": "string" }, "request_body": { "description": "The request body sent by the API call.", @@ -1664,10 +1688,73 @@ }, "type": "object" }, + "ClientMetrics": { + "description": "ClientMetrics contains information regarding the state of the peer.", + "properties": { + "rtc_frames_decoded": { + "description": "Counter of the number of WebRTC frames that the client has decoded during this session.", + "format": "uint64", + "minimum": 0, + "type": "integer" + }, + "rtc_frames_dropped": { + "description": "Counter of the number of WebRTC frames the client has dropped during this session.", + "format": "uint32", + "minimum": 0, + "type": "integer" + }, + "rtc_frames_per_second": { + "description": "Current number of frames being rendered per second. A good target is 60 frames per second, but it can fluctuate depending on network conditions.", + "format": "uint8", + "minimum": 0, + "type": "integer" + }, + "rtc_frames_received": { + "description": "Counter of the number of WebRTC frames that the client has received during this session.", + "format": "uint64", + "minimum": 0, + "type": "integer" + }, + "rtc_freeze_count": { + "description": "Number of times the WebRTC playback has frozen. This is usually due to network conditions.", + "format": "uint32", + "minimum": 0, + "type": "integer" + }, + "rtc_jitter_sec": { + "description": "Amount of \"jitter\" in the WebRTC session. Network latency is the time it takes a packet to traverse the network. The amount that the latency varies is the jitter. Video latency is the time it takes to render a frame sent by the server (including network latency). A low jitter means the video latency can be reduced without impacting smooth playback. High jitter means clients will increase video latency to ensure smooth playback.", + "format": "float", + "type": "number" + }, + "rtc_keyframes_decoded": { + "description": "Number of \"key frames\" decoded in the underlying h.264 stream. A key frame is an expensive (bandwidth-wise) \"full image\" of the video frame. Data after the keyframe become -- effectively -- \"diff\" operations on that key frame. The Engine will only send a keyframe if required, which is an indication that some of the \"diffs\" have been lost, usually an indication of poor network conditions. We like this metric to understand times when the connection has had to recover.", + "format": "uint32", + "minimum": 0, + "type": "integer" + }, + "rtc_total_freezes_duration_sec": { + "description": "Number of seconds of frozen video the user has been subjected to.", + "format": "float", + "type": "number" + } + }, + "required": [ + "rtc_frames_decoded", + "rtc_frames_dropped", + "rtc_frames_per_second", + "rtc_frames_received", + "rtc_freeze_count", + "rtc_jitter_sec", + "rtc_keyframes_decoded", + "rtc_total_freezes_duration_sec" + ], + "type": "object" + }, "Cluster": { "description": "Cluster information.", "properties": { "addr": { + "default": null, "description": "The IP address of the cluster.", "nullable": true, "type": "string" @@ -1696,6 +1783,7 @@ "type": "integer" }, "urls": { + "default": [], "description": "The urls of the cluster.", "items": { "type": "string" @@ -1786,22 +1874,6 @@ ], "type": "object" }, - "Commit": { - "description": "Commit holds the Git-commit (SHA1) that a binary was built from, as reported in the version-string of external tools, such as `containerd`, or `runC`.", - "properties": { - "expected": { - "description": "Commit ID of external tool expected by dockerd as set at build time.", - "nullable": true, - "type": "string" - }, - "id": { - "description": "Actual commit ID of external tool.", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, "Connection": { "description": "Metadata about a pub-sub connection.\n\nThis is mostly used for internal purposes and debugging.", "properties": { @@ -1818,10 +1890,12 @@ } ], "default": { + "addr": null, "auth_timeout": 0, "cluster_port": 0, "name": "", - "tls_timeout": 0 + "tls_timeout": 0, + "urls": [] }, "description": "Information about the cluster." }, @@ -1843,8 +1917,9 @@ "type": "integer" }, "cpu": { + "default": 0.0, + "description": "The CPU usage of the server.", "format": "double", - "nullable": true, "type": "number" }, "gateway": { @@ -1904,6 +1979,7 @@ "format": "int64", "type": "integer" }, + "description": "HTTP request statistics.", "type": "object" }, "https_port": { @@ -2132,2876 +2208,187 @@ "type": "object" }, "CountryCode": { - "description": "An enumeration of all ISO-3166 alpha-2 country codes.", - "oneOf": [ - { - "description": "Afghanistan", - "enum": [ - "AF" - ], + "description": "An ISO-3166 alpha-2 country code. Always uppercase.", + "type": "string" + }, + "Coupon": { + "description": "The resource representing a Coupon.", + "properties": { + "amount_off": { + "description": "Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer.", + "format": "money-usd", + "nullable": true, + "pattern": "^-?[0-9]+(\\.[0-9]+)?$", + "title": "Decimal", "type": "string" }, - { - "description": "Åland Islands", - "enum": [ - "AX" - ], - "type": "string" + "deleted": { + "default": false, + "description": "Always true for a deleted object.", + "type": "boolean" }, - { - "description": "Albania", - "enum": [ - "AL" - ], + "id": { + "description": "Unique identifier for the object.", "type": "string" }, + "percent_off": { + "description": "Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon.\n\nFor example, a coupon with percent_off of 50 will make a %s100 invoice %s50 instead.", + "format": "double", + "nullable": true, + "type": "number" + } + }, + "type": "object" + }, + "CreatedAtSortMode": { + "description": "Supported set of sort modes for scanning by created_at only.\n\nCurrently, we only support scanning in ascending order.", + "oneOf": [ { - "description": "Algeria", + "description": "Sort in increasing order of \"created_at\".", "enum": [ - "DZ" + "created_at_ascending" ], "type": "string" }, { - "description": "American Samoa", + "description": "Sort in decreasing order of \"created_at\".", "enum": [ - "AS" + "created_at_descending" ], "type": "string" - }, - { - "description": "Andorra", - "enum": [ - "AD" + } + ] + }, + "Currency": { + "description": "Currency is the list of supported currencies. Always lowercase.\n\nThis comes from the Stripe API docs: For more details see .", + "type": "string" + }, + "CurveGetControlPoints": { + "description": "The response from the `CurveGetControlPoints` command.", + "properties": { + "control_points": { + "description": "Control points in the curve.", + "items": { + "$ref": "#/components/schemas/Point3d" + }, + "type": "array" + } + }, + "required": [ + "control_points" + ], + "type": "object" + }, + "CurveGetEndPoints": { + "description": "Endpoints of a curve", + "properties": { + "end": { + "allOf": [ + { + "$ref": "#/components/schemas/Point3d" + } ], - "type": "string" + "description": "End" }, - { - "description": "Angola", - "enum": [ - "AO" + "start": { + "allOf": [ + { + "$ref": "#/components/schemas/Point3d" + } ], - "type": "string" - }, - { - "description": "Anguilla", - "enum": [ - "AI" + "description": "Start" + } + }, + "required": [ + "end", + "start" + ], + "type": "object" + }, + "CurveGetType": { + "description": "The response from the `CurveGetType` command.", + "properties": { + "curve_type": { + "allOf": [ + { + "$ref": "#/components/schemas/CurveType" + } ], - "type": "string" - }, - { - "description": "Antarctica", - "enum": [ - "AQ" + "description": "Curve type" + } + }, + "required": [ + "curve_type" + ], + "type": "object" + }, + "CurveType": { + "description": "The type of Curve (embedded within path)", + "enum": [ + "line", + "arc", + "nurbs" + ], + "type": "string" + }, + "Customer": { + "description": "The resource representing a payment \"Customer\".", + "properties": { + "address": { + "allOf": [ + { + "$ref": "#/components/schemas/NewAddress" + } ], - "type": "string" + "description": "The customer's address.", + "nullable": true }, - { - "description": "Antigua and Barbuda", - "enum": [ - "AG" - ], + "balance": { + "default": 0.0, + "description": "Current balance, if any, being stored on the customer in the payments service.\n\nIf negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized.", + "format": "money-usd", + "pattern": "^-?[0-9]+(\\.[0-9]+)?$", + "title": "Decimal", "type": "string" }, - { - "description": "Argentina", - "enum": [ - "AR" - ], + "created_at": { + "description": "Time at which the object was created.", + "format": "date-time", "type": "string" }, - { - "description": "Armenia", - "enum": [ - "AM" + "currency": { + "allOf": [ + { + "$ref": "#/components/schemas/Currency" + } ], - "type": "string" + "default": "usd", + "description": "Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes." }, - { - "description": "Aruba", - "enum": [ - "AW" - ], - "type": "string" + "delinquent": { + "default": false, + "description": "When the customer's latest invoice is billed by charging automatically, `delinquent` is `true` if the invoice's latest charge failed.\n\nWhen the customer's latest invoice is billed by sending an invoice, `delinquent` is `true` if the invoice isn't paid by its due date. If an invoice is marked uncollectible by dunning, `delinquent` doesn't get reset to `false`.", + "type": "boolean" }, - { - "description": "Australia", - "enum": [ - "AU" - ], + "email": { + "description": "The customer's email address.", + "format": "email", "type": "string" }, - { - "description": "Austria", - "enum": [ - "AT" - ], + "id": { + "description": "Unique identifier for the object.", "type": "string" }, - { - "description": "Azerbaijan", - "enum": [ - "AZ" - ], - "type": "string" - }, - { - "description": "Bahamas", - "enum": [ - "BS" - ], - "type": "string" - }, - { - "description": "Bahrain", - "enum": [ - "BH" - ], - "type": "string" - }, - { - "description": "Bangladesh", - "enum": [ - "BD" - ], - "type": "string" - }, - { - "description": "Barbados", - "enum": [ - "BB" - ], - "type": "string" - }, - { - "description": "Belarus", - "enum": [ - "BY" - ], - "type": "string" - }, - { - "description": "Belgium", - "enum": [ - "BE" - ], - "type": "string" - }, - { - "description": "Belize", - "enum": [ - "BZ" - ], - "type": "string" - }, - { - "description": "Benin", - "enum": [ - "BJ" - ], - "type": "string" - }, - { - "description": "Bermuda", - "enum": [ - "BM" - ], - "type": "string" - }, - { - "description": "Bhutan", - "enum": [ - "BT" - ], - "type": "string" - }, - { - "description": "Bolivia (Plurinational State of)", - "enum": [ - "BO" - ], - "type": "string" - }, - { - "description": "Bonaire, Sint Eustatius and Saba", - "enum": [ - "BQ" - ], - "type": "string" - }, - { - "description": "Bosnia and Herzegovina", - "enum": [ - "BA" - ], - "type": "string" - }, - { - "description": "Botswana", - "enum": [ - "BW" - ], - "type": "string" - }, - { - "description": "Bouvet Island", - "enum": [ - "BV" - ], - "type": "string" - }, - { - "description": "Brazil", - "enum": [ - "BR" - ], - "type": "string" - }, - { - "description": "British Indian Ocean Territory", - "enum": [ - "IO" - ], - "type": "string" - }, - { - "description": "Brunei Darussalam", - "enum": [ - "BN" - ], - "type": "string" - }, - { - "description": "Bulgaria", - "enum": [ - "BG" - ], - "type": "string" - }, - { - "description": "Burkina Faso", - "enum": [ - "BF" - ], - "type": "string" - }, - { - "description": "Burundi", - "enum": [ - "BI" - ], - "type": "string" - }, - { - "description": "Cabo Verde", - "enum": [ - "CV" - ], - "type": "string" - }, - { - "description": "Cambodia", - "enum": [ - "KH" - ], - "type": "string" - }, - { - "description": "Cameroon", - "enum": [ - "CM" - ], - "type": "string" - }, - { - "description": "Canada", - "enum": [ - "CA" - ], - "type": "string" - }, - { - "description": "Cayman Islands", - "enum": [ - "KY" - ], - "type": "string" - }, - { - "description": "Central African Republic", - "enum": [ - "CF" - ], - "type": "string" - }, - { - "description": "Chad", - "enum": [ - "TD" - ], - "type": "string" - }, - { - "description": "Chile", - "enum": [ - "CL" - ], - "type": "string" - }, - { - "description": "China", - "enum": [ - "CN" - ], - "type": "string" - }, - { - "description": "Christmas Island", - "enum": [ - "CX" - ], - "type": "string" - }, - { - "description": "Cocos (Keeling) Islands", - "enum": [ - "CC" - ], - "type": "string" - }, - { - "description": "Colombia", - "enum": [ - "CO" - ], - "type": "string" - }, - { - "description": "Comoros", - "enum": [ - "KM" - ], - "type": "string" - }, - { - "description": "Congo", - "enum": [ - "CG" - ], - "type": "string" - }, - { - "description": "Congo (Democratic Republic of the)", - "enum": [ - "CD" - ], - "type": "string" - }, - { - "description": "Cook Islands", - "enum": [ - "CK" - ], - "type": "string" - }, - { - "description": "Costa Rica", - "enum": [ - "CR" - ], - "type": "string" - }, - { - "description": "Côte d'Ivoire", - "enum": [ - "CI" - ], - "type": "string" - }, - { - "description": "Croatia", - "enum": [ - "HR" - ], - "type": "string" - }, - { - "description": "Cuba", - "enum": [ - "CU" - ], - "type": "string" - }, - { - "description": "Curaçao", - "enum": [ - "CW" - ], - "type": "string" - }, - { - "description": "Cyprus", - "enum": [ - "CY" - ], - "type": "string" - }, - { - "description": "Czechia", - "enum": [ - "CZ" - ], - "type": "string" - }, - { - "description": "Denmark", - "enum": [ - "DK" - ], - "type": "string" - }, - { - "description": "Djibouti", - "enum": [ - "DJ" - ], - "type": "string" - }, - { - "description": "Dominica", - "enum": [ - "DM" - ], - "type": "string" - }, - { - "description": "Dominican Republic", - "enum": [ - "DO" - ], - "type": "string" - }, - { - "description": "Ecuador", - "enum": [ - "EC" - ], - "type": "string" - }, - { - "description": "Egypt", - "enum": [ - "EG" - ], - "type": "string" - }, - { - "description": "El Salvador", - "enum": [ - "SV" - ], - "type": "string" - }, - { - "description": "Equatorial Guinea", - "enum": [ - "GQ" - ], - "type": "string" - }, - { - "description": "Eritrea", - "enum": [ - "ER" - ], - "type": "string" - }, - { - "description": "Estonia", - "enum": [ - "EE" - ], - "type": "string" - }, - { - "description": "Ethiopia", - "enum": [ - "ET" - ], - "type": "string" - }, - { - "description": "Falkland Islands (Malvinas)", - "enum": [ - "FK" - ], - "type": "string" - }, - { - "description": "Faroe Islands", - "enum": [ - "FO" - ], - "type": "string" - }, - { - "description": "Fiji", - "enum": [ - "FJ" - ], - "type": "string" - }, - { - "description": "Finland", - "enum": [ - "FI" - ], - "type": "string" - }, - { - "description": "France", - "enum": [ - "FR" - ], - "type": "string" - }, - { - "description": "French Guiana", - "enum": [ - "GF" - ], - "type": "string" - }, - { - "description": "French Polynesia", - "enum": [ - "PF" - ], - "type": "string" - }, - { - "description": "French Southern Territories", - "enum": [ - "TF" - ], - "type": "string" - }, - { - "description": "Gabon", - "enum": [ - "GA" - ], - "type": "string" - }, - { - "description": "Gambia", - "enum": [ - "GM" - ], - "type": "string" - }, - { - "description": "Georgia", - "enum": [ - "GE" - ], - "type": "string" - }, - { - "description": "Germany", - "enum": [ - "DE" - ], - "type": "string" - }, - { - "description": "Ghana", - "enum": [ - "GH" - ], - "type": "string" - }, - { - "description": "Gibraltar", - "enum": [ - "GI" - ], - "type": "string" - }, - { - "description": "Greece", - "enum": [ - "GR" - ], - "type": "string" - }, - { - "description": "Greenland", - "enum": [ - "GL" - ], - "type": "string" - }, - { - "description": "Grenada", - "enum": [ - "GD" - ], - "type": "string" - }, - { - "description": "Guadeloupe", - "enum": [ - "GP" - ], - "type": "string" - }, - { - "description": "Guam", - "enum": [ - "GU" - ], - "type": "string" - }, - { - "description": "Guatemala", - "enum": [ - "GT" - ], - "type": "string" - }, - { - "description": "Guernsey", - "enum": [ - "GG" - ], - "type": "string" - }, - { - "description": "Guinea", - "enum": [ - "GN" - ], - "type": "string" - }, - { - "description": "Guinea-Bissau", - "enum": [ - "GW" - ], - "type": "string" - }, - { - "description": "Guyana", - "enum": [ - "GY" - ], - "type": "string" - }, - { - "description": "Haiti", - "enum": [ - "HT" - ], - "type": "string" - }, - { - "description": "Heard Island and McDonald Islands", - "enum": [ - "HM" - ], - "type": "string" - }, - { - "description": "Holy See", - "enum": [ - "VA" - ], - "type": "string" - }, - { - "description": "Honduras", - "enum": [ - "HN" - ], - "type": "string" - }, - { - "description": "Hong Kong", - "enum": [ - "HK" - ], - "type": "string" - }, - { - "description": "Hungary", - "enum": [ - "HU" - ], - "type": "string" - }, - { - "description": "Iceland", - "enum": [ - "IS" - ], - "type": "string" - }, - { - "description": "India", - "enum": [ - "IN" - ], - "type": "string" - }, - { - "description": "Indonesia", - "enum": [ - "ID" - ], - "type": "string" - }, - { - "description": "Iran (Islamic Republic of)", - "enum": [ - "IR" - ], - "type": "string" - }, - { - "description": "Iraq", - "enum": [ - "IQ" - ], - "type": "string" - }, - { - "description": "Ireland", - "enum": [ - "IE" - ], - "type": "string" - }, - { - "description": "Isle of Man", - "enum": [ - "IM" - ], - "type": "string" - }, - { - "description": "Israel", - "enum": [ - "IL" - ], - "type": "string" - }, - { - "description": "Italy", - "enum": [ - "IT" - ], - "type": "string" - }, - { - "description": "Jamaica", - "enum": [ - "JM" - ], - "type": "string" - }, - { - "description": "Japan", - "enum": [ - "JP" - ], - "type": "string" - }, - { - "description": "Jersey", - "enum": [ - "JE" - ], - "type": "string" - }, - { - "description": "Jordan", - "enum": [ - "JO" - ], - "type": "string" - }, - { - "description": "Kazakhstan", - "enum": [ - "KZ" - ], - "type": "string" - }, - { - "description": "Kenya", - "enum": [ - "KE" - ], - "type": "string" - }, - { - "description": "Kiribati", - "enum": [ - "KI" - ], - "type": "string" - }, - { - "description": "Korea (Democratic People's Republic of)", - "enum": [ - "KP" - ], - "type": "string" - }, - { - "description": "Korea (Republic of)", - "enum": [ - "KR" - ], - "type": "string" - }, - { - "description": "Kuwait", - "enum": [ - "KW" - ], - "type": "string" - }, - { - "description": "Kyrgyzstan", - "enum": [ - "KG" - ], - "type": "string" - }, - { - "description": "Lao People's Democratic Republic", - "enum": [ - "LA" - ], - "type": "string" - }, - { - "description": "Latvia", - "enum": [ - "LV" - ], - "type": "string" - }, - { - "description": "Lebanon", - "enum": [ - "LB" - ], - "type": "string" - }, - { - "description": "Lesotho", - "enum": [ - "LS" - ], - "type": "string" - }, - { - "description": "Liberia", - "enum": [ - "LR" - ], - "type": "string" - }, - { - "description": "Libya", - "enum": [ - "LY" - ], - "type": "string" - }, - { - "description": "Liechtenstein", - "enum": [ - "LI" - ], - "type": "string" - }, - { - "description": "Lithuania", - "enum": [ - "LT" - ], - "type": "string" - }, - { - "description": "Luxembourg", - "enum": [ - "LU" - ], - "type": "string" - }, - { - "description": "Macao", - "enum": [ - "MO" - ], - "type": "string" - }, - { - "description": "Macedonia (the former Yugoslav Republic of)", - "enum": [ - "MK" - ], - "type": "string" - }, - { - "description": "Madagascar", - "enum": [ - "MG" - ], - "type": "string" - }, - { - "description": "Malawi", - "enum": [ - "MW" - ], - "type": "string" - }, - { - "description": "Malaysia", - "enum": [ - "MY" - ], - "type": "string" - }, - { - "description": "Maldives", - "enum": [ - "MV" - ], - "type": "string" - }, - { - "description": "Mali", - "enum": [ - "ML" - ], - "type": "string" - }, - { - "description": "Malta", - "enum": [ - "MT" - ], - "type": "string" - }, - { - "description": "Marshall Islands", - "enum": [ - "MH" - ], - "type": "string" - }, - { - "description": "Martinique", - "enum": [ - "MQ" - ], - "type": "string" - }, - { - "description": "Mauritania", - "enum": [ - "MR" - ], - "type": "string" - }, - { - "description": "Mauritius", - "enum": [ - "MU" - ], - "type": "string" - }, - { - "description": "Mayotte", - "enum": [ - "YT" - ], - "type": "string" - }, - { - "description": "Mexico", - "enum": [ - "MX" - ], - "type": "string" - }, - { - "description": "Micronesia (Federated States of)", - "enum": [ - "FM" - ], - "type": "string" - }, - { - "description": "Moldova (Republic of)", - "enum": [ - "MD" - ], - "type": "string" - }, - { - "description": "Monaco", - "enum": [ - "MC" - ], - "type": "string" - }, - { - "description": "Mongolia", - "enum": [ - "MN" - ], - "type": "string" - }, - { - "description": "Montenegro", - "enum": [ - "ME" - ], - "type": "string" - }, - { - "description": "Montserrat", - "enum": [ - "MS" - ], - "type": "string" - }, - { - "description": "Morocco", - "enum": [ - "MA" - ], - "type": "string" - }, - { - "description": "Mozambique", - "enum": [ - "MZ" - ], - "type": "string" - }, - { - "description": "Myanmar", - "enum": [ - "MM" - ], - "type": "string" - }, - { - "description": "Namibia", - "enum": [ - "NA" - ], - "type": "string" - }, - { - "description": "Nauru", - "enum": [ - "NR" - ], - "type": "string" - }, - { - "description": "Nepal", - "enum": [ - "NP" - ], - "type": "string" - }, - { - "description": "Netherlands", - "enum": [ - "NL" - ], - "type": "string" - }, - { - "description": "New Caledonia", - "enum": [ - "NC" - ], - "type": "string" - }, - { - "description": "New Zealand", - "enum": [ - "NZ" - ], - "type": "string" - }, - { - "description": "Nicaragua", - "enum": [ - "NI" - ], - "type": "string" - }, - { - "description": "Niger", - "enum": [ - "NE" - ], - "type": "string" - }, - { - "description": "Nigeria", - "enum": [ - "NG" - ], - "type": "string" - }, - { - "description": "Niue", - "enum": [ - "NU" - ], - "type": "string" - }, - { - "description": "Norfolk Island", - "enum": [ - "NF" - ], - "type": "string" - }, - { - "description": "Northern Mariana Islands", - "enum": [ - "MP" - ], - "type": "string" - }, - { - "description": "Norway", - "enum": [ - "NO" - ], - "type": "string" - }, - { - "description": "Oman", - "enum": [ - "OM" - ], - "type": "string" - }, - { - "description": "Pakistan", - "enum": [ - "PK" - ], - "type": "string" - }, - { - "description": "Palau", - "enum": [ - "PW" - ], - "type": "string" - }, - { - "description": "Palestine, State of", - "enum": [ - "PS" - ], - "type": "string" - }, - { - "description": "Panama", - "enum": [ - "PA" - ], - "type": "string" - }, - { - "description": "Papua New Guinea", - "enum": [ - "PG" - ], - "type": "string" - }, - { - "description": "Paraguay", - "enum": [ - "PY" - ], - "type": "string" - }, - { - "description": "Peru", - "enum": [ - "PE" - ], - "type": "string" - }, - { - "description": "Philippines", - "enum": [ - "PH" - ], - "type": "string" - }, - { - "description": "Pitcairn", - "enum": [ - "PN" - ], - "type": "string" - }, - { - "description": "Poland", - "enum": [ - "PL" - ], - "type": "string" - }, - { - "description": "Portugal", - "enum": [ - "PT" - ], - "type": "string" - }, - { - "description": "Puerto Rico", - "enum": [ - "PR" - ], - "type": "string" - }, - { - "description": "Qatar", - "enum": [ - "QA" - ], - "type": "string" - }, - { - "description": "Réunion", - "enum": [ - "RE" - ], - "type": "string" - }, - { - "description": "Romania", - "enum": [ - "RO" - ], - "type": "string" - }, - { - "description": "Russian Federation", - "enum": [ - "RU" - ], - "type": "string" - }, - { - "description": "Rwanda", - "enum": [ - "RW" - ], - "type": "string" - }, - { - "description": "Saint Barthélemy", - "enum": [ - "BL" - ], - "type": "string" - }, - { - "description": "Saint Helena, Ascension and Tristan da Cunha", - "enum": [ - "SH" - ], - "type": "string" - }, - { - "description": "Saint Kitts and Nevis", - "enum": [ - "KN" - ], - "type": "string" - }, - { - "description": "Saint Lucia", - "enum": [ - "LC" - ], - "type": "string" - }, - { - "description": "Saint Martin (French part)", - "enum": [ - "MF" - ], - "type": "string" - }, - { - "description": "Saint Pierre and Miquelon", - "enum": [ - "PM" - ], - "type": "string" - }, - { - "description": "Saint Vincent and the Grenadines", - "enum": [ - "VC" - ], - "type": "string" - }, - { - "description": "Samoa", - "enum": [ - "WS" - ], - "type": "string" - }, - { - "description": "San Marino", - "enum": [ - "SM" - ], - "type": "string" - }, - { - "description": "Sao Tome and Principe", - "enum": [ - "ST" - ], - "type": "string" - }, - { - "description": "Saudi Arabia", - "enum": [ - "SA" - ], - "type": "string" - }, - { - "description": "Senegal", - "enum": [ - "SN" - ], - "type": "string" - }, - { - "description": "Serbia", - "enum": [ - "RS" - ], - "type": "string" - }, - { - "description": "Seychelles", - "enum": [ - "SC" - ], - "type": "string" - }, - { - "description": "Sierra Leone", - "enum": [ - "SL" - ], - "type": "string" - }, - { - "description": "Singapore", - "enum": [ - "SG" - ], - "type": "string" - }, - { - "description": "Sint Maarten (Dutch part)", - "enum": [ - "SX" - ], - "type": "string" - }, - { - "description": "Slovakia", - "enum": [ - "SK" - ], - "type": "string" - }, - { - "description": "Slovenia", - "enum": [ - "SI" - ], - "type": "string" - }, - { - "description": "Solomon Islands", - "enum": [ - "SB" - ], - "type": "string" - }, - { - "description": "Somalia", - "enum": [ - "SO" - ], - "type": "string" - }, - { - "description": "South Africa", - "enum": [ - "ZA" - ], - "type": "string" - }, - { - "description": "South Georgia and the South Sandwich Islands", - "enum": [ - "GS" - ], - "type": "string" - }, - { - "description": "South Sudan", - "enum": [ - "SS" - ], - "type": "string" - }, - { - "description": "Spain", - "enum": [ - "ES" - ], - "type": "string" - }, - { - "description": "Sri Lanka", - "enum": [ - "LK" - ], - "type": "string" - }, - { - "description": "Sudan", - "enum": [ - "SD" - ], - "type": "string" - }, - { - "description": "Suriname", - "enum": [ - "SR" - ], - "type": "string" - }, - { - "description": "Svalbard and Jan Mayen", - "enum": [ - "SJ" - ], - "type": "string" - }, - { - "description": "Swaziland", - "enum": [ - "SZ" - ], - "type": "string" - }, - { - "description": "Sweden", - "enum": [ - "SE" - ], - "type": "string" - }, - { - "description": "Switzerland", - "enum": [ - "CH" - ], - "type": "string" - }, - { - "description": "Syrian Arab Republic", - "enum": [ - "SY" - ], - "type": "string" - }, - { - "description": "Taiwan, Province of China", - "enum": [ - "TW" - ], - "type": "string" - }, - { - "description": "Tajikistan", - "enum": [ - "TJ" - ], - "type": "string" - }, - { - "description": "Tanzania, United Republic of", - "enum": [ - "TZ" - ], - "type": "string" - }, - { - "description": "Thailand", - "enum": [ - "TH" - ], - "type": "string" - }, - { - "description": "Timor-Leste", - "enum": [ - "TL" - ], - "type": "string" - }, - { - "description": "Togo", - "enum": [ - "TG" - ], - "type": "string" - }, - { - "description": "Tokelau", - "enum": [ - "TK" - ], - "type": "string" - }, - { - "description": "Tonga", - "enum": [ - "TO" - ], - "type": "string" - }, - { - "description": "Trinidad and Tobago", - "enum": [ - "TT" - ], - "type": "string" - }, - { - "description": "Tunisia", - "enum": [ - "TN" - ], - "type": "string" - }, - { - "description": "Turkey", - "enum": [ - "TR" - ], - "type": "string" - }, - { - "description": "Turkmenistan", - "enum": [ - "TM" - ], - "type": "string" - }, - { - "description": "Turks and Caicos Islands", - "enum": [ - "TC" - ], - "type": "string" - }, - { - "description": "Tuvalu", - "enum": [ - "TV" - ], - "type": "string" - }, - { - "description": "Uganda", - "enum": [ - "UG" - ], - "type": "string" - }, - { - "description": "Ukraine", - "enum": [ - "UA" - ], - "type": "string" - }, - { - "description": "United Arab Emirates", - "enum": [ - "AE" - ], - "type": "string" - }, - { - "description": "United Kingdom of Great Britain and Northern Ireland", - "enum": [ - "GB" - ], - "type": "string" - }, - { - "description": "United States of America", - "enum": [ - "US" - ], - "type": "string" - }, - { - "description": "United States Minor Outlying Islands", - "enum": [ - "UM" - ], - "type": "string" - }, - { - "description": "Uruguay", - "enum": [ - "UY" - ], - "type": "string" - }, - { - "description": "Uzbekistan", - "enum": [ - "UZ" - ], - "type": "string" - }, - { - "description": "Vanuatu", - "enum": [ - "VU" - ], - "type": "string" - }, - { - "description": "Venezuela (Bolivarian Republic of)", - "enum": [ - "VE" - ], - "type": "string" - }, - { - "description": "Viet Nam", - "enum": [ - "VN" - ], - "type": "string" - }, - { - "description": "Virgin Islands (British)", - "enum": [ - "VG" - ], - "type": "string" - }, - { - "description": "Virgin Islands (U.S.)", - "enum": [ - "VI" - ], - "type": "string" - }, - { - "description": "Wallis and Futuna", - "enum": [ - "WF" - ], - "type": "string" - }, - { - "description": "Western Sahara", - "enum": [ - "EH" - ], - "type": "string" - }, - { - "description": "Yemen", - "enum": [ - "YE" - ], - "type": "string" - }, - { - "description": "Zambia", - "enum": [ - "ZM" - ], - "type": "string" - }, - { - "description": "Zimbabwe", - "enum": [ - "ZW" - ], - "type": "string" - } - ] - }, - "Coupon": { - "description": "The resource representing a Coupon.", - "properties": { - "amount_off": { - "description": "Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer.", - "format": "money-usd", - "nullable": true, - "title": "Number", - "type": "number" - }, - "deleted": { - "default": false, - "description": "Always true for a deleted object.", - "type": "boolean" - }, - "id": { - "description": "Unique identifier for the object.", - "type": "string" - }, - "percent_off": { - "description": "Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon.\n\nFor example, a coupon with percent_off of 50 will make a %s100 invoice %s50 instead.", - "format": "double", - "nullable": true, - "type": "number" - } - }, - "type": "object" - }, - "CreatedAtSortMode": { - "description": "Supported set of sort modes for scanning by created_at only.\n\nCurrently, we only support scanning in ascending order.", - "oneOf": [ - { - "description": "Sort in increasing order of \"created_at\".", - "enum": [ - "created_at_ascending" - ], - "type": "string" - }, - { - "description": "Sort in decreasing order of \"created_at\".", - "enum": [ - "created_at_descending" - ], - "type": "string" - } - ] - }, - "Currency": { - "description": "Currency is the list of supported currencies.\n\nThis comes from the Stripe API docs: For more details see .", - "oneOf": [ - { - "description": "United Arab Emirates Dirham", - "enum": [ - "aed" - ], - "type": "string" - }, - { - "description": "Afghan Afghani", - "enum": [ - "afn" - ], - "type": "string" - }, - { - "description": "Albanian Lek", - "enum": [ - "all" - ], - "type": "string" - }, - { - "description": "Armenian Dram", - "enum": [ - "amd" - ], - "type": "string" - }, - { - "description": "Netherlands Antillean Gulden", - "enum": [ - "ang" - ], - "type": "string" - }, - { - "description": "Angolan Kwanza", - "enum": [ - "aoa" - ], - "type": "string" - }, - { - "description": "Argentine Peso", - "enum": [ - "ars" - ], - "type": "string" - }, - { - "description": "Australian Dollar", - "enum": [ - "aud" - ], - "type": "string" - }, - { - "description": "Aruban Florin", - "enum": [ - "awg" - ], - "type": "string" - }, - { - "description": "Azerbaijani Manat", - "enum": [ - "azn" - ], - "type": "string" - }, - { - "description": "Bosnia & Herzegovina Convertible Mark", - "enum": [ - "bam" - ], - "type": "string" - }, - { - "description": "Barbadian Dollar", - "enum": [ - "bbd" - ], - "type": "string" - }, - { - "description": "Bangladeshi Taka", - "enum": [ - "bdt" - ], - "type": "string" - }, - { - "description": "Bulgarian Lev", - "enum": [ - "bgn" - ], - "type": "string" - }, - { - "description": "Burundian Franc", - "enum": [ - "bif" - ], - "type": "string" - }, - { - "description": "Bermudian Dollar", - "enum": [ - "bmd" - ], - "type": "string" - }, - { - "description": "Brunei Dollar", - "enum": [ - "bnd" - ], - "type": "string" - }, - { - "description": "Bolivian Boliviano", - "enum": [ - "bob" - ], - "type": "string" - }, - { - "description": "Brazilian Real", - "enum": [ - "brl" - ], - "type": "string" - }, - { - "description": "Bahamian Dollar", - "enum": [ - "bsd" - ], - "type": "string" - }, - { - "description": "Botswana Pula", - "enum": [ - "bwp" - ], - "type": "string" - }, - { - "description": "Belize Dollar", - "enum": [ - "bzd" - ], - "type": "string" - }, - { - "description": "Canadian Dollar", - "enum": [ - "cad" - ], - "type": "string" - }, - { - "description": "Congolese Franc", - "enum": [ - "cdf" - ], - "type": "string" - }, - { - "description": "Swiss Franc", - "enum": [ - "chf" - ], - "type": "string" - }, - { - "description": "Chilean Peso", - "enum": [ - "clp" - ], - "type": "string" - }, - { - "description": "Chinese Renminbi Yuan", - "enum": [ - "cny" - ], - "type": "string" - }, - { - "description": "Colombian Peso", - "enum": [ - "cop" - ], - "type": "string" - }, - { - "description": "Costa Rican Colón", - "enum": [ - "crc" - ], - "type": "string" - }, - { - "description": "Cape Verdean Escudo", - "enum": [ - "cve" - ], - "type": "string" - }, - { - "description": "Czech Koruna", - "enum": [ - "czk" - ], - "type": "string" - }, - { - "description": "Djiboutian Franc", - "enum": [ - "djf" - ], - "type": "string" - }, - { - "description": "Danish Krone", - "enum": [ - "dkk" - ], - "type": "string" - }, - { - "description": "Dominican Peso", - "enum": [ - "dop" - ], - "type": "string" - }, - { - "description": "Algerian Dinar", - "enum": [ - "dzd" - ], - "type": "string" - }, - { - "description": "Estonian Kroon", - "enum": [ - "eek" - ], - "type": "string" - }, - { - "description": "Egyptian Pound", - "enum": [ - "egp" - ], - "type": "string" - }, - { - "description": "Ethiopian Birr", - "enum": [ - "etb" - ], - "type": "string" - }, - { - "description": "Euro", - "enum": [ - "eur" - ], - "type": "string" - }, - { - "description": "Fijian Dollar", - "enum": [ - "fjd" - ], - "type": "string" - }, - { - "description": "Falkland Islands Pound", - "enum": [ - "fkp" - ], - "type": "string" - }, - { - "description": "British Pound", - "enum": [ - "gbp" - ], - "type": "string" - }, - { - "description": "Georgian Lari", - "enum": [ - "gel" - ], - "type": "string" - }, - { - "description": "Gibraltar Pound", - "enum": [ - "gip" - ], - "type": "string" - }, - { - "description": "Gambian Dalasi", - "enum": [ - "gmd" - ], - "type": "string" - }, - { - "description": "Guinean Franc", - "enum": [ - "gnf" - ], - "type": "string" - }, - { - "description": "Guatemalan Quetzal", - "enum": [ - "gtq" - ], - "type": "string" - }, - { - "description": "Guyanese Dollar", - "enum": [ - "gyd" - ], - "type": "string" - }, - { - "description": "Hong Kong Dollar", - "enum": [ - "hkd" - ], - "type": "string" - }, - { - "description": "Honduran Lempira", - "enum": [ - "hnl" - ], - "type": "string" - }, - { - "description": "Croatian Kuna", - "enum": [ - "hrk" - ], - "type": "string" - }, - { - "description": "Haitian Gourde", - "enum": [ - "htg" - ], - "type": "string" - }, - { - "description": "Hungarian Forint", - "enum": [ - "huf" - ], - "type": "string" - }, - { - "description": "Indonesian Rupiah", - "enum": [ - "idr" - ], - "type": "string" - }, - { - "description": "Israeli New Sheqel", - "enum": [ - "ils" - ], - "type": "string" - }, - { - "description": "Indian Rupee", - "enum": [ - "inr" - ], - "type": "string" - }, - { - "description": "Icelandic Króna", - "enum": [ - "isk" - ], - "type": "string" - }, - { - "description": "Jamaican Dollar", - "enum": [ - "jmd" - ], - "type": "string" - }, - { - "description": "Japanese Yen", - "enum": [ - "jpy" - ], - "type": "string" - }, - { - "description": "Kenyan Shilling", - "enum": [ - "kes" - ], - "type": "string" - }, - { - "description": "Kyrgyzstani Som", - "enum": [ - "kgs" - ], - "type": "string" - }, - { - "description": "Cambodian Riel", - "enum": [ - "khr" - ], - "type": "string" - }, - { - "description": "Comorian Franc", - "enum": [ - "kmf" - ], - "type": "string" - }, - { - "description": "South Korean Won", - "enum": [ - "krw" - ], - "type": "string" - }, - { - "description": "Cayman Islands Dollar", - "enum": [ - "kyd" - ], - "type": "string" - }, - { - "description": "Kazakhstani Tenge", - "enum": [ - "kzt" - ], - "type": "string" - }, - { - "description": "Lao Kip", - "enum": [ - "lak" - ], - "type": "string" - }, - { - "description": "Lebanese Pound", - "enum": [ - "lbp" - ], - "type": "string" - }, - { - "description": "Sri Lankan Rupee", - "enum": [ - "lkr" - ], - "type": "string" - }, - { - "description": "Liberian Dollar", - "enum": [ - "lrd" - ], - "type": "string" - }, - { - "description": "Lesotho Loti", - "enum": [ - "lsl" - ], - "type": "string" - }, - { - "description": "Lithuanian Litas", - "enum": [ - "ltl" - ], - "type": "string" - }, - { - "description": "Latvian Lats", - "enum": [ - "lvl" - ], - "type": "string" - }, - { - "description": "Moroccan Dirham", - "enum": [ - "mad" - ], - "type": "string" - }, - { - "description": "Moldovan Leu", - "enum": [ - "mdl" - ], - "type": "string" - }, - { - "description": "Malagasy Ariary", - "enum": [ - "mga" - ], - "type": "string" - }, - { - "description": "Macedonian Denar", - "enum": [ - "mkd" - ], - "type": "string" - }, - { - "description": "Mongolian Tögrög", - "enum": [ - "mnt" - ], - "type": "string" - }, - { - "description": "Macanese Pataca", - "enum": [ - "mop" - ], - "type": "string" - }, - { - "description": "Mauritanian Ouguiya", - "enum": [ - "mro" - ], - "type": "string" - }, - { - "description": "Mauritian Rupee", - "enum": [ - "mur" - ], - "type": "string" - }, - { - "description": "Maldivian Rufiyaa", - "enum": [ - "mvr" - ], - "type": "string" - }, - { - "description": "Malawian Kwacha", - "enum": [ - "mwk" - ], - "type": "string" - }, - { - "description": "Mexican Peso", - "enum": [ - "mxn" - ], - "type": "string" - }, - { - "description": "Malaysian Ringgit", - "enum": [ - "myr" - ], - "type": "string" - }, - { - "description": "Mozambican Metical", - "enum": [ - "mzn" - ], - "type": "string" - }, - { - "description": "Namibian Dollar", - "enum": [ - "nad" - ], - "type": "string" - }, - { - "description": "Nigerian Naira", - "enum": [ - "ngn" - ], - "type": "string" - }, - { - "description": "Nicaraguan Córdoba", - "enum": [ - "nio" - ], - "type": "string" - }, - { - "description": "Norwegian Krone", - "enum": [ - "nok" - ], - "type": "string" - }, - { - "description": "Nepalese Rupee", - "enum": [ - "npr" - ], - "type": "string" - }, - { - "description": "New Zealand Dollar", - "enum": [ - "nzd" - ], - "type": "string" - }, - { - "description": "Panamanian Balboa", - "enum": [ - "pab" - ], - "type": "string" - }, - { - "description": "Peruvian Nuevo Sol", - "enum": [ - "pen" - ], - "type": "string" - }, - { - "description": "Papua New Guinean Kina", - "enum": [ - "pgk" - ], - "type": "string" - }, - { - "description": "Philippine Peso", - "enum": [ - "php" - ], - "type": "string" - }, - { - "description": "Pakistani Rupee", - "enum": [ - "pkr" - ], - "type": "string" - }, - { - "description": "Polish Złoty", - "enum": [ - "pln" - ], - "type": "string" - }, - { - "description": "Paraguayan Guaraní", - "enum": [ - "pyg" - ], - "type": "string" - }, - { - "description": "Qatari Riyal", - "enum": [ - "qar" - ], - "type": "string" - }, - { - "description": "Romanian Leu", - "enum": [ - "ron" - ], - "type": "string" - }, - { - "description": "Serbian Dinar", - "enum": [ - "rsd" - ], - "type": "string" - }, - { - "description": "Russian Ruble", - "enum": [ - "rub" - ], - "type": "string" - }, - { - "description": "Rwandan Franc", - "enum": [ - "rwf" - ], - "type": "string" - }, - { - "description": "Saudi Riyal", - "enum": [ - "sar" - ], - "type": "string" - }, - { - "description": "Solomon Islands Dollar", - "enum": [ - "sbd" - ], - "type": "string" - }, - { - "description": "Seychellois Rupee", - "enum": [ - "scr" - ], - "type": "string" - }, - { - "description": "Swedish Krona", - "enum": [ - "sek" - ], - "type": "string" - }, - { - "description": "Singapore Dollar", - "enum": [ - "sgd" - ], - "type": "string" - }, - { - "description": "Saint Helenian Pound", - "enum": [ - "shp" - ], - "type": "string" - }, - { - "description": "Sierra Leonean Leone", - "enum": [ - "sll" - ], - "type": "string" - }, - { - "description": "Somali Shilling", - "enum": [ - "sos" - ], - "type": "string" - }, - { - "description": "Surinamese Dollar", - "enum": [ - "srd" - ], - "type": "string" - }, - { - "description": "São Tomé and Príncipe Dobra", - "enum": [ - "std" - ], - "type": "string" - }, - { - "description": "Salvadoran Colón", - "enum": [ - "svc" - ], - "type": "string" - }, - { - "description": "Swazi Lilangeni", - "enum": [ - "szl" - ], - "type": "string" - }, - { - "description": "Thai Baht", - "enum": [ - "thb" - ], - "type": "string" - }, - { - "description": "Tajikistani Somoni", - "enum": [ - "tjs" - ], - "type": "string" - }, - { - "description": "Tongan Paʻanga", - "enum": [ - "top" - ], - "type": "string" - }, - { - "description": "Turkish Lira", - "enum": [ - "try" - ], - "type": "string" - }, - { - "description": "Trinidad and Tobago Dollar", - "enum": [ - "ttd" - ], - "type": "string" - }, - { - "description": "New Taiwan Dollar", - "enum": [ - "twd" - ], - "type": "string" - }, - { - "description": "Tanzanian Shilling", - "enum": [ - "tzs" - ], - "type": "string" - }, - { - "description": "Ukrainian Hryvnia", - "enum": [ - "uah" - ], - "type": "string" - }, - { - "description": "Ugandan Shilling", - "enum": [ - "ugx" - ], - "type": "string" - }, - { - "description": "United States Dollar", - "enum": [ - "usd" - ], - "type": "string" - }, - { - "description": "Uruguayan Peso", - "enum": [ - "uyu" - ], - "type": "string" - }, - { - "description": "Uzbekistani Som", - "enum": [ - "uzs" - ], - "type": "string" - }, - { - "description": "Venezuelan Bolívar", - "enum": [ - "vef" - ], - "type": "string" - }, - { - "description": "Vietnamese Đồng", - "enum": [ - "vnd" - ], - "type": "string" - }, - { - "description": "Vanuatu Vatu", - "enum": [ - "vuv" - ], - "type": "string" - }, - { - "description": "Samoan Tala", - "enum": [ - "wst" - ], - "type": "string" - }, - { - "description": "Central African Cfa Franc", - "enum": [ - "xaf" - ], - "type": "string" - }, - { - "description": "East Caribbean Dollar", - "enum": [ - "xcd" - ], - "type": "string" - }, - { - "description": "West African Cfa Franc", - "enum": [ - "xof" - ], - "type": "string" - }, - { - "description": "Cfp Franc", - "enum": [ - "xpf" - ], - "type": "string" - }, - { - "description": "Yemeni Rial", - "enum": [ - "yer" - ], - "type": "string" - }, - { - "description": "South African Rand", - "enum": [ - "zar" - ], - "type": "string" - }, - { - "description": "Zambian Kwacha", - "enum": [ - "zmw" - ], - "type": "string" - } - ] - }, - "CurveGetControlPoints": { - "description": "The response from the `CurveGetControlPoints` command.", - "properties": { - "control_points": { - "description": "Control points in the curve.", - "items": { - "$ref": "#/components/schemas/Point3d" - }, - "type": "array" - } - }, - "required": [ - "control_points" - ], - "type": "object" - }, - "CurveGetType": { - "description": "The response from the `CurveGetType` command.", - "properties": { - "curve_type": { - "allOf": [ - { - "$ref": "#/components/schemas/CurveType" - } - ], - "description": "Curve type" - } - }, - "required": [ - "curve_type" - ], - "type": "object" - }, - "CurveType": { - "description": "The type of Curve (embedded within path)", - "enum": [ - "line", - "nurbs" - ], - "type": "string" - }, - "Customer": { - "description": "The resource representing a payment \"Customer\".", - "properties": { - "address": { - "allOf": [ - { - "$ref": "#/components/schemas/NewAddress" - } - ], - "description": "The customer's address.", - "nullable": true - }, - "balance": { - "default": 0.0, - "description": "Current balance, if any, being stored on the customer in the payments service.\n\nIf negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized.", - "format": "money-usd", - "title": "Number", - "type": "number" - }, - "created_at": { - "description": "Time at which the object was created.", - "format": "date-time", - "type": "string" - }, - "currency": { - "allOf": [ - { - "$ref": "#/components/schemas/Currency" - } - ], - "default": "usd", - "description": "Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes." - }, - "delinquent": { - "default": false, - "description": "When the customer's latest invoice is billed by charging automatically, `delinquent` is `true` if the invoice's latest charge failed.\n\nWhen the customer's latest invoice is billed by sending an invoice, `delinquent` is `true` if the invoice isn't paid by its due date. If an invoice is marked uncollectible by dunning, `delinquent` doesn't get reset to `false`.", - "type": "boolean" - }, - "email": { - "description": "The customer's email address.", - "format": "email", - "type": "string" - }, - "id": { - "description": "Unique identifier for the object.", - "type": "string" - }, - "metadata": { - "additionalProperties": { - "type": "string" - }, - "default": {}, - "description": "Set of key-value pairs.", - "type": "object" - }, - "name": { - "description": "The customer's full name or business name.", + "metadata": { + "additionalProperties": { + "type": "string" + }, + "default": {}, + "description": "Set of key-value pairs.", + "type": "object" + }, + "name": { + "description": "The customer's full name or business name.", "type": "string" }, "phone": { @@ -5037,26 +2424,30 @@ "monthly_credits_remaining": { "description": "The monthy credits remaining in the balance. This gets re-upped every month, but if the credits are not used for a month they do not carry over to the next month. It is a stable amount granted to the user per month.", "format": "money-usd", - "title": "Number", - "type": "number" + "pattern": "^-?[0-9]+(\\.[0-9]+)?$", + "title": "Decimal", + "type": "string" }, "pre_pay_cash_remaining": { "description": "The amount of pre-pay cash remaining in the balance. This number goes down as the user uses their pre-paid credits. The reason we track this amount is if a user ever wants to withdraw their pre-pay cash, we can use this amount to determine how much to give them. Say a user has $100 in pre-paid cash, their bill is worth, $50 after subtracting any other credits (like monthly etc.) Their bill is $50, their pre-pay cash remaining will be subtracted by 50 to pay the bill and their `pre_pay_credits_remaining` will be subtracted by 50 to pay the bill. This way if they want to withdraw money after, they can only withdraw $50 since that is the amount of cash they have remaining.", "format": "money-usd", - "title": "Number", - "type": "number" + "pattern": "^-?[0-9]+(\\.[0-9]+)?$", + "title": "Decimal", + "type": "string" }, "pre_pay_credits_remaining": { "description": "The amount of credits remaining in the balance. This is typically the amount of cash * some multiplier they get for pre-paying their account. This number lowers every time a bill is paid with the balance. This number increases every time a user adds funds to their balance. This may be through a subscription or a one off payment.", "format": "money-usd", - "title": "Number", - "type": "number" + "pattern": "^-?[0-9]+(\\.[0-9]+)?$", + "title": "Decimal", + "type": "string" }, "total_due": { "description": "This includes any outstanding, draft, or open invoices and any pending invoice items. This does not include any credits the user has on their account.", "format": "money-usd", - "title": "Number", - "type": "number" + "pattern": "^-?[0-9]+(\\.[0-9]+)?$", + "title": "Decimal", + "type": "string" }, "updated_at": { "description": "The date and time the balance was last updated.", @@ -5167,365 +2558,9 @@ "description": "The coupon that applied to create this discount." } }, - "required": [ - "coupon" - ], - "type": "object" - }, - "DockerSystemInfo": { - "description": "Docker system info.", - "properties": { - "architecture": { - "description": "Hardware architecture of the host, as returned by the Go runtime (`GOARCH`). A full list of possible values can be found in the [Go documentation](https://golang.org/doc/install/source#environment).", - "nullable": true, - "type": "string" - }, - "bridge_nf_ip6tables": { - "description": "Indicates if `bridge-nf-call-ip6tables` is available on the host.", - "nullable": true, - "type": "boolean" - }, - "bridge_nf_iptables": { - "description": "Indicates if `bridge-nf-call-iptables` is available on the host.", - "nullable": true, - "type": "boolean" - }, - "cgroup_driver": { - "allOf": [ - { - "$ref": "#/components/schemas/SystemInfoCgroupDriverEnum" - } - ], - "description": "The driver to use for managing cgroups.", - "nullable": true - }, - "cgroup_version": { - "allOf": [ - { - "$ref": "#/components/schemas/SystemInfoCgroupVersionEnum" - } - ], - "description": "The version of the cgroup.", - "nullable": true - }, - "cluster_advertise": { - "description": "The network endpoint that the Engine advertises for the purpose of node discovery. ClusterAdvertise is a `host:port` combination on which the daemon is reachable by other hosts.\n\n**Deprecated**: This field is only propagated when using standalone Swarm mode, and overlay networking using an external k/v store. Overlay networks with Swarm mode enabled use the built-in raft store, and this field will be empty.", - "nullable": true, - "type": "string" - }, - "cluster_store": { - "description": "URL of the distributed storage backend. The storage backend is used for multihost networking (to store network and endpoint information) and by the node discovery mechanism.\n\n**Deprecated**: This field is only propagated when using standalone Swarm mode, and overlay networking using an external k/v store. Overlay networks with Swarm mode enabled use the built-in raft store, and this field will be empty.", - "nullable": true, - "type": "string" - }, - "containerd_commit": { - "allOf": [ - { - "$ref": "#/components/schemas/Commit" - } - ], - "nullable": true - }, - "containers": { - "description": "Total number of containers on the host.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "containers_paused": { - "description": "Number of containers with status `\\\"paused\\\"`.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "containers_running": { - "description": "Number of containers with status `\\\"running\\\"`.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "containers_stopped": { - "description": "Number of containers with status `\\\"stopped\\\"`.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "cpu_cfs_period": { - "description": "Indicates if CPU CFS(Completely Fair Scheduler) period is supported by the host.", - "nullable": true, - "type": "boolean" - }, - "cpu_cfs_quota": { - "description": "Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by the host.", - "nullable": true, - "type": "boolean" - }, - "cpu_set": { - "description": "Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host. See [cpuset(7)](https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.txt)", - "nullable": true, - "type": "boolean" - }, - "cpu_shares": { - "description": "Indicates if CPU Shares limiting is supported by the host.", - "nullable": true, - "type": "boolean" - }, - "debug": { - "description": "Indicates if the daemon is running in debug-mode / with debug-level logging enabled.", - "nullable": true, - "type": "boolean" - }, - "default_address_pools": { - "description": "List of custom default address pools for local networks, which can be specified in the daemon.json file or dockerd option. Example: a Base \\\"10.10.0.0/16\\\" with Size 24 will define the set of 256 10.10.[0-255].0/24 address pools.", - "items": { - "$ref": "#/components/schemas/SystemInfoDefaultAddressPools" - }, - "type": "array" - }, - "default_runtime": { - "description": "Name of the default OCI runtime that is used when starting containers. The default can be overridden per-container at create time.", - "nullable": true, - "type": "string" - }, - "docker_root_dir": { - "description": "Root directory of persistent Docker state. Defaults to `/var/lib/docker` on Linux, and `C:\\\\ProgramData\\\\docker` on Windows.", - "nullable": true, - "type": "string" - }, - "driver": { - "description": "Name of the storage driver in use.", - "nullable": true, - "type": "string" - }, - "driver_status": { - "description": "Information specific to the storage driver, provided as \\\"label\\\" / \\\"value\\\" pairs. This information is provided by the storage driver, and formatted in a way consistent with the output of `docker info` on the command line.\n\n**Note**: The information returned in this field, including the formatting of values and labels, should not be considered stable, and may change without notice.", - "items": { - "items": { - "type": "string" - }, - "type": "array" - }, - "type": "array" - }, - "experimental_build": { - "description": "Indicates if experimental features are enabled on the daemon.", - "nullable": true, - "type": "boolean" - }, - "http_proxy": { - "description": "HTTP-proxy configured for the daemon. This value is obtained from the [`HTTP_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration.", - "nullable": true, - "type": "string" - }, - "https_proxy": { - "description": "HTTPS-proxy configured for the daemon. This value is obtained from the [`HTTPS_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration.", - "nullable": true, - "type": "string" - }, - "id": { - "description": "Unique identifier of the daemon.\n\n**Note**: The format of the ID itself is not part of the API, and should not be considered stable.", - "nullable": true, - "type": "string" - }, - "images": { - "description": "Total number of images on the host. Both _tagged_ and _untagged_ (dangling) images are counted.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "index_server_address": { - "description": "Address / URL of the index server that is used for image search, and as a default for user authentication for Docker Hub and Docker Cloud.", - "nullable": true, - "type": "string" - }, - "init_binary": { - "description": "Name and, optional, path of the `docker-init` binary. If the path is omitted, the daemon searches the host's `$PATH` for the binary and uses the first result.", - "nullable": true, - "type": "string" - }, - "init_commit": { - "allOf": [ - { - "$ref": "#/components/schemas/Commit" - } - ], - "nullable": true - }, - "ipv4_forwarding": { - "description": "Indicates IPv4 forwarding is enabled.", - "nullable": true, - "type": "boolean" - }, - "isolation": { - "allOf": [ - { - "$ref": "#/components/schemas/SystemInfoIsolationEnum" - } - ], - "description": "Represents the isolation technology to use as a default for containers. The supported values are platform-specific. If no isolation value is specified on daemon start, on Windows client, the default is `hyperv`, and on Windows server, the default is `process`. This option is currently not used on other platforms.", - "nullable": true - }, - "kernel_memory": { - "description": "Indicates if the host has kernel memory limit support enabled.\n\n**Deprecated**: This field is deprecated as the kernel 5.4 deprecated `kmem.limit_in_bytes`.", - "nullable": true, - "type": "boolean" - }, - "kernel_memory_tcp": { - "description": "Indicates if the host has kernel memory TCP limit support enabled. Kernel memory TCP limits are not supported when using cgroups v2, which does not support the corresponding `memory.kmem.tcp.limit_in_bytes` cgroup.", - "nullable": true, - "type": "boolean" - }, - "kernel_version": { - "description": "Kernel version of the host. On Linux, this information obtained from `uname`. On Windows this information is queried from the HKEY_LOCAL_MACHINE\\\\\\\\SOFTWARE\\\\\\\\Microsoft\\\\\\\\Windows NT\\\\\\\\CurrentVersion\\\\\\\\ registry value, for example _\\\"10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)\\\"_.", - "nullable": true, - "type": "string" - }, - "labels": { - "description": "User-defined labels (key/value metadata) as set on the daemon.\n\n**Note**: When part of a Swarm, nodes can both have _daemon_ labels, set through the daemon configuration, and _node_ labels, set from a manager node in the Swarm. Node labels are not included in this field. Node labels can be retrieved using the `/nodes/(id)` endpoint on a manager node in the Swarm.", - "items": { - "type": "string" - }, - "type": "array" - }, - "live_restore_enabled": { - "description": "Indicates if live restore is enabled. If enabled, containers are kept running when the daemon is shutdown or upon daemon start if running containers are detected.", - "nullable": true, - "type": "boolean" - }, - "logging_driver": { - "description": "The logging driver to use as a default for new containers.", - "nullable": true, - "type": "string" - }, - "mem_total": { - "description": "Total amount of physical memory available on the host, in bytes.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "memory_limit": { - "description": "Indicates if the host has memory limit support enabled.", - "nullable": true, - "type": "boolean" - }, - "n_events_listener": { - "description": "Number of event listeners subscribed.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "n_fd": { - "description": "The total number of file Descriptors in use by the daemon process. This information is only returned if debug-mode is enabled.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "name": { - "description": "Hostname of the host.", - "nullable": true, - "type": "string" - }, - "ncpu": { - "description": "The number of logical CPUs usable by the daemon. The number of available CPUs is checked by querying the operating system when the daemon starts. Changes to operating system CPU allocation after the daemon is started are not reflected.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "no_proxy": { - "description": "Comma-separated list of domain extensions for which no proxy should be used. This value is obtained from the [`NO_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Containers do not automatically inherit this configuration.", - "nullable": true, - "type": "string" - }, - "oom_kill_disable": { - "description": "Indicates if OOM killer disable is supported on the host.", - "nullable": true, - "type": "boolean" - }, - "operating_system": { - "description": "Name of the host's operating system, for example: \\\"Ubuntu 16.04.2 LTS\\\" or \\\"Windows Server 2016 Datacenter\\\"", - "nullable": true, - "type": "string" - }, - "os_type": { - "description": "Generic type of the operating system of the host, as returned by the Go runtime (`GOOS`). Currently returned values are \\\"linux\\\" and \\\"windows\\\". A full list of possible values can be found in the [Go documentation](https://golang.org/doc/install/source#environment).", - "nullable": true, - "type": "string" - }, - "os_version": { - "description": "Version of the host's operating system\n\n**Note**: The information returned in this field, including its very existence, and the formatting of values, should not be considered stable, and may change without notice.", - "nullable": true, - "type": "string" - }, - "pids_limit": { - "description": "Indicates if the host kernel has PID limit support enabled.", - "nullable": true, - "type": "boolean" - }, - "plugins": { - "allOf": [ - { - "$ref": "#/components/schemas/PluginsInfo" - } - ], - "nullable": true - }, - "product_license": { - "description": "Reports a summary of the product license on the daemon. If a commercial license has been applied to the daemon, information such as number of nodes, and expiration are included.", - "nullable": true, - "type": "string" - }, - "registry_config": { - "allOf": [ - { - "$ref": "#/components/schemas/RegistryServiceConfig" - } - ], - "nullable": true - }, - "runc_commit": { - "allOf": [ - { - "$ref": "#/components/schemas/Commit" - } - ], - "nullable": true - }, - "runtimes": { - "additionalProperties": { - "$ref": "#/components/schemas/Runtime" - }, - "type": "object" - }, - "security_options": { - "description": "List of security features that are enabled on the daemon, such as apparmor, seccomp, SELinux, user-namespaces (userns), and rootless. Additional configuration options for each security feature may be present, and are included as a comma-separated list of key/value pairs.", - "items": { - "type": "string" - }, - "type": "array" - }, - "server_version": { - "description": "Version string of the daemon. **Note**: the [standalone Swarm API](https://docs.docker.com/swarm/swarm-api/) returns the Swarm version instead of the daemon version, for example `swarm/1.2.8`.", - "nullable": true, - "type": "string" - }, - "swap_limit": { - "description": "Indicates if the host has memory swap limit support enabled.", - "nullable": true, - "type": "boolean" - }, - "system_time": { - "description": "The number of goroutines that currently exist. This information is only returned if debug-mode is enabled.", - "nullable": true, - "type": "string" - }, - "warnings": { - "description": "List of warnings / informational messages about missing features, or issues related to the daemon configuration. These messages can be printed by the client as information to the user.", - "items": { - "type": "string" - }, - "type": "array" - } - }, + "required": [ + "coupon" + ], "type": "object" }, "EmailAuthenticationForm": { @@ -5548,60 +2583,6 @@ ], "type": "object" }, - "EngineMetadata": { - "description": "Metadata about our currently running server.\n\nThis is mostly used for internal purposes and debugging.", - "properties": { - "async_jobs_running": { - "description": "If any async job is currently running.", - "type": "boolean" - }, - "cache": { - "allOf": [ - { - "$ref": "#/components/schemas/CacheMetadata" - } - ], - "description": "Metadata about our cache." - }, - "environment": { - "allOf": [ - { - "$ref": "#/components/schemas/Environment" - } - ], - "description": "The environment we are running in." - }, - "fs": { - "allOf": [ - { - "$ref": "#/components/schemas/FileSystemMetadata" - } - ], - "description": "Metadata about our file system." - }, - "git_hash": { - "description": "The git hash of the server.", - "type": "string" - }, - "pubsub": { - "allOf": [ - { - "$ref": "#/components/schemas/Connection" - } - ], - "description": "Metadata about our pub-sub connection." - } - }, - "required": [ - "async_jobs_running", - "cache", - "environment", - "fs", - "git_hash", - "pubsub" - ], - "type": "object" - }, "EntityGetAllChildUuids": { "description": "The response from the `EntityGetAllChildUuids` command.", "properties": { @@ -5776,37 +2757,6 @@ } ] }, - "ExecutorMetadata": { - "description": "Metadata about our currently running server.\n\nThis is mostly used for internal purposes and debugging.", - "properties": { - "docker_info": { - "allOf": [ - { - "$ref": "#/components/schemas/DockerSystemInfo" - } - ], - "description": "Information about the docker daemon." - }, - "environment": { - "allOf": [ - { - "$ref": "#/components/schemas/Environment" - } - ], - "description": "The environment we are running in." - }, - "git_hash": { - "description": "The git hash of the server.", - "type": "string" - } - }, - "required": [ - "docker_info", - "environment", - "git_hash" - ], - "type": "object" - }, "Export": { "description": "The response from the `Export` endpoint.", "properties": { @@ -6866,34 +3816,6 @@ ], "type": "string" }, - "IndexInfo": { - "description": "IndexInfo contains information about a registry.", - "properties": { - "mirrors": { - "description": "List of mirrors, expressed as URIs.", - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name of the registry, such as \\\"docker.io\\\".", - "nullable": true, - "type": "string" - }, - "official": { - "description": "Indicates whether this is an official registry (i.e., Docker Hub / docker.io)", - "nullable": true, - "type": "boolean" - }, - "secure": { - "description": "Indicates if the registry is part of the list of insecure registries. If `false`, the registry is insecure. Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication.\n\n**Warning**: Insecure registries can be useful when running a local registry. However, because its use creates security vulnerabilities it should ONLY be enabled for testing purposes. For increased security, users should add their CA to their system's list of trusted CAs instead of enabling this option.", - "nullable": true, - "type": "boolean" - } - }, - "type": "object" - }, "InputFormat": { "description": "Input format specifier.", "oneOf": [ @@ -6950,7 +3872,7 @@ "$ref": "#/components/schemas/UnitLength" } ], - "description": "The units of the input data. This is very important for correct scaling and when calculating physics properties like mass, etc." + "description": "The units of the input data. This is very important for correct scaling and when calculating physics properties like mass, etc.\n\nDefaults to meters." } }, "required": [ @@ -7065,22 +3987,25 @@ "default": 0.0, "description": "Final amount due at this time for this invoice.\n\nIf the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`.", "format": "money-usd", - "title": "Number", - "type": "number" + "pattern": "^-?[0-9]+(\\.[0-9]+)?$", + "title": "Decimal", + "type": "string" }, "amount_paid": { "default": 0.0, "description": "The amount, in USD, that was paid.", "format": "money-usd", - "title": "Number", - "type": "number" + "pattern": "^-?[0-9]+(\\.[0-9]+)?$", + "title": "Decimal", + "type": "string" }, "amount_remaining": { "default": 0.0, "description": "The amount remaining, in USD, that is due.", "format": "money-usd", - "title": "Number", - "type": "number" + "pattern": "^-?[0-9]+(\\.[0-9]+)?$", + "title": "Decimal", + "type": "string" }, "attempt_count": { "default": 0, @@ -7187,22 +4112,25 @@ "default": 0.0, "description": "Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or tax is applied.\n\nItem discounts are already incorporated.", "format": "money-usd", - "title": "Number", - "type": "number" + "pattern": "^-?[0-9]+(\\.[0-9]+)?$", + "title": "Decimal", + "type": "string" }, "tax": { "default": 0.0, "description": "The amount of tax on this invoice.\n\nThis is the sum of all the tax amounts on this invoice.", "format": "money-usd", - "title": "Number", - "type": "number" + "pattern": "^-?[0-9]+(\\.[0-9]+)?$", + "title": "Decimal", + "type": "string" }, "total": { "default": 0.0, "description": "Total after discounts and taxes.", "format": "money-usd", - "title": "Number", - "type": "number" + "pattern": "^-?[0-9]+(\\.[0-9]+)?$", + "title": "Decimal", + "type": "string" }, "url": { "description": "The URL for the hosted invoice page, which allows customers to view and pay an invoice.", @@ -7223,8 +4151,9 @@ "default": 0.0, "description": "The amount, in USD.", "format": "money-usd", - "title": "Number", - "type": "number" + "pattern": "^-?[0-9]+(\\.[0-9]+)?$", + "title": "Decimal", + "type": "string" }, "currency": { "allOf": [ @@ -7539,14 +4468,6 @@ ], "description": "Metadata about our cache." }, - "engine": { - "allOf": [ - { - "$ref": "#/components/schemas/EngineMetadata" - } - ], - "description": "Metadata about our engine API connection." - }, "environment": { "allOf": [ { @@ -7555,14 +4476,6 @@ ], "description": "The environment we are running in." }, - "executor": { - "allOf": [ - { - "$ref": "#/components/schemas/ExecutorMetadata" - } - ], - "description": "Metadata about our executor API connection." - }, "fs": { "allOf": [ { @@ -7594,9 +4507,7 @@ }, "required": [ "cache", - "engine", "environment", - "executor", "fs", "git_hash", "point_e", @@ -8790,7 +5701,7 @@ }, "size": { "description": "What should the plane's span/extent? When rendered visually, this is both the width and height along X and Y axis respectively.", - "format": "float", + "format": "double", "type": "number" }, "type": { @@ -9093,6 +6004,36 @@ ], "type": "object" }, + { + "description": "Get curves for vertices within a path", + "properties": { + "path_id": { + "description": "Which path to query", + "format": "uuid", + "type": "string" + }, + "type": { + "enum": [ + "path_get_curve_uuids_for_vertices" + ], + "type": "string" + }, + "vertex_ids": { + "description": "IDs of the vertices for which to obtain curve ids from", + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "path_id", + "type", + "vertex_ids" + ], + "type": "object" + }, { "description": "Start dragging mouse.", "properties": { @@ -9196,156 +6137,163 @@ "type" ], "type": "object" - } - ] - }, - "ModelingCmdId": { - "description": "All commands have unique IDs. These should be randomly generated.", - "format": "uuid", - "type": "string" - }, - "ModelingCmdReq": { - "description": "A graphics command submitted to the KittyCAD engine via the Modeling API.", - "properties": { - "cmd": { - "allOf": [ - { - "$ref": "#/components/schemas/ModelingCmd" + }, + { + "description": "Adds a tangent arc from current pen position to the new position.", + "properties": { + "angle_snap_increment": { + "allOf": [ + { + "$ref": "#/components/schemas/Angle" + } + ], + "description": "0 will be interpreted as none/null.", + "nullable": true + }, + "to": { + "allOf": [ + { + "$ref": "#/components/schemas/Point3d" + } + ], + "description": "Where the arc should end. Must lie in the same plane as the current path pen position. Must not be colinear with current path pen position." + }, + "type": { + "enum": [ + "path_tangential_arc_to" + ], + "type": "string" } + }, + "required": [ + "to", + "type" ], - "description": "Which command to submit to the Kittycad engine." + "type": "object" }, - "cmd_id": { - "allOf": [ - { - "$ref": "#/components/schemas/ModelingCmdId" + { + "description": "Adds a tangent arc from current pen position with the given radius and angle.", + "properties": { + "offset": { + "allOf": [ + { + "$ref": "#/components/schemas/Angle" + } + ], + "description": "Offset of the arc." + }, + "radius": { + "description": "Radius of the arc. Not to be confused with Raiders of the Lost Ark.", + "format": "double", + "type": "number" + }, + "type": { + "enum": [ + "path_tangential_arc" + ], + "type": "string" } - ], - "description": "ID of command being submitted." - } - }, - "required": [ - "cmd", - "cmd_id" - ], - "type": "object" - }, - "ModelingCmdReqBatch": { - "description": "A batch set of graphics commands submitted to the KittyCAD engine via the Modeling API.", - "properties": { - "cmds": { - "additionalProperties": { - "$ref": "#/components/schemas/ModelingCmdReq" }, + "required": [ + "offset", + "radius", + "type" + ], "type": "object" - } - }, - "required": [ - "cmds" - ], - "type": "object" - }, - "ModelingError": { - "description": "Why a command submitted to the Modeling API failed.", - "properties": { - "error_code": { - "description": "A string error code which refers to a family of errors. E.g. \"InvalidInput\".", - "type": "string" - }, - "external_message": { - "description": "Describe the specific error which occurred. Will be shown to users, not logged.", - "type": "string" }, - "internal_message": { - "description": "Describe the specific error which occurred. Will be logged, not shown to users.", - "type": "string" - }, - "status_code": { - "description": "A HTTP status code.", - "format": "uint16", - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "error_code", - "external_message", - "internal_message", - "status_code" - ], - "type": "object" - }, - "ModelingOutcome": { - "description": "The result from one modeling command in a batch.", - "oneOf": [ { - "additionalProperties": false, - "description": "Each successful command has some result.", + "description": "Utility method. Performs both a ray cast and projection to plane-local coordinates. Returns the plane coordinates for the given window coordinates.", "properties": { - "success": { - "$ref": "#/components/schemas/OkModelingCmdResponse" + "plane_id": { + "description": "The plane you're intersecting against.", + "format": "uuid", + "type": "string" + }, + "type": { + "enum": [ + "plane_intersect_and_project" + ], + "type": "string" + }, + "window": { + "allOf": [ + { + "$ref": "#/components/schemas/Point2d" + } + ], + "description": "Window coordinates where the ray cast should be aimed." } }, "required": [ - "success" + "plane_id", + "type", + "window" ], "type": "object" }, { - "additionalProperties": false, - "description": "It failed. Why? See 'struct Error' above.", + "description": "Find the start and end of a curve.", "properties": { - "error": { - "$ref": "#/components/schemas/ModelingError" + "curve_id": { + "description": "ID of the curve being queried.", + "format": "uuid", + "type": "string" + }, + "type": { + "enum": [ + "curve_get_end_points" + ], + "type": "string" } }, "required": [ - "error" + "curve_id", + "type" ], "type": "object" }, { - "additionalProperties": false, - "description": "Cancelled because it required the output of a previous command, which failed.", + "description": "Reconfigure the stream.", "properties": { - "cancelled": { - "properties": { - "what_failed": { - "allOf": [ - { - "$ref": "#/components/schemas/ModelingCmdId" - } - ], - "description": "The ID of the command that failed, cancelling this command." - } - }, - "required": [ - "what_failed" + "fps": { + "description": "Frames per second.", + "format": "uint32", + "minimum": 0, + "type": "integer" + }, + "height": { + "description": "Height of the stream.", + "format": "uint32", + "minimum": 0, + "type": "integer" + }, + "type": { + "enum": [ + "reconfigure_stream" ], - "type": "object" + "type": "string" + }, + "width": { + "description": "Width of the stream.", + "format": "uint32", + "minimum": 0, + "type": "integer" } }, "required": [ - "cancelled" + "fps", + "height", + "type", + "width" ], "type": "object" } ] }, - "ModelingOutcomes": { - "description": "The result from a batch of modeling commands.", - "properties": { - "outcomes": { - "additionalProperties": { - "$ref": "#/components/schemas/ModelingOutcome" - }, - "type": "object" - } - }, - "required": [ - "outcomes" - ], - "type": "object" + "ModelingCmdId": { + "description": "All commands have unique IDs. These should be randomly generated.", + "format": "uuid", + "type": "string" }, "MouseClick": { "description": "The response from the `MouseClick` command.", @@ -9823,6 +6771,63 @@ "type" ], "type": "object" + }, + { + "description": "The response from the `Path Get Curve UUIDs for Vertices` command.", + "properties": { + "data": { + "$ref": "#/components/schemas/PathGetCurveUuidsForVertices" + }, + "type": { + "enum": [ + "path_get_curve_uuids_for_vertices" + ], + "type": "string" + } + }, + "required": [ + "data", + "type" + ], + "type": "object" + }, + { + "description": "The response from the `PlaneIntersectAndProject` command.", + "properties": { + "data": { + "$ref": "#/components/schemas/PlaneIntersectAndProject" + }, + "type": { + "enum": [ + "plane_intersect_and_project" + ], + "type": "string" + } + }, + "required": [ + "data", + "type" + ], + "type": "object" + }, + { + "description": "The response from the `CurveGetEndPoints` command.", + "properties": { + "data": { + "$ref": "#/components/schemas/CurveGetEndPoints" + }, + "type": { + "enum": [ + "curve_get_end_points" + ], + "type": "string" + } + }, + "required": [ + "data", + "type" + ], + "type": "object" } ] }, @@ -9986,6 +6991,25 @@ "type" ], "type": "object" + }, + { + "description": "Request a collection of metrics, to include WebRTC.", + "properties": { + "data": { + "type": "object" + }, + "type": { + "enum": [ + "metrics_request" + ], + "type": "string" + } + }, + "required": [ + "data", + "type" + ], + "type": "object" } ] }, @@ -10099,11 +7123,20 @@ "obj" ], "type": "string" + }, + "units": { + "allOf": [ + { + "$ref": "#/components/schemas/UnitLength" + } + ], + "description": "Export length unit.\n\nDefaults to meters." } }, "required": [ "coords", - "type" + "type", + "units" ], "type": "object" }, @@ -10188,12 +7221,21 @@ "stl" ], "type": "string" + }, + "units": { + "allOf": [ + { + "$ref": "#/components/schemas/UnitLength" + } + ], + "description": "Export length unit.\n\nDefaults to meters." } }, "required": [ "coords", "storage", - "type" + "type", + "units" ], "type": "object" } @@ -10210,6 +7252,23 @@ ], "type": "string" }, + "PathGetCurveUuidsForVertices": { + "description": "The response from the `PathGetCurveUuidsForVertices` command.", + "properties": { + "curve_ids": { + "description": "The UUIDs of the curve entities.", + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "curve_ids" + ], + "type": "object" + }, "PathGetInfo": { "description": "The response from the `PathGetInfo` command.", "properties": { @@ -10240,6 +7299,10 @@ ], "description": "End point of the line." }, + "relative": { + "description": "Whether or not this line is a relative offset", + "type": "boolean" + }, "type": { "enum": [ "line" @@ -10249,6 +7312,7 @@ }, "required": [ "end", + "relative", "type" ], "type": "object" @@ -10258,12 +7322,12 @@ "properties": { "angle_end": { "description": "Start of the arc along circle's perimeter.", - "format": "float", + "format": "double", "type": "number" }, "angle_start": { "description": "Start of the arc along circle's perimeter.", - "format": "float", + "format": "double", "type": "number" }, "center": { @@ -10276,9 +7340,13 @@ }, "radius": { "description": "Radius of the circle", - "format": "float", + "format": "double", "type": "number" }, + "relative": { + "description": "Whether or not this arc is a relative offset", + "type": "boolean" + }, "type": { "enum": [ "arc" @@ -10291,6 +7359,7 @@ "angle_start", "center", "radius", + "relative", "type" ], "type": "object" @@ -10322,6 +7391,10 @@ ], "description": "Final control point." }, + "relative": { + "description": "Whether or not this bezier is a relative offset", + "type": "boolean" + }, "type": { "enum": [ "bezier" @@ -10333,6 +7406,7 @@ "control1", "control2", "end", + "relative", "type" ], "type": "object" @@ -10358,10 +7432,15 @@ ], "description": "Which command created this path? This field is absent if the path command is not actually creating a path segment, e.g. moving the pen doesn't create a path segment.", "nullable": true + }, + "relative": { + "description": "Whether or not this segment is a relative offset", + "type": "boolean" } }, "required": [ - "command" + "command", + "relative" ], "type": "object" }, @@ -10461,36 +7540,17 @@ } ] }, - "PluginsInfo": { - "description": "Available plugins per type.\n\n**Note**: Only unmanaged (V1) plugins are included in this list. V1 plugins are \\\"lazily\\\" loaded, and are not returned in this list if there is no resource using the plugin.", + "PlaneIntersectAndProject": { + "description": "Corresponding coordinates of given window coordinates, intersected on given plane.", "properties": { - "authorization": { - "description": "Names of available authorization plugins.", - "items": { - "type": "string" - }, - "type": "array" - }, - "log": { - "description": "Names of available logging-drivers, and logging-driver plugins.", - "items": { - "type": "string" - }, - "type": "array" - }, - "network": { - "description": "Names of available network-drivers, and network-driver plugins.", - "items": { - "type": "string" - }, - "type": "array" - }, - "volume": { - "description": "Names of available volume-drivers, and network-driver plugins.", - "items": { - "type": "string" - }, - "type": "array" + "plane_coordinates": { + "allOf": [ + { + "$ref": "#/components/schemas/Point2d" + } + ], + "description": "Corresponding coordinates of given window coordinates, intersected on given plane.", + "nullable": true } }, "type": "object" @@ -10525,11 +7585,11 @@ "description": "A point in 2D space", "properties": { "x": { - "format": "float", + "format": "double", "type": "number" }, "y": { - "format": "float", + "format": "double", "type": "number" } }, @@ -10611,46 +7671,6 @@ ], "type": "object" }, - "RegistryServiceConfig": { - "description": "RegistryServiceConfig stores daemon registry services configuration.", - "properties": { - "allow_nondistributable_artifacts_cid_rs": { - "description": "List of IP ranges to which nondistributable artifacts can be pushed, using the CIDR syntax [RFC 4632](https://tools.ietf.org/html/4632). Some images (for example, Windows base images) contain artifacts whose distribution is restricted by license. When these images are pushed to a registry, restricted artifacts are not included. This configuration override this behavior, and enables the daemon to push nondistributable artifacts to all registries whose resolved IP address is within the subnet described by the CIDR syntax. This option is useful when pushing images containing nondistributable artifacts to a registry on an air-gapped network so hosts on that network can pull the images without connecting to another server.\n\n**Warning**: Nondistributable artifacts typically have restrictions on how and where they can be distributed and shared. Only use this feature to push artifacts to private registries and ensure that you are in compliance with any terms that cover redistributing nondistributable artifacts.", - "items": { - "type": "string" - }, - "type": "array" - }, - "allow_nondistributable_artifacts_hostnames": { - "description": "List of registry hostnames to which nondistributable artifacts can be pushed, using the format `[:]` or `[:]`. Some images (for example, Windows base images) contain artifacts whose distribution is restricted by license. When these images are pushed to a registry, restricted artifacts are not included. This configuration override this behavior for the specified registries. This option is useful when pushing images containing nondistributable artifacts to a registry on an air-gapped network so hosts on that network can pull the images without connecting to another server.\n\n**Warning**: Nondistributable artifacts typically have restrictions on how and where they can be distributed and shared. Only use this feature to push artifacts to private registries and ensure that you are in compliance with any terms that cover redistributing nondistributable artifacts.", - "items": { - "type": "string" - }, - "type": "array" - }, - "index_configs": { - "additionalProperties": { - "$ref": "#/components/schemas/IndexInfo" - }, - "type": "object" - }, - "insecure_registry_cid_rs": { - "description": "List of IP ranges of insecure registries, using the CIDR syntax ([RFC 4632](https://tools.ietf.org/html/4632)). Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication. By default, local registries (`127.0.0.0/8`) are configured as insecure. All other registries are secure. Communicating with an insecure registry is not possible if the daemon assumes that registry is secure. This configuration override this behavior, insecure communication with registries whose resolved IP address is within the subnet described by the CIDR syntax. Registries can also be marked insecure by hostname. Those registries are listed under `IndexConfigs` and have their `Secure` field set to `false`.\n\n**Warning**: Using this option can be useful when running a local registry, but introduces security vulnerabilities. This option should therefore ONLY be used for testing purposes. For increased security, users should add their CA to their system's list of trusted CAs instead of enabling this option.", - "items": { - "type": "string" - }, - "type": "array" - }, - "mirrors": { - "description": "List of registry URLs that act as a mirror for the official (`docker.io`) registry.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, "RtcIceCandidateInit": { "description": "ICECandidateInit is used to serialize ice candidates", "properties": { @@ -10743,24 +7763,6 @@ ], "type": "object" }, - "Runtime": { - "description": "Runtime describes an [OCI compliant](https://github.com/opencontainers/runtime-spec) runtime. The runtime is invoked by the daemon via the `containerd` daemon. OCI runtimes act as an interface to the Linux kernel namespaces, cgroups, and SELinux.", - "properties": { - "path": { - "description": "Name and, optional, path, of the OCI executable binary. If the path is omitted, the daemon searches the host's `$PATH` for the binary and uses the first result.", - "nullable": true, - "type": "string" - }, - "runtime_args": { - "description": "List of command-line arguments to pass to the runtime when invoked.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, "SceneSelectionType": { "description": "The type of scene selection change", "oneOf": [ @@ -11023,48 +8025,6 @@ ], "type": "object" }, - "SystemInfoCgroupDriverEnum": { - "enum": [ - "", - "cgroupfs", - "systemd", - "none" - ], - "type": "string" - }, - "SystemInfoCgroupVersionEnum": { - "enum": [ - "", - "1", - "2" - ], - "type": "string" - }, - "SystemInfoDefaultAddressPools": { - "properties": { - "base": { - "description": "The network address in CIDR format", - "nullable": true, - "type": "string" - }, - "size": { - "description": "The network pool size", - "format": "int64", - "nullable": true, - "type": "integer" - } - }, - "type": "object" - }, - "SystemInfoIsolationEnum": { - "enum": [ - "", - "default", - "hyperv", - "process" - ], - "type": "string" - }, "TakeSnapshot": { "description": "The response from the `TakeSnapshot` command.", "properties": { @@ -13154,6 +10114,30 @@ "type" ], "type": "object" + }, + { + "description": "The response to a metrics collection request from the server.", + "properties": { + "metrics": { + "allOf": [ + { + "$ref": "#/components/schemas/ClientMetrics" + } + ], + "description": "Collected metrics from the Client's end of the engine connection." + }, + "type": { + "enum": [ + "metrics_response" + ], + "type": "string" + } + }, + "required": [ + "metrics", + "type" + ], + "type": "object" } ] }, @@ -15857,257 +12841,6 @@ ] } }, - "/modeling/cmd": { - "options": { - "description": "This is necessary for some preflight requests, specifically POST, PUT, and DELETE.", - "operationId": "options_cmd", - "responses": { - "204": { - "description": "successful operation, no content", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error" - }, - "5XX": { - "$ref": "#/components/responses/Error" - } - }, - "summary": "OPTIONS endpoint.", - "tags": [ - "hidden" - ] - }, - "post": { - "description": "Response depends on which command was submitted, so unfortunately the OpenAPI schema can't generate the right response type.", - "operationId": "cmd", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ModelingCmdReq" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OkModelingCmdResponse" - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error" - }, - "5XX": { - "$ref": "#/components/responses/Error" - } - }, - "summary": "Submit one modeling operation.", - "tags": [ - "modeling", - "hidden" - ] - } - }, - "/modeling/cmd-batch": { - "options": { - "description": "This is necessary for some preflight requests, specifically POST, PUT, and DELETE.", - "operationId": "options_cmd_batch", - "responses": { - "204": { - "description": "successful operation, no content", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error" - }, - "5XX": { - "$ref": "#/components/responses/Error" - } - }, - "summary": "OPTIONS endpoint.", - "tags": [ - "hidden" - ] - }, - "post": { - "operationId": "cmd_batch", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ModelingCmdReqBatch" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ModelingOutcomes" - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error" - }, - "5XX": { - "$ref": "#/components/responses/Error" - } - }, - "summary": "Submit many modeling operations.", - "tags": [ - "modeling", - "hidden" - ] - } - }, "/oauth2/device/auth": { "options": { "description": "This is necessary for some preflight requests, specifically POST, PUT, and DELETE.",