Add support for idempotency key in create_organization method (#143)

* Add support for idempotency key in create_organization method

* Refactor idempotency method and test

* Update casing for idempotency-key header

* Update headers declaration in organizations.py

* Remove erroneous description of idempotency-key param

Co-authored-by: Adam Wolfman <adamwolfman@Adams-MBP-3.domain>

Author: awolfden

tests/test_organizations.py

@@ -1,9 +1,4 @@
-import json
-from requests import Response
-
 import pytest
-
-import workos
 from workos.organizations import Organizations
 
 
@@ -109,6 +104,19 @@ def test_create_organization(self, mock_organization, mock_request_method):
         assert organization["id"] == "org_01EHT88Z8J8795GZNQ4ZP1J81T"
         assert organization["name"] == "Foo Corporation"
 
+    def test_sends_idempotency_key(self, capture_and_mock_request):
+        idempotency_key = "test_123456789"
+        payload = {"domains": ["example.com"], "name": "Foo Corporation"}
+
+        _, request_kwargs = capture_and_mock_request("post", payload, 200)
+
+        response = self.organizations.create_organization(
+            payload, idempotency_key=idempotency_key
+        )
+
+        assert request_kwargs["headers"]["idempotency-key"] == idempotency_key
+        assert response["name"] == "Foo Corporation"
+
     def test_update_organization(self, mock_organization_updated, mock_request_method):
         mock_request_method("put", mock_organization_updated, 201)
 

workos/organizations.py

@@ -78,7 +78,7 @@ def get_organization(self, organization):
 
         return WorkOSOrganization.construct_from_response(response).to_dict()
 
-    def create_organization(self, organization):
+    def create_organization(self, organization, idempotency_key=None):
         """Create an organization
 
         Args:
@@ -88,14 +88,20 @@ def create_organization(self, organization):
                     within the Organization allow profiles that are outside of the Organization's
                     configured User Email Domains. (Optional)
                 organization[domains] (list) - List of domains that belong to the organization
+            idempotency_key (str) - Idempotency key for creating an organization. (Optional)
 
         Returns:
             dict: Created Organization response from WorkOS.
         """
+        headers = {}
+        if idempotency_key:
+            headers["idempotency-key"] = idempotency_key
+
         response = self.request_helper.request(
             ORGANIZATIONS_PATH,
             method=REQUEST_METHOD_POST,
             params=organization,
+            headers=headers,
             token=workos.api_key,
         )