Update Readme

Author: zhanganderson

README.md

@@ -291,7 +291,7 @@ please see here:
 
 ### Assign Virtual Number
 
-When a recipient receives your message, you can choose whether they'll see a privateNumber,
+When a recipient receives your message, you can choose whether they'll see a
 Virtual Number or senderName (paid plans only) in the from field.
 If you want to use a Virtual Number, use this function to assign one.
 For more information, please see here:
@@ -616,7 +616,7 @@ The function `messages.send` can be used to send a message.
 It takes an object with following properties as argument:
 
 -   `to`: The destination address, expected to be a phone number of the form `+614XXXXXXXX` or `04XXXXXXXX`.
--   `from`: This will be either "privateNumber", one of your Virtual Numbers or your senderName.
+-   `from`: This will be either one of your Virtual Numbers or your senderName.
 -   `messageContent` (Either one of messageContent or multimedia is required): The content of the message.
 -   `multimedia` (Either one of messageContent or multimedia is required): MMS multimedia content.
 -   `retryTimeout` (optional): How many minutes you asked the server to keep trying to send the message.
@@ -637,7 +637,7 @@ It returns an object with the following properties:
 -   `messageId`: Use this UUID with our other endpoints to fetch, update or delete the message.
 -   `status`: The status will be either queued, sent, delivered or expired.
 -   `to`: The recipient's mobile number(s).
--   `from`: This will be either "privateNumber", one of your Virtual Numbers or your senderName.
+-   `from`: This will be either one of your Virtual Numbers or your senderName.
 -   `messageContent`: The content of the message.
 -   `multimedia`: The multimedia content of the message (MMS only).
 -   `retryTimeout`: How many minutes you asked the server to keep trying to send the message.
@@ -739,7 +739,7 @@ It returns an object with the following properties:
 -   `sentTimestamp`: The time the message was sent from the server.
 -   `receivedTimestamp`: The time the message was received by the recipient's device.
 -   `to`: The recipient's mobile number(s).
--   `from`: This will be either "privateNumber", one of your Virtual Numbers or your senderName.
+-   `from`: This will be either one of your Virtual Numbers or your senderName.
 -   `messageContent`: The content of the message.
 -   `multimedia`: The multimedia content of the message (MMS only).
 -   `direction`: Direction of the message (outgoing or incoming).
@@ -854,7 +854,7 @@ It takes an object with following properties as argument:
 
 -   `messageId`: Use this UUID with our other endpoints to fetch, update or delete the message.
 -   `to`: The destination address, expected to be a phone number of the form `+614XXXXXXXX` or `04XXXXXXXX`.
--   `from`: This will be either "privateNumber", one of your Virtual Numbers or your senderName.
+-   `from`: This will be either one of your Virtual Numbers or your senderName.
 -   `messageContent` (Either one of messageContent or multimedia is required): The content of the message.
 -   `multimedia` (Either one of messageContent or multimedia is required): MMS multimedia content.
 -   `retryTimeout` (optional): How many minutes you asked the server to keep trying to send the message.
@@ -882,7 +882,7 @@ It returns an object with the following properties:
 -   `messageId`: Use this UUID with our other endpoints to fetch, update or delete the message.
 -   `status`: The status will be either queued, sent, delivered or expired.
 -   `to`: The recipient's mobile number(s).
--   `from`: This will be either "privateNumber", one of your Virtual Numbers or your senderName.
+-   `from`: This will be either one of your Virtual Numbers or your senderName.
 -   `messageContent`: The content of the message.
 -   `multimedia`: The multimedia content of the message (MMS only).
 -   `retryTimeout`: How many minutes you asked the server to keep trying to send the message.

src/main/java/com/telstra/MessageGet.java

@@ -277,10 +277,10 @@ public MessageGet from(String from) {
   }
 
    /**
-   * This will be either \"privateNumber\", one of your Virtual Numbers or your senderName.
+   * This will be either one of your Virtual Numbers or your senderName.
    * @return from
   **/
-  @Schema(description = "This will be either \"privateNumber\", one of your Virtual Numbers or your senderName.")
+  @Schema(description = "This will be either one of your Virtual Numbers or your senderName.")
   public String getFrom() {
     return from;
   }

src/main/java/com/telstra/MessageSent.java

@@ -167,10 +167,10 @@ public MessageSent from(String from) {
   }
 
    /**
-   * This will be either \"privateNumber\", one of your Virtual Numbers or your senderName.
+   * This will be either one of your Virtual Numbers or your senderName.
    * @return from
   **/
