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

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package voiceidiface provides an interface to enable mocking the Amazon Voice ID 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 voiceidiface
    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/voiceid"
    15  )
    16  
    17  // VoiceIDAPI provides an interface to enable mocking the
    18  // voiceid.VoiceID 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 Voice ID.
    28  //    func myFunc(svc voiceidiface.VoiceIDAPI) bool {
    29  //        // Make svc.CreateDomain request
    30  //    }
    31  //
    32  //    func main() {
    33  //        sess := session.New()
    34  //        svc := voiceid.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 mockVoiceIDClient struct {
    43  //        voiceidiface.VoiceIDAPI
    44  //    }
    45  //    func (m *mockVoiceIDClient) CreateDomain(input *voiceid.CreateDomainInput) (*voiceid.CreateDomainOutput, error) {
    46  //        // mock response/functionality
    47  //    }
    48  //
    49  //    func TestMyFunc(t *testing.T) {
    50  //        // Setup Test
    51  //        mockSvc := &mockVoiceIDClient{}
    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 VoiceIDAPI interface {
    63  	CreateDomain(*voiceid.CreateDomainInput) (*voiceid.CreateDomainOutput, error)
    64  	CreateDomainWithContext(aws.Context, *voiceid.CreateDomainInput, ...request.Option) (*voiceid.CreateDomainOutput, error)
    65  	CreateDomainRequest(*voiceid.CreateDomainInput) (*request.Request, *voiceid.CreateDomainOutput)
    66  
    67  	DeleteDomain(*voiceid.DeleteDomainInput) (*voiceid.DeleteDomainOutput, error)
    68  	DeleteDomainWithContext(aws.Context, *voiceid.DeleteDomainInput, ...request.Option) (*voiceid.DeleteDomainOutput, error)
    69  	DeleteDomainRequest(*voiceid.DeleteDomainInput) (*request.Request, *voiceid.DeleteDomainOutput)
    70  
    71  	DeleteFraudster(*voiceid.DeleteFraudsterInput) (*voiceid.DeleteFraudsterOutput, error)
    72  	DeleteFraudsterWithContext(aws.Context, *voiceid.DeleteFraudsterInput, ...request.Option) (*voiceid.DeleteFraudsterOutput, error)
    73  	DeleteFraudsterRequest(*voiceid.DeleteFraudsterInput) (*request.Request, *voiceid.DeleteFraudsterOutput)
    74  
    75  	DeleteSpeaker(*voiceid.DeleteSpeakerInput) (*voiceid.DeleteSpeakerOutput, error)
    76  	DeleteSpeakerWithContext(aws.Context, *voiceid.DeleteSpeakerInput, ...request.Option) (*voiceid.DeleteSpeakerOutput, error)
    77  	DeleteSpeakerRequest(*voiceid.DeleteSpeakerInput) (*request.Request, *voiceid.DeleteSpeakerOutput)
    78  
    79  	DescribeDomain(*voiceid.DescribeDomainInput) (*voiceid.DescribeDomainOutput, error)
    80  	DescribeDomainWithContext(aws.Context, *voiceid.DescribeDomainInput, ...request.Option) (*voiceid.DescribeDomainOutput, error)
    81  	DescribeDomainRequest(*voiceid.DescribeDomainInput) (*request.Request, *voiceid.DescribeDomainOutput)
    82  
    83  	DescribeFraudster(*voiceid.DescribeFraudsterInput) (*voiceid.DescribeFraudsterOutput, error)
    84  	DescribeFraudsterWithContext(aws.Context, *voiceid.DescribeFraudsterInput, ...request.Option) (*voiceid.DescribeFraudsterOutput, error)
    85  	DescribeFraudsterRequest(*voiceid.DescribeFraudsterInput) (*request.Request, *voiceid.DescribeFraudsterOutput)
    86  
    87  	DescribeFraudsterRegistrationJob(*voiceid.DescribeFraudsterRegistrationJobInput) (*voiceid.DescribeFraudsterRegistrationJobOutput, error)
    88  	DescribeFraudsterRegistrationJobWithContext(aws.Context, *voiceid.DescribeFraudsterRegistrationJobInput, ...request.Option) (*voiceid.DescribeFraudsterRegistrationJobOutput, error)
    89  	DescribeFraudsterRegistrationJobRequest(*voiceid.DescribeFraudsterRegistrationJobInput) (*request.Request, *voiceid.DescribeFraudsterRegistrationJobOutput)
    90  
    91  	DescribeSpeaker(*voiceid.DescribeSpeakerInput) (*voiceid.DescribeSpeakerOutput, error)
    92  	DescribeSpeakerWithContext(aws.Context, *voiceid.DescribeSpeakerInput, ...request.Option) (*voiceid.DescribeSpeakerOutput, error)
    93  	DescribeSpeakerRequest(*voiceid.DescribeSpeakerInput) (*request.Request, *voiceid.DescribeSpeakerOutput)
    94  
    95  	DescribeSpeakerEnrollmentJob(*voiceid.DescribeSpeakerEnrollmentJobInput) (*voiceid.DescribeSpeakerEnrollmentJobOutput, error)
    96  	DescribeSpeakerEnrollmentJobWithContext(aws.Context, *voiceid.DescribeSpeakerEnrollmentJobInput, ...request.Option) (*voiceid.DescribeSpeakerEnrollmentJobOutput, error)
    97  	DescribeSpeakerEnrollmentJobRequest(*voiceid.DescribeSpeakerEnrollmentJobInput) (*request.Request, *voiceid.DescribeSpeakerEnrollmentJobOutput)
    98  
    99  	EvaluateSession(*voiceid.EvaluateSessionInput) (*voiceid.EvaluateSessionOutput, error)
   100  	EvaluateSessionWithContext(aws.Context, *voiceid.EvaluateSessionInput, ...request.Option) (*voiceid.EvaluateSessionOutput, error)
   101  	EvaluateSessionRequest(*voiceid.EvaluateSessionInput) (*request.Request, *voiceid.EvaluateSessionOutput)
   102  
   103  	ListDomains(*voiceid.ListDomainsInput) (*voiceid.ListDomainsOutput, error)
   104  	ListDomainsWithContext(aws.Context, *voiceid.ListDomainsInput, ...request.Option) (*voiceid.ListDomainsOutput, error)
   105  	ListDomainsRequest(*voiceid.ListDomainsInput) (*request.Request, *voiceid.ListDomainsOutput)
   106  
   107  	ListDomainsPages(*voiceid.ListDomainsInput, func(*voiceid.ListDomainsOutput, bool) bool) error
   108  	ListDomainsPagesWithContext(aws.Context, *voiceid.ListDomainsInput, func(*voiceid.ListDomainsOutput, bool) bool, ...request.Option) error
   109  
   110  	ListFraudsterRegistrationJobs(*voiceid.ListFraudsterRegistrationJobsInput) (*voiceid.ListFraudsterRegistrationJobsOutput, error)
   111  	ListFraudsterRegistrationJobsWithContext(aws.Context, *voiceid.ListFraudsterRegistrationJobsInput, ...request.Option) (*voiceid.ListFraudsterRegistrationJobsOutput, error)
   112  	ListFraudsterRegistrationJobsRequest(*voiceid.ListFraudsterRegistrationJobsInput) (*request.Request, *voiceid.ListFraudsterRegistrationJobsOutput)
   113  
   114  	ListFraudsterRegistrationJobsPages(*voiceid.ListFraudsterRegistrationJobsInput, func(*voiceid.ListFraudsterRegistrationJobsOutput, bool) bool) error
   115  	ListFraudsterRegistrationJobsPagesWithContext(aws.Context, *voiceid.ListFraudsterRegistrationJobsInput, func(*voiceid.ListFraudsterRegistrationJobsOutput, bool) bool, ...request.Option) error
   116  
   117  	ListSpeakerEnrollmentJobs(*voiceid.ListSpeakerEnrollmentJobsInput) (*voiceid.ListSpeakerEnrollmentJobsOutput, error)
   118  	ListSpeakerEnrollmentJobsWithContext(aws.Context, *voiceid.ListSpeakerEnrollmentJobsInput, ...request.Option) (*voiceid.ListSpeakerEnrollmentJobsOutput, error)
   119  	ListSpeakerEnrollmentJobsRequest(*voiceid.ListSpeakerEnrollmentJobsInput) (*request.Request, *voiceid.ListSpeakerEnrollmentJobsOutput)
   120  
   121  	ListSpeakerEnrollmentJobsPages(*voiceid.ListSpeakerEnrollmentJobsInput, func(*voiceid.ListSpeakerEnrollmentJobsOutput, bool) bool) error
   122  	ListSpeakerEnrollmentJobsPagesWithContext(aws.Context, *voiceid.ListSpeakerEnrollmentJobsInput, func(*voiceid.ListSpeakerEnrollmentJobsOutput, bool) bool, ...request.Option) error
   123  
   124  	ListSpeakers(*voiceid.ListSpeakersInput) (*voiceid.ListSpeakersOutput, error)
   125  	ListSpeakersWithContext(aws.Context, *voiceid.ListSpeakersInput, ...request.Option) (*voiceid.ListSpeakersOutput, error)
   126  	ListSpeakersRequest(*voiceid.ListSpeakersInput) (*request.Request, *voiceid.ListSpeakersOutput)
   127  
   128  	ListSpeakersPages(*voiceid.ListSpeakersInput, func(*voiceid.ListSpeakersOutput, bool) bool) error
   129  	ListSpeakersPagesWithContext(aws.Context, *voiceid.ListSpeakersInput, func(*voiceid.ListSpeakersOutput, bool) bool, ...request.Option) error
   130  
   131  	ListTagsForResource(*voiceid.ListTagsForResourceInput) (*voiceid.ListTagsForResourceOutput, error)
   132  	ListTagsForResourceWithContext(aws.Context, *voiceid.ListTagsForResourceInput, ...request.Option) (*voiceid.ListTagsForResourceOutput, error)
   133  	ListTagsForResourceRequest(*voiceid.ListTagsForResourceInput) (*request.Request, *voiceid.ListTagsForResourceOutput)
   134  
   135  	OptOutSpeaker(*voiceid.OptOutSpeakerInput) (*voiceid.OptOutSpeakerOutput, error)
   136  	OptOutSpeakerWithContext(aws.Context, *voiceid.OptOutSpeakerInput, ...request.Option) (*voiceid.OptOutSpeakerOutput, error)
   137  	OptOutSpeakerRequest(*voiceid.OptOutSpeakerInput) (*request.Request, *voiceid.OptOutSpeakerOutput)
   138  
   139  	StartFraudsterRegistrationJob(*voiceid.StartFraudsterRegistrationJobInput) (*voiceid.StartFraudsterRegistrationJobOutput, error)
   140  	StartFraudsterRegistrationJobWithContext(aws.Context, *voiceid.StartFraudsterRegistrationJobInput, ...request.Option) (*voiceid.StartFraudsterRegistrationJobOutput, error)
   141  	StartFraudsterRegistrationJobRequest(*voiceid.StartFraudsterRegistrationJobInput) (*request.Request, *voiceid.StartFraudsterRegistrationJobOutput)
   142  
   143  	StartSpeakerEnrollmentJob(*voiceid.StartSpeakerEnrollmentJobInput) (*voiceid.StartSpeakerEnrollmentJobOutput, error)
   144  	StartSpeakerEnrollmentJobWithContext(aws.Context, *voiceid.StartSpeakerEnrollmentJobInput, ...request.Option) (*voiceid.StartSpeakerEnrollmentJobOutput, error)
   145  	StartSpeakerEnrollmentJobRequest(*voiceid.StartSpeakerEnrollmentJobInput) (*request.Request, *voiceid.StartSpeakerEnrollmentJobOutput)
   146  
   147  	TagResource(*voiceid.TagResourceInput) (*voiceid.TagResourceOutput, error)
   148  	TagResourceWithContext(aws.Context, *voiceid.TagResourceInput, ...request.Option) (*voiceid.TagResourceOutput, error)
   149  	TagResourceRequest(*voiceid.TagResourceInput) (*request.Request, *voiceid.TagResourceOutput)
   150  
   151  	UntagResource(*voiceid.UntagResourceInput) (*voiceid.UntagResourceOutput, error)
   152  	UntagResourceWithContext(aws.Context, *voiceid.UntagResourceInput, ...request.Option) (*voiceid.UntagResourceOutput, error)
   153  	UntagResourceRequest(*voiceid.UntagResourceInput) (*request.Request, *voiceid.UntagResourceOutput)
   154  
   155  	UpdateDomain(*voiceid.UpdateDomainInput) (*voiceid.UpdateDomainOutput, error)
   156  	UpdateDomainWithContext(aws.Context, *voiceid.UpdateDomainInput, ...request.Option) (*voiceid.UpdateDomainOutput, error)
   157  	UpdateDomainRequest(*voiceid.UpdateDomainInput) (*request.Request, *voiceid.UpdateDomainOutput)
   158  }
   159  
   160  var _ VoiceIDAPI = (*voiceid.VoiceID)(nil)