tl_account_verify_phone_gen.go

// Code generated by gotdgen, DO NOT EDIT.

package tg

import (
	"context"
	"errors"
	"fmt"
	"sort"
	"strings"

	"go.uber.org/multierr"

	"github.com/gotd/td/bin"
	"github.com/gotd/td/tdjson"
	"github.com/gotd/td/tdp"
	"github.com/gotd/td/tgerr"
)

// No-op definition for keeping imports.
var (
	_ = bin.Buffer{}
	_ = context.Background()
	_ = fmt.Stringer(nil)
	_ = strings.Builder{}
	_ = errors.Is
	_ = multierr.AppendInto
	_ = sort.Ints
	_ = tdp.Format
	_ = tgerr.Error{}
	_ = tdjson.Encoder{}
)

// AccountVerifyPhoneRequest represents TL type `account.verifyPhone#4dd3a7f6`.
// Verify a phone number for telegram passport¹.
//
// Links:
//  1. https://core.telegram.org/passport
//
// See https://core.telegram.org/method/account.verifyPhone for reference.
type AccountVerifyPhoneRequest struct {
	// Phone number
	PhoneNumber string
	// Phone code hash received from the call to account.sendVerifyPhoneCode¹
	//
	// Links:
	//  1) https://core.telegram.org/method/account.sendVerifyPhoneCode
	PhoneCodeHash string
	// Code received after the call to account.sendVerifyPhoneCode¹
	//
	// Links:
	//  1) https://core.telegram.org/method/account.sendVerifyPhoneCode
	PhoneCode string
}

// AccountVerifyPhoneRequestTypeID is TL type id of AccountVerifyPhoneRequest.
const AccountVerifyPhoneRequestTypeID = 0x4dd3a7f6

// Ensuring interfaces in compile-time for AccountVerifyPhoneRequest.
var (
	_ bin.Encoder     = &AccountVerifyPhoneRequest{}
	_ bin.Decoder     = &AccountVerifyPhoneRequest{}
	_ bin.BareEncoder = &AccountVerifyPhoneRequest{}
	_ bin.BareDecoder = &AccountVerifyPhoneRequest{}
)

func (v *AccountVerifyPhoneRequest) Zero() bool {
	if v == nil {
		return true
	}
	if !(v.PhoneNumber == "") {
		return false
	}
	if !(v.PhoneCodeHash == "") {
		return false
	}
	if !(v.PhoneCode == "") {
		return false
	}

	return true
}

// String implements fmt.Stringer.
func (v *AccountVerifyPhoneRequest) String() string {
	if v == nil {
		return "AccountVerifyPhoneRequest(nil)"
	}
	type Alias AccountVerifyPhoneRequest
	return fmt.Sprintf("AccountVerifyPhoneRequest%+v", Alias(*v))
}

// FillFrom fills AccountVerifyPhoneRequest from given interface.
func (v *AccountVerifyPhoneRequest) FillFrom(from interface {
	GetPhoneNumber() (value string)
	GetPhoneCodeHash() (value string)
	GetPhoneCode() (value string)
}) {
	v.PhoneNumber = from.GetPhoneNumber()
	v.PhoneCodeHash = from.GetPhoneCodeHash()
	v.PhoneCode = from.GetPhoneCode()
}

// TypeID returns type id in TL schema.
//
// See https://core.telegram.org/mtproto/TL-tl#remarks.
func (*AccountVerifyPhoneRequest) TypeID() uint32 {
	return AccountVerifyPhoneRequestTypeID
}

// TypeName returns name of type in TL schema.
func (*AccountVerifyPhoneRequest) TypeName() string {
	return "account.verifyPhone"
}

// TypeInfo returns info about TL type.
func (v *AccountVerifyPhoneRequest) TypeInfo() tdp.Type {
	typ := tdp.Type{
		Name: "account.verifyPhone",
		ID:   AccountVerifyPhoneRequestTypeID,
	}
	if v == nil {
		typ.Null = true
		return typ
	}
	typ.Fields = []tdp.Field{
		{
			Name:       "PhoneNumber",
			SchemaName: "phone_number",
		},
		{
			Name:       "PhoneCodeHash",
			SchemaName: "phone_code_hash",
		},
		{
			Name:       "PhoneCode",
			SchemaName: "phone_code",
		},
	}
	return typ
}

