Support API CreateSmsSign.

Author: sdk-team

ChangeLog.md

@@ -1,3 +1,26 @@
+2024-06-25 Version: 3.0.0
+- Support API CreateSmsSign.
+- Support API CreateSmsTemplate.
+- Support API GetOSSInfoForUploadFile.
+- Support API GetSmsSign.
+- Support API GetSmsTemplate.
+- Support API UpdateSmsSign.
+- Support API UpdateSmsTemplate.
+- Update API CreateSmartShortUrl: add param OutId.
+- Update API CreateSmartShortUrl: delete param Expiration.
+- Update API CreateSmartShortUrl: delete param SourceName.
+- Update API CreateSmartShortUrl: update param PhoneNumbers.
+- Update API CreateSmartShortUrl: update param SourceUrl.
+- Update API QueryPageSmartShortUrlLog: delete param ClickState.
+- Update API QueryPageSmartShortUrlLog: delete param EndId.
+- Update API QueryPageSmartShortUrlLog: delete param ShortName.
+- Update API QueryPageSmartShortUrlLog: delete param StartId.
+- Update API QueryPageSmartShortUrlLog: update param CreateDateEnd.
+- Update API QueryPageSmartShortUrlLog: update param CreateDateStart.
+- Update API QueryPageSmartShortUrlLog: update param PageNo.
+- Update API QueryPageSmartShortUrlLog: update param PageSize.
+
+
 2023-07-04 Version: 2.0.24
 - Add CreateSmartShortUrl api.
 

composer.json

@@ -11,8 +11,8 @@
   ],
   "require": {
     "php": ">5.5",
-    "alibabacloud/tea-utils": "^0.2.19",
-    "alibabacloud/darabonba-openapi": "^0.2.8",
+    "alibabacloud/tea-utils": "^0.2.20",
+    "alibabacloud/darabonba-openapi": "^0.2.12",
     "alibabacloud/openapi-util": "^0.1.10|^0.2.1",
     "alibabacloud/endpoint-util": "^0.1.0"
   },

src/Dysmsapi.php

