@crvouga/mockingbird-service-paddle 2.0.0 → 2.1.0

package/openapi.yaml

@@ -1389,27 +1389,113 @@ paths:
     get:
       operationId: ListNotificationSettings
       x-mockingbird:
-        supported: false
-        reason: Notification destinations are configured on the mock (`--webhook-url`, `PUT /__admin/webhook-endpoints`), not through the API.
+        supported: true
+        parity:
+          enabled: true
+          safe: true
+      parameters:
+        - $ref: "#/components/parameters/After"
+        - $ref: "#/components/parameters/PerPage"
+        - $ref: "#/components/parameters/OrderBy"
       responses:
         "200":
-          description: Notification settings
+          description: Notification destinations, newest first. Secrets are not included.
           content:
             application/json:
               schema:
                 type: object
+                required: [data, meta]
+                properties:
+                  data:
+                    type: array
+                    items:
+                      $ref: "#/components/schemas/NotificationSetting"
+                  meta:
+                    $ref: "#/components/schemas/MetaPaginated"
+        "400":
+          $ref: "#/components/responses/BadRequest"
+        "403":
+          $ref: "#/components/responses/Forbidden"
     post:
       operationId: CreateNotificationSetting
       x-mockingbird:
-        supported: false
-        reason: Notification destinations are configured on the mock (`--webhook-url`, `PUT /__admin/webhook-endpoints`), not through the API.
+        supported: true
+        parity:
+          enabled: true
+          safe: false
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/NotificationSettingCreate"
       responses:
         "201":
-          description: The created notification setting
+          description: The created destination, including its endpoint secret
           content:
             application/json:
               schema:
-                type: object
+                $ref: "#/components/schemas/NotificationSettingResponse"
+        "400":
+          $ref: "#/components/responses/BadRequest"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+  /notification-settings/{notification_setting_id}:
+    parameters:
+      - name: notification_setting_id
+        in: path
+        required: true
+        schema:
+          type: string
+          x-mockingbird-resource-ref:
+            type: notification_setting
+            missing: ntfset_00000000000000000000000000
+    get:
+      operationId: GetNotificationSetting
+      x-mockingbird:
+        supported: true
+        parity:
+          enabled: true
+          safe: true
+      responses:
+        "200":
+          description: The notification destination, without its secret
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/NotificationSettingResponse"
+        "400":
+          $ref: "#/components/responses/BadRequest"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+        "404":
+          $ref: "#/components/responses/NotFound"
+    patch:
+      operationId: UpdateNotificationSetting
+      x-mockingbird:
+        supported: true
+        parity:
+          enabled: true
+          safe: false
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/NotificationSettingUpdate"
+      responses:
+        "200":
+          description: The updated destination. The existing secret stays valid and is not returned.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/NotificationSettingResponse"
+        "400":
+          $ref: "#/components/responses/BadRequest"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+        "404":
+          $ref: "#/components/responses/NotFound"
   /discounts:
     get:
       operationId: ListDiscounts
@@ -1466,15 +1552,29 @@ paths:
     post:
       operationId: CreateCustomerPortalSession
       x-mockingbird:
-        supported: false
-        reason: The hosted customer portal is not served; `management_urls` on a subscription point at placeholder links.
+        supported: true
+        parity:
+          enabled: true
+          safe: false
+      requestBody:
+        required: false
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/PortalSessionCreate"
       responses:
         "201":
-          description: The created portal session
+          description: The created portal session and its temporary https links
           content:
             application/json:
               schema:
-                type: object
+                $ref: "#/components/schemas/PortalSessionResponse"
+        "400":
+          $ref: "#/components/responses/BadRequest"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+        "404":
+          $ref: "#/components/responses/NotFound"
 components:
   securitySchemes:
     bearerAuth:
@@ -3043,3 +3143,230 @@ components:
           type: "null"
         data:
           type: object
