@remit/api-openapi-spec 0.0.38 → 0.0.39

package/openapi.json

@@ -1868,6 +1868,237 @@
         }
       }
     },
+    "/calendar-suggestions": {
+      "get": {
+        "operationId": "CalendarSuggestionOperations_listCalendarSuggestions",
+        "description": "List the caller's suggestions in one state, newest first. `Pending` is the set that is waiting on a person and the one a client normally asks for.",
+        "parameters": [
+          {
+            "name": "state",
+            "in": "query",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/RemitImap.CalendarSuggestionState"
+            }
+          },
+          {
+            "name": "continuationToken",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The request has succeeded.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "required": [
+                    "items"
+                  ],
+                  "properties": {
+                    "continuationToken": {
+                      "allOf": [
+                        {
+                          "$ref": "#/components/schemas/String800"
+                        }
+                      ],
+                      "description": "Opaque, server-minted cursor: absent means the first (or last) page, present means resume from here. Echo it back unchanged to fetch the next page. Every listing endpoint that accepts it rejects a token it cannot decode with 400 ValidationError rather than silently restarting from the first page (#136, #172)."
+                    },
+                    "items": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/RemitImap.CalendarSuggestionResponse"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Validation error response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ApiError"
+                }
+              }
+            }
+          }
+        },
+        "x-amazon-apigateway-integration": {
+          "type": "aws_proxy",
+          "httpMethod": "POST",
+          "passthroughBehavior": "when_no_match",
+          "uri": {
+            "Fn::Sub": "arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:{{HandlerFunctionName}}/invocations"
+          }
+        }
+      }
+    },
+    "/calendar-suggestions/{suggestionId}/accept": {
+      "post": {
+        "operationId": "CalendarSuggestionActionOperations_acceptCalendarSuggestion",
+        "description": "Add the suggested event to a calendar. One transaction: a VCALENDAR is\nbuilt from the invitation's own bytes, keeping its UID and SEQUENCE and\nmarking the user `ATTENDEE;PARTSTAT=ACCEPTED`, and written through the\nsame service function every other calendar write goes through — so a web\nedit and a native edit of that event cannot diverge. Accepting a `Cancel`\nsuggestion writes `STATUS:CANCELLED` on the resource the same way.\n\nNo reply is sent to the organizer. This endpoint sends no mail at all,\nand the card says so.\n\nIdempotent: accepting an already-accepted suggestion rewrites the same\nresource and returns the same suggestion, because both the resource id\nand the suggestion id are derived rather than minted.\n\n400 when the suggestion is not one that can be accepted — already\ndeclined, dismissed or superseded — or when its iCalendar will not parse.",
+        "parameters": [
+          {
+            "name": "suggestionId",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/UUID"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The request has succeeded.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RemitImap.CalendarSuggestionResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Validation error response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ApiError"
+                }
+              }
+            }
+          }
+        },
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/RemitImap.AcceptCalendarSuggestionInput"
+              }
+            }
+          }
+        },
+        "x-amazon-apigateway-integration": {
+          "type": "aws_proxy",
+          "httpMethod": "POST",
+          "passthroughBehavior": "when_no_match",
+          "uri": {
+            "Fn::Sub": "arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:{{HandlerFunctionName}}/invocations"
+          }
+        }
+      }
+    },
+    "/calendar-suggestions/{suggestionId}/decline": {
+      "post": {
+        "operationId": "CalendarSuggestionActionOperations_declineCalendarSuggestion",
+        "description": "Say no. Writes no calendar object and sends no reply to the organizer. Idempotent; 400 when the suggestion was already accepted, since a resource exists and declining would not remove it.",
+        "parameters": [
+          {
+            "name": "suggestionId",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/UUID"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The request has succeeded.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RemitImap.CalendarSuggestionResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Validation error response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ApiError"
+                }
+              }
+            }
+          }
+        },
+        "x-amazon-apigateway-integration": {
+          "type": "aws_proxy",
+          "httpMethod": "POST",
+          "passthroughBehavior": "when_no_match",
+          "uri": {
+            "Fn::Sub": "arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:{{HandlerFunctionName}}/invocations"
+          }
+        }
+      }
+    },
+    "/calendar-suggestions/{suggestionId}/dismiss": {
+      "post": {
+        "operationId": "CalendarSuggestionActionOperations_dismissCalendarSuggestion",
+        "description": "Wave the card away. Writes no calendar object. With `muteSender`, also writes a standing `Filter` rule on the message's sender so their invitations stop being offered. Idempotent; 400 when the suggestion was already accepted.",
+        "parameters": [
+          {
+            "name": "suggestionId",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/UUID"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The request has succeeded.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RemitImap.CalendarSuggestionResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Validation error response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ApiError"
+                }
+              }
+            }
+          }
+        },
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/RemitImap.DismissCalendarSuggestionInput"
+              }
+            }
+          }
+        },
+        "x-amazon-apigateway-integration": {
+          "type": "aws_proxy",
+          "httpMethod": "POST",
+          "passthroughBehavior": "when_no_match",
+          "uri": {
+            "Fn::Sub": "arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:{{HandlerFunctionName}}/invocations"
+          }
+        }
+      }
+    },
     "/calendars": {
       "get": {
         "operationId": "CalendarOperations_listCalendars",
@@ -2913,6 +3144,71 @@
         }
       }
     },
