Add Support for CRUD operations on UserFlowAttributes

internal/test/testing.go

@@ -123,6 +123,7 @@ type Test struct {
 	ServicePrincipalsClient                   *msgraph.ServicePrincipalsClient
 	SignInReportsClient                       *msgraph.SignInReportsClient
 	SynchronizationJobClient                  *msgraph.SynchronizationJobClient
+	UserFlowAttributesClient                  *msgraph.UserFlowAttributesClient
 	UsersAppRoleAssignmentsClient             *msgraph.AppRoleAssignmentsClient
 	UsersClient                               *msgraph.UsersClient
 }

msgraph/models.go

@@ -1685,3 +1685,11 @@ type EmployeeOrgData struct {
 	CostCenter *string `json:"costCenter,omitempty"`
 	Division   *string `json:"division,omitempty"`
 }
+
+type UserFlowAttribute struct {
+	ID                    *string `json:"id,omitempty"`
+	Description           *string `json:"description,omitempty"`
+	DisplayName           *string `json:"displayName,omitempty"`
+	UserFlowAttributeType *string `json:"userFlowAttributeType,omitempty"`
+	DataType              *string `json:"dataType,omitempty"`
+}

msgraph/userflow_attributes.go

@@ -0,0 +1,171 @@
+package msgraph
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+	"io"
+	"net/http"
+
+	"github.com/manicminer/hamilton/odata"
+)
+
+// UserFlowAttributesClient performs operations on UserFlowAttributes.
+type UserFlowAttributesClient struct {
+	BaseClient Client
+}
+
+// NewUserFlowAttributesClient returns a new UserFlowAttributesClient.
+func NewUserFlowAttributesClient(tenantId string) *UserFlowAttributesClient {
+	return &UserFlowAttributesClient{
+		BaseClient: NewClient(Version10, tenantId),
+	}
+}
+
+// List returns a list of UserFlowAttributes, optionally queried using OData.
+func (c *UserFlowAttributesClient) List(ctx context.Context, query odata.Query) (*[]UserFlowAttribute, int, error) {
+	resp, status, _, err := c.BaseClient.Get(ctx, GetHttpRequestInput{
+		OData:            query,
+		ValidStatusCodes: []int{http.StatusOK},
+		Uri: Uri{
+			Entity:      "/identity/userFlowAttributes",
+			HasTenantId: true,
+		},
+	})
+	if err != nil {
+		return nil, status, fmt.Errorf("UserFlowAttributesClient.BaseClient.Get(): %v", err)
+	}
+
+	defer resp.Body.Close()
+	respBody, err := io.ReadAll(resp.Body)
+	if err != nil {
+		return nil, status, fmt.Errorf("io.ReadAll(): %v", err)
+	}
+
+	var data struct {
+		UserFlowAttributes []UserFlowAttribute `json:"value"`
+	}
+	if err := json.Unmarshal(respBody, &data); err != nil {
+		return nil, status, fmt.Errorf("json.Unmarshal(): %v", err)
+	}
+
+	return &data.UserFlowAttributes, status, nil
+}
+
+// Create creates a new UserFlowAttribute.
+func (c *UserFlowAttributesClient) Create(ctx context.Context, userFlowAttribute UserFlowAttribute) (*UserFlowAttribute, int, error) {
+	var status int
+
+	body, err := json.Marshal(userFlowAttribute)
+	if err != nil {
+		return nil, status, fmt.Errorf("json.Marshal(): %v", err)
+	}
+
+	resp, status, _, err := c.BaseClient.Post(ctx, PostHttpRequestInput{
+		Body: body,
+		OData: odata.Query{
+			Metadata: odata.MetadataFull,
+		},
+		ValidStatusCodes: []int{http.StatusCreated},
+		Uri: Uri{
+			Entity:      "/identity/userFlowAttributes",
+			HasTenantId: true,
+		},
+	})
+	if err != nil {
+		return nil, status, fmt.Errorf("UserFlowAttributesClient.BaseClient.Post(): %v", err)
+	}
+
+	defer resp.Body.Close()
+	respBody, err := io.ReadAll(resp.Body)
+	if err != nil {
+		return nil, status, fmt.Errorf("io.ReadAll(): %v", err)
+	}
+
+	var newUserFlowAttribute UserFlowAttribute
+	if err := json.Unmarshal(respBody, &newUserFlowAttribute); err != nil {
+		return nil, status, fmt.Errorf("json.Unmarshal(): %v", err)
+	}
+
+	return &newUserFlowAttribute, status, nil
+}
+
+// Delete returns a UserFlowAttribute.
+func (c *UserFlowAttributesClient) Get(ctx context.Context, id string, query odata.Query) (*UserFlowAttribute, int, error) {
+	resp, status, _, err := c.BaseClient.Get(ctx, GetHttpRequestInput{
+		ConsistencyFailureFunc: RetryOn404ConsistencyFailureFunc,
+		OData:                  query,
+		ValidStatusCodes:       []int{http.StatusOK},
+		Uri: Uri{
+			Entity:      fmt.Sprintf("/identity/userFlowAttributes/%s", id),
+			HasTenantId: true,
+		},
+	})
+	if err != nil {
+		return nil, status, fmt.Errorf("UserFlowAttributesClient.BaseClient.Get(): %v", err)
+	}
+
+	defer resp.Body.Close()
+	respBody, err := io.ReadAll(resp.Body)
+	if err != nil {
+		return nil, status, fmt.Errorf("io.ReadAll(): %v", err)
+	}
+
+	var userflowAttribute UserFlowAttribute
+	if err := json.Unmarshal(respBody, &userflowAttribute); err != nil {
+		return nil, status, fmt.Errorf("json.Unmarshal(): %v", err)
+	}
+
+	return &userflowAttribute, status, nil
+}
+
+// Update amends an existing UserFlowAttribute.
+func (c *UserFlowAttributesClient) Update(ctx context.Context, userflowAttribute UserFlowAttribute) (int, error) {
+	var status int
+	if userflowAttribute.ID == nil {
+		return status, fmt.Errorf("cannot update userflowAttribute with nil ID")
+	}
+
+	userflowID := *userflowAttribute.ID
+	userflowAttribute.ID = nil
+
+	body, err := json.Marshal(userflowAttribute)
+	if err != nil {
+		return status, fmt.Errorf("json.Marshal(): %v", err)
+	}
+
+	_, status, _, err = c.BaseClient.Patch(ctx, PatchHttpRequestInput{
+		Body:                   body,
+		ConsistencyFailureFunc: RetryOn404ConsistencyFailureFunc,
+		ValidStatusCodes: []int{
+			http.StatusOK,
+			http.StatusNoContent,
+		},
+		Uri: Uri{
+			Entity:      fmt.Sprintf("/identity/userFlowAttributes//%s", userflowID),
+			HasTenantId: true,
+		},
+	})
+	if err != nil {
+		return status, fmt.Errorf("UserFlowAttributesClient.BaseClient.Patch(): %v", err)
+	}
+
+	return status, nil
+}
+
+// Delete removes a UserFlowAttribute.
+func (c *UserFlowAttributesClient) Delete(ctx context.Context, id string) (int, error) {
+	_, status, _, err := c.BaseClient.Delete(ctx, DeleteHttpRequestInput{
+		ConsistencyFailureFunc: RetryOn404ConsistencyFailureFunc,
+		ValidStatusCodes:       []int{http.StatusNoContent},
+		Uri: Uri{
+			Entity:      fmt.Sprintf("/identity/userFlowAttributes/%s", id),
+			HasTenantId: true,
+		},
+	})
+	if err != nil {
+		return status, fmt.Errorf("UserFlowAttributesClient.BaseClient.Delete(): %v", err)
+	}
+
+	return status, nil
+}

