tl_payments_apply_gift_code_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{}
)

// PaymentsApplyGiftCodeRequest represents TL type `payments.applyGiftCode#f6e26854`.
// Apply a Telegram Premium giftcode »¹
//
// Links:
//  1. https://core.telegram.org/api/giveaways
//
// See https://core.telegram.org/method/payments.applyGiftCode for reference.
type PaymentsApplyGiftCodeRequest struct {
	// The code to apply
	Slug string
}

// PaymentsApplyGiftCodeRequestTypeID is TL type id of PaymentsApplyGiftCodeRequest.
const PaymentsApplyGiftCodeRequestTypeID = 0xf6e26854

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

func (a *PaymentsApplyGiftCodeRequest) Zero() bool {
	if a == nil {
		return true
	}
	if !(a.Slug == "") {
		return false
	}

	return true
}

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

// FillFrom fills PaymentsApplyGiftCodeRequest from given interface.
func (a *PaymentsApplyGiftCodeRequest) FillFrom(from interface {
	GetSlug() (value string)
}) {
	a.Slug = from.GetSlug()
}

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

// TypeName returns name of type in TL schema.
func (*PaymentsApplyGiftCodeRequest) TypeName() string {
	return "payments.applyGiftCode"
}

// TypeInfo returns info about TL type.
func (a *PaymentsApplyGiftCodeRequest) TypeInfo() tdp.Type {
	typ := tdp.Type{
		Name: "payments.applyGiftCode",
		ID:   PaymentsApplyGiftCodeRequestTypeID,
	}
	if a == nil {
		typ.Null = true
		return typ
	}
	typ.Fields = []tdp.Field{
		{
			Name:       "Slug",
			SchemaName: "slug",
		},
	}
	return typ
}

// Encode implements bin.Encoder.
func (a *PaymentsApplyGiftCodeRequest) Encode(b *bin.Buffer) error {
	if a == nil {
		return fmt.Errorf("can't encode payments.applyGiftCode#f6e26854 as nil")
	}
	b.PutID(PaymentsApplyGiftCodeRequestTypeID)
	return a.EncodeBare(b)
}

// EncodeBare implements bin.BareEncoder.
func (a *PaymentsApplyGiftCodeRequest) EncodeBare(b *bin.Buffer) error {
	if a == nil {
		return fmt.Errorf("can't encode payments.applyGiftCode#f6e26854 as nil")
	}
	b.PutString(a.Slug)
	return nil
}

// Decode implements bin.Decoder.
func (a *PaymentsApplyGiftCodeRequest) Decode(b *bin.Buffer) error {
	if a == nil {
		return fmt.Errorf("can't decode payments.applyGiftCode#f6e26854 to nil")
	}
	if err := b.ConsumeID(PaymentsApplyGiftCodeRequestTypeID); err != nil {
		return fmt.Errorf("unable to decode payments.applyGiftCode#f6e26854: %w", err)
	}
	return a.DecodeBare(b)
}

// DecodeBare implements bin.BareDecoder.
func (a *PaymentsApplyGiftCodeRequest) DecodeBare(b *bin.Buffer) error {
	if a == nil {
		return fmt.Errorf("can't decode payments.applyGiftCode#f6e26854 to nil")
	}
	{
		value, err := b.String()
		if err != nil {
			return fmt.Errorf("unable to decode payments.applyGiftCode#f6e26854: field slug: %w", err)
		}
		a.Slug = value
	}
	return nil
}

// GetSlug returns value of Slug field.
func (a *PaymentsApplyGiftCodeRequest) GetSlug() (value string) {
	if a == nil {
		return
	}
	return a.Slug
}

// PaymentsApplyGiftCode invokes method payments.applyGiftCode#f6e26854 returning error if any.
// Apply a Telegram Premium giftcode »¹
//
// Links:
//  1. https://core.telegram.org/api/giveaways
//
// Possible errors:
//
//	400 GIFT_SLUG_EXPIRED: The specified gift slug has expired.
//	400 GIFT_SLUG_INVALID: The specified slug is invalid.
//	420 PREMIUM_SUB_ACTIVE_UNTIL_%d: You already have a premium subscription active until unixtime %d .
//
// See https://core.telegram.org/method/payments.applyGiftCode for reference.
func (c *Client) PaymentsApplyGiftCode(ctx context.Context, slug string) (UpdatesClass, error) {
	var result UpdatesBox

	request := &PaymentsApplyGiftCodeRequest{
		Slug: slug,
	}
	if err := c.rpc.Invoke(ctx, request, &result); err != nil {
		return nil, err
	}
	return result.Updates, nil
}