v20210409

package
v3.0.376+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 10, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// CAM signature/authentication error. Please try again later.
	AUTHFAILURE = "AuthFailure"

	// Operation failed.
	FAILEDOPERATION = "FailedOperation"

	// The email address has already been registered.
	FAILEDOPERATION_MAILISREGISTERED = "FailedOperation.MailIsRegistered"

	// Internal error. Please try again later.
	INTERNALERROR = "InternalError"

	// A parameter error occurred.
	INVALIDPARAMETER = "InvalidParameter"

	// The operation is unauthorized.
	UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
)
View Source 
const APIVersion = "2021-04-09"

Variables

This section is empty.

Functions

This section is empty.

Types

type AllocateCustomerCreditRequest 

type AllocateCustomerCreditRequest struct {
	*tchttp.BaseRequest

	// Specific value of the credit allocated to the customer
	AddedCredit *float64 `json:"AddedCredit,omitempty" name:"AddedCredit"`

	// Customer UIN
	ClientUin *uint64 `json:"ClientUin,omitempty" name:"ClientUin"`
}

func NewAllocateCustomerCreditRequest 

func NewAllocateCustomerCreditRequest() (request *AllocateCustomerCreditRequest)

func (*AllocateCustomerCreditRequest) FromJsonString 

func (r *AllocateCustomerCreditRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*AllocateCustomerCreditRequest) ToJsonString 

func (r *AllocateCustomerCreditRequest) ToJsonString() string

type AllocateCustomerCreditResponse 

type AllocateCustomerCreditResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewAllocateCustomerCreditResponse 

func NewAllocateCustomerCreditResponse() (response *AllocateCustomerCreditResponse)

func (*AllocateCustomerCreditResponse) FromJsonString 

func (r *AllocateCustomerCreditResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*AllocateCustomerCreditResponse) ToJsonString 

func (r *AllocateCustomerCreditResponse) ToJsonString() string

type Client 

type Client struct {
	common.Client
}

func NewClient 

func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId 

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) AllocateCustomerCredit 

func (c *Client) AllocateCustomerCredit(request *AllocateCustomerCreditRequest) (response *AllocateCustomerCreditResponse, err error)

AllocateCustomerCredit This API is used for a partner to set credit for a customer, such as increasing or lowering the credit and setting it to 0.

1. The credit is valid permanently and will not be zeroed regularly.

2. The customer's service will be suspended when its available credit sets to 0, so caution should be exercised with this operation.

3. To prevent the customer from making new purchases without affecting their use of previously purchased products, the partner can set their available credit to 0 after obtaining the non-stop feature privilege from the channel manager.

4. The set credit is an increase to the current available credit and cannot exceed the remaining allocable credit. Setting the credit to a negative value indicates to repossess it. The available credit can be set to 0 at the minimum.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"

func (*Client) AllocateCustomerCreditWithContext 

func (c *Client) AllocateCustomerCreditWithContext(ctx context.Context, request *AllocateCustomerCreditRequest) (response *AllocateCustomerCreditResponse, err error)

AllocateCustomerCredit This API is used for a partner to set credit for a customer, such as increasing or lowering the credit and setting it to 0.

1. The credit is valid permanently and will not be zeroed regularly.

2. The customer's service will be suspended when its available credit sets to 0, so caution should be exercised with this operation.

3. To prevent the customer from making new purchases without affecting their use of previously purchased products, the partner can set their available credit to 0 after obtaining the non-stop feature privilege from the channel manager.

4. The set credit is an increase to the current available credit and cannot exceed the remaining allocable credit. Setting the credit to a negative value indicates to repossess it. The available credit can be set to 0 at the minimum.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"

func (*Client) CreateAccount 

func (c *Client) CreateAccount(request *CreateAccountRequest) (response *CreateAccountResponse, err error)

CreateAccount This API is used to create a Tencent Cloud account in the International Partner platform for a customer. After registration, the customer will be automatically bound to the partner account.

Notes:<br>

1. To create the Tencent Cloud account, the partner should enter and verify the customer’s email address and mobile number.<br>

2. The customer needs to complete personal information after the first login.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION_MAILISREGISTERED = "FailedOperation.MailIsRegistered"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) CreateAccountWithContext 

