// Code generated by smithy-go-codegen DO NOT EDIT.

package pinpointsmsvoicev2

import (
	"context"
	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
	"github.com/aws/smithy-go/middleware"
	smithyhttp "github.com/aws/smithy-go/transport/http"
	"time"
)

// Creates an opted out destination phone number in the opt-out list. If the
// destination phone number isn't valid or if the specified opt-out list doesn't
// exist, an Error is returned.
func (c *Client) PutOptedOutNumber(ctx context.Context, params *PutOptedOutNumberInput, optFns ...func(*Options)) (*PutOptedOutNumberOutput, error) {
	if params == nil {
		params = &PutOptedOutNumberInput{}
	}

	result, metadata, err := c.invokeOperation(ctx, "PutOptedOutNumber", params, optFns, c.addOperationPutOptedOutNumberMiddlewares)
	if err != nil {
		return nil, err
	}

	out := result.(*PutOptedOutNumberOutput)
	out.ResultMetadata = metadata
	return out, nil
}

type PutOptedOutNumberInput struct {

	// The OptOutListName or OptOutListArn to add the phone number to.
	//
	// This member is required.
	OptOutListName *string

	// The phone number to add to the OptOutList in E.164 format.
	//
	// This member is required.
	OptedOutNumber *string

	noSmithyDocumentSerde
}

type PutOptedOutNumberOutput struct {

	// This is true if it was the end user who requested their phone number be removed.
	EndUserOptedOut bool

	// The OptOutListArn that the phone number was removed from.
	OptOutListArn *string

	// The OptOutListName that the phone number was removed from.
	OptOutListName *string

	// The phone number that was added to the OptOutList.
	OptedOutNumber *string

	// The time that the phone number was added to the OptOutList, in UNIX epoch time (https://www.epochconverter.com/)
	// format.
	OptedOutTimestamp *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata

	noSmithyDocumentSerde
}

func (c *Client) addOperationPutOptedOutNumberMiddlewares(stack *middleware.Stack, options Options) (err error) {
	err = stack.Serialize.Add(&awsAwsjson10_serializeOpPutOptedOutNumber{}, middleware.After)
	if err != nil {
		return err
	}
	err = stack.Deserialize.Add(&awsAwsjson10_deserializeOpPutOptedOutNumber{}, middleware.After)
	if err != nil {
		return err
	}
	if err = addSetLoggerMiddleware(stack, options); err != nil {
		return err
	}
	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
		return err
	}
	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
		return err
	}
	if err = addResolveEndpointMiddleware(stack, options); err != nil {
		return err
	}
	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
		return err
	}
	if err = addRetryMiddlewares(stack, options); err != nil {
		return err
	}
	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
		return err
	}
	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
		return err
	}
	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
		return err
	}
	if err = addClientUserAgent(stack, options); err != nil {
		return err
	}
	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
		return err
	}
	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
		return err
	}
	if err = addOpPutOptedOutNumberValidationMiddleware(stack); err != nil {
		return err
	}
	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opPutOptedOutNumber(options.Region), middleware.Before); err != nil {
		return err
	}
	if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
		return err
	}
	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
		return err
	}
	if err = addResponseErrorMiddleware(stack); err != nil {
		return err
	}
	if err = addRequestResponseLogging(stack, options); err != nil {
		return err
	}
	return nil
}

func newServiceMetadataMiddleware_opPutOptedOutNumber(region string) *awsmiddleware.RegisterServiceMetadata {
	return &awsmiddleware.RegisterServiceMetadata{
		Region:        region,
		ServiceID:     ServiceID,
		SigningName:   "sms-voice",
		OperationName: "PutOptedOutNumber",
	}
}