openai

package
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 11, 2024 License: MPL-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package openai is a generated GoMock package.

Package openai is a generated GoMock package.

Package openai is a generated GoMock package.

Package openai is a generated GoMock package.

Package openai is a generated GoMock package.

Package openai is a generated GoMock package.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func IsNotFoundError added in v1.0.0

func IsNotFoundError(err error) bool

Types

type Client

type Client struct {
	Invites                InviteService
	ProjectAPIKeys         ProjectAPIKeyService
	Projects               ProjectService
	ProjectServiceAccounts ProjectServiceAccountService
	ProjectUsers           ProjectUserService
	Users                  UserService
}

func NewSDKClient added in v1.0.0

func NewSDKClient(apiKey string, baseURL *string) Client

type Invite

type Invite struct {
	ID         string               `json:"id"`
	Email      string               `json:"email"`
	Status     InviteStatus         `json:"status"`
	Role       InviteRole           `json:"role"`
	InvitedAt  utils.UnixTimestamp  `json:"invited_at"`
	ExpiresAt  utils.UnixTimestamp  `json:"expires_at,omitempty"`
	AcceptedAt *utils.UnixTimestamp `json:"accepted_at,omitempty"`
}

type InviteCreateBody

type InviteCreateBody struct {
	Email string     `json:"email"`
	Role  InviteRole `json:"role"`
}

type InviteListParams

type InviteListParams struct {
	After *string
	Limit *int
}

func (InviteListParams) URLQuery

func (p InviteListParams) URLQuery() url.Values

type InviteListResponse

type InviteListResponse struct {
	Data    []Invite `json:"data"`
	HasMore bool     `json:"has_more"`
	LastID  string   `json:"last_id"`
}

type InviteRole

type InviteRole string

InviteRole represents the possible roles of an invite.

const (
	InviteRoleReader InviteRole = "reader"
	InviteRoleOwner  InviteRole = "owner"
)

type InviteService

type InviteService interface {
	List(ctx context.Context) ([]Invite, error)
	Create(ctx context.Context, email string, role InviteRole) (*Invite, error)
	Retrieve(ctx context.Context, inviteID string) (*Invite, error)
	Delete(ctx context.Context, inviteID string) error
}

func NewSDKInviteService added in v1.0.0

func NewSDKInviteService(client *openai.Client) InviteService

type InviteStatus

type InviteStatus string

InviteStatus represents the possible statuses of an invite.

const (
	InviteStatusPending  InviteStatus = "pending"
	InviteStatusAccepted InviteStatus = "accepted"
	InviteStatusExpired  InviteStatus = "expired"
)

type MockInviteService added in v1.0.0

type MockInviteService struct {
	// contains filtered or unexported fields
}

MockInviteService is a mock of InviteService interface.

func NewMockInviteService added in v1.0.0

func NewMockInviteService(ctrl *gomock.Controller) *MockInviteService

NewMockInviteService creates a new mock instance.

func (*MockInviteService) Create added in v1.0.0

func (m *MockInviteService) Create(ctx context.Context, email string, role InviteRole) (*Invite, error)

Create mocks base method.

func (*MockInviteService) Delete added in v1.0.0

func (m *MockInviteService) Delete(ctx context.Context, inviteID string) error

Delete mocks base method.

func (*MockInviteService) EXPECT added in v1.0.0

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockInviteService) List added in v1.0.0

func (m *MockInviteService) List(ctx context.Context) ([]Invite, error)

List mocks base method.

func (*MockInviteService) Retrieve added in v1.0.0

func (m *MockInviteService) Retrieve(ctx context.Context, inviteID string) (*Invite, error)

Retrieve mocks base method.

type MockInviteServiceCreateCall added in v1.0.0

type MockInviteServiceCreateCall struct {
	*gomock.Call
}

MockInviteServiceCreateCall wrap *gomock.Call

func (*MockInviteServiceCreateCall) Do added in v1.0.0

Do rewrite *gomock.Call.Do

func (*MockInviteServiceCreateCall) DoAndReturn added in v1.0.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockInviteServiceCreateCall) Return added in v1.0.0

Return rewrite *gomock.Call.Return

type MockInviteServiceDeleteCall added in v1.0.0

type MockInviteServiceDeleteCall struct {
	*gomock.Call
}

MockInviteServiceDeleteCall wrap *gomock.Call

func (*MockInviteServiceDeleteCall) Do added in v1.0.0

Do rewrite *gomock.Call.Do

func (*MockInviteServiceDeleteCall) DoAndReturn added in v1.0.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockInviteServiceDeleteCall) Return added in v1.0.0

Return rewrite *gomock.Call.Return

type MockInviteServiceListCall added in v1.0.0

type MockInviteServiceListCall struct {
	*gomock.Call
}

MockInviteServiceListCall wrap *gomock.Call

func (*MockInviteServiceListCall) Do added in v1.0.0