+    NotificationEventName:
+      type: string
+      enum:
+        - customer.created
+        - customer.updated
+        - transaction.created
+        - transaction.updated
+        - transaction.paid
+        - transaction.completed
+        - subscription.created
+        - subscription.imported
+        - subscription.updated
+        - subscription.activated
+        - subscription.trialing
+        - subscription.past_due
+        - subscription.paused
+        - subscription.resumed
+        - subscription.canceled
+    NotificationEvent:
+      oneOf:
+        - $ref: "#/components/schemas/NotificationEventName"
+        - type: object
+          required: [name]
+          properties:
+            name:
+              $ref: "#/components/schemas/NotificationEventName"
+    NotificationDestination:
+      type: string
+      minLength: 1
+      maxLength: 200
+      pattern: "^(https://[A-Za-z0-9./_-]+|[A-Za-z0-9._+-]+@[A-Za-z0-9-]+(\\.[A-Za-z0-9-]+)+)$"
+    NotificationSetting:
+      type: object
+      required:
+        - id
+        - description
+        - type
+        - destination
+        - active
+        - api_version
+        - traffic_source
+        - include_sensitive_fields
+        - subscribed_events
+        - created_at
+        - updated_at
+      properties:
+        id:
+          type: string
+          x-mockingbird-resource:
+            type: notification_setting
+            identity: true
+          x-mockingbird-volatile:
+            kind: id
+        description:
+          type: string
+        type:
+          type: string
+          enum: [url, email]
+        destination:
+          type: string
+        active:
+          type: boolean
+        api_version:
+          type: integer
+        traffic_source:
+          type: string
+          enum: [platform, simulation, all]
+        include_sensitive_fields:
+          type: boolean
+        subscribed_events:
+          type: array
+          items:
+            type: object
+            required: [name]
+            properties:
+              name:
+                type: string
+        endpoint_secret_key:
+          type: string
+          description: Present on create only.
+          x-mockingbird-volatile:
+            kind: token
+        created_at:
+          $ref: "#/components/schemas/Timestamp"
+        updated_at:
+          $ref: "#/components/schemas/Timestamp"
+    NotificationSettingResponse:
+      type: object
+      required: [data, meta]
+      properties:
+        data:
+          $ref: "#/components/schemas/NotificationSetting"
+        meta:
+          $ref: "#/components/schemas/Meta"
+    NotificationSettingCreate:
+      type: object
+      required: [description, destination, type, subscribed_events]
+      properties:
+        description:
+          type: string
+          minLength: 1
+          maxLength: 200
+        destination:
+          $ref: "#/components/schemas/NotificationDestination"
+        type:
+          type: string
+          enum: [url, email]
+        active:
+          type: boolean
+        subscribed_events:
+          type: array
+          minItems: 1
+          maxItems: 20
+          items:
+            $ref: "#/components/schemas/NotificationEvent"
+        api_version:
+          type: integer
+          minimum: 1
+          maximum: 1
+        traffic_source:
+          type: string
+          enum: [platform, simulation, all]
+        include_sensitive_fields:
+          type: boolean
+    NotificationSettingUpdate:
+      type: object
+      properties:
+        description:
+          type: string
+          minLength: 1
+          maxLength: 200
+        destination:
+          $ref: "#/components/schemas/NotificationDestination"
+        type:
+          type: string
+          enum: [url, email]
+        active:
+          type: boolean
+        subscribed_events:
+          type: array
+          minItems: 1
+          maxItems: 20
+          items:
+            $ref: "#/components/schemas/NotificationEvent"
+        api_version:
+          type: integer
+          minimum: 1
+          maximum: 1
+        traffic_source:
+          type: string
+          enum: [platform, simulation, all]
+        include_sensitive_fields:
+          type: boolean
+    PortalSession:
+      type: object
+      required: [id, customer_id, urls, created_at]
+      properties:
+        id:
+          type: string
+          x-mockingbird-resource:
+            type: portal_session
+            identity: true
+          x-mockingbird-volatile:
+            kind: id
+        customer_id:
+          type: string
+          x-mockingbird-volatile:
+            kind: id
+        urls:
+          type: object
+          required: [general, subscriptions]
+          properties:
+            general:
+              type: object
+              required: [overview]
+              properties:
+                overview:
+                  type: string
+                  x-mockingbird-volatile:
+                    kind: url
+            subscriptions:
+              type: array
+              items:
+                type: object
+                required:
+                  - id
+                  - cancel_subscription
+                  - update_subscription_payment_method
+                  - update_subscription
+                properties:
+                  id:
+                    type: string
+                    x-mockingbird-volatile:
+                      kind: id
+                  cancel_subscription:
+                    type: string
+                    x-mockingbird-volatile:
+                      kind: url
+                  update_subscription_payment_method:
+                    type: string
+                    x-mockingbird-volatile:
+                      kind: url
+                  update_subscription:
+                    type: string
+                    x-mockingbird-volatile:
+                      kind: url
+        created_at:
+          $ref: "#/components/schemas/Timestamp"
+    PortalSessionResponse:
+      type: object
+      required: [data, meta]
+      properties:
+        data:
+          $ref: "#/components/schemas/PortalSession"
+        meta:
+          $ref: "#/components/schemas/Meta"
+    PortalSessionCreate:
+      type: object
+      properties:
+        subscription_ids:
+          type: array
+          maxItems: 20
+          items:
+            type: string
+            x-mockingbird-resource-ref:
+              type: subscription
+              missing: sub_00000000000000000000000000

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crvouga/mockingbird-service-paddle",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Stateful mock of the Paddle Billing API (customers, addresses, businesses, products, prices, transactions with computed totals, subscriptions with pause/resume/cancel and renewals, events) with Paddle-Signature webhooks and admin routes that simulate checkout, renewals and failed payments (Mockingbird service contract).",
   "license": "MIT",
   "type": "module",