Update docs (#85)

Co-authored-by: Working Group Two Maintainers <[email protected]>

docs/intro-get-started.md

@@ -92,7 +92,7 @@ $ grpcui -protoset wgtwo.bin sandbox.api.wgtwo.com:443
 
 ## Production environment
 
-Our production environment is hosted at `api.wgtwo.com`.
+Our production environment is hosted at `api.{region}.wgtwo.com`, where all our regions are listed in the [overview of environments](https://v1.docs.wgtwo.com/reference/environments/).
 
 This part of the guide will show you how to create a OAuth 2.0 token and use that to connected to our event stream.
 
@@ -125,7 +125,7 @@ the stream will be silent until someone has given consent and sent an SMS.
 grpcurl -H "Authorization: Bearer ${ACCESS_TOKEN}" \
   -protoset wgtwo.bin \
   -d '{ "type": ["SMS_EVENT"] }' \
-  api.wgtwo.com:443 \
+  sandbox.api.wgtwo.com:443 \
   wgtwo.events.v0.EventsService.Subscribe
 ```
 

docs/metrics-how-to.md

@@ -28,7 +28,7 @@ See: [Get client access token](https://docs.wgtwo.com/guide/oauth2/get-client-ac
 ## Get metrics, curl
 
 ```shell script
-curl -s --oauth2-bearer $ACCESS_TOKEN https://api.wgtwo.com/metrics/v1
+curl -s --oauth2-bearer $ACCESS_TOKEN https://sandbox.api.wgtwo.com/metrics/v1
 ```
 
 ## Get metrics, Prometheus

docs/number-lookup-how-to.md

@@ -156,7 +156,7 @@ NumberLookupResponse {
 
 ### Keep-Alive
 
-The load balancer hosting api.wgtwo.com will silently drop connections if they have been idle for 350 seconds (5m 50s).
+The API Gateway hosting api.{region}.wgtwo.com (see [environments](https://v1.docs.wgtwo.com/reference/environments/) for list of regions) will silently drop connections if they have been idle for 350 seconds (5m 50s).
 
 To avoid this, the provider should send a keep-alive message every minute.
 

docs/subscriber-location-how-to.md

@@ -8,7 +8,7 @@ roles:
 # Get subscriber network information
 
 These APIs allow you to get network information regarding a subscription.
-In order to access this API your credentials need to have the `subscription.network:read` rights.
+In order to access this API your credentials need to have the `subscription.network_information:read` rights.
 
 ## `GetNetworkInfoForSubscriber`
 

examples/config/operator/metrics/prometheus.yml

@@ -17,6 +17,6 @@ scrape_configs:
 
     static_configs:
       - targets:
-          - "api.wgtwo.com:443" # Dublin
+          - "api.shamrock.wgtwo.com:443" # Dublin
           - "api.sakura.wgtwo.com:443" # Tokyo
           - "api.oak.wgtwo.com:443" # Oregon

examples/curl/operator/provision/disable-roaming-data.sh

@@ -1,3 +1,4 @@
+#!/usr/bin/env bash
 # Access token must be obtained via the client credentials flow
 curl -s \
     -H "Authorization: Bearer ${ACCESS_TOKEN}" \
@@ -11,4 +12,4 @@ curl -s \
         "msisdn": "46737678218"
     }
     ' \
-    https://api.wgtwo.com/provision/v2/update
+    https://sandbox.api.wgtwo.com/provision/v2/update

examples/curl/operator/provision/enable-roaming-data.sh

@@ -1,3 +1,4 @@
+#!/usr/bin/env bash
 # Access token must be obtained via the client credentials flow
 curl -s \
     -H "Authorization: Bearer ${ACCESS_TOKEN}" \
@@ -13,4 +14,4 @@ curl -s \
         "msisdn": "46737678218"
     }
     ' \
-    https://api.wgtwo.com/provision/v2/update
+    https://sandbox.api.wgtwo.com/provision/v2/update

examples/curl/operator/provision/get-subscription-info.sh

@@ -1,4 +1,5 @@
+#!/usr/bin/env bash
 # Access token must be obtained via the client credentials flow
 curl -s \
   -H "Authorization: Bearer ${ACCESS_TOKEN}" \
-  https://api.wgtwo.com/subscription/v2/msisdn/46737678218
+  https://sandbox.api.wgtwo.com/subscription/v2/msisdn/46737678218

examples/go/events/main.go

@@ -30,7 +30,7 @@ func main() {
 	}
 
 	conn, err := grpc.Dial(
-		"api.wgtwo.com:443",
+		"sandbox.api.wgtwo.com:443",
 		grpc.WithTransportCredentials(credentials.NewClientTLSFromCert(nil, "")),
 		grpc.WithPerRPCCredentials(
 			oauth.TokenSource{

examples/grpcurl/thirdpartydev/events/get-events.sh

@@ -1,3 +1,4 @@
+#!/usr/bin/env bash
 # Access token must be obtained via the client credentials flow
 grpcurl \
   -H "Authorization: Bearer ${ACCESS_TOKEN}"\
@@ -8,5 +9,5 @@ grpcurl \
     "type": ["VOICE_EVENT"]
   }
   ' \
-  api.wgtwo.com:443 \
+  sandbox.api.wgtwo.com:443 \
   wgtwo.events.v0.EventsService.Subscribe

examples/grpcurl/thirdpartydev/forwarding/conditional_to_number.sh

@@ -1,3 +1,4 @@
+#!/usr/bin/env bash
 grpcurl \
   -H "Authorization: Bearer ${ACCESS_TOKEN}"\
   -import-path . \
@@ -9,5 +10,5 @@ grpcurl \
           "unavailable": { "e164": "+4672xxxxxxx"}
         }
       }' \
-  api.wgtwo.com:443 \
+  sandbox.api.wgtwo.com:443 \
   wgtwo.callforward.v0.CallForwardingService/SetToNumber

examples/grpcurl/thirdpartydev/forwarding/conditional_to_voicemail.sh

@@ -1,3 +1,4 @@
+#!/usr/bin/env bash
 grpcurl \
   -H "Authorization: Bearer ${ACCESS_TOKEN}"\
   -import-path . \
@@ -10,5 +11,5 @@ grpcurl \
           "no_reply": { "e164": "+4672xxxxxxx"}
         }
       }' \
-  api.wgtwo.com:443 \
+  sandbox.api.wgtwo.com:443 \
   wgtwo.callforward.v0.CallForwardingService/SetToVoicemail

examples/grpcurl/thirdpartydev/forwarding/disable.sh

@@ -1,9 +1,10 @@
+#!/usr/bin/env bash
 grpcurl \
   -H "Authorization: Bearer ${ACCESS_TOKEN}"\
   -import-path . \
   -proto wgtwo/callforward/v0/callforward.proto \
   -d '{
         "subscriber": { "e164": "+4672xxxxxxx"}
       }' \
-  api.wgtwo.com:443 \
+  sandbox.api.wgtwo.com:443 \
   wgtwo.callforward.v0.CallForwardingService/Disable

examples/grpcurl/thirdpartydev/forwarding/unconditional_to_number.sh

@@ -1,3 +1,4 @@
+#!/usr/bin/env bash
 grpcurl \
   -H "Authorization: Bearer ${ACCESS_TOKEN}"\
   -import-path . \
@@ -8,5 +9,5 @@ grpcurl \
           "forward_to_number": { "e164": "+4672xxxxxxx"}
         }
       }' \
-  api.wgtwo.com:443 \
+  sandbox.api.wgtwo.com:443 \
   wgtwo.callforward.v0.CallForwardingService/SetToNumber

examples/grpcurl/thirdpartydev/forwarding/unconditional_to_trunk.sh

@@ -1,3 +1,4 @@
+#!/usr/bin/env bash
 grpcurl \
   -H "Authorization: Bearer ${ACCESS_TOKEN}"\
   -import-path . \
@@ -8,5 +9,5 @@ grpcurl \
           "forward_to_trunk": { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}
         }
       }' \
-  api.wgtwo.com:443 \
+  sandbox.api.wgtwo.com:443 \
   wgtwo.callforward.v0.CallForwardingService/SetToTrunk

examples/grpcurl/thirdpartydev/number-lookup/provider.sh

@@ -5,7 +5,7 @@ curl -sL 'https://github.com/working-group-two/wgtwoapis/blob/master/image.bin?r
 
 # Access token must be obtained via the client credentials flow
 ACCESS_TOKEN=$(
-  curl -s -u $CLIENT_ID:$CLIENT_SECRET \
+  curl -s -u "${CLIENT_ID}:${CLIENT_SECRET}" \
     --request POST \
     --url 'https://id.wgtwo.com/oauth2/token' \
     --header 'content-type: application/x-www-form-urlencoded' \
@@ -31,7 +31,7 @@ grpcurl \
    -H "Authorization: Bearer $ACCESS_TOKEN" \
    -protoset wgtwo.bin \
    -d @ \
-   api.wgtwo.com:443 \
+   sandbox.api.wgtwo.com:443 \
    wgtwo.lookup.v0.NumberLookupService/NumberLookup <&3 \
 | while IFS= read -r LINE; do
     # grpcurl sends output line by line, so we buffer until we have a valid JSON object.

examples/grpcurl/thirdpartydev/sipbreakout/register.sh

@@ -1,3 +1,4 @@
+#!/usr/bin/env bash
 # Access token must be obtained via the client credentials flow
 grpcurl -protoset wgtwo.bin \
   -d '
@@ -10,4 +11,4 @@ grpcurl -protoset wgtwo.bin \
       }
   }
   ' \
-  api.wgtwo.com:443 wgtwo.sipbreakout.v0.SipBreakoutService/UpsertRegistration
+  sandbox.api.wgtwo.com:443 wgtwo.sipbreakout.v0.SipBreakoutService/UpsertRegistration

examples/grpcurl/thirdpartydev/sms/send-text-sms.sh

@@ -1,3 +1,4 @@
+#!/usr/bin/env bash
 grpcurl \
   -H "Authorization: Bearer ${ACCESS_TOKEN}"\
   -import-path . \
@@ -7,5 +8,5 @@ grpcurl \
         "from_subscriber": { "e164": "+47xxxxxxxx" },
         "to_e164": { "e164": "+47xxxxxxxx" }
       }' \
-  api.wgtwo.com:443 \
+  sandbox.api.wgtwo.com:443 \
   wgtwo.sms.v0.SmsService/SendTextFromSubscriber

examples/grpcurl/thirdpartydev/webterminal/initiatecall.sh

@@ -1,3 +1,4 @@
+#!/usr/bin/env bash
 # Access token must be obtained via the client credentials flow
 grpcurl \
   -H "Authorization: Bearer ${ACCESS_TOKEN}"\
@@ -14,5 +15,5 @@ grpcurl \
       }
   }
   ' \
-  api.wgtwo.com:443 \
+  sandbox.api.wgtwo.com:443 \
   wgtwo.webterminal.v0.WebTerminalService/Pipe

src/assets/images/number-lookup.mermaid.md

@@ -57,7 +57,7 @@ sequenceDiagram
 ```mermaid
 flowchart LR
   subgraph wg2
-    C(api.wgtwo.com)
+    C(api.shamrock.wgtwo.com)
   end
   subgraph Provider
     A(Client)