Do rewrite *gomock.Call.Do

func (*MockInviteServiceListCall) DoAndReturn added in v1.0.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockInviteServiceListCall) Return added in v1.0.0

Return rewrite *gomock.Call.Return

type MockInviteServiceMockRecorder added in v1.0.0

type MockInviteServiceMockRecorder struct {
	// contains filtered or unexported fields
}

MockInviteServiceMockRecorder is the mock recorder for MockInviteService.

func (*MockInviteServiceMockRecorder) Create added in v1.0.0

func (mr *MockInviteServiceMockRecorder) Create(ctx, email, role any) *MockInviteServiceCreateCall

Create indicates an expected call of Create.

func (*MockInviteServiceMockRecorder) Delete added in v1.0.0

Delete indicates an expected call of Delete.

func (*MockInviteServiceMockRecorder) List added in v1.0.0

List indicates an expected call of List.

func (*MockInviteServiceMockRecorder) Retrieve added in v1.0.0

Retrieve indicates an expected call of Retrieve.

type MockInviteServiceRetrieveCall added in v1.0.0

type MockInviteServiceRetrieveCall struct {
	*gomock.Call
}

MockInviteServiceRetrieveCall wrap *gomock.Call

func (*MockInviteServiceRetrieveCall) Do added in v1.0.0

Do rewrite *gomock.Call.Do

func (*MockInviteServiceRetrieveCall) DoAndReturn added in v1.0.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockInviteServiceRetrieveCall) Return added in v1.0.0

Return rewrite *gomock.Call.Return

type MockProjectAPIKeyService added in v1.0.0

type MockProjectAPIKeyService struct {
	// contains filtered or unexported fields
}

MockProjectAPIKeyService is a mock of ProjectAPIKeyService interface.

func NewMockProjectAPIKeyService added in v1.0.0

func NewMockProjectAPIKeyService(ctrl *gomock.Controller) *MockProjectAPIKeyService

NewMockProjectAPIKeyService creates a new mock instance.

func (*MockProjectAPIKeyService) Delete added in v1.0.0

func (m *MockProjectAPIKeyService) Delete(ctx context.Context, projectID, apiKeyID string) error

Delete mocks base method.

func (*MockProjectAPIKeyService) EXPECT added in v1.0.0

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockProjectAPIKeyService) List added in v1.0.0

func (m *MockProjectAPIKeyService) List(ctx context.Context, projectID string) ([]ProjectAPIKey, error)

List mocks base method.

func (*MockProjectAPIKeyService) Retrieve added in v1.0.0

func (m *MockProjectAPIKeyService) Retrieve(ctx context.Context, projectID, apiKeyID string) (*ProjectAPIKey, error)

Retrieve mocks base method.

type MockProjectAPIKeyServiceDeleteCall added in v1.0.0

type MockProjectAPIKeyServiceDeleteCall struct {
	*gomock.Call
}

MockProjectAPIKeyServiceDeleteCall wrap *gomock.Call

func (*MockProjectAPIKeyServiceDeleteCall) Do added in v1.0.0

Do rewrite *gomock.Call.Do

func (*MockProjectAPIKeyServiceDeleteCall) DoAndReturn added in v1.0.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockProjectAPIKeyServiceDeleteCall) Return added in v1.0.0

Return rewrite *gomock.Call.Return

type MockProjectAPIKeyServiceListCall added in v1.0.0

type MockProjectAPIKeyServiceListCall struct {
	*gomock.Call
}

MockProjectAPIKeyServiceListCall wrap *gomock.Call

func (*MockProjectAPIKeyServiceListCall) Do added in v1.0.0

Do rewrite *gomock.Call.Do

func (*MockProjectAPIKeyServiceListCall) DoAndReturn added in v1.0.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockProjectAPIKeyServiceListCall) Return added in v1.0.0

Return rewrite *gomock.Call.Return

type MockProjectAPIKeyServiceMockRecorder added in v1.0.0

type MockProjectAPIKeyServiceMockRecorder struct {
	// contains filtered or unexported fields
}

MockProjectAPIKeyServiceMockRecorder is the mock recorder for MockProjectAPIKeyService.

func (*MockProjectAPIKeyServiceMockRecorder) Delete added in v1.0.0

func (mr *MockProjectAPIKeyServiceMockRecorder) Delete(ctx, projectID, apiKeyID any) *MockProjectAPIKeyServiceDeleteCall

Delete indicates an expected call of Delete.

func (*MockProjectAPIKeyServiceMockRecorder) List added in v1.0.0

List indicates an expected call of List.

func (*MockProjectAPIKeyServiceMockRecorder) Retrieve added in v1.0.0

func (mr *MockProjectAPIKeyServiceMockRecorder) Retrieve(ctx, projectID, apiKeyID any) *MockProjectAPIKeyServiceRetrieveCall

