tencentcloud-sdk-ses 1.0.243 → 1.0.244

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8bd2467bdc4311d99dd3b6281bf6213083c94bba
-  data.tar.gz: 9d25cc6c95b0f37cbe0eed899e9fa89e37bc9b19
+  metadata.gz: 1be91ac06089d675fe9cac445b38c6f205c2d1ce
+  data.tar.gz: c756c213dd9cc9795fa24da6491f29c1d52c3a0e
 SHA512:
-  metadata.gz: fe29900092bdea89304a43495e3561a47fe6b638076d7c4ac3b086bcfebc4dea53dc8a8c7609507f7f1acab6a0e8a71b175f8e22839d7089bb13f4e68052d2b1
-  data.tar.gz: 17d03d67a8e062e0a0aa90b4cdd72a439236c6b84a53b24b2926e572f4fa005b6de84828c1827a45701b96a38df27e9e9a7ab9eb8ca4182fe843bb1892e48973
+  metadata.gz: c7920c7ade07f4608d6debf00a43f385a6a7c7c9b36b8e37aa99512e60c6b8a706d59e8b114db5a141bc7fd8b9a59e51dae8285e565c964ff1033f6f78f41d17
+  data.tar.gz: 40152aab283fd9b9a5bbe7a734f4e0944893973670090a9ccf992e2ca8eec924b1c1436635a377342a2301bb187b058f4d413e78796ee39a567ab2f21720ab65

data/lib/VERSION

@@ -1 +1 @@
-1.0.243
+1.0.244

data/lib/v20201002/client.rb

