@voyant-travel/openapi 0.3.0 → 0.4.0

package/spec/admin/notifications.json

@@ -5,6 +5,12 @@
     "version": "0.0.0",
     "description": "Generated from the Voyant framework's standard module composition. Do not edit by hand."
   },
+  "servers": [
+    {
+      "url": "/",
+      "description": "This deployment (same origin)"
+    }
+  ],
   "components": {
     "schemas": {
       "CatalogSearchFilter": {
@@ -339,7 +345,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "getAdminNotificationsTemplates",
+        "summary": "GET /v1/admin/notifications/templates",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       },
       "post": {
         "requestBody": {
@@ -554,7 +567,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "postAdminNotificationsTemplates",
+        "summary": "POST /v1/admin/notifications/templates",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       }
     },
     "/v1/admin/notifications/templates/{id}": {
@@ -694,7 +714,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "getAdminNotificationsTemplatesById",
+        "summary": "GET /v1/admin/notifications/templates/{id}",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       },
       "patch": {
         "parameters": [
@@ -932,7 +959,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "patchAdminNotificationsTemplatesById",
+        "summary": "PATCH /v1/admin/notifications/templates/{id}",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       },
       "delete": {
         "parameters": [
@@ -967,7 +1001,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "deleteAdminNotificationsTemplatesById",
+        "summary": "DELETE /v1/admin/notifications/templates/{id}",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       }
     },
     "/v1/admin/notifications/preview": {
@@ -1117,7 +1158,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "postAdminNotificationsPreview",
+        "summary": "POST /v1/admin/notifications/preview",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       }
     },
     "/v1/admin/notifications/deliveries": {
@@ -1481,7 +1529,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "getAdminNotificationsDeliveries",
+        "summary": "GET /v1/admin/notifications/deliveries",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       }
     },
     "/v1/admin/notifications/deliveries/{id}": {
@@ -1724,7 +1779,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "getAdminNotificationsDeliveriesById",
+        "summary": "GET /v1/admin/notifications/deliveries/{id}",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       }
     },
     "/v1/admin/notifications/deliveries/{id}/resend": {
@@ -1985,7 +2047,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "postAdminNotificationsDeliveriesByIdResend",
+        "summary": "POST /v1/admin/notifications/deliveries/{id}/resend",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       }
     },
     "/v1/admin/notifications/reminder-rules": {
@@ -2194,7 +2263,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "getAdminNotificationsReminderRules",
+        "summary": "GET /v1/admin/notifications/reminder-rules",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       },
       "post": {
         "requestBody": {
@@ -2431,7 +2507,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "postAdminNotificationsReminderRules",
+        "summary": "POST /v1/admin/notifications/reminder-rules",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       }
     },
     "/v1/admin/notifications/reminder-rules/compose": {
@@ -2943,7 +3026,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "postAdminNotificationsReminderRulesCompose",
+        "summary": "POST /v1/admin/notifications/reminder-rules/compose",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       }
     },
     "/v1/admin/notifications/reminder-rules/{id}": {
@@ -3091,7 +3181,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "getAdminNotificationsReminderRulesById",
+        "summary": "GET /v1/admin/notifications/reminder-rules/{id}",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       },
       "patch": {
         "parameters": [
@@ -3350,7 +3447,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "patchAdminNotificationsReminderRulesById",
+        "summary": "PATCH /v1/admin/notifications/reminder-rules/{id}",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       },
       "delete": {
         "parameters": [
@@ -3385,7 +3489,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "deleteAdminNotificationsReminderRulesById",
+        "summary": "DELETE /v1/admin/notifications/reminder-rules/{id}",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       }
     },
     "/v1/admin/notifications/reminder-rules/{id}/stages": {
@@ -3539,7 +3650,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "getAdminNotificationsReminderRulesByIdStages",
+        "summary": "GET /v1/admin/notifications/reminder-rules/{id}/stages",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       },
       "post": {
         "parameters": [
@@ -3834,7 +3952,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "postAdminNotificationsReminderRulesByIdStages",
+        "summary": "POST /v1/admin/notifications/reminder-rules/{id}/stages",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       }
     },
     "/v1/admin/notifications/reminder-rules/{id}/stages/reorder": {
@@ -4030,7 +4155,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "postAdminNotificationsReminderRulesByIdStagesReorder",
+        "summary": "POST /v1/admin/notifications/reminder-rules/{id}/stages/reorder",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       }
     },
     "/v1/admin/notifications/reminder-rules/{id}/stages/{stageId}": {
@@ -4346,7 +4478,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "patchAdminNotificationsReminderRulesByIdStagesByStageId",
+        "summary": "PATCH /v1/admin/notifications/reminder-rules/{id}/stages/{stageId}",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       },
       "delete": {
         "parameters": [
@@ -4389,7 +4528,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "deleteAdminNotificationsReminderRulesByIdStagesByStageId",
+        "summary": "DELETE /v1/admin/notifications/reminder-rules/{id}/stages/{stageId}",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       }
     },
     "/v1/admin/notifications/reminder-rules/{id}/stages/{stageId}/channels": {
@@ -4511,7 +4657,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "getAdminNotificationsReminderRulesByIdStagesByStageIdChannels",
+        "summary": "GET /v1/admin/notifications/reminder-rules/{id}/stages/{stageId}/channels",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       },
       "post": {
         "parameters": [
@@ -4720,7 +4873,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "postAdminNotificationsReminderRulesByIdStagesByStageIdChannels",
+        "summary": "POST /v1/admin/notifications/reminder-rules/{id}/stages/{stageId}/channels",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       }
     },
     "/v1/admin/notifications/reminder-rules/{id}/stages/{stageId}/channels/{channelId}": {
@@ -4954,7 +5114,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "patchAdminNotificationsReminderRulesByIdStagesByStageIdChannelsByChannelId",
+        "summary": "PATCH /v1/admin/notifications/reminder-rules/{id}/stages/{stageId}/channels/{channelId}",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       },
       "delete": {
         "parameters": [
@@ -5005,7 +5172,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "deleteAdminNotificationsReminderRulesByIdStagesByStageIdChannelsByChannelId",
+        "summary": "DELETE /v1/admin/notifications/reminder-rules/{id}/stages/{stageId}/channels/{channelId}",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       }
     },
     "/v1/admin/notifications/notification-settings": {
@@ -5105,7 +5279,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "getAdminNotificationsNotificationSettings",
+        "summary": "GET /v1/admin/notifications/notification-settings",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       },
       "patch": {
         "requestBody": {
@@ -5304,7 +5485,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "patchAdminNotificationsNotificationSettings",
+        "summary": "PATCH /v1/admin/notifications/notification-settings",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       }
     },
     "/v1/admin/notifications/reminders/preview": {
@@ -5424,7 +5612,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "getAdminNotificationsRemindersPreview",
+        "summary": "GET /v1/admin/notifications/reminders/preview",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       }
     },
     "/v1/admin/notifications/reminder-runs": {
@@ -5874,7 +6069,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "getAdminNotificationsReminderRuns",
+        "summary": "GET /v1/admin/notifications/reminder-runs",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       }
     },
     "/v1/admin/notifications/reminder-runs/{id}": {
@@ -6201,7 +6403,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "getAdminNotificationsReminderRunsById",
+        "summary": "GET /v1/admin/notifications/reminder-runs/{id}",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       }
     },
     "/v1/admin/notifications/reminders/run-due": {
@@ -6263,7 +6472,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "postAdminNotificationsRemindersRunDue",
+        "summary": "POST /v1/admin/notifications/reminders/run-due",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       }
     },
     "/v1/admin/notifications/payment-sessions/{id}/send": {
@@ -6680,7 +6896,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "postAdminNotificationsPaymentSessionsByIdSend",
+        "summary": "POST /v1/admin/notifications/payment-sessions/{id}/send",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       }
     },
     "/v1/admin/notifications/invoices/{id}/send": {
@@ -7097,7 +7320,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "postAdminNotificationsInvoicesByIdSend",
+        "summary": "POST /v1/admin/notifications/invoices/{id}/send",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       }
     },
     "/v1/admin/notifications/bookings/{id}/document-bundle": {
@@ -7282,7 +7512,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "getAdminNotificationsBookingsByIdDocumentBundle",
+        "summary": "GET /v1/admin/notifications/bookings/{id}/document-bundle",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       }
     },
     "/v1/admin/notifications/bookings/{id}/confirm-and-dispatch": {
@@ -7740,7 +7977,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "postAdminNotificationsBookingsByIdConfirmAndDispatch",
+        "summary": "POST /v1/admin/notifications/bookings/{id}/confirm-and-dispatch",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       }
     },
     "/v1/admin/notifications/bookings/{id}/send-documents": {
@@ -7969,7 +8213,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "postAdminNotificationsBookingsByIdSendDocuments",
+        "summary": "POST /v1/admin/notifications/bookings/{id}/send-documents",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       }
     },
     "/v1/admin/notifications/send": {
@@ -8401,7 +8652,14 @@
               }
             }
           }
-        }
+        },
+        "operationId": "postAdminNotificationsSend",
+        "summary": "POST /v1/admin/notifications/send",
+        "tags": [
+          "notifications"
+        ],
+        "x-voyant-module": "notifications",
+        "x-voyant-surface": "admin"
       }
     }
   },