tencentcloud-sdk-nodejs-intl-en
Version:
1,900 lines (1,600 loc) • 126 kB
JavaScript
/*
* Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
const AbstractModel = require("../../common/abstract_model");
/**
* Detailed summary by billing dimension
* @class
*/
class SummaryDetails extends AbstractModel {
constructor(){
super();
/**
* Product information list.
* @type {Array.<BusinessInfo> || null}
*/
this.Business = null;
/**
* Original price.
* @type {string || null}
*/
this.OriginalCost = null;
/**
* Voucher amount.
* @type {string || null}
*/
this.VoucherPayAmount = null;
/**
* RI deduction.
* @type {string || null}
*/
this.RICost = null;
/**
* <TOTAL_AMOUNT>.
* @type {string || null}
*/
this.TotalCost = null;
/**
* Classification dimension summary key.
* @type {string || null}
*/
this.GroupKey = null;
/**
* Summary value by classification dimension.
* @type {string || null}
*/
this.GroupValue = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Business) {
this.Business = new Array();
for (let z in params.Business) {
let obj = new BusinessInfo();
obj.deserialize(params.Business[z]);
this.Business.push(obj);
}
}
this.OriginalCost = 'OriginalCost' in params ? params.OriginalCost : null;
this.VoucherPayAmount = 'VoucherPayAmount' in params ? params.VoucherPayAmount : null;
this.RICost = 'RICost' in params ? params.RICost : null;
this.TotalCost = 'TotalCost' in params ? params.TotalCost : null;
this.GroupKey = 'GroupKey' in params ? params.GroupKey : null;
this.GroupValue = 'GroupValue' in params ? params.GroupValue : null;
}
}
/**
* The credit information of direct customers
* @class
*/
class QueryDirectCustomersCreditData extends AbstractModel {
constructor(){
super();
/**
* User UIN
* @type {number || null}
*/
this.Uin = null;
/**
* Total credit
* @type {number || null}
*/
this.TotalCredit = null;
/**
* Remaining credit
* @type {number || null}
*/
this.RemainingCredit = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Uin = 'Uin' in params ? params.Uin : null;
this.TotalCredit = 'TotalCredit' in params ? params.TotalCredit : null;
this.RemainingCredit = 'RemainingCredit' in params ? params.RemainingCredit : null;
}
}
/**
* DescribeCustomerBillSummary response structure.
* @class
*/
class DescribeCustomerBillSummaryResponse extends AbstractModel {
constructor(){
super();
/**
* Total amount
* @type {number || null}
*/
this.TotalCost = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCost = 'TotalCost' in params ? params.TotalCost : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Secondary Industry Information
* @class
*/
class TradeTwoNode extends AbstractModel {
constructor(){
super();
/**
* Secondary industry id.
* @type {string || null}
*/
this.Id = null;
/**
* Secondary industry name.
* @type {string || null}
*/
this.Name = null;
/**
* Industry information.
* @type {string || null}
*/
this.TradeInfo = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Id = 'Id' in params ? params.Id : null;
this.Name = 'Name' in params ? params.Name : null;
this.TradeInfo = 'TradeInfo' in params ? params.TradeInfo : null;
}
}
/**
* CreateAndSendClientInvitationMail response structure.
* @class
*/
class CreateAndSendClientInvitationMailResponse extends AbstractModel {
constructor(){
super();
/**
* Specifies the invitation link for the customer.
* @type {string || null}
*/
this.InvitationLink = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InvitationLink = 'InvitationLink' in params ? params.InvitationLink : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Customer bill details
* @class
*/
class CustomerBillDetailData extends AbstractModel {
constructor(){
super();
/**
* Distributor account.
* @type {number || null}
*/
this.PayerAccountId = null;
/**
* Sub-Customer account.
* @type {number || null}
*/
this.OwnerAccountId = null;
/**
* Operator account.
* @type {number || null}
*/
this.OperatorAccountId = null;
/**
* Product name.
* @type {string || null}
*/
this.ProductName = null;
/**
* Billing mode
.
Monthly subscription.
Pay-As-You-Go resources.
Standard ri reserved instances.
* @type {string || null}
*/
this.BillingMode = null;
/**
* Project name.
.
* @type {string || null}
*/
this.ProjectName = null;
/**
* Resource region.
* @type {string || null}
*/
this.Region = null;
/**
* Resource availability zone.
* @type {string || null}
*/
this.AvailabilityZone = null;
/**
* Instance id.
* @type {string || null}
*/
this.InstanceId = null;
/**
* Instance name.
* @type {string || null}
*/
this.InstanceName = null;
/**
* Sub-Product name
.
* @type {string || null}
*/
this.SubProductName = null;
/**
* Settlement type.
* @type {string || null}
*/
this.TransactionType = null;
/**
* Transaction flow id.
* @type {string || null}
*/
this.TransactionId = null;
/**
* Settlement time.
* @type {string || null}
*/
this.TransactionTime = null;
/**
* Resource start time.
* @type {string || null}
*/
this.UsageStartTime = null;
/**
* Resource end time.
* @type {string || null}
*/
this.UsageEndTime = null;
/**
* Component.
* @type {string || null}
*/
this.ComponentType = null;
/**
* Component name.
* @type {string || null}
*/
this.ComponentName = null;
/**
* Component list price.
* @type {string || null}
*/
this.ComponentListPrice = null;
/**
* Price unit.
* @type {string || null}
*/
this.ComponentPriceMeasurementUnit = null;
/**
* Component usage.
* @type {string || null}
*/
this.ComponentUsage = null;
/**
* Component usage unit.
* @type {string || null}
*/
this.ComponentUsageUnit = null;
/**
* Resource usage duration.
* @type {string || null}
*/
this.UsageDuration = null;
/**
* duration unit.
* @type {string || null}
*/
this.DurationUnit = null;
/**
* Total original price.
Original cost = component list price * component usage * usage duration.
* @type {string || null}
*/
this.OriginalCost = null;
/**
* Currency.
* @type {string || null}
*/
this.Currency = null;
/**
* = Total Amount After Discount - Voucher Deduction
* @type {string || null}
*/
this.TotalCost = null;
/**
* Id identifier.
* @type {string || null}
*/
this.Id = null;
/**
* Tag information.
* @type {Array.<TagInfo> || null}
*/
this.Tags = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.PayerAccountId = 'PayerAccountId' in params ? params.PayerAccountId : null;
this.OwnerAccountId = 'OwnerAccountId' in params ? params.OwnerAccountId : null;
this.OperatorAccountId = 'OperatorAccountId' in params ? params.OperatorAccountId : null;
this.ProductName = 'ProductName' in params ? params.ProductName : null;
this.BillingMode = 'BillingMode' in params ? params.BillingMode : null;
this.ProjectName = 'ProjectName' in params ? params.ProjectName : null;
this.Region = 'Region' in params ? params.Region : null;
this.AvailabilityZone = 'AvailabilityZone' in params ? params.AvailabilityZone : null;
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
this.InstanceName = 'InstanceName' in params ? params.InstanceName : null;
this.SubProductName = 'SubProductName' in params ? params.SubProductName : null;
this.TransactionType = 'TransactionType' in params ? params.TransactionType : null;
this.TransactionId = 'TransactionId' in params ? params.TransactionId : null;
this.TransactionTime = 'TransactionTime' in params ? params.TransactionTime : null;
this.UsageStartTime = 'UsageStartTime' in params ? params.UsageStartTime : null;
this.UsageEndTime = 'UsageEndTime' in params ? params.UsageEndTime : null;
this.ComponentType = 'ComponentType' in params ? params.ComponentType : null;
this.ComponentName = 'ComponentName' in params ? params.ComponentName : null;
this.ComponentListPrice = 'ComponentListPrice' in params ? params.ComponentListPrice : null;
this.ComponentPriceMeasurementUnit = 'ComponentPriceMeasurementUnit' in params ? params.ComponentPriceMeasurementUnit : null;
this.ComponentUsage = 'ComponentUsage' in params ? params.ComponentUsage : null;
this.ComponentUsageUnit = 'ComponentUsageUnit' in params ? params.ComponentUsageUnit : null;
this.UsageDuration = 'UsageDuration' in params ? params.UsageDuration : null;
this.DurationUnit = 'DurationUnit' in params ? params.DurationUnit : null;
this.OriginalCost = 'OriginalCost' in params ? params.OriginalCost : null;
this.Currency = 'Currency' in params ? params.Currency : null;
this.TotalCost = 'TotalCost' in params ? params.TotalCost : null;
this.Id = 'Id' in params ? params.Id : null;
if (params.Tags) {
this.Tags = new Array();
for (let z in params.Tags) {
let obj = new TagInfo();
obj.deserialize(params.Tags[z]);
this.Tags.push(obj);
}
}
}
}
/**
* Region details in the customer bill data totaled by region
* @class
*/
class RegionSummaryOverviewItem extends AbstractModel {
constructor(){
super();
/**
* Region id.
* @type {string || null}
*/
this.RegionId = null;
/**
* Region name.
* @type {string || null}
*/
this.RegionName = null;
/**
* Actual total consumption, up to 8 decimal places.
* @type {string || null}
*/
this.OriginalCost = null;
/**
* Voucher payment amount, up to 8 decimal places.
* @type {string || null}
*/
this.VoucherPayAmount = null;
/**
* Total consumption, up to 8 decimal places.
* @type {string || null}
*/
this.TotalCost = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.RegionId = 'RegionId' in params ? params.RegionId : null;
this.RegionName = 'RegionName' in params ? params.RegionName : null;
this.OriginalCost = 'OriginalCost' in params ? params.OriginalCost : null;
this.VoucherPayAmount = 'VoucherPayAmount' in params ? params.VoucherPayAmount : null;
this.TotalCost = 'TotalCost' in params ? params.TotalCost : null;
}
}
/**
* DescribeCustomerBillDownloadUrl request structure.
* @class
*/
class DescribeCustomerBillDownloadUrlRequest extends AbstractModel {
constructor(){
super();
/**
* The month to which the bill belongs, formatted as yyyy-mm; the earliest month available for query is june, 2022. current month's billing data may be inaccurate; please download the current month's bill after it is generated at 1:00 on the 5th of the next month.
* @type {string || null}
*/
this.Month = null;
/**
* Bill type. valid values: [billResource, billDetail, billResourcePack, billDetailPack]. `billResource`: resource bill; `billDetail`: detailed bill; `billResourcePack`: resource bill package; `billDetailPack`: detailed bill package.
* @type {string || null}
*/
this.FileType = null;
/**
* Customer type. valid values: [Customer, Reseller, ResellerCustomer]. `Customer`: direct customer; `Reseller`: secondary reseller; `ResellerCustomer`: reseller's customers
* @type {string || null}
*/
this.CustomerUinType = null;
/**
* Language. valid values: [zh_cn, en]. default is `en` (english).
* @type {string || null}
*/
this.FileLanguage = null;
/**
* Customer uin. when downloading the bill package (FileType is billResourcePack or billDetailPack), CustomerUin is not passed
* @type {number || null}
*/
this.CustomerUin = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Month = 'Month' in params ? params.Month : null;
this.FileType = 'FileType' in params ? params.FileType : null;
this.CustomerUinType = 'CustomerUinType' in params ? params.CustomerUinType : null;
this.FileLanguage = 'FileLanguage' in params ? params.FileLanguage : null;
this.CustomerUin = 'CustomerUin' in params ? params.CustomerUin : null;
}
}
/**
* List of customer UINs
* @class
*/
class DescribeCustomerUinData extends AbstractModel {
constructor(){
super();
/**
* Customer UIN Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.CustomerUin = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.CustomerUin = 'CustomerUin' in params ? params.CustomerUin : null;
}
}
/**
* Element type of the `GetCountryCodes` API
* @class
*/
class CountryCodeItem extends AbstractModel {
constructor(){
super();
/**
* Country/region name in English
* @type {string || null}
*/
this.EnName = null;
/**
* Country/region name in Chinese
* @type {string || null}
*/
this.Name = null;
/**
*
* @type {string || null}
*/
this.IOS2 = null;
/**
*
* @type {string || null}
*/
this.IOS3 = null;
/**
* International dialing code
* @type {string || null}
*/
this.Code = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.EnName = 'EnName' in params ? params.EnName : null;
this.Name = 'Name' in params ? params.Name : null;
this.IOS2 = 'IOS2' in params ? params.IOS2 : null;
this.IOS3 = 'IOS3' in params ? params.IOS3 : null;
this.Code = 'Code' in params ? params.Code : null;
}
}
/**
* DescribeBillSummaryByRegion request structure.
* @class
*/
class DescribeBillSummaryByRegionRequest extends AbstractModel {
constructor(){
super();
/**
* Bill month in the format of "yyyy-MM"
* @type {string || null}
*/
this.BillMonth = null;
/**
* Customer UIN
* @type {number || null}
*/
this.CustomerUin = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.BillMonth = 'BillMonth' in params ? params.BillMonth : null;
this.CustomerUin = 'CustomerUin' in params ? params.CustomerUin : null;
}
}
/**
* QueryCreditByUinList response structure.
* @class
*/
class QueryCreditByUinListResponse extends AbstractModel {
constructor(){
super();
/**
* User information list
* @type {Array.<QueryDirectCustomersCreditData> || null}
*/
this.Data = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Data) {
this.Data = new Array();
for (let z in params.Data) {
let obj = new QueryDirectCustomersCreditData();
obj.deserialize(params.Data[z]);
this.Data.push(obj);
}
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* QueryCreditAllocationHistory response structure.
* @class
*/
class QueryCreditAllocationHistoryResponse extends AbstractModel {
constructor(){
super();
/**
* Total number of historical records.
* @type {number || null}
*/
this.Total = null;
/**
* Detailed list of historical information.
* @type {Array.<QueryCreditAllocationHistoryData> || null}
*/
this.History = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Total = 'Total' in params ? params.Total : null;
if (params.History) {
this.History = new Array();
for (let z in params.History) {
let obj = new QueryCreditAllocationHistoryData();
obj.deserialize(params.History[z]);
this.History.push(obj);
}
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* CreateAccount request structure.
* @class
*/
class CreateAccountRequest extends AbstractModel {
constructor(){
super();
/**
* Account type of a new customer.
Valid values: `personal`, `company`.
* @type {string || null}
*/
this.AccountType = null;
/**
* Registered email address, which should be valid and correct.
such as "account@qq.com"
* @type {string || null}
*/
this.Mail = null;
/**
* Account password.
Length limit: 8-20 characters
A password must contain numbers, letters, and symbols (!@#$%^&*()). Space is not allowed.
* @type {string || null}
*/
this.Password = null;
/**
* The confirmed password, which must be the same as that entered in the `Password` field.
* @type {string || null}
*/
this.ConfirmPassword = null;
/**
* Customer's mobile number.
The caller needs to ensure the validity and correctness of the mobile number. A global mobile number within a range of 1-32 digits is allowed.
The system will perform binding limit verification of the mobile number you provide, allowing a maximum of 5 accounts per mobile number.
* @type {string || null}
*/
this.PhoneNum = null;
/**
* Customer's country/region code, which can be obtained via the [GetCountryCodes API](https://www.tencentcloud.com/document/product/1085/51416), such as "852".
Parameter value is not allowed to be 7,380,86.
* @type {string || null}
*/
this.CountryCode = null;
/**
* Customer's ISO2 standard country/region code, which can be obtained via the [GetCountryCodes API](https://www.tencentcloud.com/document/product/1085/51416). It should correspond to the `CountryCode` field, such as `HK`.
* @type {string || null}
*/
this.Area = null;
/**
* VerifyCode. This parameter is required.
Use the [SendVerifyCode API](https://www.tencentcloud.com/document/product/1085/65907) to obtain the verifycode.The SendVerifyCode API sends a 6-digit verifycode to your specified mobile number via SMS. After receiving it, you need to pass it along with other parameters.
* @type {string || null}
*/
this.VerifyCode = null;
/**
* Extension field, which is left empty by default.
* @type {string || null}
*/
this.Extended = null;
/**
* Layer-1 industry id. This is a required item and can be obtained via the [ GetTradeConfigList API](https://www.tencentcloud.com/zh/document/product/1085/68181),
such as "kghy_01".
* @type {string || null}
*/
this.TradeOne = null;
/**
* Layer-2 industry id. This is a required item and can be obtained via the [ GetTradeConfigList API](https://www.tencentcloud.com/zh/document/product/1085/68181),
such as "kghy_0101"
* @type {string || null}
*/
this.TradeTwo = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.AccountType = 'AccountType' in params ? params.AccountType : null;
this.Mail = 'Mail' in params ? params.Mail : null;
this.Password = 'Password' in params ? params.Password : null;
this.ConfirmPassword = 'ConfirmPassword' in params ? params.ConfirmPassword : null;
this.PhoneNum = 'PhoneNum' in params ? params.PhoneNum : null;
this.CountryCode = 'CountryCode' in params ? params.CountryCode : null;
this.Area = 'Area' in params ? params.Area : null;
this.VerifyCode = 'VerifyCode' in params ? params.VerifyCode : null;
this.Extended = 'Extended' in params ? params.Extended : null;
this.TradeOne = 'TradeOne' in params ? params.TradeOne : null;
this.TradeTwo = 'TradeTwo' in params ? params.TradeTwo : null;
}
}
/**
* DescribeBillSummary request structure.
* @class
*/
class DescribeBillSummaryRequest extends AbstractModel {
constructor(){
super();
/**
* The month to which the bill belongs, formatted as YYYY-MM.
* @type {string || null}
*/
this.Month = null;
/**
* Billing dimension. Optional parameters: product, project, tag
* @type {string || null}
*/
this.GroupType = null;
/**
* Tag value list
* @type {Array.<string> || null}
*/
this.TagKey = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Month = 'Month' in params ? params.Month : null;
this.GroupType = 'GroupType' in params ? params.GroupType : null;
this.TagKey = 'TagKey' in params ? params.TagKey : null;
}
}
/**
* QueryDirectCustomersCredit request structure.
* @class
*/
class QueryDirectCustomersCreditRequest extends AbstractModel {
constructor(){
super();
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
}
}
/**
* Sub-customer credit balance data
* @class
*/
class QueryCustomerBillingQuotaData extends AbstractModel {
constructor(){
super();
/**
* Total credit limit (unit: cny), accurate down to two decimal places.
* @type {number || null}
*/
this.TotalCredit = null;
/**
* Remaining credit limit (unit: cny), accurate down to two decimal places.
* @type {number || null}
*/
this.RemainingCredit = null;
/**
* Remaining total voucher amount (unit: cny), accurate down to two decimal places.
* @type {number || null}
*/
this.RemainingVoucher = null;
/**
* Forced status
.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.Force = null;
/**
* Prepaid frozen amount.
* @type {number || null}
*/
this.PrepayFrozen = null;
/**
* Postpaid frozen amount.
* @type {number || null}
*/
this.PostpayFrozen = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCredit = 'TotalCredit' in params ? params.TotalCredit : null;
this.RemainingCredit = 'RemainingCredit' in params ? params.RemainingCredit : null;
this.RemainingVoucher = 'RemainingVoucher' in params ? params.RemainingVoucher : null;
this.Force = 'Force' in params ? params.Force : null;
this.PrepayFrozen = 'PrepayFrozen' in params ? params.PrepayFrozen : null;
this.PostpayFrozen = 'PostpayFrozen' in params ? params.PostpayFrozen : null;
}
}
/**
* QueryPartnerCredit request structure.
* @class
*/
class QueryPartnerCreditRequest extends AbstractModel {
constructor(){
super();
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
}
}
/**
* GetTradeConfigList request structure.
* @class
*/
class GetTradeConfigListRequest extends AbstractModel {
constructor(){
super();
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
}
}
/**
* DescribeBillSummaryByProduct request structure.
* @class
*/
class DescribeBillSummaryByProductRequest extends AbstractModel {
constructor(){
super();
/**
* Bill month in the format of "yyyy-MM"
* @type {string || null}
*/
this.BillMonth = null;
/**
* Customer UIN
* @type {number || null}
*/
this.CustomerUin = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.BillMonth = 'BillMonth' in params ? params.BillMonth : null;
this.CustomerUin = 'CustomerUin' in params ? params.CustomerUin : null;
}
}
/**
* ModifyClientRemark response structure.
* @class
*/
class ModifyClientRemarkResponse extends AbstractModel {
constructor(){
super();
/**
* If successful, returns the new customer remarks
* @type {string || null}
*/
this.ClientRemark = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ClientRemark = 'ClientRemark' in params ? params.ClientRemark : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* QueryPartnerCredit response structure.
* @class
*/
class QueryPartnerCreditResponse extends AbstractModel {
constructor(){
super();
/**
* Allocated credit
* @type {number || null}
*/
this.AllocatedCredit = null;
/**
* Total credit
* @type {number || null}
*/
this.TotalCredit = null;
/**
* Remaining credit
* @type {number || null}
*/
this.RemainingCredit = null;
/**
* Allocated quota for the client
* @type {number || null}
*/
this.CustomerTotalCredit = null;
/**
* Remaining quota for the client
* @type {number || null}
*/
this.CustomerRemainingCredit = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.AllocatedCredit = 'AllocatedCredit' in params ? params.AllocatedCredit : null;
this.TotalCredit = 'TotalCredit' in params ? params.TotalCredit : null;
this.RemainingCredit = 'RemainingCredit' in params ? params.RemainingCredit : null;
this.CustomerTotalCredit = 'CustomerTotalCredit' in params ? params.CustomerTotalCredit : null;
this.CustomerRemainingCredit = 'CustomerRemainingCredit' in params ? params.CustomerRemainingCredit : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* QueryVoucherListByUin response structure.
* @class
*/
class QueryVoucherListByUinResponse extends AbstractModel {
constructor(){
super();
/**
* Customer voucher information
* @type {Array.<QueryVoucherListByUinItem> || null}
*/
this.Data = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Data) {
this.Data = new Array();
for (let z in params.Data) {
let obj = new QueryVoucherListByUinItem();
obj.deserialize(params.Data[z]);
this.Data.push(obj);
}
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* QueryVoucherPool request structure.
* @class
*/
class QueryVoucherPoolRequest extends AbstractModel {
constructor(){
super();
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
}
}
/**
* Voucher information of a single customer
* @class
*/
class QueryVoucherListByUinItem extends AbstractModel {
constructor(){
super();
/**
* Customer UIN
* @type {number || null}
*/
this.ClientUin = null;
/**
* The total number of vouchers
* @type {number || null}
*/
this.TotalCount = null;
/**
* Voucher details
* @type {Array.<QueryVoucherListByUinVoucherItem> || null}
*/
this.Data = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ClientUin = 'ClientUin' in params ? params.ClientUin : null;
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.Data) {
this.Data = new Array();
for (let z in params.Data) {
let obj = new QueryVoucherListByUinVoucherItem();
obj.deserialize(params.Data[z]);
this.Data.push(obj);
}
}
}
}
/**
* Policy product list entity response parameters structure.
* @class
*/
class PolicyProductList extends AbstractModel {
constructor(){
super();
/**
* Policy code.
* @type {string || null}
*/
this.PolicyCode = null;
/**
* The code of the ProductName field in the bill data. If the return value is *, any item at this level is included in the policy product range.
* @type {string || null}
*/
this.ProductCode = null;
/**
* The ProductName field value in the billing data. If the return value is *, any item at this level is included in the policy product range.
* @type {string || null}
*/
this.ProductName = null;
/**
* The code of the SubProduct field in the bill data. If the return value is *, any item at this level is included in the policy product range.
* @type {string || null}
*/
this.SubProductCode = null;
/**
* The SubProduct field value in the billing data. If the return value is *, any item at this level is included in the policy product range.
* @type {string || null}
*/
this.SubProductName = null;
/**
* The code of the ComponentType field in the bill data. If the return value is *, any item at this level is included in the policy product range.
* @type {string || null}
*/
this.ComponentTypeCode = null;
/**
* The ComponentType field value in the billing data. If the return value is *, any item at this level is included in the policy product range.
* @type {string || null}
*/
this.ComponentTypeName = null;
/**
* The code of the Component field in the bill data. If the return value is *, any item at this level is included in the policy product range.
* @type {string || null}
*/
this.ComponentCode = null;
/**
* The Component field value in the billing data. If the return value is *, any item at this level is included in the policy product range.
* @type {string || null}
*/
this.ComponentName = null;
/**
* Policy effective time.
* @type {string || null}
*/
this.StartDate = null;
/**
* Policy expiration time.
* @type {string || null}
*/
this.EndDate = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.PolicyCode = 'PolicyCode' in params ? params.PolicyCode : null;
this.ProductCode = 'ProductCode' in params ? params.ProductCode : null;
this.ProductName = 'ProductName' in params ? params.ProductName : null;
this.SubProductCode = 'SubProductCode' in params ? params.SubProductCode : null;
this.SubProductName = 'SubProductName' in params ? params.SubProductName : null;
this.ComponentTypeCode = 'ComponentTypeCode' in params ? params.ComponentTypeCode : null;
this.ComponentTypeName = 'ComponentTypeName' in params ? params.ComponentTypeName : null;
this.ComponentCode = 'ComponentCode' in params ? params.ComponentCode : null;
this.ComponentName = 'ComponentName' in params ? params.ComponentName : null;
this.StartDate = 'StartDate' in params ? params.StartDate : null;
this.EndDate = 'EndDate' in params ? params.EndDate : null;
}
}
/**
* QueryCustomerBillingQuota response structure.
* @class
*/
class QueryCustomerBillingQuotaResponse extends AbstractModel {
constructor(){
super();
/**
* Limit data.
* @type {QueryCustomerBillingQuotaData || null}
*/
this.Data = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Data) {
let obj = new QueryCustomerBillingQuotaData();
obj.deserialize(params.Data)
this.Data = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeCustomerBillSummary request structure.
* @class
*/
class DescribeCustomerBillSummaryRequest extends AbstractModel {
constructor(){
super();
/**
* Customer UIN
* @type {number || null}
*/
this.CustomerUin = null;
/**
* The queried month in "YYYY-MM" format, such as 2023-01.
* @type {string || null}
*/
this.Month = null;
/**
* Billing mode. Valid values:
`prePay` (Monthly subscription)
`postPay` (Pay-as-you-go)
* @type {string || null}
*/
this.PayMode = null;
/**
* Transaction type. Valid values:
`prepay_purchase` (Purchase)
`prepay_renew` (Renewal)
`prepay_modify` (Upgrade/Downgrade)
`prepay_return` (Monthly subscription refund)
`postpay_deduct` (Pay-as-you-go)
`postpay_deduct_h` (Hourly settlement)
`postpay_deduct_d` (Daily settlement)
`postpay_deduct_m` (Monthly settlement)
`offline_deduct` (Offline project deduction)
`online_deduct` (Offline product deduction)
`recon_deduct` (Adjustment - deduction)
`recon_increase` (Adjustment - compensation)
`ripay_purchase` (One-off RI Fee)
`postpay_deduct_s` (Spot)
`ri_hour_pay` (Hourly RI fee)
`prePurchase` (New monthly subscription)
`preRenew` (Monthly subscription renewal)
`preUpgrade` (Upgrade/Downgrade)
`preDowngrade` (Upgrade/Downgrade)
`svp_hour_pay` (Hourly Savings Plan fee)
`recon_guarantee` (Minimum spend deduction)
`pre_purchase` (New monthly subscription)
`pre_renew` (Monthly subscription renewal)
`pre_upgrade` (Upgrade/Downgrade)
`pre_downgrade` (Upgrade/Downgrade)
* @type {string || null}
*/
this.ActionType = null;
/**
* Payment status
`0`: N/A
`1`: Paid
`2`: Unpaid
* @type {string || null}
*/
this.IsConfirmed = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.CustomerUin = 'CustomerUin' in params ? params.CustomerUin : null;
this.Month = 'Month' in params ? params.Month : null;
this.PayMode = 'PayMode' in params ? params.PayMode : null;
this.ActionType = 'ActionType' in params ? params.ActionType : null;
this.IsConfirmed = 'IsConfirmed' in params ? params.IsConfirmed : null;
}
}
/**
* QueryInvitationInfo response structure.
* @class
*/
class QueryInvitationInfoResponse extends AbstractModel {
constructor(){
super();
/**
* Invitation link information.
* @type {Array.<QueryInvitationInfoData> || null}
*/
this.InvitationInfo = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.InvitationInfo) {
this.InvitationInfo = new Array();
for (let z in params.InvitationInfo) {
let obj = new QueryInvitationInfoData();
obj.deserialize(params.InvitationInfo[z]);
this.InvitationInfo.push(obj);
}
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeBillSummaryByPayMode response structure.
* @class
*/
class DescribeBillSummaryByPayModeResponse extends AbstractModel {
constructor(){
super();
/**
* Get the payment mode details of the sub-customer bill summary through the api.
* @type {Array.<PayModeSummaryOverviewItem> || null}
*/
this.SummaryOverview = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.SummaryOverview) {
this.SummaryOverview = new Array();
for (let z in params.SummaryOverview) {
let obj = new PayModeSummaryOverviewItem();
obj.deserialize(params.SummaryOverview[z]);
this.SummaryOverview.push(obj);
}
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* QueryAccountVerificationStatus response structure.
* @class
*/
class QueryAccountVerificationStatusResponse extends AbstractModel {
constructor(){
super();
/**
* Account verification status
* @type {boolean || null}
*/
this.AccountStatus = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.AccountStatus = 'AccountStatus' in params ? params.AccountStatus : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* AllocateCustomerCredit request structure.
* @class
*/
class AllocateCustomerCreditRequest extends AbstractModel {
constructor(){
super();
/**
* Specific value of the credit allocated to the customer
* @type {number || null}
*/
this.AddedCredit = null;
/**
* Customer UIN
* @type {number || null}
*/
this.ClientUin = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.AddedCredit = 'AddedCredit' in params ? params.AddedCredit : null;
this.ClientUin = 'ClientUin' in params ? params.ClientUin : null;
}
}
/**
* DescribeBillDownloadUrl request structure.
* @class
*/
class DescribeBillDownloadUrlRequest extends AbstractModel {
constructor(){
super();
/**
* The month to which the bill belongs, formatted as YYYY-MM; the earliest month available for query is June, 2022. Current month's billing data may be inaccurate; please download the current month's bill after it is generated at 1:00 on the 5th of the next month.
* @type {string || null}
*/
this.Month = null;
/**
* Type of bill. Valid values: L2 or L3
* @type {string || null}
*/
this.FileType = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Month = 'Month' in params ? params.Month : null;
this.FileType = 'FileType' in params ? params.FileType : null;
}
}
/**
* DescribeBillSummaryByPayMode request structure.
* @class
*/
class DescribeBillSummaryByPayModeRequest extends AbstractModel {
constructor(){
super();
/**
* Bill month in the format of "yyyy-MM"
* @type {string || null}
*/
this.BillMonth = null;
/**
* Customer UIN
* @type {number || null}
*/
this.CustomerUin = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.BillMonth = 'BillMonth' in params ? params.BillMonth : null;
this.CustomerUin = 'CustomerUin' in params ? params.CustomerUin : null;
}
}
/**
* Invitation link information.
* @class
*/
class QueryInvitationInfoData extends AbstractModel {
constructor(){
super();
/**
* Invitation link token.
* @type {string || null}
*/
this.InvitationToken = null;
/**
* Creation time of the invitation link.
* @type {string || null}
*/
this.CreateTime = null;
/**
* Invite link status.
1: Unused.
2: Used.
* @type {number || null}
*/
this.Status = null;
/**
* Indicates the usage time of the invitation link.
* @type {string || null}
*/
this.UseTime = null;
/**
* Customer uin.
* @type {number || null}
*/
this.ClientUin = null;
/**
* Customer mailbox.
* @type {string || null}
*/
this.ClientMail = null;
/**
* Customer type.
1: Second-Level reseller.
2: Sub-Customer.
* @type {number || null}
*/
this.ClientType = null;
/**
* The binding time of the customer.
* @type {string || null}
*/
this.BindTime = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InvitationToken = 'InvitationToken' in params ? params.InvitationToken : null;
this.CreateTime = 'CreateTime' in params ? params.CreateTime : null;
this.Status = 'Status' in params ? params.Status : null;
this.UseTime = 'UseTime' in params ? params.UseTime : null;
this.ClientUin = 'ClientUin' in params ? params.ClientUin : null;
this.ClientMail = 'ClientMail' in params ? params.ClientMail : null;
this.ClientType = 'ClientType' in params ? params.ClientType : null;
this.BindTime = 'BindTime' in params ? params.BindTime : null;
}
}
/**
* GetCountryCodes response structure.
* @class
*/
class GetCountryCodesResponse extends AbstractModel {
constructor(){
super();
/**
* List of country/region codes
* @type {Array.<CountryCodeItem> || null}
*/
this.Data = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {