Source File
	organization_membership.go

Belonging Package
	github.com/workos/workos-go/v10

// Code generated by oagen. DO NOT EDIT.

package workos

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

// OrganizationMembershipService handles OrganizationMembership operations.
type OrganizationMembershipService struct {
	client *Client
}

// OrganizationMembershipRole is one of:
//   - OrganizationMembershipRoleSingle
//   - OrganizationMembershipRoleMultiple
type OrganizationMembershipRole interface {
	isOrganizationMembershipRole()
	applyToBody(map[string]any)
}

type OrganizationMembershipRoleSingle struct {
	Slug string
}

func (p OrganizationMembershipRoleSingle) isOrganizationMembershipRole() {}
func (p OrganizationMembershipRoleSingle) applyToBody(m map[string]any) {
	m["role_slug"] = p.Slug
}

type OrganizationMembershipRoleMultiple struct {
	Slugs []string
}

func (p OrganizationMembershipRoleMultiple) isOrganizationMembershipRole() {}
func (p OrganizationMembershipRoleMultiple) applyToBody(m map[string]any) {
	m["role_slugs"] = p.Slugs
}

// OrganizationMembershipListParams contains the parameters for List.
type OrganizationMembershipListParams struct {
	PaginationParams
	// OrganizationID is the ID of the [organization](https://workos.com/docs/reference/organization) which the user belongs to.
	OrganizationID *string `url:"organization_id,omitempty" json:"-"`
	// Statuses is filter by the status of the organization membership. Array including any of `active`, `inactive`, or `pending`.
	Statuses []UserManagementOrganizationMembershipStatuses `url:"statuses,omitempty" json:"-"`
	// UserID is the ID of the [user](https://workos.com/docs/reference/authkit/user).
	UserID *string `url:"user_id,omitempty" json:"-"`
}

// List organization memberships
// Get a list of all organization memberships matching the criteria specified. At least one of `user_id` or `organization_id` must be provided. By default only active memberships are returned. Use the `statuses` parameter to filter by other statuses.
func (s *OrganizationMembershipService) List(ctx context.Context, params *OrganizationMembershipListParams, opts ...RequestOption) *Iterator[UserOrganizationMembership] {
	return newIterator[UserOrganizationMembership](ctx, s.client, "GET", "/user_management/organization_memberships", params, "after", "data", opts, map[string]string{"limit": "10", "order": "desc"})
}

// OrganizationMembershipCreateParams contains the parameters for Create.
type OrganizationMembershipCreateParams struct {
	// UserID is the ID of the [user](https://workos.com/docs/reference/authkit/user).
	UserID string `json:"user_id" url:"-"`
	// OrganizationID is the ID of the [organization](https://workos.com/docs/reference/organization) which the user belongs to.
	OrganizationID string `json:"organization_id" url:"-"`
	// Role optionally identifies the role.
	Role OrganizationMembershipRole `url:"-" json:"-"`
}

// MarshalJSON implements json.Marshaler for OrganizationMembershipCreateParams.
func (p OrganizationMembershipCreateParams) MarshalJSON() ([]byte, error) {
	type Alias OrganizationMembershipCreateParams
	data, err := json.Marshal(Alias(p))
	if err != nil {
		return nil, err
	}
	if p.Role == nil {
		return data, nil
	}
	var m map[string]any
	if err := json.Unmarshal(data, &m); err != nil {
		return nil, err
	}
	if p.Role != nil {
		p.Role.applyToBody(m)
	}
	return json.Marshal(m)
}

// Create an organization membership
// Creates a new `active` organization membership for the given organization and user.
// Calling this API with an organization and user that match an `inactive` organization membership will activate the membership with the specified role(s).
func (s *OrganizationMembershipService) Create(ctx context.Context, params *OrganizationMembershipCreateParams, opts ...RequestOption) (*OrganizationMembership, error) {
	var result OrganizationMembership
	_, err := s.client.request(ctx, "POST", "/user_management/organization_memberships", nil, params, &result, opts)
	if err != nil {
		return nil, err
	}
	return &result, nil
}

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