func (c *Client) CreateAccountWithContext(ctx context.Context, request *CreateAccountRequest) (response *CreateAccountResponse, err error)

CreateAccount This API is used to create a Tencent Cloud account in the International Partner platform for a customer. After registration, the customer will be automatically bound to the partner account.

Notes:<br>

1. To create the Tencent Cloud account, the partner should enter and verify the customer’s email address and mobile number.<br>

2. The customer needs to complete personal information after the first login.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION_MAILISREGISTERED = "FailedOperation.MailIsRegistered"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) GetCountryCodes 

func (c *Client) GetCountryCodes(request *GetCountryCodesRequest) (response *GetCountryCodesResponse, err error)

GetCountryCodes This API is used to obtain country and region codes.

error code that may be returned: 

INTERNALERROR = "InternalError"

func (*Client) GetCountryCodesWithContext 

func (c *Client) GetCountryCodesWithContext(ctx context.Context, request *GetCountryCodesRequest) (response *GetCountryCodesResponse, err error)

GetCountryCodes This API is used to obtain country and region codes.

error code that may be returned: 

INTERNALERROR = "InternalError"

func (*Client) QueryCreditAllocationHistory 

func (c *Client) QueryCreditAllocationHistory(request *QueryCreditAllocationHistoryRequest) (response *QueryCreditAllocationHistoryResponse, err error)

QueryCreditAllocationHistory This API is used to query all the credit allocation records of a single customer.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"

func (*Client) QueryCreditAllocationHistoryWithContext 

func (c *Client) QueryCreditAllocationHistoryWithContext(ctx context.Context, request *QueryCreditAllocationHistoryRequest) (response *QueryCreditAllocationHistoryResponse, err error)

QueryCreditAllocationHistory This API is used to query all the credit allocation records of a single customer.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"

func (*Client) QueryCustomersCredit 

func (c *Client) QueryCustomersCredit(request *QueryCustomersCreditRequest) (response *QueryCustomersCreditResponse, err error)

QueryCustomersCredit This API is used for a partner to query a customer's credit and basic information.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"

func (*Client) QueryCustomersCreditWithContext 

func (c *Client) QueryCustomersCreditWithContext(ctx context.Context, request *QueryCustomersCreditRequest) (response *QueryCustomersCreditResponse, err error)

QueryCustomersCredit This API is used for a partner to query a customer's credit and basic information.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"

func (*Client) QueryPartnerCredit 

func (c *Client) QueryPartnerCredit(request *QueryPartnerCreditRequest) (response *QueryPartnerCreditResponse, err error)

QueryPartnerCredit This API is used for a partner to query its own total credit, available credit, and used credit in USD.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"

func (*Client) QueryPartnerCreditWithContext 

func (c *Client) QueryPartnerCreditWithContext(ctx context.Context, request *QueryPartnerCreditRequest) (response *QueryPartnerCreditResponse, err error)

QueryPartnerCredit This API is used for a partner to query its own total credit, available credit, and used credit in USD.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"

type CountryCodeItem 

type CountryCodeItem struct {

	// Country/region name in English
	EnName *string `json:"EnName,omitempty" name:"EnName"`

	// Country/region name in Chinese
	Name *string `json:"Name,omitempty" name:"Name"`

	// IOS2 standard country/region code
	IOS2 *string `json:"IOS2,omitempty" name:"IOS2"`

	// IOS3 standard country/region code
	IOS3 *string `json:"IOS3,omitempty" name:"IOS3"`

	// Phone code
	Code *string `json:"Code,omitempty" name:"Code"`
}

type CreateAccountRequest 