+    "/messages/{messageId}/calendar-suggestions": {
+      "get": {
+        "operationId": "MessageCalendarSuggestionOperations_listMessageCalendarSuggestions",
+        "description": "Every suggestion read out of one message, in whatever state each has reached — a superseded revision included, so the card can say which revision replaced it.",
+        "parameters": [
+          {
+            "name": "messageId",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/UUID"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The request has succeeded.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "required": [
+                    "items"
+                  ],
+                  "properties": {
+                    "continuationToken": {
+                      "allOf": [
+                        {
+                          "$ref": "#/components/schemas/String800"
+                        }
+                      ],
+                      "description": "Opaque, server-minted cursor: absent means the first (or last) page, present means resume from here. Echo it back unchanged to fetch the next page. Every listing endpoint that accepts it rejects a token it cannot decode with 400 ValidationError rather than silently restarting from the first page (#136, #172)."
+                    },
+                    "items": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/RemitImap.CalendarSuggestionResponse"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Validation error response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ApiError"
+                }
+              }
+            }
+          }
+        },
+        "x-amazon-apigateway-integration": {
+          "type": "aws_proxy",
+          "httpMethod": "POST",
+          "passthroughBehavior": "when_no_match",
+          "uri": {
+            "Fn::Sub": "arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:{{HandlerFunctionName}}/invocations"
+          }
+        }
+      }
+    },
     "/messages/{messageId}/flags": {
       "patch": {
         "operationId": "MessageOperations_updateMessageFlags",
@@ -3775,6 +4071,23 @@
           }
         }
       },
+      "RemitImap.AcceptCalendarSuggestionInput": {
+        "type": "object",
+        "required": [
+          "calendarId"
+        ],
+        "properties": {
+          "calendarId": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/UUID"
+              }
+            ],
+            "description": "Collection the accepted event is written into."
+          }
+        },
+        "description": "Body of `POST /calendar-suggestions/{suggestionId}/accept`. Names the collection the event is written into; there is no default, because filing someone else's invitation into a calendar the user did not pick is a decision the server does not get to make."
+      },
       "RemitImap.AccountAuthType": {
         "type": "string",
         "enum": [
@@ -5075,6 +5388,18 @@
         },
         "description": "One stretch of time the caller is busy in. Merged across every calendar they\nhold, so two overlapping meetings in two calendars are one span and a caller\nasking \"is this slot free\" never has to do the merging itself."
       },
