|
| 1 | +""" Code is generated by ucloud-model, DO NOT EDIT IT. """ |
| 2 | + |
| 3 | +from ucloud.core.typesystem import schema, fields |
| 4 | +from ucloud.services.usms.schemas import models |
| 5 | + |
| 6 | + |
| 7 | +""" USMS API Schema |
| 8 | +""" |
| 9 | + |
| 10 | + |
| 11 | +""" |
| 12 | +API: CreateUSMSSignature |
| 13 | +
|
| 14 | +调用接口CreateUSMSSignature申请短信签名 |
| 15 | +""" |
| 16 | + |
| 17 | + |
| 18 | +class CreateUSMSSignatureRequestSchema(schema.RequestSchema): |
| 19 | + """ CreateUSMSSignature - 调用接口CreateUSMSSignature申请短信签名 |
| 20 | + """ |
| 21 | + |
| 22 | + fields = { |
| 23 | + "CertificateType": fields.Int(required=True, dump_to="CertificateType"), |
| 24 | + "Description": fields.Str(required=True, dump_to="Description"), |
| 25 | + "File": fields.Str(required=True, dump_to="File"), |
| 26 | + "ProjectId": fields.Str(required=True, dump_to="ProjectId"), |
| 27 | + "ProxyFile": fields.Str(required=False, dump_to="ProxyFile"), |
| 28 | + "SigContent": fields.Str(required=True, dump_to="SigContent"), |
| 29 | + "SigPurpose": fields.Int(required=True, dump_to="SigPurpose"), |
| 30 | + "SigType": fields.Int(required=True, dump_to="SigType"), |
| 31 | + } |
| 32 | + |
| 33 | + |
| 34 | +class CreateUSMSSignatureResponseSchema(schema.ResponseSchema): |
| 35 | + """ CreateUSMSSignature - 调用接口CreateUSMSSignature申请短信签名 |
| 36 | + """ |
| 37 | + |
| 38 | + fields = { |
| 39 | + "Message": fields.Str(required=True, load_from="Message"), |
| 40 | + "SigContent": fields.Str(required=False, load_from="SigContent"), |
| 41 | + "SigId": fields.Str(required=False, load_from="SigId"), |
| 42 | + } |
| 43 | + |
| 44 | + |
| 45 | +""" |
| 46 | +API: CreateUSMSTemplate |
| 47 | +
|
| 48 | +调用接口CreateUSMSTemplate申请短信模板 |
| 49 | +""" |
| 50 | + |
| 51 | + |
| 52 | +class CreateUSMSTemplateRequestSchema(schema.RequestSchema): |
| 53 | + """ CreateUSMSTemplate - 调用接口CreateUSMSTemplate申请短信模板 |
| 54 | + """ |
| 55 | + |
| 56 | + fields = { |
| 57 | + "ProjectId": fields.Str(required=True, dump_to="ProjectId"), |
| 58 | + "Purpose": fields.Int(required=True, dump_to="Purpose"), |
| 59 | + "Region": fields.Str(required=False, dump_to="Region"), |
| 60 | + "Remark": fields.Str(required=False, dump_to="Remark"), |
| 61 | + "Template": fields.Str(required=True, dump_to="Template"), |
| 62 | + "TemplateName": fields.Str(required=True, dump_to="TemplateName"), |
| 63 | + "UnsubscribeInfo": fields.Str( |
| 64 | + required=False, dump_to="UnsubscribeInfo" |
| 65 | + ), |
| 66 | + "Zone": fields.Str(required=False, dump_to="Zone"), |
| 67 | + } |
| 68 | + |
| 69 | + |
| 70 | +class CreateUSMSTemplateResponseSchema(schema.ResponseSchema): |
| 71 | + """ CreateUSMSTemplate - 调用接口CreateUSMSTemplate申请短信模板 |
| 72 | + """ |
| 73 | + |
| 74 | + fields = { |
| 75 | + "Message": fields.Str(required=True, load_from="Message"), |
| 76 | + "TemplateId": fields.Str(required=True, load_from="TemplateId"), |
| 77 | + } |
| 78 | + |
| 79 | + |
| 80 | +""" |
| 81 | +API: DeleteUSMSSignature |
| 82 | +
|
| 83 | +调用接口DeleteUSMSSignature删除短信签名 |
| 84 | +""" |
| 85 | + |
| 86 | + |
| 87 | +class DeleteUSMSSignatureRequestSchema(schema.RequestSchema): |
| 88 | + """ DeleteUSMSSignature - 调用接口DeleteUSMSSignature删除短信签名 |
| 89 | + """ |
| 90 | + |
| 91 | + fields = { |
| 92 | + "ProjectId": fields.Str(required=True, dump_to="ProjectId"), |
| 93 | + "SigIds": fields.List(fields.Str()), |
| 94 | + } |
| 95 | + |
| 96 | + |
| 97 | +class DeleteUSMSSignatureResponseSchema(schema.ResponseSchema): |
| 98 | + """ DeleteUSMSSignature - 调用接口DeleteUSMSSignature删除短信签名 |
| 99 | + """ |
| 100 | + |
| 101 | + fields = {"Message": fields.Str(required=True, load_from="Message")} |
| 102 | + |
| 103 | + |
| 104 | +""" |
| 105 | +API: DeleteUSMSTemplate |
| 106 | +
|
| 107 | +调用接口DeleteUSMSTemplate删除短信模板 |
| 108 | +""" |
| 109 | + |
| 110 | + |
| 111 | +class DeleteUSMSTemplateRequestSchema(schema.RequestSchema): |
| 112 | + """ DeleteUSMSTemplate - 调用接口DeleteUSMSTemplate删除短信模板 |
| 113 | + """ |
| 114 | + |
| 115 | + fields = { |
| 116 | + "ProjectId": fields.Str(required=True, dump_to="ProjectId"), |
| 117 | + "Region": fields.Str(required=False, dump_to="Region"), |
| 118 | + "TemplateIds": fields.List(fields.Str()), |
| 119 | + "Zone": fields.Str(required=False, dump_to="Zone"), |
| 120 | + } |
| 121 | + |
| 122 | + |
| 123 | +class DeleteUSMSTemplateResponseSchema(schema.ResponseSchema): |
| 124 | + """ DeleteUSMSTemplate - 调用接口DeleteUSMSTemplate删除短信模板 |
| 125 | + """ |
| 126 | + |
| 127 | + fields = {"Message": fields.Str(required=True, load_from="Message")} |
| 128 | + |
| 129 | + |
| 130 | +""" |
| 131 | +API: GetUSMSSendReceipt |
| 132 | +
|
| 133 | +获取短信发送回执信息。下游服务提供商回执信息返回会有一定延时,建议发送完短信以后,5-10分钟后再调用该接口拉取回执信息。若超过12小时未返回,则请联系技术支持确认原因 |
| 134 | +""" |
| 135 | + |
| 136 | + |
| 137 | +class GetUSMSSendReceiptRequestSchema(schema.RequestSchema): |
| 138 | + """ GetUSMSSendReceipt - 获取短信发送回执信息。下游服务提供商回执信息返回会有一定延时,建议发送完短信以后,5-10分钟后再调用该接口拉取回执信息。若超过12小时未返回,则请联系技术支持确认原因 |
| 139 | + """ |
| 140 | + |
| 141 | + fields = { |
| 142 | + "ProjectId": fields.Str(required=False, dump_to="ProjectId"), |
| 143 | + "Region": fields.Str(required=False, dump_to="Region"), |
| 144 | + "SessionNoSet": fields.List(fields.Str()), |
| 145 | + "Zone": fields.Str(required=False, dump_to="Zone"), |
| 146 | + } |
| 147 | + |
| 148 | + |
| 149 | +class GetUSMSSendReceiptResponseSchema(schema.ResponseSchema): |
| 150 | + """ GetUSMSSendReceipt - 获取短信发送回执信息。下游服务提供商回执信息返回会有一定延时,建议发送完短信以后,5-10分钟后再调用该接口拉取回执信息。若超过12小时未返回,则请联系技术支持确认原因 |
| 151 | + """ |
| 152 | + |
| 153 | + fields = { |
| 154 | + "Data": fields.List( |
| 155 | + models.ReceiptPerSessionSchema(), required=True, load_from="Data" |
| 156 | + ), |
| 157 | + "Message": fields.Str(required=True, load_from="Message"), |
| 158 | + } |
| 159 | + |
| 160 | + |
| 161 | +""" |
| 162 | +API: QueryUSMSSignature |
| 163 | +
|
| 164 | +调用接口QueryUSMSSignature查询短信签名申请状态 |
| 165 | +""" |
| 166 | + |
| 167 | + |
| 168 | +class QueryUSMSSignatureRequestSchema(schema.RequestSchema): |
| 169 | + """ QueryUSMSSignature - 调用接口QueryUSMSSignature查询短信签名申请状态 |
| 170 | + """ |
| 171 | + |
| 172 | + fields = { |
| 173 | + "ProjectId": fields.Str(required=False, dump_to="ProjectId"), |
| 174 | + "SigContent": fields.Str(required=False, dump_to="SigContent"), |
| 175 | + "SigId": fields.Str(required=False, dump_to="SigId"), |
| 176 | + } |
| 177 | + |
| 178 | + |
| 179 | +class QueryUSMSSignatureResponseSchema(schema.ResponseSchema): |
| 180 | + """ QueryUSMSSignature - 调用接口QueryUSMSSignature查询短信签名申请状态 |
| 181 | + """ |
| 182 | + |
| 183 | + fields = { |
| 184 | + "Data": models.OutSignatureSchema(), |
| 185 | + "Message": fields.Str(required=True, load_from="Message"), |
| 186 | + } |
| 187 | + |
| 188 | + |
| 189 | +""" |
| 190 | +API: QueryUSMSTemplate |
| 191 | +
|
| 192 | +调用接口QueryUSMSTemplate查询短信模板申请状态 |
| 193 | +""" |
| 194 | + |
| 195 | + |
| 196 | +class QueryUSMSTemplateRequestSchema(schema.RequestSchema): |
| 197 | + """ QueryUSMSTemplate - 调用接口QueryUSMSTemplate查询短信模板申请状态 |
| 198 | + """ |
| 199 | + |
| 200 | + fields = { |
| 201 | + "ProjectId": fields.Str(required=True, dump_to="ProjectId"), |
| 202 | + "TemplateId": fields.Str(required=True, dump_to="TemplateId"), |
| 203 | + } |
| 204 | + |
| 205 | + |
| 206 | +class QueryUSMSTemplateResponseSchema(schema.ResponseSchema): |
| 207 | + """ QueryUSMSTemplate - 调用接口QueryUSMSTemplate查询短信模板申请状态 |
| 208 | + """ |
| 209 | + |
| 210 | + fields = { |
| 211 | + "Data": models.OutTemplateSchema(), |
| 212 | + "Message": fields.Str(required=False, load_from="Message"), |
| 213 | + } |
| 214 | + |
| 215 | + |
| 216 | +""" |
| 217 | +API: SendUSMSMessage |
| 218 | +
|
| 219 | +发送短信息。短信字数超过70个后,按照每66个进行切割(因为要加上1/3), 2/3)等字样,占用4个字长)。短信最大长度不能超过600个字。每个汉字、数字、字母、字符都按一个字计 |
| 220 | +""" |
| 221 | + |
| 222 | + |
| 223 | +class SendUSMSMessageRequestSchema(schema.RequestSchema): |
| 224 | + """ SendUSMSMessage - 发送短信息。短信字数超过70个后,按照每66个进行切割(因为要加上1/3), 2/3)等字样,占用4个字长)。短信最大长度不能超过600个字。每个汉字、数字、字母、字符都按一个字计 |
| 225 | + """ |
| 226 | + |
| 227 | + fields = { |
| 228 | + "PhoneNumbers": fields.List(fields.Str()), |
| 229 | + "ProjectId": fields.Str(required=False, dump_to="ProjectId"), |
| 230 | + "Region": fields.Str(required=False, dump_to="Region"), |
| 231 | + "SigContent": fields.Str(required=False, dump_to="SigContent"), |
| 232 | + "TemplateId": fields.Str(required=True, dump_to="TemplateId"), |
| 233 | + "TemplateParams": fields.List(fields.Str()), |
| 234 | + "Zone": fields.Str(required=False, dump_to="Zone"), |
| 235 | + } |
| 236 | + |
| 237 | + |
| 238 | +class SendUSMSMessageResponseSchema(schema.ResponseSchema): |
| 239 | + """ SendUSMSMessage - 发送短信息。短信字数超过70个后,按照每66个进行切割(因为要加上1/3), 2/3)等字样,占用4个字长)。短信最大长度不能超过600个字。每个汉字、数字、字母、字符都按一个字计 |
| 240 | + """ |
| 241 | + |
| 242 | + fields = { |
| 243 | + "Action": fields.Str(required=True, load_from="Action"), |
| 244 | + "Message": fields.Str(required=True, load_from="Message"), |
| 245 | + "RetCode": fields.Int(required=True, load_from="RetCode"), |
| 246 | + "SessionNo": fields.Str(required=False, load_from="SessionNo"), |
| 247 | + } |
| 248 | + |
| 249 | + |
| 250 | +""" |
| 251 | +API: UpdateUSMSSignature |
| 252 | +
|
| 253 | +调用接口UpdateUSMSSignature修改未通过审核的短信签名,并重新提交审核 |
| 254 | +""" |
| 255 | + |
| 256 | + |
| 257 | +class UpdateUSMSSignatureRequestSchema(schema.RequestSchema): |
| 258 | + """ UpdateUSMSSignature - 调用接口UpdateUSMSSignature修改未通过审核的短信签名,并重新提交审核 |
| 259 | + """ |
| 260 | + |
| 261 | + fields = { |
| 262 | + "CertificateType": fields.Int( |
| 263 | + required=False, dump_to="CertificateType" |
| 264 | + ), |
| 265 | + "File": fields.Str(required=True, dump_to="File"), |
| 266 | + "ProjectId": fields.Str(required=True, dump_to="ProjectId"), |
| 267 | + "ProxyFile": fields.Str(required=False, dump_to="ProxyFile"), |
| 268 | + "SigContent": fields.Str(required=True, dump_to="SigContent"), |
| 269 | + "SigId": fields.Str(required=True, dump_to="SigId"), |
| 270 | + "SigPurpose": fields.Int(required=True, dump_to="SigPurpose"), |
| 271 | + "SigType": fields.Int(required=True, dump_to="SigType"), |
| 272 | + } |
| 273 | + |
| 274 | + |
| 275 | +class UpdateUSMSSignatureResponseSchema(schema.ResponseSchema): |
| 276 | + """ UpdateUSMSSignature - 调用接口UpdateUSMSSignature修改未通过审核的短信签名,并重新提交审核 |
| 277 | + """ |
| 278 | + |
| 279 | + fields = {"Message": fields.Str(required=True, load_from="Message")} |
| 280 | + |
| 281 | + |
| 282 | +""" |
| 283 | +API: UpdateUSMSTemplate |
| 284 | +
|
| 285 | +调用接口UpdateUSMSTemplate修改未通过审核的短信模板,并重新提交审核 |
| 286 | +""" |
| 287 | + |
| 288 | + |
| 289 | +class UpdateUSMSTemplateRequestSchema(schema.RequestSchema): |
| 290 | + """ UpdateUSMSTemplate - 调用接口UpdateUSMSTemplate修改未通过审核的短信模板,并重新提交审核 |
| 291 | + """ |
| 292 | + |
| 293 | + fields = { |
| 294 | + "ProjectId": fields.Str(required=True, dump_to="ProjectId"), |
| 295 | + "Region": fields.Str(required=False, dump_to="Region"), |
| 296 | + "Remark": fields.Str(required=False, dump_to="Remark"), |
| 297 | + "Template": fields.Str(required=True, dump_to="Template"), |
| 298 | + "TemplateId": fields.Str(required=True, dump_to="TemplateId"), |
| 299 | + "TemplateName": fields.Str(required=False, dump_to="TemplateName"), |
| 300 | + "UnsubscribeInfo": fields.Str( |
| 301 | + required=False, dump_to="UnsubscribeInfo" |
| 302 | + ), |
| 303 | + "Zone": fields.Str(required=False, dump_to="Zone"), |
| 304 | + } |
| 305 | + |
| 306 | + |
| 307 | +class UpdateUSMSTemplateResponseSchema(schema.ResponseSchema): |
| 308 | + """ UpdateUSMSTemplate - 调用接口UpdateUSMSTemplate修改未通过审核的短信模板,并重新提交审核 |
| 309 | + """ |
| 310 | + |
| 311 | + fields = {"Message": fields.Str(required=True, load_from="Message")} |
0 commit comments