changedOutput schema / $defs / Attempt / additionalProperties
Previous value: -trueNew value: +false
removedOutput schema / $defs / Attempt / properties / error
Removed value: -{
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Error"
-}
changedOutput schema / $defs / Attempt / properties / evidence / anyOf
Previous value: -[
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
-]New value: +[
+ {
+ "$ref": "#/$defs/Evidence"
+ },
+ {
+ "type": "null"
+ }
+]
addedOutput schema / $defs / Attempt / properties / evidence / default
Added value: +null
removedOutput schema / $defs / Attempt / properties / evidence / title
Removed value: -"Evidence"
addedOutput schema / $defs / Attempt / properties / failure_code / default
Added value: +null
removedOutput schema / $defs / Attempt / properties / fax_job_id
Removed value: -{
- "title": "Fax Job Id",
- "type": "string"
-}
removedOutput schema / $defs / Attempt / properties / finished_at
Removed value: -{
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Finished At"
-}
removedOutput schema / $defs / Attempt / properties / id
Removed value: -{
- "title": "Id",
- "type": "string"
-}
removedOutput schema / $defs / Attempt / properties / provider
Removed value: -{
- "title": "Provider",
- "type": "string"
-}
removedOutput schema / $defs / Attempt / properties / provider_ref
Removed value: -{
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Provider Ref"
-}
removedOutput schema / $defs / Attempt / properties / started_at
Removed value: -{
- "title": "Started At",
- "type": "string"
-}
changedOutput schema / $defs / Attempt / required
Previous value: -[
- "id",
- "fax_job_id",
- "attempt_number",
- "provider",
- "provider_ref",
- "status",
- "pages_sent",
- "failure_code",
- "evidence",
- "error",
- "started_at",
- "finished_at"
-]New value: +[
+ "attempt_number",
+ "status",
+ "pages_sent"
+]
addedOutput schema / $defs / Evidence
Added value: +{
+ "additionalProperties": false,
+ "description": "What the carrier reported about a delivered or partial fax, without its raw payload, its call ids\nand its signature material. The keys differ by carrier: each one keeps what it reports.",
+ "properties": {
+ "completed_at": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "title": "Completed At"
+ },
+ "from": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "title": "From"
+ },
+ "occurred_at": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "title": "Occurred At"
+ },
+ "page_count": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "title": "Page Count"
+ },
+ "pages_sent": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "title": "Pages Sent"
+ },
+ "pages_total": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "title": "Pages Total"
+ },
+ "provider": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "The carrier that reported it.",
+ "title": "Provider"
+ },
+ "quality": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "title": "Quality"
+ },
+ "remote_station_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "The receiving machine's station id, as it gave it. Listed under untrusted.",
+ "title": "Remote Station Id"
+ },
+ "status": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "title": "Status"
+ },
+ "to": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "title": "To"
+ }
+ },
+ "title": "Evidence",
+ "type": "object"
+}
changedOutput schema / $defs / FaxJob / additionalProperties
Previous value: -trueNew value: +false
removedOutput schema / $defs / FaxJob / properties / approval_id / description
Removed value: -"The approval request a person approved for this send. Null when another path authorized it: a delegated policy (policy_version_id), a test key no policy binds, or the payer's confirmation of a one-time order."
removedOutput schema / $defs / FaxJob / properties / cancel_requested_at
Removed value: -{
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Cancel Requested At"
-}
addedOutput schema / $defs / FaxJob / properties / client_reference / default
Added value: +null
addedOutput schema / $defs / FaxJob / properties / completed_at / default
Added value: +null
removedOutput schema / $defs / FaxJob / properties / direction
Removed value: -{
- "title": "Direction",
- "type": "string"
-}
removedOutput schema / $defs / FaxJob / properties / document_sha256
Removed value: -{
- "title": "Document Sha256",
- "type": "string"
-}
changedOutput schema / $defs / FaxJob / properties / evidence / anyOf
Previous value: -[
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
-]New value: +[
+ {
+ "$ref": "#/$defs/Evidence"
+ },
+ {
+ "type": "null"
+ }
+]
removedOutput schema / $defs / FaxJob / properties / evidence / description
Removed value: -"The carrier's evidence once delivered or partial; null before."
removedOutput schema / $defs / FaxJob / properties / evidence / title
Removed value: -"Evidence"
addedOutput schema / $defs / FaxJob / properties / failure_code / default
Added value: +null
removedOutput schema / $defs / FaxJob / properties / one_time
Removed value: -{
- "anyOf": [
- {
- "$ref": "#/$defs/OneTimeJob"
- },
- {
- "type": "null"
- }
- ],
- "default": null
-}
removedOutput schema / $defs / FaxJob / properties / one_time_order_id / description
Removed value: -"The one-time order this fax was paid by; null for a wallet fax."
removedOutput schema / $defs / FaxJob / properties / policy_version_id
Removed value: -{
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "The version of the delegated policy that allowed this send. A version never changes, so it shows the limits the send was allowed under. Null when no policy decided the send.",
- "title": "Policy Version Id"
-}
removedOutput schema / $defs / FaxJob / properties / provider
Removed value: -{
- "title": "Provider",
- "type": "string"
-}
removedOutput schema / $defs / FaxJob / properties / provider_ref
Removed value: -{
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Provider Ref"
-}
addedOutput schema / $defs / FaxJob / properties / quote_id / default
Added value: +null
addedOutput schema / $defs / FaxJob / properties / receipt_url
Added value: +{
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Once the fax has ended: the dashboard page with its receipt, for a signed-in person.",
+ "title": "Receipt Url"
+}
removedOutput schema / $defs / FaxJob / properties / route_paused / description
Removed value: -"An operator has paused sends on this fax's route while the fax waits for a line (queued or between tries). It goes out when the route is resumed. Read when the fax is read, not stored."
removedOutput schema / $defs / FaxJob / properties / transmitted_sha256
Removed value: -{
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Transmitted Sha256"
-}
removedOutput schema / $defs / FaxJob / properties / updated_at
Removed value: -{
- "title": "Updated At",
- "type": "string"
-}
changedOutput schema / $defs / FaxJob / required
Previous value: -[
- "id",
- "environment",
- "direction",
- "state",
- "failure_code",
- "to",
- "route",
- "document_id",
- "document_sha256",
- "transmitted_sha256",
- "quote_id",
- "billable_pages",
- "cover_pages",
- "pages_sent",
- "amount_micro",
- "captured_micro",
- "currency",
- "provider",
- "provider_ref",
- "client_reference",
- "attempt_count",
- "created_at",
- "updated_at",
- "completed_at",
- "cancel_requested_at"
-]New value: +[
+ "id",
+ "environment",
+ "state",
+ "to",
+ "route",
+ "document_id",
+ "billable_pages",
+ "cover_pages",
+ "pages_sent",
+ "amount_micro",
+ "captured_micro",
+ "currency",
+ "attempt_count",
+ "created_at"
+]
removedOutput schema / $defs / OneTimeCard
Removed value: -{
- "additionalProperties": true,
- "properties": {
- "brand": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Brand"
- },
- "last4": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Last4"
- }
- },
- "required": [
- "last4",
- "brand"
- ],
- "title": "OneTimeCard",
- "type": "object"
-}
removedOutput schema / $defs / OneTimeJob
Removed value: -{
- "additionalProperties": true,
- "description": "The order behind a fax job that a one-time send made: what was held on the card, what was charged.",
- "properties": {
- "amount_micro": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "title": "Amount Micro"
- },
- "authorized_at": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "On a receipt: when the card was held.",
- "title": "Authorized At"
- },
- "captured_micro": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "title": "Captured Micro"
- },
- "card": {
- "anyOf": [
- {
- "$ref": "#/$defs/OneTimeCard"
- },
- {
- "type": "null"
- }
- ],
- "default": null
- },
- "document_pages": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "The pages of the order's document. The cover sheet is not counted.",
- "title": "Document Pages"
- },
- "email": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "On a receipt: the address the order was made with.",
- "title": "Email"
- },
- "failure_code": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "On a receipt: why the order ended unpaid.",
- "title": "Failure Code"
- },
- "order_id": {
- "title": "Order Id",
- "type": "string"
- },
- "price": {
- "anyOf": [
- {
- "additionalProperties": {
- "type": "integer"
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "On a receipt: flat_micro, included_pages and extra_page_micro the amount follows from.",
- "title": "Price"
- },
- "refunded_micro": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "What was refunded to the card after the charge, in micro-units.",
- "title": "Refunded Micro"
- },
- "sender_name": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "On a receipt: the sender's name.",
- "title": "Sender Name"
- },
- "settled_at": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "On a receipt: when the payment provider confirmed the charge, or the release.",
- "title": "Settled At"
- },
- "status": {
- "anyOf": [
- {
- "enum": [
- "draft",
- "checkout_open",
- "authorized",
- "awaiting_confirmation",
- "released",
- "capturing",
- "canceling",
- "captured",
- "released_hold",
- "expired",
- "refused",
- "settle_failed",
- "refunding",
- "refunded",
- "canceled"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "title": "Status"
- }
- },
- "required": [
- "order_id"
- ],
- "title": "OneTimeJob",
- "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."