@@ -9,6 +9,9 @@
 class AddShortUrlRequest extends Model
 {
     /**
+     * @description The validity period of the short URL. Unit: days. The maximum validity period is 90 days.
+     *
+     * This parameter is required.
      * @example 7
      *
      * @var string
@@ -31,11 +34,19 @@ class AddShortUrlRequest extends Model
     public $resourceOwnerId;
 
     /**
+     * @description The service name of the short URL. The name cannot exceed 13 characters in length.
+     *
+     * This parameter is required.
+     * @example The Alibaba Cloud Short Link service.
+     *
      * @var string
      */
     public $shortUrlName;
 
     /**
+     * @description The source URL. The URL cannot exceed 1,000 characters in length.
+     *
+     * This parameter is required.
      * @example https://www.****.com/product/sms
      *
      * @var string

src/Models/AddShortUrlRequest.php

@@ -30,9 +30,6 @@ class AddShortUrlResponse extends Model
 
     public function validate()
     {
-        Model::validateRequired('headers', $this->headers, true);
-        Model::validateRequired('statusCode', $this->statusCode, true);
-        Model::validateRequired('body', $this->body, true);
     }
 
     public function toMap()

src/Models/AddShortUrlResponse.php

@@ -10,25 +10,36 @@
 class AddShortUrlResponseBody extends Model
 {
     /**
+     * @description The response code.
+     *
+     *   The value OK indicates that the request was successful.
+     *   Other values indicate that the request failed. For more information, see [Error codes](https://help.aliyun.com/document_detail/101346.html).
+     *
      * @example OK
      *
      * @var string
      */
     public $code;
 
     /**
+     * @description The details of the short URL.
+     *
      * @var data
      */
     public $data;
 
     /**
+     * @description The returned message.
+     *
      * @example OK
      *
      * @var string
      */
     public $message;
 
     /**
+     * @description The request ID.
+     *
      * @example 819BE656-D2E0-4858-8B21-B2E477085AAF
      *
      * @var string

src/Models/AddShortUrlResponseBody.php

@@ -9,20 +9,27 @@
 class data extends Model
 {
     /**
+     * @description The time when the short URL expires.
+     *
+     * > The value of **ExpireDate** is on the hour.
      * @example 2021-09-19 00:00:00
      *
      * @var string
      */
     public $expireDate;
 
     /**
+     * @description The short URL.
+     *
      * @example http://****.cn/6y8uy7
      *
      * @var string
      */
     public $shortUrl;
 
     /**
+     * @description The source URL.
+     *
      * @example https://www.****.com/product/sms
      *
      * @var string

src/Models/AddShortUrlResponseBody/data.php

@@ -15,6 +15,11 @@ class AddSmsSignRequest extends Model
     public $ownerId;
 
     /**
+     * @description The description of the signature application. The description cannot exceed 200 characters in length. The description is one of the reference information for signature review. We recommend that you describe the use scenarios of your services in detail, and provide information that can verify the services, such as a website URL, a domain name with an ICP filing, an app download URL, an official account name, or a mini program name. For sign-in scenarios, you must also provide an account and password for tests. A detailed description can improve the review efficiency of signatures and templates.
+     *
+     * This parameter is required.
+     * @example This is the abbreviation of our company.
+     *
      * @var string
      */
     public $remark;
@@ -30,23 +35,52 @@ class AddSmsSignRequest extends Model
     public $resourceOwnerId;
 
     /**
+     * @description The signature files.
+     *
+     * This parameter is required.
      * @var signFileList[]
      */
     public $signFileList;
 
     /**
+     * @description The name of the signature.
+     *
+     * >
+     *
+     *   The signature name is not case-sensitive. For example, [Alibaba Cloud Communication] and [alibaba cloud communication] are considered as the same name.
+     *
+     *   If your verification code signature and general-purpose signature have the same name, the system uses the general-purpose signature to send messages by default.
+     *
+     * This parameter is required.
+     * @example Aliyun
+     *
      * @var string
      */
     public $signName;
 
     /**
+     * @description The source of the signature. Valid values:
+     *
+     *   **0**: the full name or abbreviation of an enterprise or institution
+     *   **1**: the full name or abbreviation of a website that has obtained an ICP filing from the Ministry of Industry and Information Technology (MIIT) of China
+     *   **2**: the full name or abbreviation of an app
+     *   **3**: the full name or abbreviation of an official account or mini-program
+     *   **4**: the full name or abbreviation of an e-commerce store
+     *   **5**: the full name or abbreviation of a trademark
+     *
+     * This parameter is required.
      * @example 1
      *
      * @var int
      */
     public $signSource;
 
     /**
+     * @description The type of the signature. Valid values:
+     *
+     *   **0**: verification code
+     *   **1**: general-purpose
+     *
      * @example 1
      *
      * @var int

src/Models/AddSmsSignRequest.php

@@ -9,13 +9,19 @@
 class signFileList extends Model
 {
     /**
+     * @description The Base64-encoded string of the qualification document. An image cannot exceed 2 MB in size. In some scenarios, you must upload supporting documents to apply for signatures. For more information, see [SMS signature specifications](https://help.aliyun.com/document_detail/108076.html).
+     *
+     * This parameter is required.
      * @example R0lGODlhHAAmAKIHAKqqqsvLy0hISObm5vf394uL****
      *
      * @var string
      */
     public $fileContents;
 
     /**
+     * @description The format of the qualification document. You can upload multiple images. Images in JPG, PNG, GIF, or JPEG format are supported.
+     *
+     * This parameter is required.
      * @example jpg
      *
      * @var string

src/Models/AddSmsSignRequest/signFileList.php

@@ -30,9 +30,6 @@ class AddSmsSignResponse extends Model
 
     public function validate()
     {
-        Model::validateRequired('headers', $this->headers, true);
-        Model::validateRequired('statusCode', $this->statusCode, true);
-        Model::validateRequired('body', $this->body, true);
     }
 
     public function toMap()

src/Models/AddSmsSignResponse.php

@@ -9,27 +9,40 @@
 class AddSmsSignResponseBody extends Model
 {
     /**
+     * @description The response code.
+     *
+     *   The value OK indicates that the request was successful.
+     *   Other values indicate that the request failed. For more information, see [Error codes](https://help.aliyun.com/document_detail/101346.html).
+     *
      * @example OK
      *
      * @var string
      */
     public $code;
 
     /**
+     * @description The returned message.
+     *
      * @example OK
      *
      * @var string
      */
     public $message;
 
     /**
+     * @description The request ID.
+     *
      * @example F655A8D5-B967-440B-8683-DAD6FF8DE990
      *
      * @var string
      */
     public $requestId;
 
     /**
+     * @description The name of the signature.
+     *
+     * @example Aliyun
+     *
      * @var string
      */
     public $signName;

src/Models/AddSmsSignResponseBody.php

@@ -14,6 +14,11 @@ class AddSmsTemplateRequest extends Model
     public $ownerId;
 
     /**
+     * @description The description of the message template. It is one of the reference information for template review. The description cannot exceed 100 characters in length.
+     *
+     * This parameter is required.
+     * @example Apply for a template to send verification codes.
+     *
      * @var string
      */
     public $remark;
@@ -29,16 +34,34 @@ class AddSmsTemplateRequest extends Model
     public $resourceOwnerId;
 
     /**
+     * @description The content of the template. The content can be up to 500 characters in length. For more information, see [Message template specifications](https://help.aliyun.com/document_detail/108253.html).
+     *
+     * This parameter is required.
+     * @example You are applying for mobile registration. The verification code is: ${code}, valid for 5 minutes!
+     *
      * @var string
      */
     public $templateContent;
 
     /**
+     * @description The name of the template. The name can be up to 30 characters in length.
+     *
+     * This parameter is required.
+     * @example Aliyun Test
+     *
      * @var string
      */
     public $templateName;
 
     /**
+     * @description The type of the message. Valid values:
+     *
+     *   **0**: verification code
+     *   **1**: notification
+     *   **2**: promotional message
+     *   **3**: message sent to countries or regions outside the Chinese mainland
+     *
+     * This parameter is required.
      * @example 1
      *
      * @var int

src/Models/AddSmsTemplateRequest.php

@@ -30,9 +30,6 @@ class AddSmsTemplateResponse extends Model
 
     public function validate()
     {
-        Model::validateRequired('headers', $this->headers, true);
-        Model::validateRequired('statusCode', $this->statusCode, true);
-        Model::validateRequired('body', $this->body, true);
     }
 
     public function toMap()

src/Models/AddSmsTemplateResponse.php

@@ -9,27 +9,38 @@
 class AddSmsTemplateResponseBody extends Model
 {
     /**
+     * @description The response code.
+     *
+     *   The value OK indicates that the request was successful.
+     *   For more information about other response codes, see [API error codes](https://help.aliyun.com/document_detail/101346.html).
+     *
      * @example OK
      *
      * @var string
      */
     public $code;
 
     /**
+     * @description The returned message.
+     *
      * @example OK
      *
      * @var string
      */
     public $message;
 
     /**
+     * @description The request ID.
+     *
      * @example F655A8D5-B967-440B-8683-DAD6FF8DE990
      *
      * @var string
      */
     public $requestId;
 
     /**
+     * @description The code of the message template.
+     *
      * @example SMS_15255****
      *
      * @var string

src/Models/AddSmsTemplateResponseBody.php

@@ -9,11 +9,17 @@
 class CheckMobilesCardSupportRequest extends Model
 {
     /**
+     * @description The list of mobile phone numbers that receive messages.
+     *
+     * This parameter is required.
      * @var mixed[][]
      */
     public $mobiles;
 
     /**
+     * @description The code of the message template. You can view the template code in the **Template Code** column on the **Templates** tab of the **Go China** page in the Alibaba Cloud SMS console.
+     *
+     * This parameter is required.
      * @example CARD_SMS_****
      *
      * @var string