user.go

// Code generated by Fern. DO NOT EDIT.

package zep

import (
	json "encoding/json"
	fmt "fmt"
	internal "github.com/getzep/zep-go/v3/internal"
)

type CreateUserRequest struct {
	// When true, disables the use of default/fallback ontology for the user's graph.
	DisableDefaultOntology *bool `json:"disable_default_ontology,omitempty" url:"-"`
	// The email address of the user.
	Email *string `json:"email,omitempty" url:"-"`
	// The first name of the user.
	FirstName *string `json:"first_name,omitempty" url:"-"`
	// The last name of the user.
	LastName *string `json:"last_name,omitempty" url:"-"`
	// The metadata associated with the user.
	Metadata map[string]interface{} `json:"metadata,omitempty" url:"-"`
	// The user's IANA time zone. Null or omission leaves it unset at creation.
	TimeZone *string `json:"time_zone,omitempty" url:"-"`
	// The unique identifier of the user.
	UserID string `json:"user_id" url:"-"`
}

type AddUserInstructionsRequest struct {
	// Instructions to add to the user summary generation.
	Instructions []*UserInstruction `json:"instructions,omitempty" url:"-"`
	// User IDs to add the instructions to. If empty, the instructions are added to the project-wide default.
	UserIDs []string `json:"user_ids,omitempty" url:"-"`
}

type DeleteUserInstructionsRequest struct {
	// Unique identifier for the instructions to be deleted. If empty deletes all instructions.
	InstructionNames []string `json:"instruction_names,omitempty" url:"-"`
	// Determines which users will have their custom instructions deleted. If no users are provided, the project-wide custom instructions will be effected.
	UserIDs []string `json:"user_ids,omitempty" url:"-"`
}

type UserListOrderedRequest struct {
	// Page number for pagination, starting from 1
	PageNumber *int `json:"-" url:"pageNumber,omitempty"`
	// Number of users to retrieve per page
	PageSize *int `json:"-" url:"pageSize,omitempty"`
	// Search term for filtering users by user_id, name, or email
	Search *string `json:"-" url:"search,omitempty"`
	// Column to sort by (created_at, user_id, email)
	OrderBy *string `json:"-" url:"order_by,omitempty"`
	// Sort in ascending order
	Asc *bool `json:"-" url:"asc,omitempty"`
}

type UserListUserSummaryInstructionsRequest struct {
	// User ID to get user-specific instructions
	UserID *string `json:"-" url:"user_id,omitempty"`
}

type ListUserInstructionsResponse struct {
	Instructions []*UserInstruction `json:"instructions,omitempty" url:"instructions,omitempty"`

	extraProperties map[string]interface{}
	rawJSON         json.RawMessage
}

func (l *ListUserInstructionsResponse) GetInstructions() []*UserInstruction {
	if l == nil {
		return nil
	}
	return l.Instructions
}

func (l *ListUserInstructionsResponse) GetExtraProperties() map[string]interface{} {
	return l.extraProperties
}

func (l *ListUserInstructionsResponse) UnmarshalJSON(data []byte) error {
	type unmarshaler ListUserInstructionsResponse
	var value unmarshaler
	if err := json.Unmarshal(data, &value); err != nil {
		return err
	}
	*l = ListUserInstructionsResponse(value)
	extraProperties, err := internal.ExtractExtraProperties(data, *l)
	if err != nil {
		return err
	}
	l.extraProperties = extraProperties
	l.rawJSON = json.RawMessage(data)
	return nil
}

func (l *ListUserInstructionsResponse) String() string {
	if len(l.rawJSON) > 0 {
		if value, err := internal.StringifyJSON(l.rawJSON); err == nil {
			return value
		}
	}
	if value, err := internal.StringifyJSON(l); err == nil {
		return value
	}
	return fmt.Sprintf("%#v", l)
}

