Merge pull request #33 from Bandwidth/release/2021-09-10-19-19-11

DX-2205 Voice, Answering Machine Detection

.github/workflows/validate.yml

@@ -15,14 +15,17 @@ jobs:
     - name: Validate
       uses: ./.github/actions/validate
       env:
-        USERNAME: ${{ secrets.USERNAME }}
-        PASSWORD: ${{ secrets.PASSWORD }}
-        ACCOUNT_ID: ${{ secrets.ACCOUNT_ID }}
-        VOICE_APPLICATION_ID: ${{ secrets.VOICE_APPLICATION_ID }}
-        MESSAGING_APPLICATION_ID: ${{ secrets.MESSAGING_APPLICATION_ID }}
-        VOICE_CALLBACK_URL: ${{ secrets.VOICE_CALLBACK_URL }}
-        PHONE_NUMBER_OUTBOUND: ${{ secrets.PHONE_NUMBER_OUTBOUND }}
-        PHONE_NUMBER_INBOUND: ${{ secrets.PHONE_NUMBER_INBOUND }}
-        MFA_MESSAGING_APPLICATION_ID: ${{ secrets.MFA_MESSAGING_APPLICATION_ID }}
-        MFA_VOICE_APPLICATION_ID: ${{ secrets.MFA_VOICE_APPLICATION_ID }}
-        PHONE_NUMBER_MFA: ${{ secrets.PHONE_NUMBER_MFA }}
+        BW_ACCOUNT_ID: ${{ secrets.BW_ACCOUNT_ID }}
+        BW_USERNAME: ${{ secrets.BW_USERNAME }}
+        BW_PASSWORD: ${{ secrets.BW_PASSWORD }}
+        BW_VOICE_APPLICATION_ID: ${{ secrets.BW_VOICE_APPLICATION_ID }}
+        BW_MESSAGING_APPLICATION_ID: ${{ secrets.BW_MESSAGING_APPLICATION_ID }}
+        BW_NUMBER: ${{ secrets.BW_NUMBER }}
+        USER_NUMBER: ${{ secrets.USER_NUMBER }}
+        BASE_CALLBACK_URL: ${{ secrets.BASE_CALLBACK_URL }}
+    - uses: Bandwidth/[email protected]
+      if: always()
+      with:
+        job-status: ${{ job.status }}
+        slack-bot-token: ${{ secrets.SLACK_BOT_TOKEN }}
+        slack-channel: ${{ secrets.SLACK_CHANNEL }}

.gitignore

@@ -0,0 +1,4 @@
+# PHP Dev Resources
+vendor
+composer.lock
+.phpunit.result.cache

composer.json

@@ -3,14 +3,14 @@
     "type": "library",
     "description": "Bandwidth's set of APIs",
     "keywords": ["bandwidth","API","SDK"],
