|
255 | 255 | } |
256 | 256 | } |
257 | 257 | }, |
258 | | - "/lists/{list}/members": { |
| 258 | + "/lists/{id}/subscribers": { |
259 | 259 | "get": { |
260 | 260 | "tags": [ |
261 | 261 | "lists" |
262 | 262 | ], |
263 | | - "summary": "Gets a list of all subscribers (members) of a subscriber list.", |
| 263 | + "summary": "Gets a list of all subscribers of a subscriber list.", |
264 | 264 | "description": "Returns a JSON list of all subscribers for a subscriber list.", |
265 | | - "operationId": "29f6848c27ee3e30b7e4bd7997c73a18", |
| 265 | + "operationId": "4758420770106043c526018727384dc0", |
266 | 266 | "parameters": [ |
267 | 267 | { |
268 | 268 | "name": "session", |
|
274 | 274 | } |
275 | 275 | }, |
276 | 276 | { |
277 | | - "name": "list", |
| 277 | + "name": "id", |
278 | 278 | "in": "path", |
279 | 279 | "description": "List ID", |
280 | 280 | "required": true, |
|
355 | 355 | } |
356 | 356 | } |
357 | 357 | }, |
358 | | - "/lists/{list}/count": { |
| 358 | + "/lists/{id}/count": { |
359 | 359 | "get": { |
360 | 360 | "tags": [ |
361 | 361 | "lists" |
362 | 362 | ], |
363 | 363 | "summary": "Gets the total number of subscribers of a list", |
364 | 364 | "description": "Returns a count of all subscribers in a given list.", |
365 | | - "operationId": "c1e2f17c0078014a816c914a25d8e889", |
| 365 | + "operationId": "55d76d7f22b445a9d9dd7ba38a3156cf", |
366 | 366 | "parameters": [ |
367 | 367 | { |
368 | 368 | "name": "session", |
|
374 | 374 | } |
375 | 375 | }, |
376 | 376 | { |
377 | | - "name": "list", |
| 377 | + "name": "id", |
378 | 378 | "in": "path", |
379 | 379 | "description": "List ID", |
380 | 380 | "required": true, |
|
559 | 559 | } |
560 | 560 | } |
561 | 561 | }, |
562 | | - "/subscriber": { |
| 562 | + "/subscribers": { |
563 | 563 | "post": { |
564 | 564 | "tags": [ |
565 | 565 | "subscribers" |
566 | 566 | ], |
567 | 567 | "summary": "Create a subscriber", |
568 | 568 | "description": "Creates a new subscriber (if there is no subscriber with the given email address yet).", |
569 | | - "operationId": "9dc1ae0a66e2eed292c4aed09bab8de0", |
| 569 | + "operationId": "e99d8d230dcb6ef5004ca48d716cd66b", |
570 | 570 | "parameters": [ |
571 | 571 | { |
572 | 572 | "name": "session", |
|
593 | 593 | "format": "string", |
594 | 594 | "example": "admin@example.com" |
595 | 595 | }, |
596 | | - "confirmed": { |
597 | | - "type": "boolean", |
598 | | - "example": false |
599 | | - }, |
600 | | - "blacklisted": { |
| 596 | + "request_confirmation": { |
601 | 597 | "type": "boolean", |
602 | 598 | "example": false |
603 | 599 | }, |
604 | 600 | "html_email": { |
605 | 601 | "type": "boolean", |
606 | 602 | "example": false |
607 | | - }, |
608 | | - "disabled": { |
609 | | - "type": "boolean", |
610 | | - "example": false |
611 | 603 | } |
612 | 604 | }, |
613 | 605 | "type": "object" |
|
715 | 707 | } |
716 | 708 | } |
717 | 709 | } |
| 710 | + }, |
| 711 | + "/subscribers/{subscriber}": { |
| 712 | + "get": { |
| 713 | + "tags": [ |
| 714 | + "subscribers" |
| 715 | + ], |
| 716 | + "summary": "Get a subscriber", |
| 717 | + "description": "Get subscriber date by id.", |
| 718 | + "operationId": "e44a0899dcd578274795f5899d6a9fa5", |
| 719 | + "parameters": [ |
| 720 | + { |
| 721 | + "name": "session", |
| 722 | + "in": "header", |
| 723 | + "description": "Session ID obtained from authentication", |
| 724 | + "required": true, |
| 725 | + "schema": { |
| 726 | + "type": "string" |
| 727 | + } |
| 728 | + }, |
| 729 | + { |
| 730 | + "name": "id", |
| 731 | + "in": "path", |
| 732 | + "description": "Subscriber ID", |
| 733 | + "required": true, |
| 734 | + "schema": { |
| 735 | + "type": "string" |
| 736 | + } |
| 737 | + } |
| 738 | + ], |
| 739 | + "responses": { |
| 740 | + "200": { |
| 741 | + "description": "Success", |
| 742 | + "content": { |
| 743 | + "application/json": { |
| 744 | + "schema": { |
| 745 | + "properties": { |
| 746 | + "creation_date": { |
| 747 | + "type": "string", |
| 748 | + "format": "date-time", |
| 749 | + "example": "2017-12-16T18:44:27+00:00" |
| 750 | + }, |
| 751 | + "email": { |
| 752 | + "type": "string", |
| 753 | + "example": "subscriber@example.com" |
| 754 | + }, |
| 755 | + "confirmed": { |
| 756 | + "type": "boolean", |
| 757 | + "example": false |
| 758 | + }, |
| 759 | + "blacklisted": { |
| 760 | + "type": "boolean", |
| 761 | + "example": false |
| 762 | + }, |
| 763 | + "bounced": { |
| 764 | + "type": "integer", |
| 765 | + "example": 0 |
| 766 | + }, |
| 767 | + "unique_id": { |
| 768 | + "type": "string", |
| 769 | + "example": "69f4e92cf50eafca9627f35704f030f4" |
| 770 | + }, |
| 771 | + "html_email": { |
| 772 | + "type": "boolean", |
| 773 | + "example": false |
| 774 | + }, |
| 775 | + "disabled": { |
| 776 | + "type": "boolean", |
| 777 | + "example": false |
| 778 | + }, |
| 779 | + "id": { |
| 780 | + "type": "integer", |
| 781 | + "example": 1 |
| 782 | + } |
| 783 | + }, |
| 784 | + "type": "object" |
| 785 | + } |
| 786 | + } |
| 787 | + } |
| 788 | + }, |
| 789 | + "403": { |
| 790 | + "description": "Failure", |
| 791 | + "content": { |
| 792 | + "application/json": { |
| 793 | + "schema": { |
| 794 | + "properties": { |
| 795 | + "message": { |
| 796 | + "type": "string", |
| 797 | + "example": "No valid session key was provided as basic auth password." |
| 798 | + } |
| 799 | + }, |
| 800 | + "type": "object" |
| 801 | + } |
| 802 | + } |
| 803 | + } |
| 804 | + }, |
| 805 | + "404": { |
| 806 | + "description": "Not Found" |
| 807 | + } |
| 808 | + } |
| 809 | + } |
718 | 810 | } |
719 | 811 | }, |
720 | 812 | "tags": [ |
|
0 commit comments