Change method name, to align with other methods

descope · Jul 30, 2023 · 095a757 · 095a757
1 parent 0b018d1
commit 095a757
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -1008,7 +1008,7 @@ link, pendingRef, err := descopeClient.Management.User().GenerateEnchantedLinkFo
 
 // Embedded link can be created via the following call,
 // The return value is a token that can be verified via magic link, or using flows
-token, err := descopeClient.Management.User().CreateEmbeddedLink("[email protected]", map[string]any{"key1":"value1"})
+token, err := descopeClient.Management.User().GenerateEmbeddedLink("[email protected]", map[string]any{"key1":"value1"})
 ```
 
 # API Rate Limits

diff --git a/descope/api/client.go b/descope/api/client.go
@@ -556,7 +556,7 @@ func (e *endpoints) ManagementUpdateJWT() string {
 	return path.Join(e.version, e.mgmt.updateJWT)
 }
 
-func (e *endpoints) ManagementCreateEmbeddedLink() string {
+func (e *endpoints) ManagementGenerateEmbeddedLink() string {
 	return path.Join(e.version, e.mgmt.createEmbeddedLink)
 }
 

diff --git a/descope/internal/mgmt/user.go b/descope/internal/mgmt/user.go
@@ -371,11 +371,11 @@ type embeddedLinkRes struct {
 	Token string `json:"token"`
 }
 
-func (u *user) CreateEmbeddedLink(loginID string, customClaims map[string]any) (string, error) {
+func (u *user) GenerateEmbeddedLink(loginID string, customClaims map[string]any) (string, error) {
 	if loginID == "" {
 		return "", utils.NewInvalidArgumentError("loginId")
 	}
-	res, err := u.client.DoPostRequest(api.Routes.ManagementCreateEmbeddedLink(), map[string]any{
+	res, err := u.client.DoPostRequest(api.Routes.ManagementGenerateEmbeddedLink(), map[string]any{
 		"loginId":      loginID,
 		"customClaims": customClaims,
 	}, nil, u.conf.ManagementKey)

diff --git a/descope/internal/mgmt/user_test.go b/descope/internal/mgmt/user_test.go
@@ -1011,7 +1011,7 @@ func TestGenerateEnchantedLinkForTestUserNoLoginID(t *testing.T) {
 	require.Empty(t, resPendingRef)
 	require.False(t, visited)
 }
-func TestCreateEmbeddedLink(t *testing.T) {
+func TestGenerateEmbeddedLink(t *testing.T) {
 	readyToken := "orgjwt"
 	loginID := "sometext"
 	mgmt := newTestMgmt(nil, helpers.DoOkWithBody(func(r *http.Request) {
@@ -1022,29 +1022,29 @@ func TestCreateEmbeddedLink(t *testing.T) {
 		require.NotEmpty(t, req["customClaims"])
 
 	}, map[string]interface{}{"token": readyToken}))
-	token, err := mgmt.User().CreateEmbeddedLink(loginID, map[string]any{"ak": "av"})
+	token, err := mgmt.User().GenerateEmbeddedLink(loginID, map[string]any{"ak": "av"})
 	require.NoError(t, err)
 	require.EqualValues(t, readyToken, token)
 }
 
-func TestCreateEmbeddedLinkMissingLoginID(t *testing.T) {
+func TestGenerateEmbeddedLinkMissingLoginID(t *testing.T) {
 	called := false
 	mgmt := newTestMgmt(nil, helpers.DoOk(func(r *http.Request) {
 		called = true
 
 	}))
-	token, err := mgmt.User().CreateEmbeddedLink("", map[string]any{"ak": "av"})
+	token, err := mgmt.User().GenerateEmbeddedLink("", map[string]any{"ak": "av"})
 	require.Error(t, err)
 	require.False(t, called)
 	require.Empty(t, token)
 }
 
-func TestCreateEmbeddedLinkHTTPError(t *testing.T) {
+func TestGenerateEmbeddedLinkHTTPError(t *testing.T) {
 	called := false
 	mgmt := newTestMgmt(nil, helpers.DoBadRequest(func(r *http.Request) {
 		called = true
 	}))
-	token, err := mgmt.User().CreateEmbeddedLink("test", map[string]any{"ak": "av"})
+	token, err := mgmt.User().GenerateEmbeddedLink("test", map[string]any{"ak": "av"})
 	require.Error(t, err)
 	require.True(t, called)
 	require.Empty(t, token)

diff --git a/descope/sdk/mgmt.go b/descope/sdk/mgmt.go
@@ -211,7 +211,7 @@ type User interface {
 
 	// Generate an embedded link token, later can be used to authenticate via magiclink verify method
 	// Or via flow verify step
-	CreateEmbeddedLink(loginID string, customClaims map[string]any) (string, error)
+	GenerateEmbeddedLink(loginID string, customClaims map[string]any) (string, error)
 }
 
 // Provides functions for managing access keys in a project.

diff --git a/descope/tests/mocks/mgmt/managementmock.go b/descope/tests/mocks/mgmt/managementmock.go
@@ -240,9 +240,9 @@ type MockUser struct {
 	GenerateEnchantedLinkForTestUserResponsePendingRef string
 	GenerateEnchantedLinkForTestUserError              error
 
-	CreateEmbeddedLinkAssert   func(loginID string, customClaims map[string]any)
-	CreateEmbeddedLinkResponse string
-	CreateEmbeddedLinkError    error
+	GenerateEmbeddedLinkAssert   func(loginID string, customClaims map[string]any)
+	GenerateEmbeddedLinkResponse string
+	GenerateEmbeddedLinkError    error
 }
 
 func (m *MockUser) Create(loginID string, user *descope.UserRequest) (*descope.UserResponse, error) {
@@ -448,11 +448,11 @@ func (m *MockUser) GenerateEnchantedLinkForTestUser(loginID, URI string) (link,
 	return m.GenerateEnchantedLinkForTestUserResponseLink, m.GenerateEnchantedLinkForTestUserResponsePendingRef, m.GenerateEnchantedLinkForTestUserError
 }
 
-func (m *MockUser) CreateEmbeddedLink(loginID string, customClaims map[string]any) (string, error) {
-	if m.CreateEmbeddedLinkAssert != nil {
-		m.CreateEmbeddedLinkAssert(loginID, customClaims)
+func (m *MockUser) GenerateEmbeddedLink(loginID string, customClaims map[string]any) (string, error) {
+	if m.GenerateEmbeddedLinkAssert != nil {
+		m.GenerateEmbeddedLinkAssert(loginID, customClaims)
 	}
-	return m.CreateEmbeddedLinkResponse, m.CreateEmbeddedLinkError
+	return m.GenerateEmbeddedLinkResponse, m.GenerateEmbeddedLinkError
 }
 
 // Mock Access Key