Trendsic Platform Service

UserVerifyCellPhoneRequest

The following routes are available for this service:
GET,PUT,POST,OPTIONS	/v1/userverifycellphone

"use strict";
/** @typedef {'NONE'|'CRC32C'|'CRC32'|'SHA256'|'SHA1'} */
export var CoreChecksumAlgorithm;
(function (CoreChecksumAlgorithm) {
    CoreChecksumAlgorithm["NONE"] = "NONE"
    CoreChecksumAlgorithm["CRC32C"] = "CRC32C"
    CoreChecksumAlgorithm["CRC32"] = "CRC32"
    CoreChecksumAlgorithm["SHA256"] = "SHA256"
    CoreChecksumAlgorithm["SHA1"] = "SHA1"
})(CoreChecksumAlgorithm || (CoreChecksumAlgorithm = {}));
/** @typedef {'NOT_VALIDATED'|'PENDING_RESPONSE_READ'|'SUCCESSFUL'|'INVALID'} */
export var ChecksumValidationStatus;
(function (ChecksumValidationStatus) {
    ChecksumValidationStatus["NOT_VALIDATED"] = "NOT_VALIDATED"
    ChecksumValidationStatus["PENDING_RESPONSE_READ"] = "PENDING_RESPONSE_READ"
    ChecksumValidationStatus["SUCCESSFUL"] = "SUCCESSFUL"
    ChecksumValidationStatus["INVALID"] = "INVALID"
})(ChecksumValidationStatus || (ChecksumValidationStatus = {}));
export class ResponseMetadata {
    /** @param {{RequestId?:string,Metadata?:{ [index:string]: string; },ChecksumAlgorithm?:CoreChecksumAlgorithm,ChecksumValidationStatus?:ChecksumValidationStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RequestId;
    /** @type {{ [index:string]: string; }} */
    Metadata;
    /** @type {CoreChecksumAlgorithm} */
    ChecksumAlgorithm;
    /** @type {ChecksumValidationStatus} */
    ChecksumValidationStatus;
}
export class AmazonWebServiceResponse {
    /** @param {{ResponseMetadata?:ResponseMetadata,ContentLength?:number,HttpStatusCode?:HttpStatusCode}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseMetadata} */
    ResponseMetadata;
    /** @type {number} */
    ContentLength;
    /** @type {HttpStatusCode} */
    HttpStatusCode;
}
export class NewDeviceMetadataType {
    /** @param {{DeviceGroupKey?:string,DeviceKey?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    DeviceGroupKey;
    /** @type {string} */
    DeviceKey;
}
export class AuthenticationResultType {
    /** @param {{AccessToken?:string,ExpiresIn?:number,IdToken?:string,NewDeviceMetadata?:NewDeviceMetadataType,RefreshToken?:string,TokenType?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    AccessToken;
    /** @type {number} */
    ExpiresIn;
    /** @type {string} */
    IdToken;
    /** @type {NewDeviceMetadataType} */
    NewDeviceMetadata;
    /** @type {string} */
    RefreshToken;
    /** @type {string} */
    TokenType;
}
export class ConstantClass {
    /** @param {{Value?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Value;
}
export class ChallengeNameType extends ConstantClass {
    /** @param {{Value?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class InitiateAuthResponse extends AmazonWebServiceResponse {
    /** @param {{AuthenticationResult?:AuthenticationResultType,ChallengeName?:ChallengeNameType,ChallengeParameters?:{ [index:string]: string; },Session?:string,ResponseMetadata?:ResponseMetadata,ContentLength?:number,HttpStatusCode?:HttpStatusCode}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {AuthenticationResultType} */
    AuthenticationResult;
    /** @type {ChallengeNameType} */
    ChallengeName;
    /** @type {{ [index:string]: string; }} */
    ChallengeParameters = {};
    /** @type {string} */
    Session;
}
export class AwsAuthResponse {
    /** @param {{ResponseStatus?:ResponseStatus,InitiateAuthResponse?:InitiateAuthResponse,Success?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {InitiateAuthResponse} */
    InitiateAuthResponse;
    /** @type {boolean} */
    Success;
}
export class UserVerifyCellPhoneRequest {
    /** @param {{UserId?:string,CellPhone?:string,VerificationCode?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    UserId;
    /** @type {string} */
    CellPhone;
    /** @type {string} */
    VerificationCode;
}

JavaScript UserVerifyCellPhoneRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/userverifycellphone HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	UserId: 00000000000000000000000000000000,
	CellPhone: String,
	VerificationCode: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	InitiateAuthResponse: 
	{
		AuthenticationResult: 
		{
			AccessToken: String,
			ExpiresIn: 0,
			IdToken: String,
			NewDeviceMetadata: 
			{
				DeviceGroupKey: String,
				DeviceKey: String
			},
			RefreshToken: String,
			TokenType: String
		},
		ChallengeParameters: 
		{
			String: String
		},
		Session: String,
		ResponseMetadata: 
		{
			RequestId: String,
			Metadata: {},
			ChecksumAlgorithm: NONE,
			ChecksumValidationStatus: NOT_VALIDATED
		},
		ContentLength: 0,
		HttpStatusCode: Continue
	},
	Success: False
}