generalsettings

Documentation

Overview

Package generalsettings contains methods related to GeneralSettings

Index

• type GeneralSettingsV2
  • func (g *GeneralSettingsV2) ReadGeneralSettings() (*models.ReadGeneralSettingsResponseV2, *apiutils.APIError)
  • func (g *GeneralSettingsV2) UpdateGeneralSettings(body *models.UpdateGeneralSettingsV2Request) (*models.PatchGeneralSettingsResponseV2, *apiutils.APIError)
• type GeneralSettingsV2Client
  • func NewGeneralSettingsV2(config config.Config) GeneralSettingsV2Client

Types

type GeneralSettingsV2

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

GeneralSettingsV2 represents a custom type struct

func (*GeneralSettingsV2) ReadGeneralSettings

func (g *GeneralSettingsV2) ReadGeneralSettings() (
	*models.ReadGeneralSettingsResponseV2, *apiutils.APIError)

ReadGeneralSettings Retrieves organization-wide setting details, including password and security settings.

func (*GeneralSettingsV2) UpdateGeneralSettings

func (g *GeneralSettingsV2) UpdateGeneralSettings(
	body *models.UpdateGeneralSettingsV2Request) (
	*models.PatchGeneralSettingsResponseV2, *apiutils.APIError)

UpdateGeneralSettings Updates organization-wide settings, including password and security settings.

type GeneralSettingsV2Client

type GeneralSettingsV2Client interface {
	// ReadGeneralSettings Retrieves organization-wide setting details, including password and security settings.
	ReadGeneralSettings() (
		*models.ReadGeneralSettingsResponseV2, *apiutils.APIError)

	// UpdateGeneralSettings Updates organization-wide settings, including password and security settings.
	UpdateGeneralSettings(
		body *models.UpdateGeneralSettingsV2Request) (
		*models.PatchGeneralSettingsResponseV2, *apiutils.APIError)
}

GeneralSettingsV2Client represents a custom type interface

func NewGeneralSettingsV2

func NewGeneralSettingsV2(config config.Config) GeneralSettingsV2Client

NewGeneralSettingsV2 returns GeneralSettingsV2Client