@@ -126,6 +126,54 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 创建收件人列表，收件人列表是发送批量邮件的目标邮件地址列表。创建列表后，需要上传收件人邮箱地址。之后创建发送任务，关联列表，便可以实现批量发送邮件的功能
+
+        # @param request: Request instance for CreateReceiver.
+        # @type request: :class:`Tencentcloud::ses::V20201002::CreateReceiverRequest`
+        # @rtype: :class:`Tencentcloud::ses::V20201002::CreateReceiverResponse`
+        def CreateReceiver(request)
+          body = send_request('CreateReceiver', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = CreateReceiverResponse.new
+            model.deserialize(response['Response'])
+            model
+          else
+            code = response['Response']['Error']['Code']
+            message = response['Response']['Error']['Message']
+            reqid = response['Response']['RequestId']
+            raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
+          end
+        rescue TencentCloud::Common::TencentCloudSDKException => e
+          raise e
+        rescue StandardError => e
+          raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
+        end
+
+        # 在创建完收件人列表后，向这个收件人列表中批量增加收件人邮箱地址，一次最大支持10W，异步完成处理。收件人列表只可以上传一次，不可追加上传。数据量比较大的时候，上传可能需要一点时间，可以通过查询收件人列表了解上传状态和上传数量
+
+        # @param request: Request instance for CreateReceiverDetail.
+        # @type request: :class:`Tencentcloud::ses::V20201002::CreateReceiverDetailRequest`
+        # @rtype: :class:`Tencentcloud::ses::V20201002::CreateReceiverDetailResponse`
+        def CreateReceiverDetail(request)
+          body = send_request('CreateReceiverDetail', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = CreateReceiverDetailResponse.new
+            model.deserialize(response['Response'])
+            model
+          else
+            code = response['Response']['Error']['Code']
+            message = response['Response']['Error']['Message']
+            reqid = response['Response']['RequestId']
+            raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
+          end
+        rescue TencentCloud::Common::TencentCloudSDKException => e
+          raise e
+        rescue StandardError => e
+          raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
+        end
+
         # 邮箱被拉黑之后，用户如果确认收件邮箱有效或者已经处于激活状态，可以从腾讯云地址库中删除该黑名单之后继续投递。
 
         # @param request: Request instance for DeleteBlackList.
@@ -414,6 +462,54 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 根据条件查询收件人列表，支持分页，模糊查询，状态查询
+
+        # @param request: Request instance for ListReceivers.
+        # @type request: :class:`Tencentcloud::ses::V20201002::ListReceiversRequest`
+        # @rtype: :class:`Tencentcloud::ses::V20201002::ListReceiversResponse`
+        def ListReceivers(request)
+          body = send_request('ListReceivers', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = ListReceiversResponse.new
+            model.deserialize(response['Response'])
+            model
+          else
+            code = response['Response']['Error']['Code']
+            message = response['Response']['Error']['Message']
+            reqid = response['Response']['RequestId']
+            raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
+          end
+        rescue TencentCloud::Common::TencentCloudSDKException => e
+          raise e
+        rescue StandardError => e
+          raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
+        end
+
+        # 分页查询批量发送邮件任务，包含即时发送任务，定时发送任务，周期重复发送任务，查询发送情况，包括请求数量，已发数量，缓存数量，任务状态等信息
+
+        # @param request: Request instance for ListSendTasks.
+        # @type request: :class:`Tencentcloud::ses::V20201002::ListSendTasksRequest`
+        # @rtype: :class:`Tencentcloud::ses::V20201002::ListSendTasksResponse`
+        def ListSendTasks(request)
+          body = send_request('ListSendTasks', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = ListSendTasksResponse.new
+            model.deserialize(response['Response'])
+            model
+          else
+            code = response['Response']['Error']['Code']
+            message = response['Response']['Error']['Message']
+            reqid = response['Response']['RequestId']
+            raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
+          end
+        rescue TencentCloud::Common::TencentCloudSDKException => e
+          raise e
+        rescue StandardError => e
+          raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
+        end
+
         # 您可以通过此API发送TEXT或者HTML邮件，适用于触发类邮件（验证码、交易类）。默认仅支持使用模板发送邮件，如需发送自定义内容，请单独联系商务开通此功能。
 
         # @param request: Request instance for SendEmail.

data/lib/v20201002/models.rb

@@ -61,10 +61,12 @@ module TencentCloud
         # @type CycleParam: :class:`Tencentcloud::Ses.v20201002.models.CycleEmailParam`
         # @param TimedParam: 定时发送任务的必要参数
         # @type TimedParam: :class:`Tencentcloud::Ses.v20201002.models.TimedEmailParam`
+        # @param Unsubscribe: 退订选项 1: 加入退订链接 0: 不加入退订链接
+        # @type Unsubscribe: String
 
-        attr_accessor :FromEmailAddress, :ReceiverId, :Subject, :TaskType, :ReplyToAddresses, :Template, :Simple, :Attachments, :CycleParam, :TimedParam
+        attr_accessor :FromEmailAddress, :ReceiverId, :Subject, :TaskType, :ReplyToAddresses, :Template, :Simple, :Attachments, :CycleParam, :TimedParam, :Unsubscribe
         
-        def initialize(fromemailaddress=nil, receiverid=nil, subject=nil, tasktype=nil, replytoaddresses=nil, template=nil, simple=nil, attachments=nil, cycleparam=nil, timedparam=nil)
+        def initialize(fromemailaddress=nil, receiverid=nil, subject=nil, tasktype=nil, replytoaddresses=nil, template=nil, simple=nil, attachments=nil, cycleparam=nil, timedparam=nil, unsubscribe=nil)
           @FromEmailAddress = fromemailaddress
           @ReceiverId = receiverid
           @Subject = subject
@@ -75,6 +77,7 @@ module TencentCloud
           @Attachments = attachments
           @CycleParam = cycleparam
           @TimedParam = timedparam
+          @Unsubscribe = unsubscribe
         end
 
         def deserialize(params)
@@ -107,6 +110,7 @@ module TencentCloud
             @TimedParam = TimedEmailParam.new
             @TimedParam.deserialize(params['TimedParam'])
           end
+          @Unsubscribe = params['Unsubscribe']
         end
       end
 
@@ -276,6 +280,82 @@ module TencentCloud
         end
       end
 
+      # CreateReceiverDetail请求参数结构体
+      class CreateReceiverDetailRequest < TencentCloud::Common::AbstractModel
+        # @param ReceiverId: 收件人列表ID
+        # @type ReceiverId: Integer
+        # @param Emails: 邮箱
+        # @type Emails: Array
+
+        attr_accessor :ReceiverId, :Emails
+        
+        def initialize(receiverid=nil, emails=nil)
+          @ReceiverId = receiverid
+          @Emails = emails
+        end
+
+        def deserialize(params)
+          @ReceiverId = params['ReceiverId']
+          @Emails = params['Emails']
+        end
+      end
+
+      # CreateReceiverDetail返回参数结构体
+      class CreateReceiverDetailResponse < TencentCloud::Common::AbstractModel
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :RequestId
+        
+        def initialize(requestid=nil)
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @RequestId = params['RequestId']
+        end
+      end
+
+      # CreateReceiver请求参数结构体
+      class CreateReceiverRequest < TencentCloud::Common::AbstractModel
+        # @param ReceiversName: 收件人列表名称
+        # @type ReceiversName: String
+        # @param Desc: 收件人列表描述
+        # @type Desc: String
+
+        attr_accessor :ReceiversName, :Desc
+        
+        def initialize(receiversname=nil, desc=nil)
+          @ReceiversName = receiversname
+          @Desc = desc
+        end
+
+        def deserialize(params)
+          @ReceiversName = params['ReceiversName']
+          @Desc = params['Desc']
+        end
+      end
+
+      # CreateReceiver返回参数结构体
+      class CreateReceiverResponse < TencentCloud::Common::AbstractModel
+        # @param ReceiverId: 收件人列表id，后续根据收件人列表id上传收件人地址
+        # @type ReceiverId: Integer
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :ReceiverId, :RequestId
+        
+        def initialize(receiverid=nil, requestid=nil)
+          @ReceiverId = receiverid
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @ReceiverId = params['ReceiverId']
+          @RequestId = params['RequestId']
+        end
+      end
+
       # 创建重复周期发送邮件任务的参数
       class CycleEmailParam < TencentCloud::Common::AbstractModel
         # @param BeginTime: 任务开始时间
@@ -912,6 +992,166 @@ module TencentCloud
         end
       end
 
+      # ListReceivers请求参数结构体
+      class ListReceiversRequest < TencentCloud::Common::AbstractModel
+        # @param Offset: 偏移量，整型，从0开始
+        # @type Offset: Integer
+        # @param Limit: 限制数目，整型，不超过100
+        # @type Limit: Integer
+        # @param Status: 列表状态(1 待上传 2 上传中  3传完成)，若查询所有就不传这个字段
+        # @type Status: Integer
+        # @param KeyWord: 列表名称的关键字，模糊查询
+        # @type KeyWord: String
+
+        attr_accessor :Offset, :Limit, :Status, :KeyWord
+        
+        def initialize(offset=nil, limit=nil, status=nil, keyword=nil)
+          @Offset = offset
+          @Limit = limit
+          @Status = status
+          @KeyWord = keyword
+        end
+
+        def deserialize(params)
+          @Offset = params['Offset']
+          @Limit = params['Limit']
+          @Status = params['Status']
+          @KeyWord = params['KeyWord']
+        end
+      end
+
+      # ListReceivers返回参数结构体
+      class ListReceiversResponse < TencentCloud::Common::AbstractModel
+        # @param TotalCount: 总数
+        # @type TotalCount: Integer
+        # @param Data: 数据记录
+        # @type Data: Array
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :TotalCount, :Data, :RequestId
+        
+        def initialize(totalcount=nil, data=nil, requestid=nil)
+          @TotalCount = totalcount
+          @Data = data
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @TotalCount = params['TotalCount']
+          unless params['Data'].nil?
+            @Data = []
+            params['Data'].each do |i|
+              receiverdata_tmp = ReceiverData.new
+              receiverdata_tmp.deserialize(i)
+              @Data << receiverdata_tmp
+            end
+          end
+          @RequestId = params['RequestId']
+        end
+      end
+
+      # ListSendTasks请求参数结构体
+      class ListSendTasksRequest < TencentCloud::Common::AbstractModel
+        # @param Offset: 偏移量，整型，从0开始，0代表跳过0行
+        # @type Offset: Integer
+        # @param Limit: 限制数目，整型,不超过100
+        # @type Limit: Integer
+        # @param Status: 任务状态 1 待开始 5 发送中 6 今日暂停发送  7 发信异常 10 发送完成。查询所有状态，则不传这个字段
+        # @type Status: Integer
+        # @param ReceiverId: 收件人列表ID
+        # @type ReceiverId: Integer
+        # @param TaskType: 任务类型 1即时 2定时 3周期，查询所有类型则不传这个字段
+        # @type TaskType: Integer
+
+        attr_accessor :Offset, :Limit, :Status, :ReceiverId, :TaskType
+        
+        def initialize(offset=nil, limit=nil, status=nil, receiverid=nil, tasktype=nil)
+          @Offset = offset
+          @Limit = limit
+          @Status = status
+          @ReceiverId = receiverid
+          @TaskType = tasktype
+        end
+
+        def deserialize(params)
+          @Offset = params['Offset']
+          @Limit = params['Limit']
+          @Status = params['Status']
+          @ReceiverId = params['ReceiverId']
+          @TaskType = params['TaskType']
+        end
+      end
+
+      # ListSendTasks返回参数结构体
+      class ListSendTasksResponse < TencentCloud::Common::AbstractModel
+        # @param TotalCount: 总数
+        # @type TotalCount: Integer
+        # @param Data: 数据记录
+        # @type Data: Array
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :TotalCount, :Data, :RequestId
+        
+        def initialize(totalcount=nil, data=nil, requestid=nil)
+          @TotalCount = totalcount
+          @Data = data
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @TotalCount = params['TotalCount']
+          unless params['Data'].nil?
+            @Data = []
+            params['Data'].each do |i|
+              sendtaskdata_tmp = SendTaskData.new
+              sendtaskdata_tmp.deserialize(i)
+              @Data << sendtaskdata_tmp
+            end
+          end
+          @RequestId = params['RequestId']
+        end
+      end
+
+      # 收件人列表数据类型
+      class ReceiverData < TencentCloud::Common::AbstractModel
+        # @param ReceiverId: 收件人列表ID
+        # @type ReceiverId: Integer
+        # @param ReceiversName: 收件人列表名称
+        # @type ReceiversName: String
+        # @param Count: 收件人地址总数
+        # @type Count: Integer
+        # @param Desc: 收件人列表描述
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type Desc: String
+        # @param ReceiversStatus: 列表状态(1 待上传 2 上传中 3 上传完成)
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type ReceiversStatus: Integer
+        # @param CreateTime: 创建时间,如:2021-09-28 16:40:35
+        # @type CreateTime: String
+
+        attr_accessor :ReceiverId, :ReceiversName, :Count, :Desc, :ReceiversStatus, :CreateTime
+        
+        def initialize(receiverid=nil, receiversname=nil, count=nil, desc=nil, receiversstatus=nil, createtime=nil)
+          @ReceiverId = receiverid
+          @ReceiversName = receiversname
+          @Count = count
+          @Desc = desc
+          @ReceiversStatus = receiversstatus
+          @CreateTime = createtime
+        end
+
+        def deserialize(params)
+          @ReceiverId = params['ReceiverId']
+          @ReceiversName = params['ReceiversName']
+          @Count = params['Count']
+          @Desc = params['Desc']
+          @ReceiversStatus = params['ReceiversStatus']
+          @CreateTime = params['CreateTime']
+        end
+      end
+
       # SendEmail请求参数结构体
       class SendEmailRequest < TencentCloud::Common::AbstractModel
         # @param FromEmailAddress: 发信邮件地址。请填写发件人邮箱地址，例如：noreply@mail.qcloud.com
@@ -930,7 +1170,7 @@ module TencentCloud
         # @type Simple: :class:`Tencentcloud::Ses.v20201002.models.Simple`
         # @param Attachments: 需要发送附件时，填写附件相关参数。
         # @type Attachments: Array
-        # @param Unsubscribe: 是否加入退订链接
+        # @param Unsubscribe: 退订选项 1: 加入退订链接 0: 不加入退订链接
         # @type Unsubscribe: String
 
         attr_accessor :FromEmailAddress, :Destination, :Subject, :ReplyToAddresses, :Template, :Simple, :Attachments, :Unsubscribe
@@ -1078,6 +1318,95 @@ module TencentCloud
         end
       end
 
+      # 发送任务数据
+      class SendTaskData < TencentCloud::Common::AbstractModel
+        # @param TaskId: 任务id
+        # @type TaskId: Integer
+        # @param FromEmailAddress: 发信地址
+        # @type FromEmailAddress: String
+        # @param ReceiverId: 收件人列表Id
+        # @type ReceiverId: Integer
+        # @param TaskStatus: 任务状态 1 待开始 5 发送中 6 今日暂停发送  7 发信异常 10 发送完成
+        # @type TaskStatus: Integer
+        # @param TaskType: 任务类型 1 即时 2 定时 3 周期
+        # @type TaskType: Integer
+        # @param RequestCount: 任务请求发信数量
+        # @type RequestCount: Integer
+        # @param SendCount: 已经发送数量
+        # @type SendCount: Integer
+        # @param CacheCount: 缓存数量
+        # @type CacheCount: Integer
+        # @param CreateTime: 任务创建时间
+        # @type CreateTime: String
+        # @param UpdateTime: 任务更新时间
+        # @type UpdateTime: String
+        # @param Subject: 邮件主题
+        # @type Subject: String
+        # @param Template: 模板和模板数据
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type Template: :class:`Tencentcloud::Ses.v20201002.models.Template`
+        # @param CycleParam: 周期任务参数
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type CycleParam: :class:`Tencentcloud::Ses.v20201002.models.CycleEmailParam`
+        # @param TimedParam: 定时任务参数
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type TimedParam: :class:`Tencentcloud::Ses.v20201002.models.TimedEmailParam`
+        # @param ErrMsg: 任务异常信息
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type ErrMsg: String
+        # @param ReceiversName: 收件人列表名称
+        # @type ReceiversName: String
+
+        attr_accessor :TaskId, :FromEmailAddress, :ReceiverId, :TaskStatus, :TaskType, :RequestCount, :SendCount, :CacheCount, :CreateTime, :UpdateTime, :Subject, :Template, :CycleParam, :TimedParam, :ErrMsg, :ReceiversName
+        
+        def initialize(taskid=nil, fromemailaddress=nil, receiverid=nil, taskstatus=nil, tasktype=nil, requestcount=nil, sendcount=nil, cachecount=nil, createtime=nil, updatetime=nil, subject=nil, template=nil, cycleparam=nil, timedparam=nil, errmsg=nil, receiversname=nil)
+          @TaskId = taskid
+          @FromEmailAddress = fromemailaddress
+          @ReceiverId = receiverid
+          @TaskStatus = taskstatus
+          @TaskType = tasktype
+          @RequestCount = requestcount
+          @SendCount = sendcount
+          @CacheCount = cachecount
+          @CreateTime = createtime
+          @UpdateTime = updatetime
+          @Subject = subject
+          @Template = template
+          @CycleParam = cycleparam
+          @TimedParam = timedparam
+          @ErrMsg = errmsg
+          @ReceiversName = receiversname
+        end
+
+        def deserialize(params)
+          @TaskId = params['TaskId']
+          @FromEmailAddress = params['FromEmailAddress']
+          @ReceiverId = params['ReceiverId']
+          @TaskStatus = params['TaskStatus']
+          @TaskType = params['TaskType']
+          @RequestCount = params['RequestCount']
+          @SendCount = params['SendCount']
+          @CacheCount = params['CacheCount']
+          @CreateTime = params['CreateTime']
+          @UpdateTime = params['UpdateTime']
+          @Subject = params['Subject']
+          unless params['Template'].nil?
+            @Template = Template.new
+            @Template.deserialize(params['Template'])
+          end
+          unless params['CycleParam'].nil?
+            @CycleParam = CycleEmailParam.new
+            @CycleParam.deserialize(params['CycleParam'])
+          end
+          unless params['TimedParam'].nil?
+            @TimedParam = TimedEmailParam.new
+            @TimedParam.deserialize(params['TimedParam'])
+          end
+          @ErrMsg = params['ErrMsg']
+          @ReceiversName = params['ReceiversName']
+        end
+      end
+
       # 邮件发送的内容，可以是纯文本(TEXT)，也可以是纯代码(HTML)，或者纯文本+HTML的组合(建议方式)
       class Simple < TencentCloud::Common::AbstractModel
         # @param Html: base64之后的Html代码。需要包含所有的代码信息，不要包含外部css，否则会导致显示格式错乱

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-ses
 version: !ruby/object:Gem::Version
-  version: 1.0.243
+  version: 1.0.244
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-17 00:00:00.000000000 Z
+date: 2022-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common