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

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package connectparticipantiface provides an interface to enable mocking the Amazon Connect Participant 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 connectparticipantiface
    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/connectparticipant"
    15  )
    16  
    17  // ConnectParticipantAPI provides an interface to enable mocking the
    18  // connectparticipant.ConnectParticipant 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 Connect Participant Service.
    28  //    func myFunc(svc connectparticipantiface.ConnectParticipantAPI) bool {
    29  //        // Make svc.CompleteAttachmentUpload request
    30  //    }
    31  //
    32  //    func main() {
    33  //        sess := session.New()
    34  //        svc := connectparticipant.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 mockConnectParticipantClient struct {
    43  //        connectparticipantiface.ConnectParticipantAPI
    44  //    }
    45  //    func (m *mockConnectParticipantClient) CompleteAttachmentUpload(input *connectparticipant.CompleteAttachmentUploadInput) (*connectparticipant.CompleteAttachmentUploadOutput, error) {
    46  //        // mock response/functionality
    47  //    }
    48  //
    49  //    func TestMyFunc(t *testing.T) {
    50  //        // Setup Test
    51  //        mockSvc := &mockConnectParticipantClient{}
    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 ConnectParticipantAPI interface {
    63  	CompleteAttachmentUpload(*connectparticipant.CompleteAttachmentUploadInput) (*connectparticipant.CompleteAttachmentUploadOutput, error)
    64  	CompleteAttachmentUploadWithContext(aws.Context, *connectparticipant.CompleteAttachmentUploadInput, ...request.Option) (*connectparticipant.CompleteAttachmentUploadOutput, error)
    65  	CompleteAttachmentUploadRequest(*connectparticipant.CompleteAttachmentUploadInput) (*request.Request, *connectparticipant.CompleteAttachmentUploadOutput)
    66  
    67  	CreateParticipantConnection(*connectparticipant.CreateParticipantConnectionInput) (*connectparticipant.CreateParticipantConnectionOutput, error)
    68  	CreateParticipantConnectionWithContext(aws.Context, *connectparticipant.CreateParticipantConnectionInput, ...request.Option) (*connectparticipant.CreateParticipantConnectionOutput, error)
    69  	CreateParticipantConnectionRequest(*connectparticipant.CreateParticipantConnectionInput) (*request.Request, *connectparticipant.CreateParticipantConnectionOutput)
    70  
    71  	DisconnectParticipant(*connectparticipant.DisconnectParticipantInput) (*connectparticipant.DisconnectParticipantOutput, error)
    72  	DisconnectParticipantWithContext(aws.Context, *connectparticipant.DisconnectParticipantInput, ...request.Option) (*connectparticipant.DisconnectParticipantOutput, error)
    73  	DisconnectParticipantRequest(*connectparticipant.DisconnectParticipantInput) (*request.Request, *connectparticipant.DisconnectParticipantOutput)
    74  
    75  	GetAttachment(*connectparticipant.GetAttachmentInput) (*connectparticipant.GetAttachmentOutput, error)
    76  	GetAttachmentWithContext(aws.Context, *connectparticipant.GetAttachmentInput, ...request.Option) (*connectparticipant.GetAttachmentOutput, error)
    77  	GetAttachmentRequest(*connectparticipant.GetAttachmentInput) (*request.Request, *connectparticipant.GetAttachmentOutput)
    78  
    79  	GetTranscript(*connectparticipant.GetTranscriptInput) (*connectparticipant.GetTranscriptOutput, error)
    80  	GetTranscriptWithContext(aws.Context, *connectparticipant.GetTranscriptInput, ...request.Option) (*connectparticipant.GetTranscriptOutput, error)
    81  	GetTranscriptRequest(*connectparticipant.GetTranscriptInput) (*request.Request, *connectparticipant.GetTranscriptOutput)
    82  
    83  	GetTranscriptPages(*connectparticipant.GetTranscriptInput, func(*connectparticipant.GetTranscriptOutput, bool) bool) error
    84  	GetTranscriptPagesWithContext(aws.Context, *connectparticipant.GetTranscriptInput, func(*connectparticipant.GetTranscriptOutput, bool) bool, ...request.Option) error
    85  
    86  	SendEvent(*connectparticipant.SendEventInput) (*connectparticipant.SendEventOutput, error)
    87  	SendEventWithContext(aws.Context, *connectparticipant.SendEventInput, ...request.Option) (*connectparticipant.SendEventOutput, error)
    88  	SendEventRequest(*connectparticipant.SendEventInput) (*request.Request, *connectparticipant.SendEventOutput)
    89  
    90  	SendMessage(*connectparticipant.SendMessageInput) (*connectparticipant.SendMessageOutput, error)
    91  	SendMessageWithContext(aws.Context, *connectparticipant.SendMessageInput, ...request.Option) (*connectparticipant.SendMessageOutput, error)
    92  	SendMessageRequest(*connectparticipant.SendMessageInput) (*request.Request, *connectparticipant.SendMessageOutput)
    93  
    94  	StartAttachmentUpload(*connectparticipant.StartAttachmentUploadInput) (*connectparticipant.StartAttachmentUploadOutput, error)
    95  	StartAttachmentUploadWithContext(aws.Context, *connectparticipant.StartAttachmentUploadInput, ...request.Option) (*connectparticipant.StartAttachmentUploadOutput, error)
    96  	StartAttachmentUploadRequest(*connectparticipant.StartAttachmentUploadInput) (*request.Request, *connectparticipant.StartAttachmentUploadOutput)
    97  }
    98  
    99  var _ ConnectParticipantAPI = (*connectparticipant.ConnectParticipant)(nil)