Retrieve indicates an expected call of Retrieve.

type MockProjectAPIKeyServiceRetrieveCall added in v1.0.0

type MockProjectAPIKeyServiceRetrieveCall struct {
	*gomock.Call
}

MockProjectAPIKeyServiceRetrieveCall wrap *gomock.Call

func (*MockProjectAPIKeyServiceRetrieveCall) Do added in v1.0.0

Do rewrite *gomock.Call.Do

func (*MockProjectAPIKeyServiceRetrieveCall) DoAndReturn added in v1.0.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockProjectAPIKeyServiceRetrieveCall) Return added in v1.0.0

Return rewrite *gomock.Call.Return

type MockProjectService added in v1.0.0

type MockProjectService struct {
	// contains filtered or unexported fields
}

MockProjectService is a mock of ProjectService interface.

func NewMockProjectService added in v1.0.0

func NewMockProjectService(ctrl *gomock.Controller) *MockProjectService

NewMockProjectService creates a new mock instance.

func (*MockProjectService) Archive added in v1.0.0

func (m *MockProjectService) Archive(ctx context.Context, projectID string) error

Archive mocks base method.

func (*MockProjectService) Create added in v1.0.0

func (m *MockProjectService) Create(ctx context.Context, name string) (*Project, error)

Create mocks base method.

func (*MockProjectService) EXPECT added in v1.0.0

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockProjectService) List added in v1.0.0

func (m *MockProjectService) List(ctx context.Context) ([]Project, error)

List mocks base method.

func (*MockProjectService) Modify added in v1.0.0

func (m *MockProjectService) Modify(ctx context.Context, projectID, name string) (*Project, error)

Modify mocks base method.

func (*MockProjectService) Retrieve added in v1.0.0

func (m *MockProjectService) Retrieve(ctx context.Context, projectID string) (*Project, error)

Retrieve mocks base method.

type MockProjectServiceAccountService added in v1.0.0

type MockProjectServiceAccountService struct {
	// contains filtered or unexported fields
}

MockProjectServiceAccountService is a mock of ProjectServiceAccountService interface.

func NewMockProjectServiceAccountService added in v1.0.0

func NewMockProjectServiceAccountService(ctrl *gomock.Controller) *MockProjectServiceAccountService

NewMockProjectServiceAccountService creates a new mock instance.

func (*MockProjectServiceAccountService) Create added in v1.0.0

Create mocks base method.

func (*MockProjectServiceAccountService) Delete added in v1.0.0

func (m *MockProjectServiceAccountService) Delete(ctx context.Context, projectID, serviceAccountID string) error

Delete mocks base method.

func (*MockProjectServiceAccountService) EXPECT added in v1.0.0

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockProjectServiceAccountService) List added in v1.0.0

List mocks base method.

func (*MockProjectServiceAccountService) Retrieve added in v1.0.0

func (m *MockProjectServiceAccountService) Retrieve(ctx context.Context, projectID, serviceAccountID string) (*ProjectServiceAccount, error)

Retrieve mocks base method.

type MockProjectServiceAccountServiceCreateCall added in v1.0.0

type MockProjectServiceAccountServiceCreateCall struct {
	*gomock.Call
}

MockProjectServiceAccountServiceCreateCall wrap *gomock.Call

func (*MockProjectServiceAccountServiceCreateCall) Do added in v1.0.0

Do rewrite *gomock.Call.Do

func (*MockProjectServiceAccountServiceCreateCall) DoAndReturn added in v1.0.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockProjectServiceAccountServiceCreateCall) Return added in v1.0.0

Return rewrite *gomock.Call.Return

type MockProjectServiceAccountServiceDeleteCall added in v1.0.0

type MockProjectServiceAccountServiceDeleteCall struct {
	*gomock.Call
}

MockProjectServiceAccountServiceDeleteCall wrap *gomock.Call

func (*MockProjectServiceAccountServiceDeleteCall) Do added in v1.0.0

Do rewrite *gomock.Call.Do

func (*MockProjectServiceAccountServiceDeleteCall) DoAndReturn added in v1.0.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockProjectServiceAccountServiceDeleteCall) Return added in v1.0.0

Return rewrite *gomock.Call.Return

type MockProjectServiceAccountServiceListCall added in v1.0.0

type MockProjectServiceAccountServiceListCall struct {
	*gomock.Call
}

MockProjectServiceAccountServiceListCall wrap *gomock.Call

func (*MockProjectServiceAccountServiceListCall) Do added in v1.0.0

Do rewrite *gomock.Call.Do

func (*MockProjectServiceAccountServiceListCall) DoAndReturn added in v1.0.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockProjectServiceAccountServiceListCall) Return added in v1.0.0

Return rewrite *gomock.Call.Return

type MockProjectServiceAccountServiceMockRecorder added in v1.0.0

