Add domains_data to Organization API and deprecate domains (#327)

* Add `domains_data` to Organization API and deprecate `domains` * Updates to godoc comments --------- Co-authored-by: Michael Hadley <[email protected]>
workos · Apr 29, 2024 · 9b79122 · 9b79122
1 parent 2491e87
commit 9b79122
Show file tree

Hide file tree

Showing 2 changed files with 89 additions and 2 deletions.
diff --git a/pkg/organizations/client.go b/pkg/organizations/client.go
@@ -125,6 +125,22 @@ type ListOrganizationsResponse struct {
 	ListMetadata common.ListMetadata `json:"listMetadata"`
 }
 
+type OrganizationDomainDataState string
+
+const (
+	Verified OrganizationDomainDataState = "verified"
+	Pending  OrganizationDomainDataState = "pending"
+)
+
+// OrganizationDomainData contains data used to create an OrganizationDomain.
+type OrganizationDomainData struct {
+	// The domain's value.
+	Domain string `json:"domain"`
+
+	// The domain's state.
+	State OrganizationDomainDataState `json:"state"`
+}
+
 // CreateOrganizationOpts contains the options to create an Organization.
 type CreateOrganizationOpts struct {
 	// Name of the Organization.
@@ -135,8 +151,13 @@ type CreateOrganizationOpts struct {
 	AllowProfilesOutsideOrganization bool `json:"allow_profiles_outside_organization"`
 
 	// Domains of the Organization.
+	//
+	// Deprecated:  Use DomainData instead.
 	Domains []string `json:"domains"`
 
+	// Domains of the Organization.
+	DomainData []OrganizationDomainData `json:"domain_data"`
+
 	// Optional unique identifier to ensure idempotency
 	IdempotencyKey string `json:"idempotency_iey,omitempty"`
 }
@@ -154,7 +175,12 @@ type UpdateOrganizationOpts struct {
 	AllowProfilesOutsideOrganization bool
 
 	// Domains of the Organization.
+	//
+	// Deprecated:  Use DomainData instead.
 	Domains []string
+
+	// Domains of the Organization.
+	DomainData []OrganizationDomainData `json:"domain_data"`
 }
 
 // GetOrganization gets an Organization.

diff --git a/pkg/organizations/client_test.go b/pkg/organizations/client_test.go
@@ -216,7 +216,7 @@ func TestCreateOrganization(t *testing.T) {
 			err:      true,
 		},
 		{
-			scenario: "Request returns Organization",
+			scenario: "Request returns Organization with Domains",
 			client: &Client{
 				APIKey: "test",
 			},
@@ -236,6 +236,32 @@ func TestCreateOrganization(t *testing.T) {
 				},
 			},
 		},
+		{
+			scenario: "Request returns Organization with DomainData",
+			client: &Client{
+				APIKey: "test",
+			},
+			options: CreateOrganizationOpts{
+				Name: "Foo Corp",
+				DomainData: []OrganizationDomainData{
+					OrganizationDomainData{
+						Domain: "foo-corp.com",
+						State:  "verified",
+					},
+				},
+			},
+			expected: Organization{
+				ID:                               "organization_id",
+				Name:                             "Foo Corp",
+				AllowProfilesOutsideOrganization: false,
+				Domains: []OrganizationDomain{
+					OrganizationDomain{
+						ID:     "organization_domain_id",
+						Domain: "foo-corp.com",
+					},
+				},
+			},
+		},
 		{
 			scenario: "Request with duplicate Organization Domain returns error",
 			client: &Client{
@@ -350,7 +376,7 @@ func TestUpdateOrganization(t *testing.T) {
 			err:      true,
 		},
 		{
-			scenario: "Request returns Organization",
+			scenario: "Request returns Organization with Domains",
 			client: &Client{
 				APIKey: "test",
 			},
@@ -375,6 +401,41 @@ func TestUpdateOrganization(t *testing.T) {
 				},
 			},
 		},
+		{
+			scenario: "Request returns Organization with DomainData",
+			client: &Client{
+				APIKey: "test",
+			},
+			options: UpdateOrganizationOpts{
+				Organization: "organization_id",
+				Name:         "Foo Corp",
+				DomainData: []OrganizationDomainData{
+					OrganizationDomainData{
+						Domain: "foo-corp.com",
+						State:  "verified",
+					},
+					OrganizationDomainData{
+						Domain: "foo-corp.io",
+						State:  "verified",
+					},
+				},
+			},
+			expected: Organization{
+				ID:                               "organization_id",
+				Name:                             "Foo Corp",
+				AllowProfilesOutsideOrganization: false,
+				Domains: []OrganizationDomain{
+					OrganizationDomain{
+						ID:     "organization_domain_id",
+						Domain: "foo-corp.com",
+					},
+					OrganizationDomain{
+						ID:     "organization_domain_id_2",
+						Domain: "foo-corp.io",
+					},
+				},
+			},
+		},
 		{
 			scenario: "Request with duplicate Organization Domain returns error",
 			client: &Client{