mautrix-telegram/pkg/gotd/tg/tl_payments_refund_stars_charge_gen.go

// Code generated by gotdgen, DO NOT EDIT.

package tg

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

	"go.uber.org/multierr"

	"go.mau.fi/mautrix-telegram/pkg/gotd/bin"
	"go.mau.fi/mautrix-telegram/pkg/gotd/tdjson"
	"go.mau.fi/mautrix-telegram/pkg/gotd/tdp"
	"go.mau.fi/mautrix-telegram/pkg/gotd/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{}
)

// PaymentsRefundStarsChargeRequest represents TL type `payments.refundStarsCharge#25ae8f4a`.
// Refund a Telegram Stars¹ transaction, see here »² for more info.
//
// Links:
//  1. https://core.telegram.org/api/stars
//  2. https://core.telegram.org/api/payments#6-refunds
//
// See https://core.telegram.org/method/payments.refundStarsCharge for reference.
type PaymentsRefundStarsChargeRequest struct {
	// User to refund.
	UserID InputUserClass
	// Transaction ID.
	ChargeID string
}

// PaymentsRefundStarsChargeRequestTypeID is TL type id of PaymentsRefundStarsChargeRequest.
const PaymentsRefundStarsChargeRequestTypeID = 0x25ae8f4a

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

func (r *PaymentsRefundStarsChargeRequest) Zero() bool {
	if r == nil {
		return true
	}
	if !(r.UserID == nil) {
		return false
	}
	if !(r.ChargeID == "") {
		return false
	}

	return true
}

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

// FillFrom fills PaymentsRefundStarsChargeRequest from given interface.
func (r *PaymentsRefundStarsChargeRequest) FillFrom(from interface {
	GetUserID() (value InputUserClass)
	GetChargeID() (value string)
}) {
	r.UserID = from.GetUserID()
	r.ChargeID = from.GetChargeID()
}

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

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

// TypeInfo returns info about TL type.
func (r *PaymentsRefundStarsChargeRequest) TypeInfo() tdp.Type {
	typ := tdp.Type{
		Name: "payments.refundStarsCharge",
		ID:   PaymentsRefundStarsChargeRequestTypeID,
	}
	if r == nil {
		typ.Null = true
		return typ
	}
	typ.Fields = []tdp.Field{
		{
			Name:       "UserID",
			SchemaName: "user_id",
		},
		{
			Name:       "ChargeID",
			SchemaName: "charge_id",
		},
	}
	return typ
}

// Encode implements bin.Encoder.
func (r *PaymentsRefundStarsChargeRequest) Encode(b *bin.Buffer) error {
	if r == nil {
		return fmt.Errorf("can't encode payments.refundStarsCharge#25ae8f4a as nil")
	}
	b.PutID(PaymentsRefundStarsChargeRequestTypeID)
	return r.EncodeBare(b)
}

// EncodeBare implements bin.BareEncoder.
func (r *PaymentsRefundStarsChargeRequest) EncodeBare(b *bin.Buffer) error {
	if r == nil {
		return fmt.Errorf("can't encode payments.refundStarsCharge#25ae8f4a as nil")
	}
	if r.UserID == nil {
		return fmt.Errorf("unable to encode payments.refundStarsCharge#25ae8f4a: field user_id is nil")
	}
	if err := r.UserID.Encode(b); err != nil {
		return fmt.Errorf("unable to encode payments.refundStarsCharge#25ae8f4a: field user_id: %w", err)
	}
	b.PutString(r.ChargeID)
	return nil
}

// Decode implements bin.Decoder.
func (r *PaymentsRefundStarsChargeRequest) Decode(b *bin.Buffer) error {
	if r == nil {
		return fmt.Errorf("can't decode payments.refundStarsCharge#25ae8f4a to nil")
	}
	if err := b.ConsumeID(PaymentsRefundStarsChargeRequestTypeID); err != nil {
		return fmt.Errorf("unable to decode payments.refundStarsCharge#25ae8f4a: %w", err)
	}
	return r.DecodeBare(b)
}

// DecodeBare implements bin.BareDecoder.
func (r *PaymentsRefundStarsChargeRequest) DecodeBare(b *bin.Buffer) error {
	if r == nil {
		return fmt.Errorf("can't decode payments.refundStarsCharge#25ae8f4a to nil")
	}
	{
		value, err := DecodeInputUser(b)
		if err != nil {
			return fmt.Errorf("unable to decode payments.refundStarsCharge#25ae8f4a: field user_id: %w", err)
		}
		r.UserID = value
	}
	{
		value, err := b.String()
		if err != nil {
			return fmt.Errorf("unable to decode payments.refundStarsCharge#25ae8f4a: field charge_id: %w", err)
		}
		r.ChargeID = value
	}
	return nil
}

// GetUserID returns value of UserID field.
func (r *PaymentsRefundStarsChargeRequest) GetUserID() (value InputUserClass) {
	if r == nil {
		return
	}
	return r.UserID
}

// GetChargeID returns value of ChargeID field.
func (r *PaymentsRefundStarsChargeRequest) GetChargeID() (value string) {
	if r == nil {
		return
	}
	return r.ChargeID
}

// PaymentsRefundStarsCharge invokes method payments.refundStarsCharge#25ae8f4a returning error if any.
// Refund a Telegram Stars¹ transaction, see here »² for more info.
//
// Links:
//  1. https://core.telegram.org/api/stars
//  2. https://core.telegram.org/api/payments#6-refunds
//
// Possible errors:
//
//	400 CHARGE_ALREADY_REFUNDED: The transaction was already refunded.
//	400 USER_BOT_REQUIRED: This method can only be called by a bot.
//	400 USER_ID_INVALID: The provided user ID is invalid.
//
// See https://core.telegram.org/method/payments.refundStarsCharge for reference.
// Can be used by bots.
func (c *Client) PaymentsRefundStarsCharge(ctx context.Context, request *PaymentsRefundStarsChargeRequest) (UpdatesClass, error) {
	var result UpdatesBox

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