directorysync

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 get Directory Sync records from WorkOS.
	// Defaults to http.Client.
	HTTPClient *http.Client

	// The endpoint to WorkOS API. Defaults to https://api.workos.com.
	Endpoint string
	// contains filtered or unexported fields
}

type DeleteDirectoryOpts struct {
	// Directory unique identifier.
	Directory string
}

type Directory struct {
	// Directory unique identifier.
	ID string `json:"id"`

	// Directory name.
	Name string `json:"name"`

	// Directory domain.
	Domain string `json:"domain"`

	// Externally used identifier for the Directory.
	ExternalKey string `json:"external_key"`

	// Type of the directory.
	Type DirectoryType `json:"type"`

	// Linked status for the Directory.
	State DirectoryState `json:"state"`

	// The user's directory provider's Identifier
	IdpID string `json:"idp_id"`

	// Identifier for the Directory's Organization.
	OrganizationID string `json:"organization_id"`

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

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

type DirectoryState string

type DirectoryType string

type GetDirectoryOpts struct {
	// Directory unique identifier.
	Directory string
}

type GetGroupOpts struct {
	// Directory Group unique identifier.
	Group string
}

type GetUserOpts struct {
	// Directory User unique identifier.
	User string
}

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

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

	// The Group's unique identifier assigned by the Directory Provider.
	IdpID string `json:"idp_id"`

	// The identifier of the Directory the group belongs to.
	DirectoryID string `json:"directory_id"`

	// The identifier for the Organization in which the Directory resides.
	OrganizationID string `json:"organization_id"`

	// The Group's created at date.
	CreatedAt string `json:"created_at"`

	// The Group's updated at date.
	UpdatedAt string `json:"updated_at"`

	// The Group's raw attributes in raw encoded JSON.
	RawAttributes json.RawMessage `json:"raw_attributes"`
}

type ListDirectoriesOpts struct {
	// Domain of a Directory. Can be empty.
	Domain string `url:"domain,omitempty"`

	// Searchable text for a Directory. Can be empty.
	Search string `url:"search,omitempty"`

	// Organization ID of a Directory. Can be empty.
	OrganizationID string `url:"organization_id,omitempty"`

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

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

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

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

type ListDirectoriesResponse struct {
	// List of Directories.
	Data []Directory `json:"data"`

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

type ListGroupsOpts struct {
	// Directory unique identifier.
	Directory string `url:"directory,omitempty"`

	// Directory unique identifier.
	User string `url:"user,omitempty"`

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

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

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

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

type ListGroupsResponse struct {
	// List of provisioned Users.
	Data []Group `json:"data"`

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

type ListUsersOpts struct {
	// Directory unique identifier.
	Directory string `url:"directory,omitempty"`

	// Directory Group unique identifier.
	Group string `url:"group,omitempty"`

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

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

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

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

type ListUsersResponse struct {
	// List of provisioned Users.
	Data []User `json:"data"`

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

type Order string

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

	// The User's unique identifier assigned by the Directory Provider.
	IdpID string `json:"idp_id"`

	// The identifier of the Directory the Directory User belongs to.
	DirectoryID string `json:"directory_id"`

	// The identifier for the Organization in which the Directory resides.
	OrganizationID string `json:"organization_id"`

	// The User's username.
	Username string `json:"username"`

	// The User's e-mails.
	Emails []UserEmail `json:"emails"`

	// The User's groups.
	Groups []UserGroup `json:"groups"`

	// The User's first name.
	FirstName string `json:"first_name"`

	// The User's last name.
	LastName string `json:"last_name"`

	// The User's job title.
	JobTitle string `json:"job_title"`

	// The User's state.
	State UserState `json:"state"`

	// The User's raw attributes in raw encoded JSON.
	RawAttributes json.RawMessage `json:"raw_attributes"`

	// The User's custom attributes in raw encoded JSON.
	CustomAttributes json.RawMessage `json:"custom_attributes"`

	// The User's created at date
	CreatedAt string `json:"created_at"`

	// The User's updated at date
	UpdatedAt string `json:"updated_at"`
}

type UserEmail struct {
	// Flag to indicate if this e-mail is primary.
	Primary bool

	// Directory User's e-mail.
	Value string

	// Type of e-mail (ex. work).
	Type string
}

type UserGroup struct {
	// Description of the record.
	Object string

	// The Group's identifier.
	ID string

	// The Group's Name.
	Name string
}

type UserState string