tapimo 0.11.0 → 0.12.0

package/src/apps/management/routes/billing.test.ts

@@ -77,6 +77,215 @@ function createApp(
   })
 }
 
+test('publishes generator-ready OpenAPI contracts', async () => {
+  const spec = await (await createApp().request('/openapi.json')).json()
+  const billing = spec.paths['/v1/orgs/{orgId}/billing']
+  const checkout = spec.paths['/v1/orgs/{orgId}/billing/stripe/checkout'].post
+  const manage = spec.paths['/v1/orgs/{orgId}/billing/stripe/manage'].post
+  const methods = spec.paths['/v1/orgs/{orgId}/billing/payment-methods'].get
+  const remove = spec.paths['/v1/orgs/{orgId}/billing/payment-methods/{methodId}'].delete
+
+  expect({
+    checkout: {
+      errors: {
+        400: checkout.responses[400].content['application/json'].schema,
+        403: checkout.responses[403].content['application/json'].schema,
+        404: checkout.responses[404].content['application/json'].schema,
+        501: checkout.responses[501].content['application/json'].schema,
+      },
+      operationId: checkout.operationId,
+      response: checkout.responses[200].content['application/json'].schema,
+    },
+    components: [
+      'Billing',
+      'BillingPaymentMethod',
+      'BillingPaymentMethodList',
+      'BillingSession',
+      'BillingSpendLimit',
+      'BillingTransactionFeeLimit',
+      'UpdateBillingRequest',
+    ].filter((name) => spec.components.schemas[name]),
+    get: {
+      errors: {
+        400: billing.get.responses[400].content['application/json'].schema,
+        404: billing.get.responses[404].content['application/json'].schema,
+      },
+      operationId: billing.get.operationId,
+      response: billing.get.responses[200].content['application/json'].schema,
+    },
+    manage: {
+      errors: {
+        400: manage.responses[400].content['application/json'].schema,
+        403: manage.responses[403].content['application/json'].schema,
+        404: manage.responses[404].content['application/json'].schema,
+        501: manage.responses[501].content['application/json'].schema,
+      },
+      operationId: manage.operationId,
+      response: manage.responses[200].content['application/json'].schema,
+    },
+    methods: {
+      errors: {
+        400: methods.responses[400].content['application/json'].schema,
+        404: methods.responses[404].content['application/json'].schema,
+        501: methods.responses[501].content['application/json'].schema,
+      },
+      operationId: methods.operationId,
+      response: methods.responses[200].content['application/json'].schema,
+    },
+    remove: {
+      errors: {
+        400: remove.responses[400].content['application/json'].schema,
+        403: remove.responses[403].content['application/json'].schema,
+        404: remove.responses[404].content['application/json'].schema,
+        501: remove.responses[501].content['application/json'].schema,
+      },
+      operationId: remove.operationId,
+      response: remove.responses[200].content['application/json'].schema,
+    },
+    timestamps: {
+      billing: spec.components.schemas.Billing.properties.updatedAt.format,
+      paymentMethod: spec.components.schemas.BillingPaymentMethod.properties.createdAt.format,
+    },
+    update: {
+      errors: {
+        400: billing.patch.responses[400].content['application/json'].schema,
+        403: billing.patch.responses[403].content['application/json'].schema,
+        404: billing.patch.responses[404].content['application/json'].schema,
+      },
+      operationId: billing.patch.operationId,
+      request: billing.patch.requestBody.content['application/json'].schema,
+      response: billing.patch.responses[200].content['application/json'].schema,
+    },
+  }).toMatchInlineSnapshot(`
+    {
+      "checkout": {
+        "errors": {
+          "400": {
+            "$ref": "#/components/schemas/ApiKeyMalformedOrParamInvalidOrQueryInvalidError",
+          },
+          "403": {
+            "$ref": "#/components/schemas/ApiKeyForbiddenOrApiKeyIpForbiddenOrBillingSourceDisabledOrForbiddenError",
+          },
+          "404": {
+            "$ref": "#/components/schemas/OrganizationNotFoundError",
+          },
+          "501": {
+            "$ref": "#/components/schemas/NotImplementedError",
+          },
+        },
+        "operationId": "createStripeCheckout",
+        "response": {
+          "$ref": "#/components/schemas/BillingSession",
+        },
+      },
+      "components": [
+        "Billing",
+        "BillingPaymentMethod",
+        "BillingPaymentMethodList",
+        "BillingSession",
+        "BillingSpendLimit",
+        "BillingTransactionFeeLimit",
+        "UpdateBillingRequest",
+      ],
+      "get": {
+        "errors": {
+          "400": {
+            "$ref": "#/components/schemas/ApiKeyMalformedOrParamInvalidOrQueryInvalidError",
+          },
+          "404": {
+            "$ref": "#/components/schemas/OrganizationNotFoundError",
+          },
+        },
+        "operationId": "getBilling",
+        "response": {
+          "$ref": "#/components/schemas/Billing",
+        },
+      },
+      "manage": {
+        "errors": {
+          "400": {
+            "$ref": "#/components/schemas/ApiKeyMalformedOrParamInvalidOrQueryInvalidError",
+          },
+          "403": {
+            "$ref": "#/components/schemas/ForbiddenError",
+          },
+          "404": {
+            "$ref": "#/components/schemas/BillingNotFoundOrOrganizationNotFoundError",
+          },
+          "501": {
+            "$ref": "#/components/schemas/NotImplementedError",
+          },
+        },
+        "operationId": "createStripeManage",
+        "response": {
+          "$ref": "#/components/schemas/BillingSession",
+        },
+      },
+      "methods": {
+        "errors": {
+          "400": {
+            "$ref": "#/components/schemas/ApiKeyMalformedOrParamInvalidOrQueryInvalidError",
+          },
+          "404": {
+            "$ref": "#/components/schemas/OrganizationNotFoundError",
+          },
+          "501": {
+            "$ref": "#/components/schemas/NotImplementedError",
+          },
+        },
+        "operationId": "getBillingPaymentMethods",
+        "response": {
+          "$ref": "#/components/schemas/BillingPaymentMethodList",
+        },
+      },
+      "remove": {
+        "errors": {
+          "400": {
+            "$ref": "#/components/schemas/ApiKeyMalformedOrParamInvalidOrQueryInvalidError",
+          },
+          "403": {
+            "$ref": "#/components/schemas/ForbiddenError",
+          },
+          "404": {
+            "$ref": "#/components/schemas/BillingNotFoundOrOrganizationNotFoundOrPaymentMethodNotFoundError",
+          },
+          "501": {
+            "$ref": "#/components/schemas/NotImplementedError",
+          },
+        },
+        "operationId": "deleteBillingPaymentMethod",
+        "response": {
+          "$ref": "#/components/schemas/Billing",
+        },
+      },
+      "timestamps": {
+        "billing": "date-time",
+        "paymentMethod": "date-time",
+      },
+      "update": {
+        "errors": {
+          "400": {
+            "$ref": "#/components/schemas/ApiKeyMalformedOrBodyInvalidOrParamInvalidOrQueryInvalidError",
+          },
+          "403": {
+            "$ref": "#/components/schemas/ForbiddenError",
+          },
+          "404": {
+            "$ref": "#/components/schemas/OrganizationNotFoundError",
+          },
+        },
+        "operationId": "updateBilling",
+        "request": {
+          "$ref": "#/components/schemas/UpdateBillingRequest",
+        },
+        "response": {
+          "$ref": "#/components/schemas/Billing",
+        },
+      },
+    }
+  `)
+})
+
 /** RequestInit presenting the given token. */
 function as(token: string) {
   return { headers: { 'tempo-api-key': token } } as const