type MockProjectServiceAccountServiceMockRecorder struct {
	// contains filtered or unexported fields
}

MockProjectServiceAccountServiceMockRecorder is the mock recorder for MockProjectServiceAccountService.

func (*MockProjectServiceAccountServiceMockRecorder) Create added in v1.0.0

Create indicates an expected call of Create.

func (*MockProjectServiceAccountServiceMockRecorder) Delete added in v1.0.0

Delete indicates an expected call of Delete.

func (*MockProjectServiceAccountServiceMockRecorder) List added in v1.0.0

List indicates an expected call of List.

func (*MockProjectServiceAccountServiceMockRecorder) Retrieve added in v1.0.0

Retrieve indicates an expected call of Retrieve.

type MockProjectServiceAccountServiceRetrieveCall added in v1.0.0

type MockProjectServiceAccountServiceRetrieveCall struct {
	*gomock.Call
}

MockProjectServiceAccountServiceRetrieveCall wrap *gomock.Call

func (*MockProjectServiceAccountServiceRetrieveCall) Do added in v1.0.0

Do rewrite *gomock.Call.Do

func (*MockProjectServiceAccountServiceRetrieveCall) DoAndReturn added in v1.0.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockProjectServiceAccountServiceRetrieveCall) Return added in v1.0.0

Return rewrite *gomock.Call.Return

type MockProjectServiceArchiveCall added in v1.0.0

type MockProjectServiceArchiveCall struct {
	*gomock.Call
}

MockProjectServiceArchiveCall wrap *gomock.Call

func (*MockProjectServiceArchiveCall) Do added in v1.0.0

Do rewrite *gomock.Call.Do

func (*MockProjectServiceArchiveCall) DoAndReturn added in v1.0.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockProjectServiceArchiveCall) Return added in v1.0.0

Return rewrite *gomock.Call.Return

type MockProjectServiceCreateCall added in v1.0.0

type MockProjectServiceCreateCall struct {
	*gomock.Call
}

MockProjectServiceCreateCall wrap *gomock.Call

func (*MockProjectServiceCreateCall) Do added in v1.0.0

Do rewrite *gomock.Call.Do

func (*MockProjectServiceCreateCall) DoAndReturn added in v1.0.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockProjectServiceCreateCall) Return added in v1.0.0

Return rewrite *gomock.Call.Return

type MockProjectServiceListCall added in v1.0.0

type MockProjectServiceListCall struct {
	*gomock.Call
}

MockProjectServiceListCall wrap *gomock.Call

func (*MockProjectServiceListCall) Do added in v1.0.0

Do rewrite *gomock.Call.Do

func (*MockProjectServiceListCall) DoAndReturn added in v1.0.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockProjectServiceListCall) Return added in v1.0.0

Return rewrite *gomock.Call.Return

type MockProjectServiceMockRecorder added in v1.0.0

type MockProjectServiceMockRecorder struct {
	// contains filtered or unexported fields
}

MockProjectServiceMockRecorder is the mock recorder for MockProjectService.

func (*MockProjectServiceMockRecorder) Archive added in v1.0.0

Archive indicates an expected call of Archive.

func (*MockProjectServiceMockRecorder) Create added in v1.0.0

Create indicates an expected call of Create.

func (*MockProjectServiceMockRecorder) List added in v1.0.0

List indicates an expected call of List.

func (*MockProjectServiceMockRecorder) Modify added in v1.0.0

func (mr *MockProjectServiceMockRecorder) Modify(ctx, projectID, name any) *MockProjectServiceModifyCall

Modify indicates an expected call of Modify.

func (*MockProjectServiceMockRecorder) Retrieve added in v1.0.0

Retrieve indicates an expected call of Retrieve.

type MockProjectServiceModifyCall added in v1.0.0

type MockProjectServiceModifyCall struct {
	*gomock.Call
}

MockProjectServiceModifyCall wrap *gomock.Call

func (*MockProjectServiceModifyCall) Do added in v1.0.0

Do rewrite *gomock.Call.Do

func (*MockProjectServiceModifyCall) DoAndReturn added in v1.0.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockProjectServiceModifyCall) Return added in v1.0.0

Return rewrite *gomock.Call.Return

type MockProjectServiceRetrieveCall added in v1.0.0

type MockProjectServiceRetrieveCall struct {
	*gomock.Call
}

MockProjectServiceRetrieveCall wrap *gomock.Call

func (*MockProjectServiceRetrieveCall) Do added in v1.0.0

Do rewrite *gomock.Call.Do

func (*MockProjectServiceRetrieveCall) DoAndReturn added in v1.0.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockProjectServiceRetrieveCall) Return added in v1.0.0

Return rewrite *gomock.Call.Return

type MockProjectUserService added in v1.0.0

type MockProjectUserService struct {
	// contains filtered or unexported fields
}

MockProjectUserService is a mock of ProjectUserService interface.