type User struct {
	CreatedAt              *string `json:"created_at,omitempty" url:"created_at,omitempty"`
	DeletedAt              *string `json:"deleted_at,omitempty" url:"deleted_at,omitempty"`
	DisableDefaultOntology *bool   `json:"disable_default_ontology,omitempty" url:"disable_default_ontology,omitempty"`
	Email                  *string `json:"email,omitempty" url:"email,omitempty"`
	FirstName              *string `json:"first_name,omitempty" url:"first_name,omitempty"`
	ID                     *int    `json:"id,omitempty" url:"id,omitempty"`
	LastName               *string `json:"last_name,omitempty" url:"last_name,omitempty"`
	// Deprecated
	Metadata    map[string]interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	ProjectUUID *string                `json:"project_uuid,omitempty" url:"project_uuid,omitempty"`
	// Deprecated
	SessionCount *int    `json:"session_count,omitempty" url:"session_count,omitempty"`
	TimeZone     *string `json:"time_zone,omitempty" url:"time_zone,omitempty"`
	// Deprecated
	UpdatedAt *string `json:"updated_at,omitempty" url:"updated_at,omitempty"`
	UserID    *string `json:"user_id,omitempty" url:"user_id,omitempty"`
	UUID      *string `json:"uuid,omitempty" url:"uuid,omitempty"`

	extraProperties map[string]interface{}
	rawJSON         json.RawMessage
}

func (u *User) GetCreatedAt() *string {
	if u == nil {
		return nil
	}
	return u.CreatedAt
}

func (u *User) GetDeletedAt() *string {
	if u == nil {
		return nil
	}
	return u.DeletedAt
}

func (u *User) GetDisableDefaultOntology() *bool {
	if u == nil {
		return nil
	}
	return u.DisableDefaultOntology
}

func (u *User) GetEmail() *string {
	if u == nil {
		return nil
	}
	return u.Email
}

func (u *User) GetFirstName() *string {
	if u == nil {
		return nil
	}
	return u.FirstName
}

func (u *User) GetID() *int {
	if u == nil {
		return nil
	}
	return u.ID
}

func (u *User) GetLastName() *string {
	if u == nil {
		return nil
	}
	return u.LastName
}

func (u *User) GetMetadata() map[string]interface{} {
	if u == nil {
		return nil
	}
	return u.Metadata
}

func (u *User) GetProjectUUID() *string {
	if u == nil {
		return nil
	}
	return u.ProjectUUID
}

func (u *User) GetSessionCount() *int {
	if u == nil {
		return nil
	}
	return u.SessionCount
}

func (u *User) GetTimeZone() *string {
	if u == nil {
		return nil
	}
	return u.TimeZone
}

func (u *User) GetUpdatedAt() *string {
	if u == nil {
		return nil
	}
	return u.UpdatedAt
}

func (u *User) GetUserID() *string {
	if u == nil {
		return nil
	}
	return u.UserID
}

func (u *User) GetUUID() *string {
	if u == nil {
		return nil
	}
	return u.UUID
}

func (u *User) GetExtraProperties() map[string]interface{} {
	return u.extraProperties
}

func (u *User) UnmarshalJSON(data []byte) error {
	type unmarshaler User
	var value unmarshaler
	if err := json.Unmarshal(data, &value); err != nil {
		return err
	}
	*u = User(value)
	extraProperties, err := internal.ExtractExtraProperties(data, *u)
	if err != nil {
		return err
	}
	u.extraProperties = extraProperties
	u.rawJSON = json.RawMessage(data)
	return nil
}

func (u *User) String() string {
	if len(u.rawJSON) > 0 {
		if value, err := internal.StringifyJSON(u.rawJSON); err == nil {
			return value
		}
	}
	if value, err := internal.StringifyJSON(u); err == nil {
		return value
	}
	return fmt.Sprintf("%#v", u)
}

type UserInstruction struct {
	Name string `json:"name" url:"name"`
	Text string `json:"text" url:"text"`

	extraProperties map[string]interface{}
	rawJSON         json.RawMessage
}

func (u *UserInstruction) GetName() string {
	if u == nil {
		return ""
	}
	return u.Name
}

func (u *UserInstruction) GetText() string {
	if u == nil {
		return ""
	}
	return u.Text
}

func (u *UserInstruction) GetExtraProperties() map[string]interface{} {
	return u.extraProperties
}

