organizations

type Client struct {
	// The WorkOS API Key. It can be found in https://dashboard.workos.com/api-keys.
	APIKey string

	// The http.Client that is used to manage Organization records from WorkOS.
	// Defaults to http.Client.
	HTTPClient *http.Client

	// The endpoint to WorkOS API. Defaults to https://api.workos.com.
	Endpoint string

	// The function used to encode in JSON. Defaults to json.Marshal.
	JSONEncode func(v interface{}) ([]byte, error)
	// contains filtered or unexported fields
}

type CreateOrganizationOpts struct {
	// Name of the Organization.
	Name string `json:"name"`

	// Whether Connections within the Organization allow profiles that are
	// outside of the Organization's configured User Email Domains.
	//
	// Deprecated: If you need to allow sign-ins from any email domain, contact support@workos.com.
	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_key,omitempty"`

	// The Organization's external id.
	ExternalID string `json:"external_id,omitempty"`

	// The Organization's metadata.
	Metadata map[string]string `json:"metadata,omitempty"`
}

type DeleteOrganizationOpts struct {
	// Organization unique identifier.
	Organization string
}

type GetOrganizationByExternalIDOpts struct {
	ExternalID string
}

type GetOrganizationOpts struct {
	// Organization unique identifier.
	Organization string
}

type ListOrganizationRolesOpts struct {
	// The Organization's unique identifier.
	OrganizationID string
}

type ListOrganizationRolesResponse struct {
	// List of roles for the given organization.
	Data []roles.Role `json:"data"`
}

type ListOrganizationsOpts struct {
	// Domains of the Organization.
	Domains []string `url:"domains,brackets,omitempty"`

	// Maximum number of records to return.
	Limit int `url:"limit,omitempty"`

	// The order in which to paginate records.
	Order Order `url:"order,omitempty"`

	// Pagination cursor to receive records before a provided Organization ID.
	Before string `url:"before,omitempty"`

	// Pagination cursor to receive records after a provided Organization ID.
	After string `url:"after,omitempty"`
}

type ListOrganizationsResponse struct {
	// List of provisioned Organizations.
	Data []Organization `json:"data"`

	// Cursor pagination options.
	ListMetadata common.ListMetadata `json:"list_metadata"`
}

type Order string

type Organization struct {
	// The Organization's unique identifier.
	ID string `json:"id"`

	// The Organization's name.
	Name string `json:"name"`

	// Whether Connections within the Organization allow profiles that are
	// outside of the Organization's configured User Email Domains.
	//
	// Deprecated: If you need to allow sign-ins from any email domain, contact support@workos.com.
	AllowProfilesOutsideOrganization bool `json:"allow_profiles_outside_organization"`

	// The Organization's Domains.
	Domains []OrganizationDomain `json:"domains"`

	// The Organization's Stripe Customer ID.
	StripeCustomerID string `json:"stripe_customer_id,omitempty	"`

	// The timestamp of when the Organization was created.
	CreatedAt string `json:"created_at"`

	// The timestamp of when the Organization was updated.
	UpdatedAt string `json:"updated_at"`

	// The Organization's external id.
	ExternalID string `json:"external_id"`

	// The Organization's metadata.
	Metadata map[string]string `json:"metadata"`
}

type OrganizationDomain = organization_domains.OrganizationDomain

type OrganizationDomainData struct {
	// The domain's value.
	Domain string `json:"domain"`

	// The domain's state.
	State OrganizationDomainDataState `json:"state"`
}

type OrganizationDomainDataState string

type OrganizationDomainState = organization_domains.OrganizationDomainState

type OrganizationDomainVerificationStrategy = organization_domains.OrganizationDomainVerificationStrategy

type UpdateOrganizationOpts struct {
	// Organization unique identifier.
	Organization string `json:"-"`

	// Name of the Organization.
	Name string `json:"name,omitempty"`

	// Whether Connections within the Organization allow profiles that are
	// outside of the Organization's configured User Email Domains.
	//
	// Deprecated: If you need to allow sign-ins from any email domain, contact support@workos.com.
	AllowProfilesOutsideOrganization bool `json:"allow_profiles_outside_organization,omitempty"`

	// Domains of the Organization.
	//
	// Deprecated:  Use DomainData instead.
	Domains []string `json:"domains,omitempty"`

	// Domains of the Organization.
	DomainData []OrganizationDomainData `json:"domain_data,omitempty"`

	// The Organization's external id.
	ExternalID string `json:"external_id,omitempty"`

	// The Organization's Stripe Customer ID.
	StripeCustomerID string `json:"stripe_customer_id,omitempty"`

	// The Organization's metadata.
	Metadata map[string]*string `json:"metadata,omitempty"`
}