Merge pull request #2 from aviva-verde/deprecate-client

chore(VER-5669): Deprecate Client in clientcredentials.go

Author: jdmcgrath-az

clientcredentials/clientcredentials.go

@@ -68,10 +68,20 @@ func (c *Config) Token(ctx context.Context) (*oauth2.Token, error) {
 // is returned. See the oauth2.HTTPClient variable.
 //
 // The returned Client and its Transport should not be modified.
+//
+// Deprecated: Client exists for historical compatibility and should not be
+// used. It is recommended to use ClientWithXRay instead, as it provides much better visibility into the client's behavior.
 func (c *Config) Client(ctx context.Context) *http.Client {
 	return oauth2.NewClient(ctx, c.TokenSource(ctx))
 }
 
+// ClientWithXRay returns an HTTP client using the provided token with an attached XRay client..
+// The token will auto-refresh as necessary.
+//
+// The provided context optionally controls which HTTP client
+// is returned. See the oauth2.HTTPClient variable.
+//
+// The returned Client and its Transport should not be modified.
 func (c *Config) ClientWithXRay(ctx context.Context, hc *http.Client) *http.Client {
 	if hc == nil {
 		hc = http.DefaultClient