// Encode implements bin.Encoder.
func (v *AccountVerifyPhoneRequest) Encode(b *bin.Buffer) error {
	if v == nil {
		return fmt.Errorf("can't encode account.verifyPhone#4dd3a7f6 as nil")
	}
	b.PutID(AccountVerifyPhoneRequestTypeID)
	return v.EncodeBare(b)
}

// EncodeBare implements bin.BareEncoder.
func (v *AccountVerifyPhoneRequest) EncodeBare(b *bin.Buffer) error {
	if v == nil {
		return fmt.Errorf("can't encode account.verifyPhone#4dd3a7f6 as nil")
	}
	b.PutString(v.PhoneNumber)
	b.PutString(v.PhoneCodeHash)
	b.PutString(v.PhoneCode)
	return nil
}

// Decode implements bin.Decoder.
func (v *AccountVerifyPhoneRequest) Decode(b *bin.Buffer) error {
	if v == nil {
		return fmt.Errorf("can't decode account.verifyPhone#4dd3a7f6 to nil")
	}
	if err := b.ConsumeID(AccountVerifyPhoneRequestTypeID); err != nil {
		return fmt.Errorf("unable to decode account.verifyPhone#4dd3a7f6: %w", err)
	}
	return v.DecodeBare(b)
}

// DecodeBare implements bin.BareDecoder.
func (v *AccountVerifyPhoneRequest) DecodeBare(b *bin.Buffer) error {
	if v == nil {
		return fmt.Errorf("can't decode account.verifyPhone#4dd3a7f6 to nil")
	}
	{
		value, err := b.String()
		if err != nil {
			return fmt.Errorf("unable to decode account.verifyPhone#4dd3a7f6: field phone_number: %w", err)
		}
		v.PhoneNumber = value
	}
	{
		value, err := b.String()
		if err != nil {
			return fmt.Errorf("unable to decode account.verifyPhone#4dd3a7f6: field phone_code_hash: %w", err)
		}
		v.PhoneCodeHash = value
	}
	{
		value, err := b.String()
		if err != nil {
			return fmt.Errorf("unable to decode account.verifyPhone#4dd3a7f6: field phone_code: %w", err)
		}
		v.PhoneCode = value
	}
	return nil
}

// GetPhoneNumber returns value of PhoneNumber field.
func (v *AccountVerifyPhoneRequest) GetPhoneNumber() (value string) {
	if v == nil {
		return
	}
	return v.PhoneNumber
}

// GetPhoneCodeHash returns value of PhoneCodeHash field.
func (v *AccountVerifyPhoneRequest) GetPhoneCodeHash() (value string) {
	if v == nil {
		return
	}
	return v.PhoneCodeHash
}

// GetPhoneCode returns value of PhoneCode field.
func (v *AccountVerifyPhoneRequest) GetPhoneCode() (value string) {
	if v == nil {
		return
	}
	return v.PhoneCode
}

// AccountVerifyPhone invokes method account.verifyPhone#4dd3a7f6 returning error if any.
// Verify a phone number for telegram passport¹.
//
// Links:
//  1. https://core.telegram.org/passport
//
// Possible errors:
//
//	400 PHONE_CODE_EMPTY: phone_code is missing.
//	400 PHONE_CODE_EXPIRED: The phone code you provided has expired.
//	400 PHONE_NUMBER_INVALID: The phone number is invalid.
//
// See https://core.telegram.org/method/account.verifyPhone for reference.
func (c *Client) AccountVerifyPhone(ctx context.Context, request *AccountVerifyPhoneRequest) (bool, error) {
	var result BoolBox

	if err := c.rpc.Invoke(ctx, request, &result); err != nil {
		return false, err
	}
	_, ok := result.Bool.(*BoolTrue)
	return ok, nil
}