tencentcloud-sdk-python-tcb 3.1.102__tar.gz → 3.1.104__tar.gz

{tencentcloud_sdk_python_tcb-3.1.102 → tencentcloud_sdk_python_tcb-3.1.104}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tencentcloud-sdk-python-tcb
-Version: 3.1.102
+Version: 3.1.104
 Summary: Tencent Cloud Tcb SDK for Python
 Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
 Author: Tencent Cloud
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 2.7
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
-Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.102
+Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.104
 
 ============================
 Tencent Cloud SDK for Python

{tencentcloud_sdk_python_tcb-3.1.102 → tencentcloud_sdk_python_tcb-3.1.104}/setup.py

@@ -8,7 +8,7 @@ ROOT = os.path.dirname(__file__)
 
 setup(
     name='tencentcloud-sdk-python-tcb',
-    install_requires=["tencentcloud-sdk-python-common>=3.1.102,<4.0.0"],
+    install_requires=["tencentcloud-sdk-python-common>=3.1.104,<4.0.0"],
     
     version=tencentcloud.__version__,
     description='Tencent Cloud Tcb SDK for Python',

{tencentcloud_sdk_python_tcb-3.1.102 → tencentcloud_sdk_python_tcb-3.1.104}/tencentcloud/__init__.py

@@ -14,4 +14,4 @@
 # limitations under the License.
 
 
-__version__ = '3.1.102'
+__version__ = '3.1.104'

{tencentcloud_sdk_python_tcb-3.1.102 → tencentcloud_sdk_python_tcb-3.1.104}/tencentcloud/tcb/v20180608/models.py

@@ -18478,6 +18478,223 @@ class RunSqlResponse(AbstractModel):
         self._RequestId = params.get("RequestId")
 
 
+class SMSProviderTemplateConfig(AbstractModel):
+    r"""自定义短信服务商模板配置
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _Vendor: <p>短信服务商类型</p><p>枚举值：</p><ul><li>TENCENT_CN： 腾讯云国内短信</li><li>TENCENT_INTL： 腾讯云国际短信</li></ul>
+注意：此字段可能返回 null，表示取不到有效值。
+        :type Vendor: str
+        :param _TemplateId: <p>短信服务商侧申请并审核通过的模板ID。</p><ul><li>腾讯云短信模板ID可前往 <a href="https://console.cloud.tencent.com/smsv2/csms-template">腾讯云国内短信</a> 或 <a href="https://console.cloud.tencent.com/smsv2/isms-template">国际/港澳台短信</a> 的正文模板管理查看，若向境外手机号发送短信，仅支持使用国际/港澳台短信模板。</li></ul>
+注意：此字段可能返回 null，表示取不到有效值。
+        :type TemplateId: str
+        :param _SdkAppId: <p>短信服务商侧为应用分配的ID，按照服务商文档和要求需要此参数的，填写该参数。</p><ul><li>腾讯云国内短信和国际短信此参数必填，可以在<a href="https://console.cloud.tencent.com/smsv2/app-manage">短信控制台</a>的应用列表中查看对应的应用id。</li></ul>
+注意：此字段可能返回 null，表示取不到有效值。
+        :type SdkAppId: str
+        :param _SignName: <p>短信服务商侧申请并审核通过的签名，按照服务商的文档和要求填写。</p><ul><li>腾讯云短信服务商，签名信息可前往 <a href="https://console.cloud.tencent.com/smsv2/csms-sign">国内短信</a> 或 <a href="https://console.cloud.tencent.com/smsv2/isms-sign">国际/港澳台短信</a> 的签名管理查看。<br> 注意：<ol><li>发送国内短信该参数必填，且需填写签名内容而非签名ID。</li><li>发送国际/港澳台短信该参数非必填。</li></ol></li></ul>
+注意：此字段可能返回 null，表示取不到有效值。
+        :type SignName: str
+        :param _SecretId: <p>调用短信服务商发送短信接口的调用秘钥对应的ID。</p><ul><li>调用api秘钥会保存在云开发平台控制台—扩展功能—授权管理中，如果对于短信调用的api秘钥有删除需求，可在此处进行删除，删除后，短信将无法正常发送。</li><li>腾讯云的调用api秘钥在腾讯云控制台获取，建议使用子账号的秘钥ID，并且按照最小权限配置。</li></ul>
+注意：此字段可能返回 null，表示取不到有效值。
+        :type SecretId: str
+        :param _SecretKey: <p>调用短信服务商发送短信接口的调用api秘钥对应的秘钥Key。</p><ul><li>腾讯云的调用api秘钥在腾讯云控制台获取，建议使用子账号的秘钥ID, 并且按照最小权限配置。平台对于调用api秘钥key是加密存储的，不会明文存储。</li></ul>
+注意：此字段可能返回 null，表示取不到有效值。
+        :type SecretKey: str
+        :param _SenderId: <p>短信服务商侧自定义短信发送的senderID，按照服务商文档和要求传参。</p><ul><li>仅国际化场景使用。部分国家/运营商支持自定义 Sender ID替代默认主叫号码。国内站点忽略此字段。</li></ul>
+注意：此字段可能返回 null，表示取不到有效值。
+        :type SenderId: str
+        :param _TemplateExtendParam: <p>当短信自定义模板含多个占位符时，平台只负责生成验证码值，其余占位符由调用方在此提供。</p><ul><li>无需提供验证码对应的占位的值，验证码由云开发平台侧生成。</li><li>如果是命名占位的服务商的短信模板，这里的参数按照需要对应的占位的key和value，会按照对应的key和value在发送短信时，填充到模板中。</li><li>如果是序号占位的服务商的短信模板，这里的参数不需要key, 只需要填写对应的value, 会按照填写的顺序依次填充到模板中。</li></ul>
+注意：此字段可能返回 null，表示取不到有效值。
+        :type TemplateExtendParam: list of SMSTemplateParams
+        """
+        self._Vendor = None
+        self._TemplateId = None
+        self._SdkAppId = None
+        self._SignName = None
+        self._SecretId = None
+        self._SecretKey = None
+        self._SenderId = None
+        self._TemplateExtendParam = None
+
+    @property
+    def Vendor(self):
+        r"""<p>短信服务商类型</p><p>枚举值：</p><ul><li>TENCENT_CN： 腾讯云国内短信</li><li>TENCENT_INTL： 腾讯云国际短信</li></ul>
+注意：此字段可能返回 null，表示取不到有效值。
+        :rtype: str
+        """
+        return self._Vendor
+
+    @Vendor.setter
+    def Vendor(self, Vendor):
+        self._Vendor = Vendor
+
+    @property
+    def TemplateId(self):
+        r"""<p>短信服务商侧申请并审核通过的模板ID。</p><ul><li>腾讯云短信模板ID可前往 <a href="https://console.cloud.tencent.com/smsv2/csms-template">腾讯云国内短信</a> 或 <a href="https://console.cloud.tencent.com/smsv2/isms-template">国际/港澳台短信</a> 的正文模板管理查看，若向境外手机号发送短信，仅支持使用国际/港澳台短信模板。</li></ul>
+注意：此字段可能返回 null，表示取不到有效值。
+        :rtype: str
+        """
+        return self._TemplateId
+
+    @TemplateId.setter
+    def TemplateId(self, TemplateId):
+        self._TemplateId = TemplateId
+
+    @property
+    def SdkAppId(self):
+        r"""<p>短信服务商侧为应用分配的ID，按照服务商文档和要求需要此参数的，填写该参数。</p><ul><li>腾讯云国内短信和国际短信此参数必填，可以在<a href="https://console.cloud.tencent.com/smsv2/app-manage">短信控制台</a>的应用列表中查看对应的应用id。</li></ul>
+注意：此字段可能返回 null，表示取不到有效值。
+        :rtype: str
+        """
+        return self._SdkAppId
+
+    @SdkAppId.setter
+    def SdkAppId(self, SdkAppId):
+        self._SdkAppId = SdkAppId
+
+    @property
+    def SignName(self):
+        r"""<p>短信服务商侧申请并审核通过的签名，按照服务商的文档和要求填写。</p><ul><li>腾讯云短信服务商，签名信息可前往 <a href="https://console.cloud.tencent.com/smsv2/csms-sign">国内短信</a> 或 <a href="https://console.cloud.tencent.com/smsv2/isms-sign">国际/港澳台短信</a> 的签名管理查看。<br> 注意：<ol><li>发送国内短信该参数必填，且需填写签名内容而非签名ID。</li><li>发送国际/港澳台短信该参数非必填。</li></ol></li></ul>
+注意：此字段可能返回 null，表示取不到有效值。
+        :rtype: str
+        """
+        return self._SignName
+
+    @SignName.setter
+    def SignName(self, SignName):
+        self._SignName = SignName
+
+    @property
+    def SecretId(self):
+        r"""<p>调用短信服务商发送短信接口的调用秘钥对应的ID。</p><ul><li>调用api秘钥会保存在云开发平台控制台—扩展功能—授权管理中，如果对于短信调用的api秘钥有删除需求，可在此处进行删除，删除后，短信将无法正常发送。</li><li>腾讯云的调用api秘钥在腾讯云控制台获取，建议使用子账号的秘钥ID，并且按照最小权限配置。</li></ul>
+注意：此字段可能返回 null，表示取不到有效值。
+        :rtype: str
+        """
+        return self._SecretId
+
+    @SecretId.setter
+    def SecretId(self, SecretId):
+        self._SecretId = SecretId
+
+    @property
+    def SecretKey(self):
+        r"""<p>调用短信服务商发送短信接口的调用api秘钥对应的秘钥Key。</p><ul><li>腾讯云的调用api秘钥在腾讯云控制台获取，建议使用子账号的秘钥ID, 并且按照最小权限配置。平台对于调用api秘钥key是加密存储的，不会明文存储。</li></ul>
+注意：此字段可能返回 null，表示取不到有效值。
+        :rtype: str
+        """
+        return self._SecretKey
+
+    @SecretKey.setter
+    def SecretKey(self, SecretKey):
+        self._SecretKey = SecretKey
+
+    @property
+    def SenderId(self):
+        r"""<p>短信服务商侧自定义短信发送的senderID，按照服务商文档和要求传参。</p><ul><li>仅国际化场景使用。部分国家/运营商支持自定义 Sender ID替代默认主叫号码。国内站点忽略此字段。</li></ul>
+注意：此字段可能返回 null，表示取不到有效值。
+        :rtype: str
+        """
+        return self._SenderId
+
+    @SenderId.setter
+    def SenderId(self, SenderId):
+        self._SenderId = SenderId
+
+    @property
+    def TemplateExtendParam(self):
+        r"""<p>当短信自定义模板含多个占位符时，平台只负责生成验证码值，其余占位符由调用方在此提供。</p><ul><li>无需提供验证码对应的占位的值，验证码由云开发平台侧生成。</li><li>如果是命名占位的服务商的短信模板，这里的参数按照需要对应的占位的key和value，会按照对应的key和value在发送短信时，填充到模板中。</li><li>如果是序号占位的服务商的短信模板，这里的参数不需要key, 只需要填写对应的value, 会按照填写的顺序依次填充到模板中。</li></ul>
+注意：此字段可能返回 null，表示取不到有效值。
+        :rtype: list of SMSTemplateParams
+        """
+        return self._TemplateExtendParam
+
+    @TemplateExtendParam.setter
+    def TemplateExtendParam(self, TemplateExtendParam):
+        self._TemplateExtendParam = TemplateExtendParam
+
+
+    def _deserialize(self, params):
+        self._Vendor = params.get("Vendor")
+        self._TemplateId = params.get("TemplateId")
+        self._SdkAppId = params.get("SdkAppId")
+        self._SignName = params.get("SignName")
+        self._SecretId = params.get("SecretId")
+        self._SecretKey = params.get("SecretKey")
+        self._SenderId = params.get("SenderId")
+        if params.get("TemplateExtendParam") is not None:
+            self._TemplateExtendParam = []
+            for item in params.get("TemplateExtendParam"):
+                obj = SMSTemplateParams()
+                obj._deserialize(item)
+                self._TemplateExtendParam.append(obj)
+        memeber_set = set(params.keys())
+        for name, value in vars(self).items():
+            property_name = name[1:]
+            if property_name in memeber_set:
+                memeber_set.remove(property_name)
+        if len(memeber_set) > 0:
+            warnings.warn("%s fileds are useless." % ",".join(memeber_set))
+        
+
+
+class SMSTemplateParams(AbstractModel):
+    r"""自定义短信模板中的自定义参数
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _Key: <p>短信模板的自定义参数的key。如果短信厂商的自定义参数按照命名占位的，才需要此参数；如果按照序号占位的， 不需要此参数。</p><p>腾讯云短信是按照序号占位的，不需要此参数。</p>
+注意：此字段可能返回 null，表示取不到有效值。
+        :type Key: str
+        :param _Value: <p>短信模板的自定义参数对应的value</p>
+注意：此字段可能返回 null，表示取不到有效值。
+        :type Value: str
+        """
+        self._Key = None
+        self._Value = None
+
+    @property
+    def Key(self):
+        r"""<p>短信模板的自定义参数的key。如果短信厂商的自定义参数按照命名占位的，才需要此参数；如果按照序号占位的， 不需要此参数。</p><p>腾讯云短信是按照序号占位的，不需要此参数。</p>
+注意：此字段可能返回 null，表示取不到有效值。
+        :rtype: str
+        """
+        return self._Key
+
+    @Key.setter
+    def Key(self, Key):
+        self._Key = Key
+
+    @property
+    def Value(self):
+        r"""<p>短信模板的自定义参数对应的value</p>
+注意：此字段可能返回 null，表示取不到有效值。
+        :rtype: str
+        """
+        return self._Value
+
+    @Value.setter
+    def Value(self, Value):
+        self._Value = Value
+
+
+    def _deserialize(self, params):
+        self._Key = params.get("Key")
+        self._Value = params.get("Value")
+        memeber_set = set(params.keys())
+        for name, value in vars(self).items():
+            property_name = name[1:]
+            if property_name in memeber_set:
+                memeber_set.remove(property_name)
+        if len(memeber_set) > 0:
+            warnings.warn("%s fileds are useless." % ",".join(memeber_set))
+        
+
+
 class SearchClsLogRequest(AbstractModel):
     r"""SearchClsLog请求参数结构体
 
@@ -20105,8 +20322,8 @@ class VMSpecLightHouse(AbstractModel):
 
 
 class VerificationConfig(AbstractModel):
-    r"""登录短信验证码发送配置。用于管理登录时使用的短信验证码发送的通道相关设置，目前提供云开发默认短信包和客户自定义短信包，推荐使用云开发默认短信包。
-    如果使用自定义APIs发送短信，方法命名规则
+    r"""登录短信验证码发送配置。用于管理登录时使用的短信验证码发送的通道相关设置，目前提供云开发默认短信包和客户自定义短信包，自定义短信包可以通过自定义apis或者自定义短信模板的方式接入，推荐使用云开发默认短信包，方便快捷。
+    - 如果使用自定义APIs发送短信，方法命名规则
     方法名称：发送验证码
     方法标识：SendVerificationCode
     入参
@@ -20115,38 +20332,37 @@ class VerificationConfig(AbstractModel):
     返回值
     ErrorCode：int（0 表示成功，非 0 表示失败）
     ErrorMessage：字符串（ErrorCode 非 0 时，返回错误信息）
+    - 如果使用自定义短信模板发送短信时，需要按照对应的短信服务商的要求，申请并审核通过对应的短信模板后，在云开发平台配置自定义短信模板，云开发平台对于短信模板不会做其他操作和限制，只做短信发送的逻辑，其他的操作限制都由短信服务商自身提供。
 
     """
 
     def __init__(self):
         r"""
-        :param _Type: 短信验证码发送通道类型。取值范围：
-default：使用默认云开发短信包发送短信。
-apis：使用云开发自定义 APIs 作为短信发送通道，需配合 Name 和 Method 参数使用。
-不传则不修改当前配置。
+        :param _Type: <p>短信验证码发送通道类型。</p><p>枚举值：</p><ul><li>default： 使用默认云开发短信包发送短信</li><li>apis： 使用云开发自定义 APIs 作为短信发送通道，需配合 Name 和 Method 参数使用。不传则不修改当前配置。</li><li>template： 自定义短信模板配置，需要配置TemplateProvider</li></ul>
 注意：此字段可能返回 null，表示取不到有效值。
         :type Type: str
-        :param _Name: 自定义 APIs 数据源唯一标识，当 Type 为 apis 时必填。用于定位微搭 APIs 中对应的数据源。
+        :param _Name: <p>自定义 APIs 数据源唯一标识，当 Type 为 apis 时必填。用于定位微搭 APIs 中对应的数据源。</p>
 注意：此字段可能返回 null，表示取不到有效值。
         :type Name: str
-        :param _Method: 自定义 APIs 方法名，当 Type 为 apis 时必填。指定微搭 APIs 中用于发送验证码的方法。
+        :param _Method: <p>自定义 APIs 方法名，当 Type 为 apis 时必填。指定微搭 APIs 中用于发送验证码的方法。</p>
 注意：此字段可能返回 null，表示取不到有效值。
         :type Method: str
-        :param _SmsDayLimit: 单个手机号每日短信发送上限。默认值为 30，传 -1 表示不限制，如果设置为不限制，需要注意恶意攻击，导致短信套餐用量计费问题。仅支持正整数或 -1。不传则不修改当前配置。
+        :param _SmsDayLimit: <p>单个手机号每日短信发送上限。默认值为 30，传 -1 表示不限制，如果设置为不限制，需要注意恶意攻击，导致短信套餐用量计费问题。仅支持正整数或 -1。不传则不修改当前配置。</p>
 注意：此字段可能返回 null，表示取不到有效值。
         :type SmsDayLimit: int
+        :param _TemplateProvider: <p>自定义短信服务商模板配置</p>
+注意：此字段可能返回 null，表示取不到有效值。
+        :type TemplateProvider: :class:`tencentcloud.tcb.v20180608.models.SMSProviderTemplateConfig`
         """
         self._Type = None
         self._Name = None
         self._Method = None
         self._SmsDayLimit = None
+        self._TemplateProvider = None
 
     @property
     def Type(self):
-        r"""短信验证码发送通道类型。取值范围：
-default：使用默认云开发短信包发送短信。
-apis：使用云开发自定义 APIs 作为短信发送通道，需配合 Name 和 Method 参数使用。
-不传则不修改当前配置。
+        r"""<p>短信验证码发送通道类型。</p><p>枚举值：</p><ul><li>default： 使用默认云开发短信包发送短信</li><li>apis： 使用云开发自定义 APIs 作为短信发送通道，需配合 Name 和 Method 参数使用。不传则不修改当前配置。</li><li>template： 自定义短信模板配置，需要配置TemplateProvider</li></ul>
 注意：此字段可能返回 null，表示取不到有效值。
         :rtype: str
         """
@@ -20158,7 +20374,7 @@ apis：使用云开发自定义 APIs 作为短信发送通道，需配合 Name
 
     @property
     def Name(self):
-        r"""自定义 APIs 数据源唯一标识，当 Type 为 apis 时必填。用于定位微搭 APIs 中对应的数据源。
+        r"""<p>自定义 APIs 数据源唯一标识，当 Type 为 apis 时必填。用于定位微搭 APIs 中对应的数据源。</p>
 注意：此字段可能返回 null，表示取不到有效值。
         :rtype: str
         """
@@ -20170,7 +20386,7 @@ apis：使用云开发自定义 APIs 作为短信发送通道，需配合 Name
 
     @property
     def Method(self):
-        r"""自定义 APIs 方法名，当 Type 为 apis 时必填。指定微搭 APIs 中用于发送验证码的方法。
+        r"""<p>自定义 APIs 方法名，当 Type 为 apis 时必填。指定微搭 APIs 中用于发送验证码的方法。</p>
 注意：此字段可能返回 null，表示取不到有效值。
         :rtype: str
         """
@@ -20182,7 +20398,7 @@ apis：使用云开发自定义 APIs 作为短信发送通道，需配合 Name
 
     @property
     def SmsDayLimit(self):
-        r"""单个手机号每日短信发送上限。默认值为 30，传 -1 表示不限制，如果设置为不限制，需要注意恶意攻击，导致短信套餐用量计费问题。仅支持正整数或 -1。不传则不修改当前配置。
+        r"""<p>单个手机号每日短信发送上限。默认值为 30，传 -1 表示不限制，如果设置为不限制，需要注意恶意攻击，导致短信套餐用量计费问题。仅支持正整数或 -1。不传则不修改当前配置。</p>
 注意：此字段可能返回 null，表示取不到有效值。
         :rtype: int
         """
@@ -20192,12 +20408,27 @@ apis：使用云开发自定义 APIs 作为短信发送通道，需配合 Name
     def SmsDayLimit(self, SmsDayLimit):
         self._SmsDayLimit = SmsDayLimit
 
+    @property
+    def TemplateProvider(self):
+        r"""<p>自定义短信服务商模板配置</p>
+注意：此字段可能返回 null，表示取不到有效值。
+        :rtype: :class:`tencentcloud.tcb.v20180608.models.SMSProviderTemplateConfig`
+        """
+        return self._TemplateProvider
+
+    @TemplateProvider.setter
+    def TemplateProvider(self, TemplateProvider):
+        self._TemplateProvider = TemplateProvider
+
 
     def _deserialize(self, params):
         self._Type = params.get("Type")
         self._Name = params.get("Name")
         self._Method = params.get("Method")
         self._SmsDayLimit = params.get("SmsDayLimit")
+        if params.get("TemplateProvider") is not None:
+            self._TemplateProvider = SMSProviderTemplateConfig()
+            self._TemplateProvider._deserialize(params.get("TemplateProvider"))
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]

{tencentcloud_sdk_python_tcb-3.1.102 → tencentcloud_sdk_python_tcb-3.1.104}/tencentcloud_sdk_python_tcb.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tencentcloud-sdk-python-tcb
-Version: 3.1.102
+Version: 3.1.104
 Summary: Tencent Cloud Tcb SDK for Python
 Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
 Author: Tencent Cloud
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 2.7
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
-Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.102
+Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.104
 
 ============================
 Tencent Cloud SDK for Python

tencentcloud_sdk_python_tcb-3.1.104/tencentcloud_sdk_python_tcb.egg-info/requires.txt

@@ -0,0 +1 @@
+tencentcloud-sdk-python-common<4.0.0,>=3.1.104

tencentcloud_sdk_python_tcb-3.1.102/tencentcloud_sdk_python_tcb.egg-info/requires.txt

@@ -1 +0,0 @@
-tencentcloud-sdk-python-common<4.0.0,>=3.1.102