directory_sync.go

// Code generated by oagen. DO NOT EDIT.

package workos

import (
	"context"
	"fmt"
	"net/url"
)

// DirectorySyncService handles DirectorySync operations.
type DirectorySyncService struct {
	client *Client
}

// DirectorySyncListParams contains the parameters for List.
type DirectorySyncListParams struct {
	PaginationParams
	// OrganizationID is filter Directories by their associated organization.
	OrganizationID *string `url:"organization_id,omitempty" json:"-"`
	// Search is searchable text to match against Directory names.
	Search *string `url:"search,omitempty" json:"-"`
	// Domain is filter Directories by their associated domain.
	//
	// Deprecated: this parameter is deprecated.
	Domain *string `url:"domain,omitempty" json:"-"`
}

// List directories
// Get a list of all of your existing directories matching the criteria specified.
func (s *DirectorySyncService) List(ctx context.Context, params *DirectorySyncListParams, opts ...RequestOption) *Iterator[Directory] {
	return newIterator[Directory](ctx, s.client, "GET", "/directories", params, "after", "data", opts, map[string]string{"limit": "10", "order": "desc"})
}

// Get a Directory
// Get the details of an existing directory.
func (s *DirectorySyncService) Get(ctx context.Context, id string, opts ...RequestOption) (*Directory, error) {
	var result Directory
	_, err := s.client.request(ctx, "GET", fmt.Sprintf("/directories/%s", url.PathEscape(id)), nil, nil, &result, opts)
	if err != nil {
		return nil, err
	}
	return &result, nil
}

// Delete a Directory
// Permanently deletes an existing directory. It cannot be undone.
func (s *DirectorySyncService) Delete(ctx context.Context, id string, opts ...RequestOption) error {
	_, err := s.client.request(ctx, "DELETE", fmt.Sprintf("/directories/%s", url.PathEscape(id)), nil, nil, nil, opts)
	return err
}

// DirectorySyncListGroupsParams contains the parameters for ListGroups.
type DirectorySyncListGroupsParams struct {
	PaginationParams
	// Directory is unique identifier of the WorkOS Directory. This value can be obtained from the WorkOS dashboard or from the WorkOS API.
	Directory *string `url:"directory,omitempty" json:"-"`
	// User is unique identifier of the WorkOS Directory User. This value can be obtained from the WorkOS API.
	User *string `url:"user,omitempty" json:"-"`
}

// ListGroups list Directory Groups
// Get a list of all of existing directory groups matching the criteria specified.
func (s *DirectorySyncService) ListGroups(ctx context.Context, params *DirectorySyncListGroupsParams, opts ...RequestOption) *Iterator[DirectoryGroup] {
	return newIterator[DirectoryGroup](ctx, s.client, "GET", "/directory_groups", params, "after", "data", opts, map[string]string{"limit": "10", "order": "desc"})
}

// GetGroup get a Directory Group
// Get the details of an existing Directory Group.
func (s *DirectorySyncService) GetGroup(ctx context.Context, id string, opts ...RequestOption) (*DirectoryGroup, error) {
	var result DirectoryGroup
	_, err := s.client.request(ctx, "GET", fmt.Sprintf("/directory_groups/%s", url.PathEscape(id)), nil, nil, &result, opts)
	if err != nil {
		return nil, err
	}
	return &result, nil
}

// DirectorySyncListUsersParams contains the parameters for ListUsers.
type DirectorySyncListUsersParams struct {
	PaginationParams
	// Directory is unique identifier of the WorkOS Directory. This value can be obtained from the WorkOS dashboard or from the WorkOS API.
	Directory *string `url:"directory,omitempty" json:"-"`
	// Group is unique identifier of the WorkOS Directory Group. This value can be obtained from the WorkOS API.
	Group *string `url:"group,omitempty" json:"-"`
}

// ListUsers list Directory Users
// Get a list of all of existing Directory Users matching the criteria specified.
func (s *DirectorySyncService) ListUsers(ctx context.Context, params *DirectorySyncListUsersParams, opts ...RequestOption) *Iterator[DirectoryUserWithGroups] {
	return newIterator[DirectoryUserWithGroups](ctx, s.client, "GET", "/directory_users", params, "after", "data", opts, map[string]string{"limit": "10", "order": "desc"})
}

// GetUser get a Directory User
// Get the details of an existing Directory User.
func (s *DirectorySyncService) GetUser(ctx context.Context, id string, opts ...RequestOption) (*DirectoryUserWithGroups, error) {
	var result DirectoryUserWithGroups
	_, err := s.client.request(ctx, "GET", fmt.Sprintf("/directory_users/%s", url.PathEscape(id)), nil, nil, &result, opts)
	if err != nil {
		return nil, err
	}
	return &result, nil
}