func NewMockProjectUserService added in v1.0.0

func NewMockProjectUserService(ctrl *gomock.Controller) *MockProjectUserService

NewMockProjectUserService creates a new mock instance.

func (*MockProjectUserService) Create added in v1.0.0

func (m *MockProjectUserService) Create(ctx context.Context, projectID, userID string, role ProjectUserRole) (*ProjectUser, error)

Create mocks base method.

func (*MockProjectUserService) Delete added in v1.0.0

func (m *MockProjectUserService) Delete(ctx context.Context, projectID, userID string) error

Delete mocks base method.

func (*MockProjectUserService) EXPECT added in v1.0.0

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockProjectUserService) List added in v1.0.0

func (m *MockProjectUserService) List(ctx context.Context, projectID string) ([]ProjectUser, error)

List mocks base method.

func (*MockProjectUserService) Modify added in v1.0.0

func (m *MockProjectUserService) Modify(ctx context.Context, projectID, userID string, role ProjectUserRole) (*ProjectUser, error)

Modify mocks base method.

func (*MockProjectUserService) Retrieve added in v1.0.0

func (m *MockProjectUserService) Retrieve(ctx context.Context, projectID, userID string) (*ProjectUser, error)

Retrieve mocks base method.

type MockProjectUserServiceCreateCall added in v1.0.0

type MockProjectUserServiceCreateCall struct {
	*gomock.Call
}

MockProjectUserServiceCreateCall wrap *gomock.Call

func (*MockProjectUserServiceCreateCall) Do added in v1.0.0

Do rewrite *gomock.Call.Do

func (*MockProjectUserServiceCreateCall) DoAndReturn added in v1.0.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockProjectUserServiceCreateCall) Return added in v1.0.0

Return rewrite *gomock.Call.Return

type MockProjectUserServiceDeleteCall added in v1.0.0

type MockProjectUserServiceDeleteCall struct {
	*gomock.Call
}

MockProjectUserServiceDeleteCall wrap *gomock.Call

func (*MockProjectUserServiceDeleteCall) Do added in v1.0.0

Do rewrite *gomock.Call.Do

func (*MockProjectUserServiceDeleteCall) DoAndReturn added in v1.0.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockProjectUserServiceDeleteCall) Return added in v1.0.0

Return rewrite *gomock.Call.Return

type MockProjectUserServiceListCall added in v1.0.0

type MockProjectUserServiceListCall struct {
	*gomock.Call
}

MockProjectUserServiceListCall wrap *gomock.Call

func (*MockProjectUserServiceListCall) Do added in v1.0.0

Do rewrite *gomock.Call.Do

func (*MockProjectUserServiceListCall) DoAndReturn added in v1.0.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockProjectUserServiceListCall) Return added in v1.0.0

Return rewrite *gomock.Call.Return

type MockProjectUserServiceMockRecorder added in v1.0.0

type MockProjectUserServiceMockRecorder struct {
	// contains filtered or unexported fields
}

MockProjectUserServiceMockRecorder is the mock recorder for MockProjectUserService.

func (*MockProjectUserServiceMockRecorder) Create added in v1.0.0

func (mr *MockProjectUserServiceMockRecorder) Create(ctx, projectID, userID, role any) *MockProjectUserServiceCreateCall

Create indicates an expected call of Create.

func (*MockProjectUserServiceMockRecorder) Delete added in v1.0.0

func (mr *MockProjectUserServiceMockRecorder) Delete(ctx, projectID, userID any) *MockProjectUserServiceDeleteCall

Delete indicates an expected call of Delete.

func (*MockProjectUserServiceMockRecorder) List added in v1.0.0

List indicates an expected call of List.

func (*MockProjectUserServiceMockRecorder) Modify added in v1.0.0

func (mr *MockProjectUserServiceMockRecorder) Modify(ctx, projectID, userID, role any) *MockProjectUserServiceModifyCall

Modify indicates an expected call of Modify.

func (*MockProjectUserServiceMockRecorder) Retrieve added in v1.0.0

func (mr *MockProjectUserServiceMockRecorder) Retrieve(ctx, projectID, userID any) *MockProjectUserServiceRetrieveCall

Retrieve indicates an expected call of Retrieve.

type MockProjectUserServiceModifyCall added in v1.0.0

type MockProjectUserServiceModifyCall struct {
	*gomock.Call
}

MockProjectUserServiceModifyCall wrap *gomock.Call

func (*MockProjectUserServiceModifyCall) Do added in v1.0.0

Do rewrite *gomock.Call.Do

func (*MockProjectUserServiceModifyCall) DoAndReturn added in v1.0.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockProjectUserServiceModifyCall) Return added in v1.0.0

Return rewrite *gomock.Call.Return

type MockProjectUserServiceRetrieveCall added in v1.0.0

type MockProjectUserServiceRetrieveCall struct {
	*gomock.Call
}

