client

package

v0.9.8 Latest Latest Go to latest Published: May 18, 2025 License: GPL-3.0 Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ystv/web-api

Links

Open Source Insights

Documentation ¶

Index ¶

type Client
- func NewClient(baseURL string) (*Client, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client struct {
	BaseURL    string
	HTTPClient *http.Client
}

func NewClient ¶

func NewClient(baseURL string) (*Client, error)

func (*Client) AddPermission ¶

func (c *Client) AddPermission(ctx context.Context, apiKey string, options people.PermissionAddEditDTO) (people.Permission, error)

func (*Client) AddRole ¶

func (c *Client) AddRole(ctx context.Context, apiKey string, options people.RoleAddEditDTO) (people.Role, error)

func (*Client) AddStreamEndpoint ¶

func (c *Client) AddStreamEndpoint(ctx context.Context, apiKey string, options stream.EndpointAddEditDTO) (stream.Endpoint, error)

func (*Client) DeletePermission ¶

func (c *Client) DeletePermission(ctx context.Context, apiKey string, permissionID int) error

func (*Client) DeleteRole ¶

func (c *Client) DeleteRole(ctx context.Context, apiKey string, roleID int) error

func (*Client) DeleteStreamEndpoint ¶

func (c *Client) DeleteStreamEndpoint(ctx context.Context, apiKey string, endpointID int) error

func (*Client) EditPermission ¶

func (c *Client) EditPermission(ctx context.Context, apiKey string, permissionID int, options people.PermissionAddEditDTO) (people.Permission, error)

func (*Client) EditRole ¶

func (c *Client) EditRole(ctx context.Context, apiKey string, roleID int, options people.RoleAddEditDTO) (people.Role, error)

func (*Client) EditStreamEndpoint ¶

func (c *Client) EditStreamEndpoint(ctx context.Context, apiKey string, endpointID int, options stream.EndpointAddEditDTO) (stream.Endpoint, error)

func (*Client) FindStreamEndpoint ¶

func (c *Client) FindStreamEndpoint(ctx context.Context, apiKey string, options types.FindStreamEndpointOptions) (stream.Endpoint, error)

func (*Client) GetPermission ¶

func (c *Client) GetPermission(ctx context.Context, apiKey string, permissionID int) (people.Permission, error)

func (*Client) GetPermissionWithRolesCount ¶

func (c *Client) GetPermissionWithRolesCount(ctx context.Context, apiKey string, permissionID int) (people.PermissionWithRolesCount, error)

func (*Client) GetRole ¶

func (c *Client) GetRole(ctx context.Context, apiKey string, roleID int) (people.Role, error)

func (*Client) GetRoleFull ¶

func (c *Client) GetRoleFull(ctx context.Context, apiKey string, roleID int) (people.RoleFull, error)

func (*Client) GetUserByEmail ¶

func (c *Client) GetUserByEmail(ctx context.Context, apiKey string, email string) (people.User, error)

func (*Client) GetUserByEmailFull ¶

func (c *Client) GetUserByEmailFull(ctx context.Context, apiKey string, email string) (people.UserFull, error)

func (*Client) GetUserByID ¶

func (c *Client) GetUserByID(ctx context.Context, apiKey string, userID int) (people.User, error)

func (*Client) GetUserByIDFull ¶

func (c *Client) GetUserByIDFull(ctx context.Context, apiKey string, userID int) (people.UserFull, error)

func (*Client) GetUserByToken ¶

func (c *Client) GetUserByToken(ctx context.Context, apiKey string) (people.User, error)

func (*Client) GetUserByTokenFull ¶

func (c *Client) GetUserByTokenFull(ctx context.Context, apiKey string) (people.UserFull, error)

func (*Client) ListPermissionMembersByID ¶

func (c *Client) ListPermissionMembersByID(ctx context.Context, apiKey string, permissionID int) ([]people.User, error)

func (*Client) ListPermissions ¶

func (c *Client) ListPermissions(ctx context.Context, apiKey string) ([]people.Permission, error)

func (*Client) ListPermissionsNotInRole ¶

func (c *Client) ListPermissionsNotInRole(ctx context.Context, apiKey string, roleID int) ([]people.Permission, error)

func (*Client) ListPermissionsWithRolesCount ¶

func (c *Client) ListPermissionsWithRolesCount(ctx context.Context, apiKey string) ([]people.PermissionWithRolesCount, error)

func (*Client) ListRoleMembersByID ¶

func (c *Client) ListRoleMembersByID(ctx context.Context, apiKey string, roleID int) ([]people.User, error)

func (*Client) ListRolePermissionsByID ¶

func (c *Client) ListRolePermissionsByID(ctx context.Context, apiKey string, roleID int) ([]people.Permission, error)

func (*Client) ListRolesWithCount ¶

func (c *Client) ListRolesWithCount(ctx context.Context, apiKey string) ([]people.RoleWithCount, error)

func (*Client) ListRolesWithPermissions ¶

func (c *Client) ListRolesWithPermissions(ctx context.Context, apiKey string) ([]people.RoleWithPermissions, error)

func (*Client) ListStreamEndpoints ¶

func (c *Client) ListStreamEndpoints(ctx context.Context, apiKey string) ([]stream.Endpoint, error)

func (*Client) ListUsers ¶

func (c *Client) ListUsers(ctx context.Context, apiKey string) ([]people.User, error)

func (*Client) ListUsersNotInRole ¶

func (c *Client) ListUsersNotInRole(ctx context.Context, apiKey string, roleID int) ([]people.User, error)

func (*Client) ListUsersPagination ¶

func (c *Client) ListUsersPagination(ctx context.Context, apiKey string, options types.ListUsersPaginationOptions) (people.UserFullPagination, error)

func (*Client) RoleAddPermission ¶

func (c *Client) RoleAddPermission(ctx context.Context, apiKey string, rolePermission people.RolePermission) (people.RolePermission, error)

func (*Client) RoleAddUser ¶

func (c *Client) RoleAddUser(ctx context.Context, apiKey string, roleUser people.RoleUser) (people.RoleUser, error)

func (*Client) RoleRemovePermission ¶

func (c *Client) RoleRemovePermission(ctx context.Context, apiKey string, rolePermission people.RolePermission) error

func (*Client) RoleRemoveUser ¶

func (c *Client) RoleRemoveUser(ctx context.Context, apiKey string, roleUser people.RoleUser) error

func (*Client) UserStats ¶

func (c *Client) UserStats(ctx context.Context, apiKey string) (people.CountUsers, error)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
types

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