Merge pull request Vonage#82 from Nexmo/tony-reports-cs

Tony Bedford · web-flow · commit 6e160c39632c · 2020-06-11T13:52:02.000+01:00
Initial versions of Reports API v2 code snippets
diff --git a/config.sh b/config.sh
@@ -82,10 +82,20 @@ WEBHOOK_URL=${WEBHOOK_URL:-""}
 # MMS
 IMG_URL=${IMG_URL:-""}
 
-# Reporting
-REPORT_PRODUCT=${REPORT_PRODUCT:-""}
-REPORT_ID=${REPORT_ID:-""}
-REPORT=${REPORT_URL:-""}
+# Reports v2 API
+ACCOUNT_ID=${ACCOUNT_ID:-""}
+DATE_START=${DATE_START:-""}
+DATE_END=${DATE_END:-""}
+REPORT_DIRECTION=${DIRECTION:-""}
+REPORT_PRODUCT=${PRODUCT:-""}
+REPORT_STATUS=${REPORT_STATUS:-""}
+ID=${ID:-""}
+REQUEST_ID=${REQUEST_ID:-""}
+FILE_ID=${FILE_ID:-""}
+TYPE=${TYPE:-""}
+INCLUDE_SUBACCOUNTS=${INCLUDE_SUBACCOUNTS:-""}
+INCLUDE_MESSAGE=${INCLUDE_MESSAGE:-""}
+STATUS=${STATUS:-""}
 
 # Verify
 REQUEST_ID=${REQUEST_ID:-""}
