addedOutput schema / $defs / Cover
Added value: +{
+ "additionalProperties": false,
+ "description": "The cover sheet as the customer typed it. Listed under untrusted.",
+ "properties": {
+ "from_email": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "title": "From Email"
+ },
+ "from_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "title": "From Name"
+ },
+ "message": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "title": "Message"
+ },
+ "subject": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "title": "Subject"
+ },
+ "to_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "title": "To Name"
+ }
+ },
+ "title": "Cover",
+ "type": "object"
+}
removedOutput schema / $defs / PolicyUsage
Removed value: -{
- "additionalProperties": true,
- "description": "What the deciding policy had counted before the send it was asked about, in UTC periods.",
- "properties": {
- "day_amount_micro": {
- "description": "The amount of those sends in micro-USD, as priced when the policy allowed each one. A fax that fails later still counts.",
- "title": "Day Amount Micro",
- "type": "integer"
- },
- "day_jobs": {
- "description": "Sends this policy allowed so far in the current UTC day.",
- "title": "Day Jobs",
- "type": "integer"
- },
- "month_amount_micro": {
- "description": "The amount of this month's sends in micro-USD, counted the same way as the day's.",
- "title": "Month Amount Micro",
- "type": "integer"
- },
- "month_jobs": {
- "description": "Sends this policy allowed so far in the current UTC month.",
- "title": "Month Jobs",
- "type": "integer"
- }
- },
- "required": [
- "day_jobs",
- "day_amount_micro",
- "month_jobs",
- "month_amount_micro"
- ],
- "title": "PolicyUsage",
- "type": "object"
-}
removedOutput schema / $defs / PolicyVerdict
Removed value: -{
- "additionalProperties": true,
- "description": "One evaluation of the delegated policies that bind a caller: the first policy that allows the plan,\nor every policy that denies it.",
- "properties": {
- "decision": {
- "enum": [
- "allow",
- "deny"
- ],
- "title": "Decision",
- "type": "string"
- },
- "denials": {
- "description": "Every policy that denied the plan, each with its policy_id, policy_version_id, decision, rule and reason. Empty on allow.",
- "items": {
- "additionalProperties": true,
- "type": "object"
- },
- "title": "Denials",
- "type": "array"
- },
- "managed": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "connected_apps when the organization's auto-send setting decided, else null.",
- "title": "Managed"
- },
- "policy_id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "The policy that allowed the plan, or the first one that denied it. Null when none binds.",
- "title": "Policy Id"
- },
- "policy_name": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "The name of that policy. Null when none binds.",
- "title": "Policy Name"
- },
- "policy_version_id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "The version of that policy that decided.",
- "title": "Policy Version Id"
- },
- "reason": {
- "description": "Why, in one sentence.",
- "title": "Reason",
- "type": "string"
- },
- "rule": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "The rule that failed first when a policy denied the plan. Null on allow, and when no policy binds the caller.",
- "title": "Rule"
- },
- "usage": {
- "anyOf": [
- {
- "$ref": "#/$defs/PolicyUsage"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "On allow: the deciding policy's counters for the day and the month before this send."
- },
- "version": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "description": "The number of that version: 1 for the policy's first rules, one more for each change. Null when none binds.",
- "title": "Version"
- }
- },
- "required": [
- "decision",
- "rule",
- "reason",
- "policy_id",
- "policy_version_id",
- "policy_name",
- "version",
- "denials"
- ],
- "title": "PolicyVerdict",
- "type": "object"
-}
changedOutput schema / $defs / Quote / additionalProperties
Previous value: -trueNew value: +false
removedOutput schema / $defs / Quote / properties / consumed_by_job_id
Removed value: -{
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Consumed By Job Id"
-}
changedOutput schema / $defs / Quote / properties / cover / anyOf
Previous value: -[
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
-]New value: +[
+ {
+ "$ref": "#/$defs/Cover"
+ },
+ {
+ "type": "null"
+ }
+]
addedOutput schema / $defs / Quote / properties / cover / default
Added value: +null
removedOutput schema / $defs / Quote / properties / cover / title
Removed value: -"Cover"
removedOutput schema / $defs / Quote / properties / created_at
Removed value: -{
- "title": "Created At",
- "type": "string"
-}
removedOutput schema / $defs / Quote / properties / live_amount_micro / description
Removed value: -"What the same fax costs with a live key, in micro-units. It is the billable pages at the live rate of the destination, priced by the rule a live quote uses. A test quote is free (amount_micro 0), and this field says what the fax would cost live. On a live quote it equals amount_micro. Null when the rate card in force is not the one the quote was priced on (price_version) or no longer serves the destination."
removedOutput schema / $defs / Quote / properties / policy_evaluation
Removed value: -{
- "anyOf": [
- {
- "$ref": "#/$defs/PolicyVerdict"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "The dry run of the delegated policies that bind the caller, made with the quote. Null when no policy binds the caller. The send evaluates the policies again, with their counters locked."
-}
removedOutput schema / $defs / Quote / properties / pricing / description
Removed value: -"per_page: priced from the rate card, paid from the wallet and sent with POST /v1/faxes. one_time: the quote of a one-time order, priced at the card's price for the order. Only the order sends it, and POST /v1/faxes refuses it with quote_pricing_mismatch."
removedOutput schema / $defs / Quote / properties / route_paused / description
Removed value: -"An operator has paused sends on this quote's route. A fax sent now is accepted and stays queued until the route is resumed. Read when the quote is answered, not stored."
addedOutput schema / $defs / Quote / properties / warnings / items / $ref
Added value: +"#/$defs/QuoteWarning"
removedOutput schema / $defs / Quote / properties / warnings / items / additionalProperties
Removed value: -true
removedOutput schema / $defs / Quote / properties / warnings / items / type
Removed value: -"object"
changedOutput schema / $defs / Quote / required
Previous value: -[
- "id",
- "environment",
- "document_id",
- "document_sha256",
- "to",
- "route",
- "document_pages",
- "cover_pages",
- "billable_pages",
- "amount_micro",
- "currency",
- "price_version",
- "cover",
- "authorization_required",
- "warnings",
- "expires_at",
- "expired",
- "consumed_by_job_id",
- "created_at"
-]New value: +[
+ "id",
+ "environment",
+ "document_id",
+ "document_sha256",
+ "document_pages",
+ "to",
+ "route",
+ "cover_pages",
+ "billable_pages",
+ "amount_micro",
+ "currency",
+ "price_version",
+ "authorization_required",
+ "expires_at",
+ "expired"
+]
removedOutput schema / $defs / QuotePolicy / properties / policy_version_id
Removed value: -{
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "title": "Policy Version Id"
-}
addedOutput schema / $defs / QuoteWarning
Added value: +{
+ "additionalProperties": false,
+ "properties": {
+ "code": {
+ "title": "Code",
+ "type": "string"
+ },
+ "message": {
+ "title": "Message",
+ "type": "string"
+ }
+ },
+ "required": [
+ "code",
+ "message"
+ ],
+ "title": "QuoteWarning",
+ "type": "object"
+}
changedOutput schema / properties / details / description
Previous value: -"The API's error details, when a refusal carries any. A field it names (details.field) is this tool's argument."New value: +"The API's error details, when a refusal carries any, cut to the keys in DETAIL_KEYS. A field it names (details.field) is this tool's argument."