+      "RemitImap.CalendarInviteMethod": {
+        "type": "string",
+        "enum": [
+          "Request",
+          "Reply",
+          "Cancel",
+          "Counter",
+          "Publish",
+          "None"
+        ],
+        "description": "The iTIP method a scheduling message carries (RFC 5546 3.2), read from the VCALENDAR's METHOD property. It says what the sender is asking for, which is not derivable from the VEVENT: a cancellation and an invitation differ by this property alone."
+      },
       "RemitImap.CalendarListResponse": {
         "type": "object",
         "required": [
@@ -5208,6 +5533,215 @@
         ],
         "description": "Where a calendar collection came from. `Default` is the one provisioned per account config on first use and is never deleted; `UserCreated` is one a person made; `MailDerived` is one populated from mail rather than by a person."
       },
+      "RemitImap.CalendarSuggestionResponse": {
+        "type": "object",
+        "required": [
+          "suggestionId",
+          "accountConfigId",
+          "messageId",
+          "bodyPartId",
+          "icalUid",
+          "sequence",
+          "method",
+          "source",
+          "state",
+          "summary",
+          "dtStart",
+          "dtEnd",
+          "allDay",
+          "location",
+          "organizer",
+          "zoneCertainty",
+          "acceptedCalendarObjectId",
+          "createdAt",
+          "updatedAt"
+        ],
+        "properties": {
+          "suggestionId": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/UUID"
+              }
+            ],
+            "description": "Primary identifier, derived from messageId + bodyPartId + icalUid",
+            "readOnly": true
+          },
+          "accountConfigId": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/UUID"
+              }
+            ],
+            "description": "Owning account configuration",
+            "readOnly": true
+          },
+          "messageId": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/UUID"
+              }
+            ],
+            "description": "Message this suggestion was read out of. The card is offered beside this message and nowhere else.",
+            "readOnly": true
+          },
+          "bodyPartId": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/UUID"
+              }
+            ],
+            "description": "MIME part the iCalendar bytes came from. Part of the identity, so two invitations in one message stay two suggestions rather than overwriting each other.",
+            "readOnly": true
+          },
+          "icalUid": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/String512"
+              }
+            ],
+            "description": "The VEVENT's UID property (RFC 5545 3.8.4.7). What ties a revision, a cancellation and the original invitation together across three separate messages.",
+            "readOnly": true
+          },
+          "sequence": {
+            "type": "integer",
+            "format": "int32",
+            "description": "The VEVENT's SEQUENCE property (RFC 5545 3.8.7.4) — the organizer's revision counter. A later message carrying the same `icalUid` with a higher value supersedes this one. `0` when the event declares none, which is the RFC default.",
+            "default": 0,
+            "readOnly": true
+          },
+          "method": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.CalendarInviteMethod"
+              }
+            ],
+            "description": "The iTIP method the VCALENDAR declared. `None` when it declared no METHOD.",
+            "default": "None",
+            "readOnly": true
+          },
+          "source": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.CalendarSuggestionSource"
+              }
+            ],
+            "description": "Where in the message this was read from",
+            "default": "IcalendarPart",
+            "readOnly": true
+          },
+          "state": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.CalendarSuggestionState"
+              }
+            ],
+            "description": "What has become of this suggestion. Only `Pending` asks the user for anything.",
+            "default": "Pending",
+            "readOnly": true
+          },
+          "summary": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/String512"
+              }
+            ],
+            "description": "Projection of the VEVENT's SUMMARY. `\"\"` when the event carries none.",
+            "readOnly": true
+          },
+          "dtStart": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/String64"
+              }
+            ],
+            "description": "Projection of the VEVENT's DTSTART as an ISO 8601 date-time with zone offset — a business date, not an epoch instant. An all-day event carries midnight in the event's own zone.",
+            "readOnly": true
+          },
+          "dtEnd": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/String64"
+              }
+            ],
+            "description": "Projection of the VEVENT's effective end as an ISO 8601 date-time with zone offset, resolved from DTEND or from DTSTART + DURATION. An event with neither ends when it starts (RFC 5545 3.6.1).",
+            "readOnly": true
+          },
+          "allDay": {
+            "type": "boolean",
+            "description": "Whether DTSTART is a DATE rather than a DATE-TIME (RFC 5545 3.3.4) — an all-day or multi-day event, whose end is exclusive.",
+            "default": false,
+            "readOnly": true
+          },
+          "location": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/String512"
+              }
+            ],
+            "description": "Projection of the VEVENT's LOCATION. `\"\"` when the event carries none.",
+            "default": "",
+            "readOnly": true
+          },
+          "organizer": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/String256"
+              }
+            ],
+            "description": "Mail address of the VEVENT's ORGANIZER, without the `mailto:` scheme. `\"\"` when the event names none — which is what a `PUBLISH` typically looks like, and why dismissing with `muteSender` mutes the message's sender rather than this field.",
+            "default": "",
+            "readOnly": true
+          },
+          "zoneCertainty": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.ZoneCertainty"
+              }
+            ],
+            "description": "How the DTSTART above was placed on the clock. `Ambiguous` means the invitation named a zone nothing could resolve, so the time shown may be hours out — a card says so rather than presenting a guess as a fact.",
+            "default": "Explicit",
+            "readOnly": true
+          },
+          "acceptedCalendarObjectId": {
+            "type": "string",
+            "description": "The `CalendarObject` that accepting this suggestion wrote. `\"\"` until it is accepted — the named absent state, never a missing attribute — and the resource's id afterwards, so the card can link to the event it produced.",
+            "default": "",
+            "readOnly": true
+          },
+          "createdAt": {
+            "type": "integer",
+            "format": "int64",
+            "readOnly": true
+          },
+          "updatedAt": {
+            "type": "integer",
+            "format": "int64",
+            "readOnly": true
+          }
+        },
+        "description": "A suggestion as the API returns it. The raw `icalData` is not surfaced: a client renders the projected fields, and the bytes exist so that accepting can write them into a calendar unchanged."
+      },
+      "RemitImap.CalendarSuggestionSource": {
+        "type": "string",
+        "enum": [
+          "IcalendarPart",
+          "IcalendarAttachment",
+          "TextHeuristic"
+        ],
+        "description": "Where in a message a suggestion was read from. It is what a card says to explain itself, and it is what separates a suggestion carrying real iCalendar from one inferred out of prose."
+      },
+      "RemitImap.CalendarSuggestionState": {
+        "type": "string",
+        "enum": [
+          "Pending",
+          "Accepted",
+          "Declined",
+          "Tentative",
+          "Dismissed",
+          "Superseded"
+        ],
+        "description": "What has become of a suggestion. `Pending` is the only state that asks a person for anything; every other value is a decision already taken, and nothing but an explicit act moves a suggestion out of `Pending`."
+      },
       "RemitImap.CalendarTransparency": {
         "type": "string",
         "enum": [
@@ -6049,6 +6583,20 @@
         },
         "description": "Complete message description including all related data. Body content is delivered via the per-part `BodyPartResponse.contentUrl` (CloudFront, JWT-authorized at the edge); the legacy `bodyText`/`bodyHtml` fields were removed once content delivery cut over end-to-end (#224)."
       },
+      "RemitImap.DismissCalendarSuggestionInput": {
+        "type": "object",
+        "required": [
+          "muteSender"
+        ],
+        "properties": {
+          "muteSender": {
+            "type": "boolean",
+            "description": "Also stop offering invitations from this message's sender, by writing a standing `Filter` rule. `false` dismisses this one card and nothing else.",
+            "default": false
+          }
+        },
+        "description": "Body of `POST /calendar-suggestions/{suggestionId}/dismiss`."
+      },
       "RemitImap.DisplayNameCorrespondence": {
         "type": "string",
         "enum": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/api-openapi-spec",
-  "version": "0.0.38",
+  "version": "0.0.39",
   "description": "Remit API OpenAPI 3 document, generated from TypeSpec.",
   "exports": {
     ".": "./openapi.json",