type CreateAccountRequest struct {
	*tchttp.BaseRequest

	// Account type of a new customer. Valid value: `business`.
	AccountType *string `json:"AccountType,omitempty" name:"AccountType"`

	// Registered email address, which should be valid and correct.
	// For example, account@qq.com.
	Mail *string `json:"Mail,omitempty" name:"Mail"`

	// Account password
	// Length limit: 8-20 characters
	// A password must contain numbers, letters, and special symbols [!@#$%^&*()]. Spaces are not allowed.
	Password *string `json:"Password,omitempty" name:"Password"`

	// Confirm the password. It must be the same as the `Password` field.
	ConfirmPassword *string `json:"ConfirmPassword,omitempty" name:"ConfirmPassword"`

	// Customer mobile number, which should be valid and correct.
	// A global mobile number within 1-32 digits is allowed, such as 18888888888.
	PhoneNum *string `json:"PhoneNum,omitempty" name:"PhoneNum"`

	// Country code, which can be obtained via the `GetCountryCodes` API, such as 852.
	CountryCode *string `json:"CountryCode,omitempty" name:"CountryCode"`

	// ISO2 standard country code, which can be obtained via the `GetCountryCodes` API. It should correspond to the `CountryCode` field.
	Area *string `json:"Area,omitempty" name:"Area"`

	// Expanded field, which is left empty by default.
	Extended *string `json:"Extended,omitempty" name:"Extended"`
}

func NewCreateAccountRequest 

func NewCreateAccountRequest() (request *CreateAccountRequest)

func (*CreateAccountRequest) FromJsonString 

func (r *CreateAccountRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateAccountRequest) ToJsonString 

func (r *CreateAccountRequest) ToJsonString() string

type CreateAccountResponse 

type CreateAccountResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Account UIN
		Uin *string `json:"Uin,omitempty" name:"Uin"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewCreateAccountResponse 

func NewCreateAccountResponse() (response *CreateAccountResponse)

func (*CreateAccountResponse) FromJsonString 

func (r *CreateAccountResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateAccountResponse) ToJsonString 

func (r *CreateAccountResponse) ToJsonString() string

type GetCountryCodesRequest 

type GetCountryCodesRequest struct {
	*tchttp.BaseRequest
}

func NewGetCountryCodesRequest 

func NewGetCountryCodesRequest() (request *GetCountryCodesRequest)

func (*GetCountryCodesRequest) FromJsonString 

func (r *GetCountryCodesRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetCountryCodesRequest) ToJsonString 

func (r *GetCountryCodesRequest) ToJsonString() string

type GetCountryCodesResponse 

type GetCountryCodesResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// List of country/region codes
		Data []*CountryCodeItem `json:"Data,omitempty" name:"Data"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewGetCountryCodesResponse 

func NewGetCountryCodesResponse() (response *GetCountryCodesResponse)

func (*GetCountryCodesResponse) FromJsonString 

func (r *GetCountryCodesResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetCountryCodesResponse) ToJsonString 

func (r *GetCountryCodesResponse) ToJsonString() string

type QueryCreditAllocationHistoryData 

type QueryCreditAllocationHistoryData struct {

	// Allocation time
	AllocatedTime *string `json:"AllocatedTime,omitempty" name:"AllocatedTime"`

	// Operator
	Operator *string `json:"Operator,omitempty" name:"Operator"`

	// Allocated credit value
	Credit *float64 `json:"Credit,omitempty" name:"Credit"`
}

type QueryCreditAllocationHistoryRequest 

type QueryCreditAllocationHistoryRequest struct {
	*tchttp.BaseRequest

	// Customer UIN
	ClientUin *uint64 `json:"ClientUin,omitempty" name:"ClientUin"`

	// Page number
	Page *uint64 `json:"Page,omitempty" name:"Page"`

	// Number of data entries per page
	PageSize *uint64 `json:"PageSize,omitempty" name:"PageSize"`
}

func NewQueryCreditAllocationHistoryRequest 

func NewQueryCreditAllocationHistoryRequest() (request *QueryCreditAllocationHistoryRequest)

func (*QueryCreditAllocationHistoryRequest) FromJsonString 

func (r *QueryCreditAllocationHistoryRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*QueryCreditAllocationHistoryRequest) ToJsonString 

func (r *QueryCreditAllocationHistoryRequest) ToJsonString() string

type QueryCreditAllocationHistoryResponse 

type QueryCreditAllocationHistoryResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Total number of records
		// Note: this field may return null, indicating that no valid values can be obtained.
		Total *uint64 `json:"Total,omitempty" name:"Total"`

		// List of record details
		// Note: this field may return null, indicating that no valid values can be obtained.
		History []*QueryCreditAllocationHistoryData `json:"History,omitempty" name:"History"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewQueryCreditAllocationHistoryResponse 

func NewQueryCreditAllocationHistoryResponse() (response *QueryCreditAllocationHistoryResponse)

func (*QueryCreditAllocationHistoryResponse) FromJsonString 

func (r *QueryCreditAllocationHistoryResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*QueryCreditAllocationHistoryResponse) ToJsonString 

func (r *QueryCreditAllocationHistoryResponse) ToJsonString() string

type QueryCustomersCreditData 

type QueryCustomersCreditData struct {

	// Name
	Name *string `json:"Name,omitempty" name:"Name"`

	// Type
	Type *string `json:"Type,omitempty" name:"Type"`

	// Phone
	Mobile *string `json:"Mobile,omitempty" name:"Mobile"`

	// Email
	Email *string `json:"Email,omitempty" name:"Email"`

	// Overdue payment flag
	Arrears *string `json:"Arrears,omitempty" name:"Arrears"`

	// Binding time
	AssociationTime *string `json:"AssociationTime,omitempty" name:"AssociationTime"`

	// Expiration time
	RecentExpiry *string `json:"RecentExpiry,omitempty" name:"RecentExpiry"`

	// The UIN of reseller’s customer
	ClientUin *uint64 `json:"ClientUin,omitempty" name:"ClientUin"`

	// Credit granted to reseller’s customer
	Credit *float64 `json:"Credit,omitempty" name:"Credit"`

	// The remaining credit of reseller’s customer
	RemainingCredit *float64 `json:"RemainingCredit,omitempty" name:"RemainingCredit"`
}

type QueryCustomersCreditRequest 

type QueryCustomersCreditRequest struct {
	*tchttp.BaseRequest
}

func NewQueryCustomersCreditRequest 

func NewQueryCustomersCreditRequest() (request *QueryCustomersCreditRequest)

func (*QueryCustomersCreditRequest) FromJsonString 

func (r *QueryCustomersCreditRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*QueryCustomersCreditRequest) ToJsonString 

func (r *QueryCustomersCreditRequest) ToJsonString() string

type QueryCustomersCreditResponse 

type QueryCustomersCreditResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Queries the list of customers
		// Note: this field may return null, indicating that no valid values can be obtained.
		Data []*QueryCustomersCreditData `json:"Data,omitempty" name:"Data"`

		// Number of customers
		Total *uint64 `json:"Total,omitempty" name:"Total"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewQueryCustomersCreditResponse 

func NewQueryCustomersCreditResponse() (response *QueryCustomersCreditResponse)

func (*QueryCustomersCreditResponse) FromJsonString 

func (r *QueryCustomersCreditResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*QueryCustomersCreditResponse) ToJsonString 

func (r *QueryCustomersCreditResponse) ToJsonString() string

type QueryPartnerCreditRequest 

type QueryPartnerCreditRequest struct {
	*tchttp.BaseRequest
}

func NewQueryPartnerCreditRequest 

func NewQueryPartnerCreditRequest() (request *QueryPartnerCreditRequest)

func (*QueryPartnerCreditRequest) FromJsonString 

func (r *QueryPartnerCreditRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*QueryPartnerCreditRequest) ToJsonString 

func (r *QueryPartnerCreditRequest) ToJsonString() string

type QueryPartnerCreditResponse 

type QueryPartnerCreditResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Allocated credit
		AllocatedCredit *float64 `json:"AllocatedCredit,omitempty" name:"AllocatedCredit"`

		// Total credit
		TotalCredit *float64 `json:"TotalCredit,omitempty" name:"TotalCredit"`

		// Remaining credit
		RemainingCredit *float64 `json:"RemainingCredit,omitempty" name:"RemainingCredit"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewQueryPartnerCreditResponse 

func NewQueryPartnerCreditResponse() (response *QueryPartnerCreditResponse)

func (*QueryPartnerCreditResponse) FromJsonString 

func (r *QueryPartnerCreditResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*QueryPartnerCreditResponse) ToJsonString 

func (r *QueryPartnerCreditResponse) ToJsonString() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.