Add domainData to Organization create and update methods, replacing deprecated domains
#223
Conversation
mthadley
requested review from
amadeo-workos,
a team and
cadef
and removed request for
a team
| @@ -14,12 +14,39 @@ import com.workos.organizations.models.OrganizationList | |||
| * The OrganizationsApi provides convenience methods for working with WorkOS Organizations. | |||
| */ | |||
| class OrganizationsApi(private val workos: WorkOS) { | |||
| /** | |||
| * Options when setting the domains for an organization. | |||
There was a problem hiding this comment.
Nit: when I built this I tried to not have any class/enum inlined into another, and have them all separated, within the types folder. I think it makes of a cleaner, easier way to find and reuse things. But I also understand this is more compact.
There was a problem hiding this comment.
Makes sense! I'll move it there.
| */ | ||
| enum class OrganizationDomainDataState { | ||
| @JsonProperty("verified") | ||
| VERIFIED, |
There was a problem hiding this comment.
Another nit, no other enum uses all uppercase to define possible values in an enum, they all use first letter in the word as uppercase, rest as lowercase.
There was a problem hiding this comment.
Ah, I hadn't seen the others. Will keep it consistent.
| /** | ||
| * Parameters for [createOrganization]. | ||
| * Use `CreateOrganizationOptions.builder()` to create a new builder instance. | ||
| * | ||
| * @param name The name of the organization. | ||
| * @param allowProfilesOutsideOrganization Whether the Connections within this Organization should allow Profiles that do not have a domain that is present in the set of the Organization's User Email Domains. | ||
| * @param domainData A list of data for the domains of the organization. |
There was a problem hiding this comment.
Should we use @deprecated here for the documentation too? https://docs.oracle.com/javase/1.5.0/docs/guide/javadoc/deprecation/deprecation.html
There was a problem hiding this comment.
Oh, are these Javadoc comments or KDoc?
https://kotlinlang.org/docs/kotlin-doc.html#suppress
KDoc does not support the @deprecated tag. Instead, please use the @deprecated annotation.
There was a problem hiding this comment.
Yes, that's right. Good to know about this.
mthadley
deleted the
feature/auth-3096-kotlin-add-domains_data-to-sdks-and-deprecate-domains
branch
Description
Adds a new
domainDataoption to be passed to Organization create and update calls, instead of thedomainsparameter which is being deprecated.Documentation
Does this require changes to the WorkOS Docs? E.g. the API Reference or code snippets need updates.
If yes, link a related docs PR and add a docs maintainer as a reviewer. Their approval is required.