// OrganizationMembershipUpdateParams contains the parameters for Update.
type OrganizationMembershipUpdateParams struct {
	// Role optionally identifies the role.
	Role OrganizationMembershipRole `url:"-" json:"-"`
}

// MarshalJSON implements json.Marshaler for OrganizationMembershipUpdateParams.
func (p OrganizationMembershipUpdateParams) MarshalJSON() ([]byte, error) {
	type Alias OrganizationMembershipUpdateParams
	data, err := json.Marshal(Alias(p))
	if err != nil {
		return nil, err
	}
	if p.Role == nil {
		return data, nil
	}
	var m map[string]any
	if err := json.Unmarshal(data, &m); err != nil {
		return nil, err
	}
	if p.Role != nil {
		p.Role.applyToBody(m)
	}
	return json.Marshal(m)
}

// Update an organization membership
// Update the details of an existing organization membership.
func (s *OrganizationMembershipService) Update(ctx context.Context, id string, params *OrganizationMembershipUpdateParams, opts ...RequestOption) (*UserOrganizationMembership, error) {
	var result UserOrganizationMembership
	_, err := s.client.request(ctx, "PUT", fmt.Sprintf("/user_management/organization_memberships/%s", url.PathEscape(id)), nil, params, &result, opts)
	if err != nil {
		return nil, err
	}
	return &result, nil
}

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

// Deactivate an organization membership
// Deactivates an `active` organization membership. Emits an [organization_membership.updated](https://workos.com/docs/events/organization-membership) event upon successful deactivation.
// - Deactivating an `inactive` membership is a no-op and does not emit an event.
// - Deactivating a `pending` membership returns an error. This membership should be [deleted](https://workos.com/docs/reference/authkit/organization-membership/delete) instead.
// See the [membership management documentation](https://workos.com/docs/authkit/users-organizations/organizations/membership-management) for additional details.
func (s *OrganizationMembershipService) Deactivate(ctx context.Context, id string, opts ...RequestOption) (*OrganizationMembership, error) {
	var result OrganizationMembership
	_, err := s.client.request(ctx, "PUT", fmt.Sprintf("/user_management/organization_memberships/%s/deactivate", url.PathEscape(id)), nil, nil, &result, opts)
	if err != nil {
		return nil, err
	}
	return &result, nil
}

// Reactivate an organization membership
// Reactivates an `inactive` organization membership, retaining the pre-existing role(s). Emits an [organization_membership.updated](https://workos.com/docs/events/organization-membership) event upon successful reactivation.
// - Reactivating an `active` membership is a no-op and does not emit an event.
// - Reactivating a `pending` membership returns an error. The user needs to [accept the invitation](https://workos.com/docs/authkit/invitations) instead.
// See the [membership management documentation](https://workos.com/docs/authkit/users-organizations/organizations/membership-management) for additional details.
func (s *OrganizationMembershipService) Reactivate(ctx context.Context, id string, opts ...RequestOption) (*UserOrganizationMembership, error) {
	var result UserOrganizationMembership
	_, err := s.client.request(ctx, "PUT", fmt.Sprintf("/user_management/organization_memberships/%s/reactivate", url.PathEscape(id)), nil, nil, &result, opts)
	if err != nil {
		return nil, err
	}
	return &result, nil
}

// OrganizationMembershipListGroupsParams contains the parameters for ListGroups.
type OrganizationMembershipListGroupsParams struct {
	PaginationParams
}

// ListGroups
// Get a list of groups that an organization membership belongs to.
func (s *OrganizationMembershipService) ListGroups(ctx context.Context, omID string, params *OrganizationMembershipListGroupsParams, opts ...RequestOption) *Iterator[Group] {
	return newIterator[Group](ctx, s.client, "GET", fmt.Sprintf("/user_management/organization_memberships/%s/groups", url.PathEscape(omID)), params, "after", "data", opts, map[string]string{"limit": "10", "order": "desc"})
}

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.