msgraph/userflow_attributes_test.go

@@ -0,0 +1,79 @@
+package msgraph_test
+
+import (
+	"testing"
+
+	"github.com/manicminer/hamilton/internal/test"
+	"github.com/manicminer/hamilton/internal/utils"
+	"github.com/manicminer/hamilton/msgraph"
+	"github.com/manicminer/hamilton/odata"
+)
+
+func TestUserFlowAttributesClient(t *testing.T) {
+	c := test.NewTest(t)
+	defer c.CancelFunc()
+
+	userflowAttribute := testUserFlowAttributesClient_Create(t, c, msgraph.UserFlowAttribute{
+		ID:                    utils.StringPtr("test attribute"),
+		DisplayName:           utils.StringPtr("test attribute"),
+		UserFlowAttributeType: utils.StringPtr("custom"),
+		DataType:              utils.StringPtr("string"),
+	})
+	testUserFlowAttributesClient_Get(t, c, *userflowAttribute.ID)
+	userflowAttribute.DisplayName = utils.StringPtr("updated test attribute")
+	testUserFlowAttributesClient_Update(t, c, *userflowAttribute)
+	testUserFlowAttributesClient_List(t, c)
+	testGroupsClient_Delete(t, c, *userflowAttribute.ID)
+}
+
+func testUserFlowAttributesClient_Create(t *testing.T, c *test.Test, u msgraph.UserFlowAttribute) *msgraph.UserFlowAttribute {
+	userflowAttribute, status, err := c.UserFlowAttributesClient.Create(c.Context, u)
+	if err != nil {
+		t.Fatalf("UserFlowAttributeclient.Create(): %v", err)
+	}
+	if status < 200 || status >= 300 {
+		t.Fatalf("UserFlowAttributesClient.Create(): invalid status: %d", status)
+	}
+	if userflowAttribute == nil {
+		t.Fatal("UserFlowAttributesClient.Create(): userflowAttribute was nil")
+	}
+	if userflowAttribute.ID == nil {
+		t.Fatal("UserFlowAttributesClient.Create(): userflowAttribute.ID was nil")
+	}
+	return userflowAttribute
+}
+
+func testUserFlowAttributesClient_Get(t *testing.T, c *test.Test, id string) *msgraph.UserFlowAttribute {
+	userflowAttribute, status, err := c.UserFlowAttributesClient.Get(c.Context, id, odata.Query{})
+	if err != nil {
+		t.Fatalf("UserFlowAttributesClient.Get(): %v", err)
+	}
+	if status < 200 || status >= 300 {
+		t.Fatalf("UserFlowAttributesClient.Get(): invalid status: %d", status)
+	}
+	if userflowAttribute == nil {
+		t.Fatal("UserFlowAttributesClient.Get(): userflowAttribute was nil")
+	}
+	return userflowAttribute
+}
+
+func testUserFlowAttributesClient_List(t *testing.T, c *test.Test) *[]msgraph.UserFlowAttribute {
+	userflowAttributes, _, err := c.UserFlowAttributesClient.List(c.Context, odata.Query{Top: 10})
+	if err != nil {
+		t.Fatalf("UserFlowAttributesClient.List(): %v", err)
+	}
+	if userflowAttributes == nil {
+		t.Fatal("UserFlowAttributesClient.List(): userflowAttributes was nil")
+	}
+	return userflowAttributes
+}
+
+func testUserFlowAttributesClient_Update(t *testing.T, c *test.Test, u msgraph.UserFlowAttribute) {
+	status, err := c.UserFlowAttributesClient.Update(c.Context, u)
+	if err != nil {
+		t.Fatalf("UserFlowAttributesClient.Update(): %v", err)
+	}
+	if status < 200 || status >= 300 {
+		t.Fatalf("UserFlowAttributesClient.Update(): invalid status: %d", status)
+	}
+}