diff --git a/reporting/check-report-status.sh b/reporting/check-report-status.sh
diff --git a/reporting/create-report.sh b/reporting/create-report.sh
diff --git a/reporting/download-report.sh b/reporting/download-report.sh
diff --git a/reports/cancel-report.sh b/reports/cancel-report.sh
@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+source "../config.sh"
+
+curl -X DELETE -u "$NEXMO_API_KEY:$NEXMO_API_SECRET" \
+     "https://api.nexmo.com/v2/reports/$REQUEST_ID"
diff --git a/reports/conversations/create-async-report.sh b/reports/conversations/create-async-report.sh
@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+source "../config.sh"
+
+curl -X POST "https://api.nexmo.com/v2/reports" \
+  -H 'Content-Type: application/json; charset=utf-8' \
+  -u "$NEXMO_API_KEY:$NEXMO_API_SECRET" \
+  -d $'{
+  "product": "CONVERSATIONS",
+  "account_id": "'$ACCOUNT_ID'",
+  "type": "'$TYPE'"
+}'
diff --git a/reports/conversations/load-records-sync.sh b/reports/conversations/load-records-sync.sh
@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+source "../config.sh"
+
+curl -G --data-urlencode date_start=$DATE_START --data-urlencode date_end=$DATE_END -u "$NEXMO_API_KEY:$NEXMO_API_SECRET" \
+     "https://api.nexmo.com/v2/reports/records?account_id=$ACCOUNT_ID&product=CONVERSATIONS&type=$TYPE"
diff --git a/reports/create-async-report.sh b/reports/create-async-report.sh
@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+
+source "../config.sh"
+
+curl -X POST "https://api.nexmo.com/v2/reports" \
+  -H 'Content-Type: application/json; charset=utf-8' \
+  -u "$NEXMO_API_KEY:$NEXMO_API_SECRET" \
+  -d $'{
+  "product": "'$REPORT_PRODUCT'",
+  "account_id": "'$ACCOUNT_ID'",
+  "direction": "'$REPORT_DIRECTION'",
+  "status": "'$STATUS'",
+  "date_start": "'$DATE_START'",
+  "date_end": "'$DATE_END'"
+}'
diff --git a/reports/get-report-status.sh b/reports/get-report-status.sh
@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+source "../config.sh"
+
+curl -u "$NEXMO_API_KEY:$NEXMO_API_SECRET" \
+     "https://api.nexmo.com/v2/reports/$REQUEST_ID"
diff --git a/reports/get-report.sh b/reports/get-report.sh
@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+source "../config.sh"
+
+curl -o report.zip -u "$NEXMO_API_KEY:$NEXMO_API_SECRET" \
+     "https://api.nexmo.com/v3/media/$FILE_ID"
diff --git a/reports/list-reports.sh b/reports/list-reports.sh
@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+source "../config.sh"
+
+curl -u "$NEXMO_API_KEY:$NEXMO_API_SECRET" \
+     "https://api.nexmo.com/v2/reports?account_id=$ACCOUNT_ID&status=$REPORT_STATUS"
diff --git a/reports/load-records-sync-dates.sh b/reports/load-records-sync-dates.sh
@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+source "../config.sh"
+
+curl -G --data-urlencode date_start=$DATE_START --data-urlencode date_end=$DATE_END -u "$NEXMO_API_KEY:$NEXMO_API_SECRET" \
+     "https://api.nexmo.com/v2/reports/records?account_id=$ACCOUNT_ID&product=$REPORT_PRODUCT&direction=$REPORT_DIRECTION"
diff --git a/reports/load-records-sync-id.sh b/reports/load-records-sync-id.sh
@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+source "../config.sh"
+
+curl -u "$NEXMO_API_KEY:$NEXMO_API_SECRET" \
+     "https://api.nexmo.com/v2/reports/records?account_id=$ACCOUNT_ID&product=$REPORT_PRODUCT&direction=$REPORT_DIRECTION&id=$ID"
diff --git a/reports/messages/create-async-report.sh b/reports/messages/create-async-report.sh
@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+source "../config.sh"
+
+curl -X POST "https://api.nexmo.com/v2/reports" \
+  -H 'Content-Type: application/json; charset=utf-8' \
+  -u "$NEXMO_API_KEY:$NEXMO_API_SECRET" \
+  -d $'{
+  "product": "MESSAGES",
+  "account_id": "'$ACCOUNT_ID'",
+  "direction": "'$REPORT_DIRECTION'",
+  "status": "'$REPORT_STATUS'",
+  "date_start": "'$DATE_START'",
+  "date_end": "'$DATE_END'",
+  "include_message": "'$INCLUDE_MESSAGE'"  
+}'
diff --git a/reports/messages/load-records-sync.sh b/reports/messages/load-records-sync.sh
@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+source "../config.sh"
+
+curl -G --data-urlencode date_start=$DATE_START --data-urlencode date_end=$DATE_END -u "$NEXMO_API_KEY:$NEXMO_API_SECRET" \
+     "https://api.nexmo.com/v2/reports/records?account_id=$ACCOUNT_ID&product=MESSAGES&direction=$REPORT_DIRECTION"
diff --git a/reports/number-insight/create-async-report.sh b/reports/number-insight/create-async-report.sh
@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+source "../config.sh"
+
+curl -X POST "https://api.nexmo.com/v2/reports" \
+  -H 'Content-Type: application/json; charset=utf-8' \
+  -u "$NEXMO_API_KEY:$NEXMO_API_SECRET" \
+  -d $'{
+  "product": "NUMBER-INSIGHT",
+  "account_id": "'$ACCOUNT_ID'"
+}'
diff --git a/reports/number-insight/load-records-sync.sh b/reports/number-insight/load-records-sync.sh
@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+source "../config.sh"
+
+curl -G --data-urlencode date_start=$DATE_START --data-urlencode date_end=$DATE_END -u "$NEXMO_API_KEY:$NEXMO_API_SECRET" \
+     "https://api.nexmo.com/v2/reports/records?account_id=$ACCOUNT_ID&product=NUMBER-INSIGHT"
diff --git a/reports/sms/create-async-report.sh b/reports/sms/create-async-report.sh
@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+
+source "../config.sh"
+
+curl -X POST "https://api.nexmo.com/v2/reports" \
+  -H 'Content-Type: application/json; charset=utf-8' \
+  -u "$NEXMO_API_KEY:$NEXMO_API_SECRET" \
+  -d $'{
+  "product": "SMS",
+  "account_id": "'$ACCOUNT_ID'",
+  "direction": "'$REPORT_DIRECTION'",
+  "status": "'$REPORT_STATUS'",
+  "date_start": "'$DATE_START'",
+  "date_end": "'$DATE_END'"
+}'
diff --git a/reports/sms/load-records-sync-dates.sh b/reports/sms/load-records-sync-dates.sh
@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+source "../config.sh"
+
+curl -G --data-urlencode date_start=$DATE_START --data-urlencode date_end=$DATE_END -u "$NEXMO_API_KEY:$NEXMO_API_SECRET" \
+     "https://api.nexmo.com/v2/reports/records?account_id=$ACCOUNT_ID&product=SMS&direction=$REPORT_DIRECTION"
diff --git a/reports/sms/load-records-sync-id.sh b/reports/sms/load-records-sync-id.sh
@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+source "../config.sh"
+
+curl -u "$NEXMO_API_KEY:$NEXMO_API_SECRET" \
+     "https://api.nexmo.com/v2/reports/records?account_id=$ACCOUNT_ID&product=SMS&direction=$REPORT_DIRECTION&id=$ID"
diff --git a/reports/verify-api/create-async-report.sh b/reports/verify-api/create-async-report.sh
@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+source "../config.sh"
+
+curl -X POST "https://api.nexmo.com/v2/reports" \
+    -H 'Content-Type: application/json; charset=utf-8' \
+    -u "$NEXMO_API_KEY:$NEXMO_API_SECRET" \
+    -d $'{
+  "product": "VERIFY-API",
+  "account_id": "'$ACCOUNT_ID'",
+  "include_subaccounts": "'$INCLUDE_SUBACCOUNTS'"
+}'
diff --git a/reports/verify-api/load-records-sync.sh b/reports/verify-api/load-records-sync.sh
@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+source "../config.sh"
+
+curl -G --data-urlencode date_start=$DATE_START --data-urlencode date_end=$DATE_END -u "$NEXMO_API_KEY:$NEXMO_API_SECRET" \
+     "https://api.nexmo.com/v2/reports/records?account_id=$ACCOUNT_ID&product=VERIFY-API"
diff --git a/reports/voice-call/create-async-report.sh b/reports/voice-call/create-async-report.sh
@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+source "../config.sh"
+
+curl -X POST "https://api.nexmo.com/v2/reports" \
+  -H 'Content-Type: application/json; charset=utf-8' \
+  -u "$NEXMO_API_KEY:$NEXMO_API_SECRET" \
+  -d $'{
+  "product": "VOICE-CALL",
+  "account_id": "'$ACCOUNT_ID'"
+}'
diff --git a/reports/voice-call/load-records-sync.sh b/reports/voice-call/load-records-sync.sh
@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+source "../config.sh"
+
+curl -G --data-urlencode date_start=$DATE_START --data-urlencode date_end=$DATE_END -u "$NEXMO_API_KEY:$NEXMO_API_SECRET" \
+     "https://api.nexmo.com/v2/reports/records?account_id=$ACCOUNT_ID&product=VOICE-CALL&direction=$REPORT_DIRECTION"
