github.com/aavshr/aws-sdk-go@v1.41.3/service/pinpointsmsvoice/pinpointsmsvoiceiface/interface.go (about)

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package pinpointsmsvoiceiface provides an interface to enable mocking the Amazon Pinpoint SMS and Voice Service service client
     4  // for testing your code.
     5  //
     6  // It is important to note that this interface will have breaking changes
     7  // when the service model is updated and adds new API operations, paginators,
     8  // and waiters.
     9  package pinpointsmsvoiceiface
    10  
    11  import (
    12  	"github.com/aavshr/aws-sdk-go/aws"
    13  	"github.com/aavshr/aws-sdk-go/aws/request"
    14  	"github.com/aavshr/aws-sdk-go/service/pinpointsmsvoice"
    15  )
    16  
    17  // PinpointSMSVoiceAPI provides an interface to enable mocking the
    18  // pinpointsmsvoice.PinpointSMSVoice service client's API operation,
    19  // paginators, and waiters. This make unit testing your code that calls out
    20  // to the SDK's service client's calls easier.
    21  //
    22  // The best way to use this interface is so the SDK's service client's calls
    23  // can be stubbed out for unit testing your code with the SDK without needing
    24  // to inject custom request handlers into the SDK's request pipeline.
    25  //
    26  //    // myFunc uses an SDK service client to make a request to
    27  //    // Amazon Pinpoint SMS and Voice Service.
    28  //    func myFunc(svc pinpointsmsvoiceiface.PinpointSMSVoiceAPI) bool {
    29  //        // Make svc.CreateConfigurationSet request
    30  //    }
    31  //
    32  //    func main() {
    33  //        sess := session.New()
    34  //        svc := pinpointsmsvoice.New(sess)
    35  //
    36  //        myFunc(svc)
    37  //    }
    38  //
    39  // In your _test.go file:
    40  //
    41  //    // Define a mock struct to be used in your unit tests of myFunc.
    42  //    type mockPinpointSMSVoiceClient struct {
    43  //        pinpointsmsvoiceiface.PinpointSMSVoiceAPI
    44  //    }
    45  //    func (m *mockPinpointSMSVoiceClient) CreateConfigurationSet(input *pinpointsmsvoice.CreateConfigurationSetInput) (*pinpointsmsvoice.CreateConfigurationSetOutput, error) {
    46  //        // mock response/functionality
    47  //    }
    48  //
    49  //    func TestMyFunc(t *testing.T) {
    50  //        // Setup Test
    51  //        mockSvc := &mockPinpointSMSVoiceClient{}
    52  //
    53  //        myfunc(mockSvc)
    54  //
    55  //        // Verify myFunc's functionality
    56  //    }
    57  //
    58  // It is important to note that this interface will have breaking changes
    59  // when the service model is updated and adds new API operations, paginators,
    60  // and waiters. Its suggested to use the pattern above for testing, or using
    61  // tooling to generate mocks to satisfy the interfaces.
    62  type PinpointSMSVoiceAPI interface {
    63  	CreateConfigurationSet(*pinpointsmsvoice.CreateConfigurationSetInput) (*pinpointsmsvoice.CreateConfigurationSetOutput, error)
    64  	CreateConfigurationSetWithContext(aws.Context, *pinpointsmsvoice.CreateConfigurationSetInput, ...request.Option) (*pinpointsmsvoice.CreateConfigurationSetOutput, error)
    65  	CreateConfigurationSetRequest(*pinpointsmsvoice.CreateConfigurationSetInput) (*request.Request, *pinpointsmsvoice.CreateConfigurationSetOutput)
    66  
    67  	CreateConfigurationSetEventDestination(*pinpointsmsvoice.CreateConfigurationSetEventDestinationInput) (*pinpointsmsvoice.CreateConfigurationSetEventDestinationOutput, error)
    68  	CreateConfigurationSetEventDestinationWithContext(aws.Context, *pinpointsmsvoice.CreateConfigurationSetEventDestinationInput, ...request.Option) (*pinpointsmsvoice.CreateConfigurationSetEventDestinationOutput, error)
    69  	CreateConfigurationSetEventDestinationRequest(*pinpointsmsvoice.CreateConfigurationSetEventDestinationInput) (*request.Request, *pinpointsmsvoice.CreateConfigurationSetEventDestinationOutput)
    70  
    71  	DeleteConfigurationSet(*pinpointsmsvoice.DeleteConfigurationSetInput) (*pinpointsmsvoice.DeleteConfigurationSetOutput, error)
    72  	DeleteConfigurationSetWithContext(aws.Context, *pinpointsmsvoice.DeleteConfigurationSetInput, ...request.Option) (*pinpointsmsvoice.DeleteConfigurationSetOutput, error)
    73  	DeleteConfigurationSetRequest(*pinpointsmsvoice.DeleteConfigurationSetInput) (*request.Request, *pinpointsmsvoice.DeleteConfigurationSetOutput)
    74  
    75  	DeleteConfigurationSetEventDestination(*pinpointsmsvoice.DeleteConfigurationSetEventDestinationInput) (*pinpointsmsvoice.DeleteConfigurationSetEventDestinationOutput, error)
    76  	DeleteConfigurationSetEventDestinationWithContext(aws.Context, *pinpointsmsvoice.DeleteConfigurationSetEventDestinationInput, ...request.Option) (*pinpointsmsvoice.DeleteConfigurationSetEventDestinationOutput, error)
    77  	DeleteConfigurationSetEventDestinationRequest(*pinpointsmsvoice.DeleteConfigurationSetEventDestinationInput) (*request.Request, *pinpointsmsvoice.DeleteConfigurationSetEventDestinationOutput)
    78  
    79  	GetConfigurationSetEventDestinations(*pinpointsmsvoice.GetConfigurationSetEventDestinationsInput) (*pinpointsmsvoice.GetConfigurationSetEventDestinationsOutput, error)
    80  	GetConfigurationSetEventDestinationsWithContext(aws.Context, *pinpointsmsvoice.GetConfigurationSetEventDestinationsInput, ...request.Option) (*pinpointsmsvoice.GetConfigurationSetEventDestinationsOutput, error)
    81  	GetConfigurationSetEventDestinationsRequest(*pinpointsmsvoice.GetConfigurationSetEventDestinationsInput) (*request.Request, *pinpointsmsvoice.GetConfigurationSetEventDestinationsOutput)
    82  
    83  	ListConfigurationSets(*pinpointsmsvoice.ListConfigurationSetsInput) (*pinpointsmsvoice.ListConfigurationSetsOutput, error)
    84  	ListConfigurationSetsWithContext(aws.Context, *pinpointsmsvoice.ListConfigurationSetsInput, ...request.Option) (*pinpointsmsvoice.ListConfigurationSetsOutput, error)
    85  	ListConfigurationSetsRequest(*pinpointsmsvoice.ListConfigurationSetsInput) (*request.Request, *pinpointsmsvoice.ListConfigurationSetsOutput)
    86  
    87  	SendVoiceMessage(*pinpointsmsvoice.SendVoiceMessageInput) (*pinpointsmsvoice.SendVoiceMessageOutput, error)
    88  	SendVoiceMessageWithContext(aws.Context, *pinpointsmsvoice.SendVoiceMessageInput, ...request.Option) (*pinpointsmsvoice.SendVoiceMessageOutput, error)
    89  	SendVoiceMessageRequest(*pinpointsmsvoice.SendVoiceMessageInput) (*request.Request, *pinpointsmsvoice.SendVoiceMessageOutput)
    90  
    91  	UpdateConfigurationSetEventDestination(*pinpointsmsvoice.UpdateConfigurationSetEventDestinationInput) (*pinpointsmsvoice.UpdateConfigurationSetEventDestinationOutput, error)
    92  	UpdateConfigurationSetEventDestinationWithContext(aws.Context, *pinpointsmsvoice.UpdateConfigurationSetEventDestinationInput, ...request.Option) (*pinpointsmsvoice.UpdateConfigurationSetEventDestinationOutput, error)
    93  	UpdateConfigurationSetEventDestinationRequest(*pinpointsmsvoice.UpdateConfigurationSetEventDestinationInput) (*request.Request, *pinpointsmsvoice.UpdateConfigurationSetEventDestinationOutput)
    94  }
    95  
    96  var _ PinpointSMSVoiceAPI = (*pinpointsmsvoice.PinpointSMSVoice)(nil)