-    "homepage": "https://apimatic.io",
+    "homepage": "https://www.bandwidth.com/",
     "license": "MIT",
     "authors": [
         {
-            "name": "APIMatic SDK Generator",
-            "email": "support@apimatic.io",
-            "homepage": "https://apimatic.io",
-            "role": "API Tool"
+            "name": "Bandwidth Inc.",
+            "email": "support@bandwidth.com",
+            "homepage": "https://www.bandwidth.com/",
+            "role": "Owner"
         }
     ],
     "require": {

src/Messaging/Controllers/APIController.php

@@ -31,7 +31,7 @@ public function __construct($config, $httpCallBack = null)
     }
 
     /**
-     * listMedia
+     * Gets a list of your media files. No query parameters are supported.
      *
      * @param string $accountId          User's account ID
      * @param string $continuationToken  (optional) Continuation token used to retrieve subsequent media.
@@ -120,7 +120,7 @@ public function listMedia(
     }
 
     /**
-     * getMedia
+     * Downloads a media file you previously uploaded.
      *
      * @param string $accountId User's account ID
      * @param string $mediaId   Media ID to retrieve
@@ -207,7 +207,8 @@ public function getMedia(
     }
 
     /**
-     * uploadMedia
+     * Uploads a file the normal HTTP way. You may add headers to the request in order to provide some
+     * control to your media-file.
      *
      * @param string $accountId     User's account ID
      * @param string $mediaId       The user supplied custom media ID
@@ -305,7 +306,9 @@ public function uploadMedia(
     }
 
     /**
-     * deleteMedia
+     * Deletes a media file from Bandwidth API server. Make sure you don't have any application scripts
+     * still using the media before you delete. If you accidentally delete a media file, you can
+     * immediately upload a new file with the same name.
      *
      * @param string $accountId User's account ID
      * @param string $mediaId   The media ID to delete
@@ -391,7 +394,7 @@ public function deleteMedia(
     }
 
     /**
-     * getMessages
+     * Gets a list of messages based on query parameters.
      *
      * @param string  $accountId     User's account ID
      * @param string  $messageId     (optional) The ID of the message to search for. Special characters need to be
@@ -516,7 +519,7 @@ public function getMessages(
     }
 
     /**
-     * createMessage
+     * Endpoint for sending text messages and picture messages using V2 messaging.
      *
      * @param string                $accountId User's account ID
      * @param Models\MessageRequest $body      TODO: type description here

src/Messaging/Models/BandwidthMessage.php

@@ -62,7 +62,9 @@ class BandwidthMessage implements \JsonSerializable
     public $from;
 
     /**
-     * The list of media URLs sent in the message
+     * The list of media URLs sent in the message. Including a `filename` field in the `Content-
+     * Disposition` header of the media linked with a URL will set the displayed file name. This is a best
+     * practice to ensure that your media has a readable file name.
      * @var array|null $media public property
      */
     public $media;

src/MultiFactorAuth/Controllers/MFAController.php

@@ -31,7 +31,8 @@ public function __construct($config, $httpCallBack = null)
     }
 
     /**
-     * Allows a user to send a MFA code through a phone call
+     * Multi-Factor authentication with Bandwidth Voice services. Allows for a user to send an MFA code via
+     * a phone call.
      *
      * @param string                            $accountId Bandwidth Account ID with Voice service enabled
      * @param Models\TwoFactorCodeRequestSchema $body      TODO: type description here
@@ -124,7 +125,8 @@ public function createVoiceTwoFactor(
     }
 
     /**
-     * Allows a user to send a MFA code through a text message (SMS)
+     * Multi-Factor authentication with Bandwidth Messaging services. Allows a user to send an MFA code via
+     * a text message (SMS).
      *
      * @param string                            $accountId Bandwidth Account ID with Messaging service enabled
      * @param Models\TwoFactorCodeRequestSchema $body      TODO: type description here
@@ -217,7 +219,7 @@ public function createMessagingTwoFactor(
     }
 
     /**
-     * Allows a user to verify an MFA code
+     * Allows a user to verify an MFA code.
      *
      * @param string                              $accountId Bandwidth Account ID with Two-Factor enabled
      * @param Models\TwoFactorVerifyRequestSchema $body      TODO: type description here

src/PhoneNumberLookup/Controllers/APIController.php

@@ -31,7 +31,7 @@ public function __construct($config, $httpCallBack = null)
     }
 
     /**
-     * Create a TN Lookup Order
+     * Create a TN Lookup Order.
      *
      * @param string              $accountId The ID of the Bandwidth account that the user belongs to.
      * @param Models\OrderRequest $body      TODO: type description here
@@ -931,7 +931,7 @@ public function createLookupRequest(
     }
 
     /**
-     * Query an existing TN Lookup Order
+     * Query an existing TN Lookup Order.
      *
      * @param string $accountId The ID of the Bandwidth account that the user belongs to.
      * @param string $requestId TODO: type description here

src/Voice/Controllers/APIController.php

@@ -31,7 +31,7 @@ public function __construct($config, $httpCallBack = null)
     }
 
     /**
-     * Creates an outbound call.
+     * Creates an outbound phone call.
      *
      * @param string                   $accountId TODO: type description here
      * @param Models\CreateCallRequest $body      TODO: type description here
@@ -473,7 +473,7 @@ public function modifyCallRecordingState(
 
     /**
      * Returns a (potentially empty) list of metadata for the recordings that took place during the
-     * specified call
+     * specified call.
      *
      * @param string $accountId TODO: type description here
      * @param string $callId    TODO: type description here