|
3350 | 3350 | }
|
3351 | 3351 | }
|
3352 | 3352 | },
|
3353 |
| - "/api/v2/subscribers/{subscriberId}/history": { |
| 3353 | + "/api/v2/subscribers/confirm": { |
3354 | 3354 | "get": {
|
3355 | 3355 | "tags": [
|
3356 | 3356 | "subscribers"
|
3357 | 3357 | ],
|
3358 |
| - "summary": "Get subscriber event history", |
3359 |
| - "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. ", |
3360 |
| - "operationId": "15830d2425a969a7482eefb114234d47", |
3361 |
| - "parameters": [ |
3362 |
| - { |
3363 |
| - "name": "php-auth-pw", |
3364 |
| - "in": "header", |
3365 |
| - "description": "Session key obtained from login", |
3366 |
| - "required": true, |
3367 |
| - "schema": { |
3368 |
| - "type": "string" |
3369 |
| - } |
3370 |
| - }, |
3371 |
| - { |
3372 |
| - "name": "subscriberId", |
3373 |
| - "in": "path", |
3374 |
| - "description": "Subscriber ID", |
3375 |
| - "required": true, |
3376 |
| - "schema": { |
3377 |
| - "type": "integer" |
3378 |
| - } |
3379 |
| - }, |
3380 |
| - { |
3381 |
| - "name": "after_id", |
3382 |
| - "in": "query", |
3383 |
| - "description": "Page number (pagination)", |
3384 |
| - "required": false, |
3385 |
| - "schema": { |
3386 |
| - "type": "integer", |
3387 |
| - "default": 1 |
3388 |
| - } |
3389 |
| - }, |
3390 |
| - { |
3391 |
| - "name": "limit", |
3392 |
| - "in": "query", |
3393 |
| - "description": "Max items per page", |
3394 |
| - "required": false, |
3395 |
| - "schema": { |
3396 |
| - "type": "integer", |
3397 |
| - "default": 25 |
3398 |
| - } |
3399 |
| - }, |
3400 |
| - { |
3401 |
| - "name": "ip", |
3402 |
| - "in": "query", |
3403 |
| - "description": "Filter by IP address", |
3404 |
| - "required": false, |
3405 |
| - "schema": { |
3406 |
| - "type": "string" |
3407 |
| - } |
3408 |
| - }, |
3409 |
| - { |
3410 |
| - "name": "date_from", |
3411 |
| - "in": "query", |
3412 |
| - "description": "Filter by date (format: Y-m-d)", |
3413 |
| - "required": false, |
3414 |
| - "schema": { |
3415 |
| - "type": "string", |
3416 |
| - "format": "date" |
3417 |
| - } |
3418 |
| - }, |
3419 |
| - { |
3420 |
| - "name": "summery", |
3421 |
| - "in": "query", |
3422 |
| - "description": "Filter by summary text", |
3423 |
| - "required": false, |
3424 |
| - "schema": { |
3425 |
| - "type": "string" |
| 3358 | + "summary": "Confirm a subscriber by uniqueId.", |
| 3359 | + "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.", |
| 3360 | + "operationId": "1e4d7709f3d02f54a4fe6a183b253140", |
| 3361 | + "requestBody": { |
| 3362 | + "required": true, |
| 3363 | + "content": { |
| 3364 | + "application/json": { |
| 3365 | + "schema": { |
| 3366 | + "properties": { |
| 3367 | + "uniqueId": { |
| 3368 | + "type": "string", |
| 3369 | + "example": "e9d8c9b2e6" |
| 3370 | + } |
| 3371 | + }, |
| 3372 | + "type": "object" |
| 3373 | + } |
3426 | 3374 | }
|
3427 | 3375 | }
|
3428 |
| - ], |
| 3376 | + }, |
3429 | 3377 | "responses": {
|
3430 | 3378 | "200": {
|
3431 |
| - "description": "Paginated list of subscriber events", |
| 3379 | + "description": "Subscriber confirmed", |
3432 | 3380 | "content": {
|
3433 |
| - "application/json": { |
3434 |
| - "schema": { |
3435 |
| - "properties": { |
3436 |
| - "items": { |
3437 |
| - "type": "array", |
3438 |
| - "items": { |
3439 |
| - "$ref": "#/components/schemas/SubscriberHistory" |
3440 |
| - } |
3441 |
| - }, |
3442 |
| - "pagination": { |
3443 |
| - "$ref": "#/components/schemas/CursorPagination" |
3444 |
| - } |
3445 |
| - }, |
3446 |
| - "type": "object" |
3447 |
| - } |
3448 |
| - } |
| 3381 | + "text/html": {} |
3449 | 3382 | }
|
3450 | 3383 | },
|
3451 |
| - "403": { |
3452 |
| - "description": "Unauthorized", |
3453 |
| - "content": { |
3454 |
| - "application/json": { |
3455 |
| - "schema": { |
3456 |
| - "$ref": "#/components/schemas/UnauthorizedResponse" |
3457 |
| - } |
3458 |
| - } |
3459 |
| - } |
| 3384 | + "400": { |
| 3385 | + "description": "Missing or invalid uniqueId" |
3460 | 3386 | },
|
3461 | 3387 | "404": {
|
3462 |
| - "description": "Not Found", |
3463 |
| - "content": { |
3464 |
| - "application/json": { |
3465 |
| - "schema": { |
3466 |
| - "$ref": "#/components/schemas/NotFoundErrorResponse" |
3467 |
| - } |
3468 |
| - } |
3469 |
| - } |
| 3388 | + "description": "Subscriber not found" |
3470 | 3389 | }
|
3471 | 3390 | }
|
3472 | 3391 | }
|
|
5055 | 4974 | }
|
5056 | 4975 | },
|
5057 | 4976 | "type": "object"
|
5058 |
| - }, |
5059 |
| - "SubscriberHistory": { |
5060 |
| - "properties": { |
5061 |
| - "id": { |
5062 |
| - "type": "integer", |
5063 |
| - "example": 1 |
5064 |
| - }, |
5065 |
| - "ip": { |
5066 |
| - "type": "string", |
5067 |
| - "example": "127.0.0.1" |
5068 |
| - }, |
5069 |
| - "created_at": { |
5070 |
| - "type": "string", |
5071 |
| - "format": "date-time", |
5072 |
| - "example": "2022-12-01T10:00:00Z" |
5073 |
| - }, |
5074 |
| - "summery": { |
5075 |
| - "type": "string", |
5076 |
| - "example": "Added by admin" |
5077 |
| - }, |
5078 |
| - "detail": { |
5079 |
| - "type": "string", |
5080 |
| - "example": "Added with add-email on test" |
5081 |
| - }, |
5082 |
| - "system_info": { |
5083 |
| - "type": "string", |
5084 |
| - "example": "HTTP_USER_AGENT = Mozilla/5.0" |
5085 |
| - } |
5086 |
| - }, |
5087 |
| - "type": "object" |
5088 | 4977 | }
|
5089 | 4978 | }
|
5090 | 4979 | },
|
|
0 commit comments