From 3f5bad1a9a9db08494400d639c6f58faf497f7c1 Mon Sep 17 00:00:00 2001 From: Kailash Nadh Date: Mon, 25 Nov 2024 10:20:08 +0530 Subject: [PATCH] Fix incorrent curl command in docs. --- docs/docs/content/apis/bounces.md | 6 ++--- docs/docs/content/apis/lists.md | 2 +- docs/docs/content/apis/media.md | 2 +- docs/docs/content/apis/subscribers.md | 32 +++++++++++++-------------- docs/docs/content/bounces.md | 2 +- 5 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/docs/content/apis/bounces.md b/docs/docs/content/apis/bounces.md index bcc13305a..9823c992a 100644 --- a/docs/docs/content/apis/bounces.md +++ b/docs/docs/content/apis/bounces.md @@ -94,7 +94,7 @@ To delete all bounces. ##### Example Request ```shell -curl -u curl -u 'api_username:access_token' -X DELETE 'http://localhost:9000/api/bounces?all=true' +curl -u 'api_username:access_token' -X DELETE 'http://localhost:9000/api/bounces?all=true' ``` ##### Example Response @@ -120,7 +120,7 @@ To delete multiple bounce records. ##### Example Request ```shell -curl -u curl -u 'api_username:access_token' -X DELETE 'http://localhost:9000/api/bounces?id=840965&id=840168&id=840879' +curl -u 'api_username:access_token' -X DELETE 'http://localhost:9000/api/bounces?id=840965&id=840168&id=840879' ``` ##### Example Response @@ -140,7 +140,7 @@ To delete specific bounce id. ##### Example Request ```shell -curl -u curl -u 'api_username:access_token' -X DELETE 'http://localhost:9000/api/bounces/840965' +curl -u 'api_username:access_token' -X DELETE 'http://localhost:9000/api/bounces/840965' ``` ##### Example Response diff --git a/docs/docs/content/apis/lists.md b/docs/docs/content/apis/lists.md index f89837242..ef62da22b 100644 --- a/docs/docs/content/apis/lists.md +++ b/docs/docs/content/apis/lists.md @@ -229,7 +229,7 @@ Delete a specific subscriber. ##### Example Request ```shell -curl -u curl -u 'api_username:access_token' -X DELETE 'http://localhost:9000/api/lists/1' +curl -u 'api_username:access_token' -X DELETE 'http://localhost:9000/api/lists/1' ``` ##### Example Response diff --git a/docs/docs/content/apis/media.md b/docs/docs/content/apis/media.md index 144e843ef..6f2654547 100644 --- a/docs/docs/content/apis/media.md +++ b/docs/docs/content/apis/media.md @@ -51,7 +51,7 @@ Retrieve a specific media. ##### Example Request ```shell -curl -u curl -u 'api_username:access_token' 'http://localhost:9000/api/media/7' +curl -u 'api_username:access_token' 'http://localhost:9000/api/media/7' ``` ##### Example Response diff --git a/docs/docs/content/apis/subscribers.md b/docs/docs/content/apis/subscribers.md index 707483552..2ac6529ff 100644 --- a/docs/docs/content/apis/subscribers.md +++ b/docs/docs/content/apis/subscribers.md @@ -40,15 +40,15 @@ Retrieve all subscribers. ##### Example Request ```shell -curl -u curl -u 'api_username:access_token' 'http://localhost:9000/api/subscribers?page=1&per_page=100' +curl -u 'api_username:access_token' 'http://localhost:9000/api/subscribers?page=1&per_page=100' ``` ```shell -curl -u curl -u 'api_username:access_token' 'http://localhost:9000/api/subscribers?list_id=1&list_id=2&page=1&per_page=100' +curl -u 'api_username:access_token' 'http://localhost:9000/api/subscribers?list_id=1&list_id=2&page=1&per_page=100' ``` ```shell -curl -u curl -u 'api_username:access_token' -X GET 'http://localhost:9000/api/subscribers' \ +curl -u 'api_username:access_token' -X GET 'http://localhost:9000/api/subscribers' \ --url-query 'page=1' \ --url-query 'per_page=100' \ --url-query "query=subscribers.name LIKE 'Test%' AND subscribers.attribs->>'city' = 'Bengaluru'" @@ -147,7 +147,7 @@ Retrieve a specific subscriber. ##### Example Request ```shell -curl -u curl -u 'api_username:access_token' 'http://localhost:9000/api/subscribers/1' +curl -u 'api_username:access_token' 'http://localhost:9000/api/subscribers/1' ``` ##### Example Response @@ -199,7 +199,7 @@ Export a specific subscriber data that gives profile, list subscriptions, campai ##### Example Request ```shell -curl -u curl -u 'api_username:access_token' 'http://localhost:9000/api/subscribers/1/export' +curl -u 'api_username:access_token' 'http://localhost:9000/api/subscribers/1/export' ``` ##### Example Response @@ -248,7 +248,7 @@ Get a specific subscriber bounce records. ##### Example Request ```shell -curl -u curl -u 'api_username:access_token' 'http://localhost:9000/api/subscribers/1/bounces' +curl -u 'api_username:access_token' 'http://localhost:9000/api/subscribers/1/bounces' ``` ##### Example Response @@ -312,7 +312,7 @@ Create a new subscriber. ##### Example Request ```shell -curl -u curl -u 'api_username:access_token' 'http://localhost:9000/api/subscribers' -H 'Content-Type: application/json' \ +curl -u 'api_username:access_token' 'http://localhost:9000/api/subscribers' -H 'Content-Type: application/json' \ --data '{"email":"subsriber@domain.com","name":"The Subscriber","status":"enabled","lists":[1],"attribs":{"city":"Bengaluru","projects":3,"stack":{"languages":["go","python"]}}}' ``` @@ -347,7 +347,7 @@ Sends optin confirmation email to subscribers. ##### Example Request ```shell -curl -u curl -u 'api_username:access_token' 'http://localhost:9000/api/subscribers/11/optin' -H 'Content-Type: application/json' \ +curl -u 'api_username:access_token' 'http://localhost:9000/api/subscribers/11/optin' -H 'Content-Type: application/json' \ --data {} ``` @@ -414,7 +414,7 @@ Modify subscriber list memberships. ##### Example Request ```shell -curl -u curl -u 'api_username:access_token' -X PUT 'http://localhost:9000/api/subscribers/lists' \ +curl -u 'api_username:access_token' -X PUT 'http://localhost:9000/api/subscribers/lists' \ -H 'Content-Type: application/json' \ --data-raw '{"ids": [1, 2, 3], "action": "add", "target_list_ids": [4, 5, 6], "status": "confirmed"}' ``` @@ -450,7 +450,7 @@ Blocklist a specific subscriber. ##### Example Request ```shell -curl -u curl -u 'api_username:access_token' -X PUT 'http://localhost:9000/api/subscribers/9/blocklist' +curl -u 'api_username:access_token' -X PUT 'http://localhost:9000/api/subscribers/9/blocklist' ``` ##### Example Response @@ -476,7 +476,7 @@ Blocklist multiple subscriber. ##### Example Request ```shell -curl -u curl -u 'api_username:access_token' -X PUT 'http://localhost:8080/api/subscribers/blocklist' -H 'Content-Type: application/json' --data-raw '{"ids":[2,1]}' +curl -u 'api_username:access_token' -X PUT 'http://localhost:8080/api/subscribers/blocklist' -H 'Content-Type: application/json' --data-raw '{"ids":[2,1]}' ``` ##### Example Response @@ -505,7 +505,7 @@ Blocklist subscribers based on SQL expression. ##### Example Request ```shell -curl -u curl -u 'api_username:access_token' -X POST 'http://localhost:9000/api/subscribers/query/blocklist' \ +curl -u 'api_username:access_token' -X POST 'http://localhost:9000/api/subscribers/query/blocklist' \ -H 'Content-Type: application/json' \ --data-raw '{"query":"subscribers.name LIKE \'John Doe\' AND subscribers.attribs->>'\''city'\'' = '\''Bengaluru'\''"}' ``` @@ -533,7 +533,7 @@ Delete a specific subscriber. ##### Example Request ```shell -curl -u curl -u 'api_username:access_token' -X DELETE 'http://localhost:9000/api/subscribers/9' +curl -u 'api_username:access_token' -X DELETE 'http://localhost:9000/api/subscribers/9' ``` ##### Example Response @@ -559,7 +559,7 @@ Delete a subscriber's bounce records ##### Example Request ```shell -curl -u curl -u 'api_username:access_token' -X DELETE 'http://localhost:9000/api/subscribers/9/bounces' +curl -u 'api_username:access_token' -X DELETE 'http://localhost:9000/api/subscribers/9/bounces' ``` ##### Example Response @@ -585,7 +585,7 @@ Delete one or more subscribers. ##### Example Request ```shell -curl -u curl -u 'api_username:access_token' -X DELETE 'http://localhost:9000/api/subscribers?id=10&id=11' +curl -u 'api_username:access_token' -X DELETE 'http://localhost:9000/api/subscribers?id=10&id=11' ``` ##### Example Response @@ -613,7 +613,7 @@ Delete subscribers based on SQL expression. ##### Example Request ```shell -curl -u curl -u 'api_username:access_token' -X POST 'http://localhost:9000/api/subscribers/query/delete' \ +curl -u 'api_username:access_token' -X POST 'http://localhost:9000/api/subscribers/query/delete' \ -H 'Content-Type: application/json' \ --data-raw '{"query":"subscribers.name LIKE \'John Doe\' AND subscribers.attribs->>'\''city'\'' = '\''Bengaluru'\''"}' ``` diff --git a/docs/docs/content/bounces.md b/docs/docs/content/bounces.md index e67e895fc..84d76418e 100644 --- a/docs/docs/content/bounces.md +++ b/docs/docs/content/bounces.md @@ -33,7 +33,7 @@ The bounce webhook API can be used to record bounce events with custom scripting ```shell -curl -u curl -u 'api_username:access_token' -X POST 'http://localhost:9000/webhooks/bounce' \ +curl -u 'api_username:access_token' -X POST 'http://localhost:9000/webhooks/bounce' \ -H "Content-Type: application/json" \ --data '{"email": "user1@mail.com", "campaign_uuid": "9f86b50d-5711-41c8-ab03-bc91c43d711b", "source": "api", "type": "hard", "meta": "{\"additional\": \"info\"}}'