MockProjectUserServiceRetrieveCall wrap *gomock.Call

func (*MockProjectUserServiceRetrieveCall) Do added in v1.0.0

Do rewrite *gomock.Call.Do

func (*MockProjectUserServiceRetrieveCall) DoAndReturn added in v1.0.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockProjectUserServiceRetrieveCall) Return added in v1.0.0

Return rewrite *gomock.Call.Return

type MockUserService added in v1.0.0

type MockUserService struct {
	// contains filtered or unexported fields
}

MockUserService is a mock of UserService interface.

func NewMockUserService added in v1.0.0

func NewMockUserService(ctrl *gomock.Controller) *MockUserService

NewMockUserService creates a new mock instance.

func (*MockUserService) Delete added in v1.0.0

func (m *MockUserService) Delete(ctx context.Context, userID string) error

Delete mocks base method.

func (*MockUserService) EXPECT added in v1.0.0

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockUserService) List added in v1.0.0

func (m *MockUserService) List(ctx context.Context) ([]User, error)

List mocks base method.

func (*MockUserService) Modify added in v1.0.0

func (m *MockUserService) Modify(ctx context.Context, userID string, role UserRole) (*User, error)

Modify mocks base method.

func (*MockUserService) Retrieve added in v1.0.0

func (m *MockUserService) Retrieve(ctx context.Context, userID string) (*User, error)

Retrieve mocks base method.

type MockUserServiceDeleteCall added in v1.0.0

type MockUserServiceDeleteCall struct {
	*gomock.Call
}

MockUserServiceDeleteCall wrap *gomock.Call

func (*MockUserServiceDeleteCall) Do added in v1.0.0

Do rewrite *gomock.Call.Do

func (*MockUserServiceDeleteCall) DoAndReturn added in v1.0.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockUserServiceDeleteCall) Return added in v1.0.0

Return rewrite *gomock.Call.Return

type MockUserServiceListCall added in v1.0.0

type MockUserServiceListCall struct {
	*gomock.Call
}

MockUserServiceListCall wrap *gomock.Call

func (*MockUserServiceListCall) Do added in v1.0.0

Do rewrite *gomock.Call.Do

func (*MockUserServiceListCall) DoAndReturn added in v1.0.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockUserServiceListCall) Return added in v1.0.0

func (c *MockUserServiceListCall) Return(arg0 []User, arg1 error) *MockUserServiceListCall

Return rewrite *gomock.Call.Return

type MockUserServiceMockRecorder added in v1.0.0

type MockUserServiceMockRecorder struct {
	// contains filtered or unexported fields
}

MockUserServiceMockRecorder is the mock recorder for MockUserService.

func (*MockUserServiceMockRecorder) Delete added in v1.0.0

Delete indicates an expected call of Delete.

func (*MockUserServiceMockRecorder) List added in v1.0.0

List indicates an expected call of List.

func (*MockUserServiceMockRecorder) Modify added in v1.0.0

func (mr *MockUserServiceMockRecorder) Modify(ctx, userID, role any) *MockUserServiceModifyCall

Modify indicates an expected call of Modify.

func (*MockUserServiceMockRecorder) Retrieve added in v1.0.0

func (mr *MockUserServiceMockRecorder) Retrieve(ctx, userID any) *MockUserServiceRetrieveCall

Retrieve indicates an expected call of Retrieve.

type MockUserServiceModifyCall added in v1.0.0

type MockUserServiceModifyCall struct {
	*gomock.Call
}

MockUserServiceModifyCall wrap *gomock.Call

func (*MockUserServiceModifyCall) Do added in v1.0.0

Do rewrite *gomock.Call.Do

func (*MockUserServiceModifyCall) DoAndReturn added in v1.0.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockUserServiceModifyCall) Return added in v1.0.0

Return rewrite *gomock.Call.Return

type MockUserServiceRetrieveCall added in v1.0.0

type MockUserServiceRetrieveCall struct {
	*gomock.Call
}

MockUserServiceRetrieveCall wrap *gomock.Call

func (*MockUserServiceRetrieveCall) Do added in v1.0.0

Do rewrite *gomock.Call.Do

func (*MockUserServiceRetrieveCall) DoAndReturn added in v1.0.0

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockUserServiceRetrieveCall) Return added in v1.0.0

Return rewrite *gomock.Call.Return

type Project added in v1.0.0

type Project struct {
	ID        string               `json:"id"`
	Name      string               `json:"name"`
	CreatedAt utils.UnixTimestamp  `json:"created_at"`
	ArchiveAt *utils.UnixTimestamp `json:"archive_at,omitempty"`
	Status    ProjectStatus        `json:"status"`
}

Project represents a project in the OpenAI system.

type ProjectAPIKey

