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

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package customerprofilesiface provides an interface to enable mocking the Amazon Connect Customer Profiles 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 customerprofilesiface
    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/customerprofiles"
    15  )
    16  
    17  // CustomerProfilesAPI provides an interface to enable mocking the
    18  // customerprofiles.CustomerProfiles 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 Customer Profiles.
    28  //    func myFunc(svc customerprofilesiface.CustomerProfilesAPI) bool {
    29  //        // Make svc.AddProfileKey request
    30  //    }
    31  //
    32  //    func main() {
    33  //        sess := session.New()
    34  //        svc := customerprofiles.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 mockCustomerProfilesClient struct {
    43  //        customerprofilesiface.CustomerProfilesAPI
    44  //    }
    45  //    func (m *mockCustomerProfilesClient) AddProfileKey(input *customerprofiles.AddProfileKeyInput) (*customerprofiles.AddProfileKeyOutput, error) {
    46  //        // mock response/functionality
    47  //    }
    48  //
    49  //    func TestMyFunc(t *testing.T) {
    50  //        // Setup Test
    51  //        mockSvc := &mockCustomerProfilesClient{}
    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 CustomerProfilesAPI interface {
    63  	AddProfileKey(*customerprofiles.AddProfileKeyInput) (*customerprofiles.AddProfileKeyOutput, error)
    64  	AddProfileKeyWithContext(aws.Context, *customerprofiles.AddProfileKeyInput, ...request.Option) (*customerprofiles.AddProfileKeyOutput, error)
    65  	AddProfileKeyRequest(*customerprofiles.AddProfileKeyInput) (*request.Request, *customerprofiles.AddProfileKeyOutput)
    66  
    67  	CreateDomain(*customerprofiles.CreateDomainInput) (*customerprofiles.CreateDomainOutput, error)
    68  	CreateDomainWithContext(aws.Context, *customerprofiles.CreateDomainInput, ...request.Option) (*customerprofiles.CreateDomainOutput, error)
    69  	CreateDomainRequest(*customerprofiles.CreateDomainInput) (*request.Request, *customerprofiles.CreateDomainOutput)
    70  
    71  	CreateProfile(*customerprofiles.CreateProfileInput) (*customerprofiles.CreateProfileOutput, error)
    72  	CreateProfileWithContext(aws.Context, *customerprofiles.CreateProfileInput, ...request.Option) (*customerprofiles.CreateProfileOutput, error)
    73  	CreateProfileRequest(*customerprofiles.CreateProfileInput) (*request.Request, *customerprofiles.CreateProfileOutput)
    74  
    75  	DeleteDomain(*customerprofiles.DeleteDomainInput) (*customerprofiles.DeleteDomainOutput, error)
    76  	DeleteDomainWithContext(aws.Context, *customerprofiles.DeleteDomainInput, ...request.Option) (*customerprofiles.DeleteDomainOutput, error)
    77  	DeleteDomainRequest(*customerprofiles.DeleteDomainInput) (*request.Request, *customerprofiles.DeleteDomainOutput)
    78  
    79  	DeleteIntegration(*customerprofiles.DeleteIntegrationInput) (*customerprofiles.DeleteIntegrationOutput, error)
    80  	DeleteIntegrationWithContext(aws.Context, *customerprofiles.DeleteIntegrationInput, ...request.Option) (*customerprofiles.DeleteIntegrationOutput, error)
    81  	DeleteIntegrationRequest(*customerprofiles.DeleteIntegrationInput) (*request.Request, *customerprofiles.DeleteIntegrationOutput)
    82  
    83  	DeleteProfile(*customerprofiles.DeleteProfileInput) (*customerprofiles.DeleteProfileOutput, error)
    84  	DeleteProfileWithContext(aws.Context, *customerprofiles.DeleteProfileInput, ...request.Option) (*customerprofiles.DeleteProfileOutput, error)
    85  	DeleteProfileRequest(*customerprofiles.DeleteProfileInput) (*request.Request, *customerprofiles.DeleteProfileOutput)
    86  
    87  	DeleteProfileKey(*customerprofiles.DeleteProfileKeyInput) (*customerprofiles.DeleteProfileKeyOutput, error)
    88  	DeleteProfileKeyWithContext(aws.Context, *customerprofiles.DeleteProfileKeyInput, ...request.Option) (*customerprofiles.DeleteProfileKeyOutput, error)
    89  	DeleteProfileKeyRequest(*customerprofiles.DeleteProfileKeyInput) (*request.Request, *customerprofiles.DeleteProfileKeyOutput)
    90  
    91  	DeleteProfileObject(*customerprofiles.DeleteProfileObjectInput) (*customerprofiles.DeleteProfileObjectOutput, error)
    92  	DeleteProfileObjectWithContext(aws.Context, *customerprofiles.DeleteProfileObjectInput, ...request.Option) (*customerprofiles.DeleteProfileObjectOutput, error)
    93  	DeleteProfileObjectRequest(*customerprofiles.DeleteProfileObjectInput) (*request.Request, *customerprofiles.DeleteProfileObjectOutput)
    94  
    95  	DeleteProfileObjectType(*customerprofiles.DeleteProfileObjectTypeInput) (*customerprofiles.DeleteProfileObjectTypeOutput, error)
    96  	DeleteProfileObjectTypeWithContext(aws.Context, *customerprofiles.DeleteProfileObjectTypeInput, ...request.Option) (*customerprofiles.DeleteProfileObjectTypeOutput, error)
    97  	DeleteProfileObjectTypeRequest(*customerprofiles.DeleteProfileObjectTypeInput) (*request.Request, *customerprofiles.DeleteProfileObjectTypeOutput)
    98  
    99  	GetDomain(*customerprofiles.GetDomainInput) (*customerprofiles.GetDomainOutput, error)
   100  	GetDomainWithContext(aws.Context, *customerprofiles.GetDomainInput, ...request.Option) (*customerprofiles.GetDomainOutput, error)
   101  	GetDomainRequest(*customerprofiles.GetDomainInput) (*request.Request, *customerprofiles.GetDomainOutput)
   102  
   103  	GetIntegration(*customerprofiles.GetIntegrationInput) (*customerprofiles.GetIntegrationOutput, error)
   104  	GetIntegrationWithContext(aws.Context, *customerprofiles.GetIntegrationInput, ...request.Option) (*customerprofiles.GetIntegrationOutput, error)
   105  	GetIntegrationRequest(*customerprofiles.GetIntegrationInput) (*request.Request, *customerprofiles.GetIntegrationOutput)
   106  
   107  	GetMatches(*customerprofiles.GetMatchesInput) (*customerprofiles.GetMatchesOutput, error)
   108  	GetMatchesWithContext(aws.Context, *customerprofiles.GetMatchesInput, ...request.Option) (*customerprofiles.GetMatchesOutput, error)
   109  	GetMatchesRequest(*customerprofiles.GetMatchesInput) (*request.Request, *customerprofiles.GetMatchesOutput)
   110  
   111  	GetProfileObjectType(*customerprofiles.GetProfileObjectTypeInput) (*customerprofiles.GetProfileObjectTypeOutput, error)
   112  	GetProfileObjectTypeWithContext(aws.Context, *customerprofiles.GetProfileObjectTypeInput, ...request.Option) (*customerprofiles.GetProfileObjectTypeOutput, error)
   113  	GetProfileObjectTypeRequest(*customerprofiles.GetProfileObjectTypeInput) (*request.Request, *customerprofiles.GetProfileObjectTypeOutput)
   114  
   115  	GetProfileObjectTypeTemplate(*customerprofiles.GetProfileObjectTypeTemplateInput) (*customerprofiles.GetProfileObjectTypeTemplateOutput, error)
   116  	GetProfileObjectTypeTemplateWithContext(aws.Context, *customerprofiles.GetProfileObjectTypeTemplateInput, ...request.Option) (*customerprofiles.GetProfileObjectTypeTemplateOutput, error)
   117  	GetProfileObjectTypeTemplateRequest(*customerprofiles.GetProfileObjectTypeTemplateInput) (*request.Request, *customerprofiles.GetProfileObjectTypeTemplateOutput)
   118  
   119  	ListAccountIntegrations(*customerprofiles.ListAccountIntegrationsInput) (*customerprofiles.ListAccountIntegrationsOutput, error)
   120  	ListAccountIntegrationsWithContext(aws.Context, *customerprofiles.ListAccountIntegrationsInput, ...request.Option) (*customerprofiles.ListAccountIntegrationsOutput, error)
   121  	ListAccountIntegrationsRequest(*customerprofiles.ListAccountIntegrationsInput) (*request.Request, *customerprofiles.ListAccountIntegrationsOutput)
   122  
   123  	ListDomains(*customerprofiles.ListDomainsInput) (*customerprofiles.ListDomainsOutput, error)
   124  	ListDomainsWithContext(aws.Context, *customerprofiles.ListDomainsInput, ...request.Option) (*customerprofiles.ListDomainsOutput, error)
   125  	ListDomainsRequest(*customerprofiles.ListDomainsInput) (*request.Request, *customerprofiles.ListDomainsOutput)
   126  
   127  	ListIntegrations(*customerprofiles.ListIntegrationsInput) (*customerprofiles.ListIntegrationsOutput, error)
   128  	ListIntegrationsWithContext(aws.Context, *customerprofiles.ListIntegrationsInput, ...request.Option) (*customerprofiles.ListIntegrationsOutput, error)
   129  	ListIntegrationsRequest(*customerprofiles.ListIntegrationsInput) (*request.Request, *customerprofiles.ListIntegrationsOutput)
   130  
   131  	ListProfileObjectTypeTemplates(*customerprofiles.ListProfileObjectTypeTemplatesInput) (*customerprofiles.ListProfileObjectTypeTemplatesOutput, error)
   132  	ListProfileObjectTypeTemplatesWithContext(aws.Context, *customerprofiles.ListProfileObjectTypeTemplatesInput, ...request.Option) (*customerprofiles.ListProfileObjectTypeTemplatesOutput, error)
   133  	ListProfileObjectTypeTemplatesRequest(*customerprofiles.ListProfileObjectTypeTemplatesInput) (*request.Request, *customerprofiles.ListProfileObjectTypeTemplatesOutput)
   134  
   135  	ListProfileObjectTypes(*customerprofiles.ListProfileObjectTypesInput) (*customerprofiles.ListProfileObjectTypesOutput, error)
   136  	ListProfileObjectTypesWithContext(aws.Context, *customerprofiles.ListProfileObjectTypesInput, ...request.Option) (*customerprofiles.ListProfileObjectTypesOutput, error)
   137  	ListProfileObjectTypesRequest(*customerprofiles.ListProfileObjectTypesInput) (*request.Request, *customerprofiles.ListProfileObjectTypesOutput)
   138  
   139  	ListProfileObjects(*customerprofiles.ListProfileObjectsInput) (*customerprofiles.ListProfileObjectsOutput, error)
   140  	ListProfileObjectsWithContext(aws.Context, *customerprofiles.ListProfileObjectsInput, ...request.Option) (*customerprofiles.ListProfileObjectsOutput, error)
   141  	ListProfileObjectsRequest(*customerprofiles.ListProfileObjectsInput) (*request.Request, *customerprofiles.ListProfileObjectsOutput)
   142  
   143  	ListTagsForResource(*customerprofiles.ListTagsForResourceInput) (*customerprofiles.ListTagsForResourceOutput, error)
   144  	ListTagsForResourceWithContext(aws.Context, *customerprofiles.ListTagsForResourceInput, ...request.Option) (*customerprofiles.ListTagsForResourceOutput, error)
   145  	ListTagsForResourceRequest(*customerprofiles.ListTagsForResourceInput) (*request.Request, *customerprofiles.ListTagsForResourceOutput)
   146  
   147  	MergeProfiles(*customerprofiles.MergeProfilesInput) (*customerprofiles.MergeProfilesOutput, error)
   148  	MergeProfilesWithContext(aws.Context, *customerprofiles.MergeProfilesInput, ...request.Option) (*customerprofiles.MergeProfilesOutput, error)
   149  	MergeProfilesRequest(*customerprofiles.MergeProfilesInput) (*request.Request, *customerprofiles.MergeProfilesOutput)
   150  
   151  	PutIntegration(*customerprofiles.PutIntegrationInput) (*customerprofiles.PutIntegrationOutput, error)
   152  	PutIntegrationWithContext(aws.Context, *customerprofiles.PutIntegrationInput, ...request.Option) (*customerprofiles.PutIntegrationOutput, error)
   153  	PutIntegrationRequest(*customerprofiles.PutIntegrationInput) (*request.Request, *customerprofiles.PutIntegrationOutput)
   154  
   155  	PutProfileObject(*customerprofiles.PutProfileObjectInput) (*customerprofiles.PutProfileObjectOutput, error)
   156  	PutProfileObjectWithContext(aws.Context, *customerprofiles.PutProfileObjectInput, ...request.Option) (*customerprofiles.PutProfileObjectOutput, error)
   157  	PutProfileObjectRequest(*customerprofiles.PutProfileObjectInput) (*request.Request, *customerprofiles.PutProfileObjectOutput)
   158  
   159  	PutProfileObjectType(*customerprofiles.PutProfileObjectTypeInput) (*customerprofiles.PutProfileObjectTypeOutput, error)
   160  	PutProfileObjectTypeWithContext(aws.Context, *customerprofiles.PutProfileObjectTypeInput, ...request.Option) (*customerprofiles.PutProfileObjectTypeOutput, error)
   161  	PutProfileObjectTypeRequest(*customerprofiles.PutProfileObjectTypeInput) (*request.Request, *customerprofiles.PutProfileObjectTypeOutput)
   162  
   163  	SearchProfiles(*customerprofiles.SearchProfilesInput) (*customerprofiles.SearchProfilesOutput, error)
   164  	SearchProfilesWithContext(aws.Context, *customerprofiles.SearchProfilesInput, ...request.Option) (*customerprofiles.SearchProfilesOutput, error)
   165  	SearchProfilesRequest(*customerprofiles.SearchProfilesInput) (*request.Request, *customerprofiles.SearchProfilesOutput)
   166  
   167  	TagResource(*customerprofiles.TagResourceInput) (*customerprofiles.TagResourceOutput, error)
   168  	TagResourceWithContext(aws.Context, *customerprofiles.TagResourceInput, ...request.Option) (*customerprofiles.TagResourceOutput, error)
   169  	TagResourceRequest(*customerprofiles.TagResourceInput) (*request.Request, *customerprofiles.TagResourceOutput)
   170  
   171  	UntagResource(*customerprofiles.UntagResourceInput) (*customerprofiles.UntagResourceOutput, error)
   172  	UntagResourceWithContext(aws.Context, *customerprofiles.UntagResourceInput, ...request.Option) (*customerprofiles.UntagResourceOutput, error)
   173  	UntagResourceRequest(*customerprofiles.UntagResourceInput) (*request.Request, *customerprofiles.UntagResourceOutput)
   174  
   175  	UpdateDomain(*customerprofiles.UpdateDomainInput) (*customerprofiles.UpdateDomainOutput, error)
   176  	UpdateDomainWithContext(aws.Context, *customerprofiles.UpdateDomainInput, ...request.Option) (*customerprofiles.UpdateDomainOutput, error)
   177  	UpdateDomainRequest(*customerprofiles.UpdateDomainInput) (*request.Request, *customerprofiles.UpdateDomainOutput)
   178  
   179  	UpdateProfile(*customerprofiles.UpdateProfileInput) (*customerprofiles.UpdateProfileOutput, error)
   180  	UpdateProfileWithContext(aws.Context, *customerprofiles.UpdateProfileInput, ...request.Option) (*customerprofiles.UpdateProfileOutput, error)
   181  	UpdateProfileRequest(*customerprofiles.UpdateProfileInput) (*request.Request, *customerprofiles.UpdateProfileOutput)
   182  }
   183  
   184  var _ CustomerProfilesAPI = (*customerprofiles.CustomerProfiles)(nil)