func (u *UserInstruction) UnmarshalJSON(data []byte) error {
	type unmarshaler UserInstruction
	var value unmarshaler
	if err := json.Unmarshal(data, &value); err != nil {
		return err
	}
	*u = UserInstruction(value)
	extraProperties, err := internal.ExtractExtraProperties(data, *u)
	if err != nil {
		return err
	}
	u.extraProperties = extraProperties
	u.rawJSON = json.RawMessage(data)
	return nil
}

func (u *UserInstruction) String() string {
	if len(u.rawJSON) > 0 {
		if value, err := internal.StringifyJSON(u.rawJSON); err == nil {
			return value
		}
	}
	if value, err := internal.StringifyJSON(u); err == nil {
		return value
	}
	return fmt.Sprintf("%#v", u)
}

type UserListResponse struct {
	RowCount   *int    `json:"row_count,omitempty" url:"row_count,omitempty"`
	TotalCount *int    `json:"total_count,omitempty" url:"total_count,omitempty"`
	Users      []*User `json:"users,omitempty" url:"users,omitempty"`

	extraProperties map[string]interface{}
	rawJSON         json.RawMessage
}

func (u *UserListResponse) GetRowCount() *int {
	if u == nil {
		return nil
	}
	return u.RowCount
}

func (u *UserListResponse) GetTotalCount() *int {
	if u == nil {
		return nil
	}
	return u.TotalCount
}

func (u *UserListResponse) GetUsers() []*User {
	if u == nil {
		return nil
	}
	return u.Users
}

func (u *UserListResponse) GetExtraProperties() map[string]interface{} {
	return u.extraProperties
}

func (u *UserListResponse) UnmarshalJSON(data []byte) error {
	type unmarshaler UserListResponse
	var value unmarshaler
	if err := json.Unmarshal(data, &value); err != nil {
		return err
	}
	*u = UserListResponse(value)
	extraProperties, err := internal.ExtractExtraProperties(data, *u)
	if err != nil {
		return err
	}
	u.extraProperties = extraProperties
	u.rawJSON = json.RawMessage(data)
	return nil
}

func (u *UserListResponse) String() string {
	if len(u.rawJSON) > 0 {
		if value, err := internal.StringifyJSON(u.rawJSON); err == nil {
			return value
		}
	}
	if value, err := internal.StringifyJSON(u); err == nil {
		return value
	}
	return fmt.Sprintf("%#v", u)
}

type UserNodeResponse struct {
	Node *EntityNode `json:"node,omitempty" url:"node,omitempty"`

	extraProperties map[string]interface{}
	rawJSON         json.RawMessage
}

func (u *UserNodeResponse) GetNode() *EntityNode {
	if u == nil {
		return nil
	}
	return u.Node
}

func (u *UserNodeResponse) GetExtraProperties() map[string]interface{} {
	return u.extraProperties
}

func (u *UserNodeResponse) UnmarshalJSON(data []byte) error {
	type unmarshaler UserNodeResponse
	var value unmarshaler
	if err := json.Unmarshal(data, &value); err != nil {
		return err
	}
	*u = UserNodeResponse(value)
	extraProperties, err := internal.ExtractExtraProperties(data, *u)
	if err != nil {
		return err
	}
	u.extraProperties = extraProperties
	u.rawJSON = json.RawMessage(data)
	return nil
}

func (u *UserNodeResponse) String() string {
	if len(u.rawJSON) > 0 {
		if value, err := internal.StringifyJSON(u.rawJSON); err == nil {
			return value
		}
	}
	if value, err := internal.StringifyJSON(u); err == nil {
		return value
	}
	return fmt.Sprintf("%#v", u)
}

type UpdateUserRequest struct {
	// When true, disables the use of default/fallback ontology for the user's graph.
	DisableDefaultOntology *bool `json:"disable_default_ontology,omitempty" url:"-"`
	// The email address of the user.
	Email *string `json:"email,omitempty" url:"-"`
	// The first name of the user.
	FirstName *string `json:"first_name,omitempty" url:"-"`
	// The last name of the user.
	LastName *string `json:"last_name,omitempty" url:"-"`
	// The metadata to update
	Metadata map[string]interface{} `json:"metadata,omitempty" url:"-"`
	// The user's IANA time zone. Null clears the existing value.
	TimeZone *string `json:"time_zone,omitempty" url:"-"`
}