type ProjectAPIKey struct {
	ID            string              `json:"id"`
	Name          *string             `json:"name"`
	RedactedValue string              `json:"redacted_value"`
	CreatedAt     utils.UnixTimestamp `json:"created_at"`
	Owner         ProjectAPIKeyOwner  `json:"owner"`
}

type ProjectAPIKeyListParams

type ProjectAPIKeyListParams struct {
	After *string
	Limit *int
}

func (ProjectAPIKeyListParams) URLQuery

func (p ProjectAPIKeyListParams) URLQuery() url.Values

type ProjectAPIKeyListResponse

type ProjectAPIKeyListResponse struct {
	Data    []ProjectAPIKey `json:"data"`
	HasMore bool            `json:"has_more"`
	LastID  string          `json:"last_id"`
}

type ProjectAPIKeyOwner

type ProjectAPIKeyOwner struct {
	Type           string `json:"type"`
	ServiceAccount *struct {
		ID        string                    `json:"id"`
		Name      string                    `json:"name"`
		CreatedAt utils.UnixTimestamp       `json:"created_at"`
		Role      ProjectServiceAccountRole `json:"role"`
	} `json:"service_account,omitempty"`
	User *struct {
		ID        string              `json:"id"`
		Name      *string             `json:"name"`
		Email     string              `json:"email"`
		CreatedAt utils.UnixTimestamp `json:"created_at"`
		Role      UserRole            `json:"role"`
	} `json:"user,omitempty"`
}

type ProjectAPIKeyService

type ProjectAPIKeyService interface {
	List(ctx context.Context, projectID string) ([]ProjectAPIKey, error)
	Retrieve(ctx context.Context, projectID, apiKeyID string) (*ProjectAPIKey, error)
	Delete(ctx context.Context, projectID, apiKeyID string) error
}

func NewSDKProjectAPIKeyService added in v1.0.0

func NewSDKProjectAPIKeyService(client *openai.Client) ProjectAPIKeyService

type ProjectCreateParams added in v1.0.0

type ProjectCreateParams struct {
	Name string `json:"name"`
}

ProjectCreateParams represents the parameters for creating a project.

type ProjectListParams added in v1.0.0

type ProjectListParams struct {
	Limit *int
	After *string
}

ProjectListParams represents the query parameters for listing projects.

func (ProjectListParams) URLQuery added in v1.0.0

func (p ProjectListParams) URLQuery() url.Values

type ProjectModifyParams added in v1.0.0

type ProjectModifyParams struct {
	Name string `json:"name"`
}

ProjectModifyParams represents the parameters for modifying a project.

type ProjectService added in v1.0.0

type ProjectService interface {
	List(ctx context.Context) ([]Project, error)
	Create(ctx context.Context, name string) (*Project, error)
	Retrieve(ctx context.Context, projectID string) (*Project, error)
	Modify(ctx context.Context, projectID, name string) (*Project, error)
	Archive(ctx context.Context, projectID string) error
}

func NewSDKProjectService added in v1.0.0

func NewSDKProjectService(client *openai.Client) ProjectService

type ProjectServiceAccount

type ProjectServiceAccount struct {
	ID        string                    `json:"id"`
	Name      string                    `json:"name"`
	ProjectID string                    `json:"project_id"`
	CreatedAt utils.UnixTimestamp       `json:"created_at"`
	Role      ProjectServiceAccountRole `json:"role"`
}

type ProjectServiceAccountCreateBody

type ProjectServiceAccountCreateBody struct {
	Name string `json:"name"`
}

type ProjectServiceAccountListParams

type ProjectServiceAccountListParams struct {
	After *string
	Limit *int
}

func (ProjectServiceAccountListParams) URLQuery

type ProjectServiceAccountListResponse

type ProjectServiceAccountListResponse struct {
	Data    []ProjectServiceAccount `json:"data"`
	HasMore bool                    `json:"has_more"`
	LastID  string                  `json:"last_id"`
}

type ProjectServiceAccountRole

type ProjectServiceAccountRole string

ProjectServiceAccountRole represents the possible roles of a project service account.

const (
	ProjectServiceAccountRoleMember ProjectServiceAccountRole = "member"
	ProjectServiceAccountRoleOwner  ProjectServiceAccountRole = "owner"
	ProjectServiceAccountRoleAdmin  ProjectServiceAccountRole = "admin"
)

type ProjectServiceAccountService

type ProjectServiceAccountService interface {
	List(ctx context.Context, projectID string) ([]ProjectServiceAccount, error)
	Create(ctx context.Context, projectID, name string) (*ProjectServiceAccountWithAPIKey, error)
	Retrieve(ctx context.Context, projectID, serviceAccountID string) (*ProjectServiceAccount, error)
	Delete(ctx context.Context, projectID, serviceAccountID string) error
}

func NewSDKProjectServiceAccountService added in v1.0.0

func NewSDKProjectServiceAccountService(client *openai.Client) ProjectServiceAccountService