-  @Schema(description = "This will be either \"privateNumber\", one of your Virtual Numbers or your senderName.")
+  @Schema(description = "This will be either one of your Virtual Numbers or your senderName.")
   public String getFrom() {
     return from;
   }

src/main/java/com/telstra/MessageUpdate.java

@@ -170,10 +170,10 @@ public MessageUpdate from(String from) {
   }
 
    /**
-   * This will be either \"privateNumber\", one of your Virtual Numbers or your senderName.
+   * This will be either one of your Virtual Numbers or your senderName.
    * @return from
   **/
-  @Schema(description = "This will be either \"privateNumber\", one of your Virtual Numbers or your senderName.")
+  @Schema(description = "This will be either one of your Virtual Numbers or your senderName.")
   public String getFrom() {
     return from;
   }

src/main/java/com/telstra/SendMessagesRequest.java

@@ -91,7 +91,7 @@ public SendMessagesRequest from(String from) {
   }
 
    /**
-   * When the recipient receives your message, you can choose whether they'll see a privateNumber, virtualNumber or senderName (paid plans only) in the **from** field.    * privateNumber: Use this string to have the message appear on the recipient's device as from \"anonymous\", \"private\" or similar.   * 04xxxxxxxx: Use one of the Virtual Numbers associated with your account. You'll also be able to receive SMS replies to this number.  * senderName: Choose a unique alphanumeric string of up to 11 characters (paid feature). 
+   * When the recipient receives your message, you can choose whether they'll see a virtualNumber or senderName (paid plans only) in the **from** field.   * 04xxxxxxxx: Use one of the Virtual Numbers associated with your account. You'll also be able to receive SMS replies to this number.  * senderName: Choose a unique alphanumeric string of up to 11 characters (paid feature). 
    * @return from
   **/
   public String getFrom() {

src/main/java/com/telstra/UpdateMessageByIdRequest.java

@@ -94,7 +94,7 @@ public UpdateMessageByIdRequest from(String from) {
   }
 
    /**
-   * When the recipient receives your message, you can choose whether they'll see a privateNumber, virtualNumber or senderName (paid plans only) in the **from** field.  * privateNumber: Use this string to have the message appear on the recipient's device as from \"anonymous\", \"private\" or similar. * 04xxxxxxxx: Use one of the Virtual Numbers associated with your account. You'll also be able to receive SMS replies to this number. * senderName: Choose a unique alphanumeric string of up to 11 characters (paid feature). 
+   * When the recipient receives your message, you can choose whether they'll see a virtualNumber or senderName (paid plans only) in the **from** field.  * 04xxxxxxxx: Use one of the Virtual Numbers associated with your account. You'll also be able to receive SMS replies to this number. * senderName: Choose a unique alphanumeric string of up to 11 characters (paid feature). 
    * @return from
   **/
 

src/main/java/com/telstra/messaging/VirtualNumbersApi.java

@@ -136,7 +136,7 @@ private com.squareup.okhttp.Call assignNumberValidateBeforeCall(Object body, Str
 
     /**
      * assign a virtual number
-     * When a recipient receives your message, you can choose whether they'll see a privateNumber, Virtual Number or senderName (paid plans only) in the **from** field. If you want to use a Virtual Number, use this endpoint to assign one. Free Trial users can assign one Virtual Number, and those on a paid plan can assign up to 100.   Virtual Numbers that have not sent a message in 30 days (Free Trial) or sent/received a message in 18 months (paid plans) will be automatically unassigned from your account. You can check the **lastUse** date of your Virtual Number at any time using GET /virtual-numbers/{virtual-number}.  Note that Virtual Numbers used in v2 of the Messaging API cannot be used to send messages in v3. Please assign a new Virtual Number instead. 
+     * When a recipient receives your message, you can choose whether they'll see a Virtual Number or senderName (paid plans only) in the **from** field. If you want to use a Virtual Number, use this endpoint to assign one. Free Trial users can assign one Virtual Number, and those on a paid plan can assign up to 100.   Virtual Numbers that have not sent a message in 30 days (Free Trial) or sent/received a message in 18 months (paid plans) will be automatically unassigned from your account. You can check the **lastUse** date of your Virtual Number at any time using GET /virtual-numbers/{virtual-number}.  Note that Virtual Numbers used in v2 of the Messaging API cannot be used to send messages in v3. Please assign a new Virtual Number instead. 
      * @param assignNumberRequest  (required)
      * @return VirtualNumber
      * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -154,7 +154,7 @@ public VirtualNumber assignNumber(AssignNumberRequest assignNumberRequest) throw
 
     /**
      * assign a virtual number
-     * When a recipient receives your message, you can choose whether they'll see a privateNumber, Virtual Number or senderName (paid plans only) in the **from** field. If you want to use a Virtual Number, use this endpoint to assign one. Free Trial users can assign one Virtual Number, and those on a paid plan can assign up to 100.   Virtual Numbers that have not sent a message in 30 days (Free Trial) or sent/received a message in 18 months (paid plans) will be automatically unassigned from your account. You can check the **lastUse** date of your Virtual Number at any time using GET /virtual-numbers/{virtual-number}.  Note that Virtual Numbers used in v2 of the Messaging API cannot be used to send messages in v3. Please assign a new Virtual Number instead. 
+     * When a recipient receives your message, you can choose whether they'll see a Virtual Number or senderName (paid plans only) in the **from** field. If you want to use a Virtual Number, use this endpoint to assign one. Free Trial users can assign one Virtual Number, and those on a paid plan can assign up to 100.   Virtual Numbers that have not sent a message in 30 days (Free Trial) or sent/received a message in 18 months (paid plans) will be automatically unassigned from your account. You can check the **lastUse** date of your Virtual Number at any time using GET /virtual-numbers/{virtual-number}.  Note that Virtual Numbers used in v2 of the Messaging API cannot be used to send messages in v3. Please assign a new Virtual Number instead. 
      * @param body  (required)
      * @param contentLanguage  (required)
      * @param accept  (required)
@@ -172,7 +172,7 @@ public ApiResponse<VirtualNumber> assignNumberWithHttpInfo(Object body, String c
 
     /**
      * assign a virtual number (asynchronously)
-     * When a recipient receives your message, you can choose whether they&#x27;ll see a privateNumber, Virtual Number or senderName (paid plans only) in the **from** field. If you want to use a Virtual Number, use this endpoint to assign one. Free Trial users can assign one Virtual Number, and those on a paid plan can assign up to 100.   Virtual Numbers that have not sent a message in 30 days (Free Trial) or sent/received a message in 18 months (paid plans) will be automatically unassigned from your account. You can check the **lastUse** date of your Virtual Number at any time using GET /virtual-numbers/{virtual-number}.  Note that Virtual Numbers used in v2 of the Messaging API cannot be used to send messages in v3. Please assign a new Virtual Number instead. 
+     * When a recipient receives your message, you can choose whether they&#x27;ll see a Virtual Number or senderName (paid plans only) in the **from** field. If you want to use a Virtual Number, use this endpoint to assign one. Free Trial users can assign one Virtual Number, and those on a paid plan can assign up to 100.   Virtual Numbers that have not sent a message in 30 days (Free Trial) or sent/received a message in 18 months (paid plans) will be automatically unassigned from your account. You can check the **lastUse** date of your Virtual Number at any time using GET /virtual-numbers/{virtual-number}.  Note that Virtual Numbers used in v2 of the Messaging API cannot be used to send messages in v3. Please assign a new Virtual Number instead. 
      * @param body  (required)
      * @param contentLanguage  (required)
      * @param authorization  (required)

src/test/java/com/telstra/messaging/VirtualNumbersApiTest.java

@@ -46,7 +46,7 @@ public void setUp() {
 
     /**
      * assign a virtual number
-     * When a recipient receives your message, you can choose whether they'll see a privateNumber, Virtual Number or senderName (paid plans only) in the **from** field. If you want to use a Virtual Number, use this endpoint to assign one. Free Trial users can assign one Virtual Number, and those on a paid plan can assign up to 100.   Virtual Numbers that have not sent a message in 30 days (Free Trial) or sent/received a message in 18 months (paid plans) will be automatically unassigned from your account. You can check the **lastUse** date of your Virtual Number at any time using GET /virtual-numbers/{virtual-number}.  Note that Virtual Numbers used in v2 of the Messaging API cannot be used to send messages in v3. Please assign a new Virtual Number instead. 
+     * When a recipient receives your message, you can choose whether they'll see a Virtual Number or senderName (paid plans only) in the **from** field. If you want to use a Virtual Number, use this endpoint to assign one. Free Trial users can assign one Virtual Number, and those on a paid plan can assign up to 100.   Virtual Numbers that have not sent a message in 30 days (Free Trial) or sent/received a message in 18 months (paid plans) will be automatically unassigned from your account. You can check the **lastUse** date of your Virtual Number at any time using GET /virtual-numbers/{virtual-number}.  Note that Virtual Numbers used in v2 of the Messaging API cannot be used to send messages in v3. Please assign a new Virtual Number instead. 
      *
      */
     @Ignore