@crvouga/mockingbird-service-customerio 2.1.0 → 2.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/server.js CHANGED
@@ -2,8 +2,8 @@ import {
2
2
  DEFAULT_PORT,
3
3
  createServer,
4
4
  serveTarget
5
- } from "./chunk-53O3NJZ5.js";
6
- import "./chunk-LFEHF77A.js";
5
+ } from "./chunk-E7RLJOZK.js";
6
+ import "./chunk-VG47BJN6.js";
7
7
  export {
8
8
  DEFAULT_PORT,
9
9
  createServer,
package/openapi.yaml CHANGED
@@ -313,6 +313,80 @@ paths:
313
313
  $ref: "#/components/responses/AppError"
314
314
  "404":
315
315
  $ref: "#/components/responses/AppError"
316
+ /v1/optouts:
317
+ get:
318
+ operationId: ListOptOuts
319
+ description: Sender-specific SMS and WhatsApp opt-outs, paginated by an opaque start cursor.
320
+ security:
321
+ - appApiKey: []
322
+ x-mockingbird:
323
+ supported: true
324
+ parity: { enabled: true, safe: true }
325
+ parameters:
326
+ - name: limit
327
+ in: query
328
+ schema: { type: integer, minimum: 1, maximum: 1000, default: 100 }
329
+ - name: start
330
+ in: query
331
+ schema: { type: string }
332
+ - name: from
333
+ in: query
334
+ schema: { type: string }
335
+ responses:
336
+ "200":
337
+ description: A page of opted-out customers
338
+ content:
339
+ application/json:
340
+ schema:
341
+ type: object
342
+ required: [optouts]
343
+ properties:
344
+ next: { type: string }
345
+ optouts:
346
+ type: array
347
+ items:
348
+ type: object
349
+ required: [customer_id, cio_id, optouts]
350
+ properties:
351
+ customer_id: { type: string }
352
+ cio_id: { type: string }
353
+ optouts:
354
+ type: array
355
+ items: { $ref: "#/components/schemas/SenderOptOut" }
356
+ "400": { $ref: "#/components/responses/AppError" }
357
+ "401": { $ref: "#/components/responses/AppError" }
358
+ /v1/customers/{customer_id}/optouts:
359
+ get:
360
+ operationId: GetCustomerOptOuts
361
+ description: Sender opt-outs for an existing person; marketing preferences are separate.
362
+ security:
363
+ - appApiKey: []
364
+ x-mockingbird:
365
+ supported: true
366
+ parity: { enabled: true, safe: true }
367
+ parameters:
368
+ - name: customer_id
369
+ in: path
370
+ required: true
371
+ schema: { type: string, minLength: 1 }
372
+ - name: id_type
373
+ in: query
374
+ schema: { type: string, enum: [id, email, cio_id], default: id }
375
+ responses:
376
+ "200":
377
+ description: The customer's sender opt-outs
378
+ content:
379
+ application/json:
380
+ schema:
381
+ type: object
382
+ required: [optouts]
383
+ properties:
384
+ optouts:
385
+ type: array
386
+ items: { $ref: "#/components/schemas/SenderOptOut" }
387
+ "400": { $ref: "#/components/responses/AppError" }
388
+ "401": { $ref: "#/components/responses/AppError" }
389
+ "404": { $ref: "#/components/responses/AppError" }
316
390
  /v1/messages/{message_id}:
317
391
  parameters:
318
392
  - name: message_id
@@ -439,6 +513,12 @@ components:
439
513
  error:
440
514
  type: string
441
515
  schemas:
516
+ SenderOptOut:
517
+ type: object
518
+ required: [channel, from]
519
+ properties:
520
+ channel: { type: string, enum: [sms, whatsapp] }
521
+ from: { type: string }
442
522
  CdpSuccess:
443
523
  type: object
444
524
  required: [success]
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@crvouga/mockingbird-service-customerio",
3
- "version": "2.1.0",
3
+ "version": "2.3.0",
4
4
  "description": "Stateful mock of Customer.io: Segment-compatible CDP (identify/track/batch, SDK drop-in), App API transactional email/SMS/inbox sends with an outbox, message catalog, link-click tracking, and signed reporting webhooks.",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -98,7 +98,7 @@
98
98
  "pack:check": "bun ../../../scripts/pack-check.ts"
99
99
  },
100
100
  "dependencies": {
101
- "@crvouga/mockingbird-service-sqlite": "2.1.0",
101
+ "@crvouga/mockingbird-service-sqlite": "2.1.1",
102
102
  "hono": "4.11.9"
103
103
  },
104
104
  "devDependencies": {