type ProjectServiceAccountWithAPIKey

type ProjectServiceAccountWithAPIKey struct {
	ProjectServiceAccount
	APIKey ServiceAccountAPIKey `json:"api_key"`
}

type ProjectStatus added in v1.0.0

type ProjectStatus string
const (
	ProjectStatusActive   ProjectStatus = "active"
	ProjectStatusArchived ProjectStatus = "archived"
)

type ProjectUser

type ProjectUser struct {
	ID      string              `json:"id"`
	Name    string              `json:"name"`
	Email   string              `json:"email"`
	Role    ProjectUserRole     `json:"role"`
	AddedAt utils.UnixTimestamp `json:"added_at"`
}

type ProjectUserCreateBody

type ProjectUserCreateBody struct {
	UserID string          `json:"user_id"`
	Role   ProjectUserRole `json:"role"`
}

type ProjectUserListParams

type ProjectUserListParams struct {
	After *string
	Limit *int
}

func (ProjectUserListParams) URLQuery

func (p ProjectUserListParams) URLQuery() url.Values

type ProjectUserListResponse

type ProjectUserListResponse struct {
	Data    []ProjectUser `json:"data"`
	FirstID string        `json:"first_id"`
	LastID  string        `json:"last_id"`
	HasMore bool          `json:"has_more"`
}

type ProjectUserModifyBody

type ProjectUserModifyBody struct {
	Role ProjectUserRole `json:"role"`
}

type ProjectUserRole

type ProjectUserRole string
const (
	ProjectUserRoleMember ProjectUserRole = "member"
	ProjectUserRoleOwner  ProjectUserRole = "owner"
)

type ProjectUserService

type ProjectUserService interface {
	List(ctx context.Context, projectID string) ([]ProjectUser, error)
	Create(ctx context.Context, projectID, userID string, role ProjectUserRole) (*ProjectUser, error)
	Retrieve(ctx context.Context, projectID, userID string) (*ProjectUser, error)
	Modify(ctx context.Context, projectID, userID string, role ProjectUserRole) (*ProjectUser, error)
	Delete(ctx context.Context, projectID, userID string) error
}

func NewSDKProjectUserService added in v1.0.0

func NewSDKProjectUserService(client *openai.Client) ProjectUserService

type SDKProjectService added in v1.0.0

type SDKProjectService struct {
	// contains filtered or unexported fields
}

SDKProjectService handles operations related to projects in the OpenAI admin API.

func (SDKProjectService) Archive added in v1.0.0

func (s SDKProjectService) Archive(ctx context.Context, projectID string) error

Archive archives a project by its ID.

func (SDKProjectService) Create added in v1.0.0

func (s SDKProjectService) Create(ctx context.Context, name string) (*Project, error)

Create creates a new project with the given parameters.

func (SDKProjectService) List added in v1.0.0

func (s SDKProjectService) List(ctx context.Context) ([]Project, error)

List retrieves a list of projects.

func (SDKProjectService) Modify added in v1.0.0

func (s SDKProjectService) Modify(ctx context.Context, projectID, name string) (*Project, error)

Modify updates a project's details with the given parameters.

func (SDKProjectService) Retrieve added in v1.0.0

func (s SDKProjectService) Retrieve(ctx context.Context, projectID string) (*Project, error)

Retrieve fetches a project by its ID.

type ServiceAccountAPIKey

type ServiceAccountAPIKey struct {
	Value     string              `json:"value"`
	Name      *string             `json:"name"`
	CreatedAt utils.UnixTimestamp `json:"created_at"`
	ID        string              `json:"id"`
}

type User

type User struct {
	ID       string              `json:"id"`
	Email    string              `json:"email"`
	Role     UserRole            `json:"role"`
	AddedAt  utils.UnixTimestamp `json:"added_at"`
	Disabled bool                `json:"disabled"`
}

User represents a user in the OpenAI system.

type UserListParams

type UserListParams struct {
	After *string
	Limit *int
}

func (UserListParams) URLQuery

func (p UserListParams) URLQuery() url.Values

type UserListResponse

type UserListResponse struct {
	Data    []User `json:"data"`
	HasMore bool   `json:"has_more"`
	LastID  string `json:"last_id"`
}

type UserModifyBody

type UserModifyBody struct {
	Role UserRole `json:"role,omitempty"`
}

type UserRole

type UserRole string

UserRole represents the possible roles of a user.

const (
	UserRoleReader UserRole = "reader"
	UserRoleOwner  UserRole = "owner"
)

type UserService

type UserService interface {
	List(ctx context.Context) ([]User, error)
	Modify(ctx context.Context, userID string, role UserRole) (*User, error)
	Retrieve(ctx context.Context, userID string) (*User, error)
	Delete(ctx context.Context, userID string) error
}

func NewSDKUserService added in v1.0.0

func NewSDKUserService(client *openai.Client) UserService

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL