organizationalunits

Documentation

Overview

Package organizationalunits contains methods related to OrganizationalUnits

Index

• type OrganizationalUnitsV1
  • func (o *OrganizationalUnitsV1) CreateOrganizationalUnit(embed *string, body *models.CreateOrganizationalUnitV1Request) (*models.CreateOrganizationalUnitResponse, *apiutils.APIError)
  • func (o *OrganizationalUnitsV1) DeleteOrganizationalUnit(id string, embed *string) (*models.DeleteOrganizationalUnitResponse, *apiutils.APIError)
  • func (o *OrganizationalUnitsV1) ListOrganizationalUnits(limit *int64, start *string, filter *string) (*models.ListOrganizationalUnitsResponse, *apiutils.APIError)
  • func (o *OrganizationalUnitsV1) PatchOrganizationalUnit(id string, embed *string, body *models.PatchOrganizationalUnitV1Request) (*models.PatchOrganizationalUnitResponse, *apiutils.APIError)
  • func (o *OrganizationalUnitsV1) ReadOrganizationalUnit(id string) (*models.ReadOrganizationalUnitResponse, *apiutils.APIError)
• type OrganizationalUnitsV1Client
  • func NewOrganizationalUnitsV1(config config.Config) OrganizationalUnitsV1Client

Types

type OrganizationalUnitsV1

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

OrganizationalUnitsV1 represents a custom type struct

func (*OrganizationalUnitsV1) CreateOrganizationalUnit

func (o *OrganizationalUnitsV1) CreateOrganizationalUnit(
	embed *string,
	body *models.CreateOrganizationalUnitV1Request) (
	*models.CreateOrganizationalUnitResponse, *apiutils.APIError)

CreateOrganizationalUnit Create a new organizational unit.

func (*OrganizationalUnitsV1) DeleteOrganizationalUnit

func (o *OrganizationalUnitsV1) DeleteOrganizationalUnit(
	id string,
	embed *string) (
	*models.DeleteOrganizationalUnitResponse, *apiutils.APIError)

DeleteOrganizationalUnit Delete the specified organizational unit.

func (*OrganizationalUnitsV1) ListOrganizationalUnits

func (o *OrganizationalUnitsV1) ListOrganizationalUnits(
	limit *int64,
	start *string,
	filter *string) (
	*models.ListOrganizationalUnitsResponse, *apiutils.APIError)

ListOrganizationalUnits Returns a list of organizational units.

func (*OrganizationalUnitsV1) PatchOrganizationalUnit

func (o *OrganizationalUnitsV1) PatchOrganizationalUnit(
	id string,
	embed *string,
	body *models.PatchOrganizationalUnitV1Request) (
	*models.PatchOrganizationalUnitResponse, *apiutils.APIError)

PatchOrganizationalUnit Patch the specified organizational unit.

The complete updated attribute(s) of the organizational unit has to be provided in the request.

func (*OrganizationalUnitsV1) ReadOrganizationalUnit

func (o *OrganizationalUnitsV1) ReadOrganizationalUnit(
	id string) (
	*models.ReadOrganizationalUnitResponse, *apiutils.APIError)

ReadOrganizationalUnit Returns a representation of the specified organizational unit.

type OrganizationalUnitsV1Client

type OrganizationalUnitsV1Client interface {
	// ListOrganizationalUnits Returns a list of organizational units.
	ListOrganizationalUnits(
		limit *int64,
		start *string,
		filter *string) (
		*models.ListOrganizationalUnitsResponse, *apiutils.APIError)

	// CreateOrganizationalUnit Create a new organizational unit.
	CreateOrganizationalUnit(
		embed *string,
		body *models.CreateOrganizationalUnitV1Request) (
		*models.CreateOrganizationalUnitResponse, *apiutils.APIError)

	// ReadOrganizationalUnit Returns a representation of the specified organizational unit.
	ReadOrganizationalUnit(
		id string) (
		*models.ReadOrganizationalUnitResponse, *apiutils.APIError)

	// DeleteOrganizationalUnit Delete the specified organizational unit.
	DeleteOrganizationalUnit(
		id string,
		embed *string) (
		*models.DeleteOrganizationalUnitResponse, *apiutils.APIError)

	// PatchOrganizationalUnit Patch the specified organizational unit.
	//  The complete updated attribute(s) of the organizational unit has to be provided in the request.
	PatchOrganizationalUnit(
		id string,
		embed *string,
		body *models.PatchOrganizationalUnitV1Request) (
		*models.PatchOrganizationalUnitResponse, *apiutils.APIError)
}

OrganizationalUnitsV1Client represents a custom type interface

func NewOrganizationalUnitsV1

func NewOrganizationalUnitsV1(config config.Config) OrganizationalUnitsV1Client

NewOrganizationalUnitsV1 returns OrganizationalUnitsV1Client