ControllerSettingsAPI

All URIs are relative to https://use1-omada-northbound.tplinkcloud.com

Method	HTTP request	Description
CancelFavoriteSite	Post /openapi/v1/{omadacId}/sites/{siteId}/favorites/cancels	Cancel favorite site
EvaluateFeedback	Post /openapi/v1/{omadacId}/users/feedback/evaluates	Evaluate a customer feedback
FavoriteSite	Post /openapi/v1/{omadacId}/sites/{siteId}/favorites	Favorite site
GetClientActiveTimeout	Get /openapi/v1/{omadacId}/controller/setting/active-timeout	Get client active timeout
GetClientDetailInformationSetting	Get /openapi/v1/{omadacId}/client-detail-information	Get client detail information settings
GetClientRecognitionEnable	Get /openapi/v1/{omadacId}/controller/setting/client-recognition	Get whether client recognition is enabled
GetExpImprove	Get /openapi/v1/{omadacId}/global/controller/setting/exp-improve	Get experience improvement
GetGernalSettings	Get /openapi/v1/{omadacId}/global/controller/setting/general	Get general settings
GetMailServerStatus	Get /openapi/v1/{omadacId}/mail/status	Get mailServer status
GetOmadacDstInfo1	Get /openapi/v1/{omadacId}/dst-info	Get controller DST
GetPrivacyPolicy	Get /openapi/v1/{omadacId}/privacy-policy	Get privacy policy
GetRemoteLogging	Get /openapi/v1/{omadacId}/global/controller/setting/syslog	Get remote logging
GetRetention	Get /openapi/v1/{omadacId}/controller/setting/retention	Get retention
GetUiInterface	Get /openapi/v1/{omadacId}/controller/setting/ui-interface	Get UI interface
ModfiyClientRecognitionEnable	Patch /openapi/v1/{omadacId}/controller/setting/client-recognition	Modify client recognition enable
ModifyClientActiveTimeout	Patch /openapi/v1/{omadacId}/controller/setting/active-timeout	Modify an existing client active timeout
ModifyClientDetailInformationSetting	Patch /openapi/v1/{omadacId}/client-detail-information	Modify client detail information settings
ModifyExpImprove	Patch /openapi/v1/{omadacId}/global/controller/setting/exp-improve	Modify an existing experience improvement
ModifyGeneralSettings	Patch /openapi/v1/{omadacId}/global/controller/setting/general	Modify an existing general settings
ModifyRemoteLogging	Patch /openapi/v1/{omadacId}/global/controller/setting/syslog	Modify an existing remote logging
ModifyRetention1	Patch /openapi/v1/{omadacId}/controller/setting/retention	Modify an existing retention
ModifyUiInterface	Patch /openapi/v1/{omadacId}/controller/setting/ui-interface	Modify an existing UI interface
SendTestEmail	Post /openapi/v1/{omadacId}/settings/test-mail	Send test mail for controller

CancelFavoriteSite

OperationResponseWithoutResult CancelFavoriteSite(ctx, omadacId, siteId).Execute()

Cancel favorite site

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ControllerSettingsAPI.CancelFavoriteSite(context.Background(), omadacId, siteId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ControllerSettingsAPI.CancelFavoriteSite``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CancelFavoriteSite`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `ControllerSettingsAPI.CancelFavoriteSite`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiCancelFavoriteSiteRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EvaluateFeedback

OperationResponseWithoutResult EvaluateFeedback(ctx, omadacId).FeedbackOpenApiVO(feedbackOpenApiVO).Execute()

Evaluate a customer feedback

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    feedbackOpenApiVO := *openapiclient.NewFeedbackOpenApiVO("Content_example", int32(123)) // FeedbackOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ControllerSettingsAPI.EvaluateFeedback(context.Background(), omadacId).FeedbackOpenApiVO(feedbackOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ControllerSettingsAPI.EvaluateFeedback``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EvaluateFeedback`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `ControllerSettingsAPI.EvaluateFeedback`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiEvaluateFeedbackRequest struct via the builder pattern

Name	Type	Description	Notes

feedbackOpenApiVO | FeedbackOpenApiVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FavoriteSite

OperationResponseWithoutResult FavoriteSite(ctx, omadacId, siteId).Execute()

Favorite site

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ControllerSettingsAPI.FavoriteSite(context.Background(), omadacId, siteId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ControllerSettingsAPI.FavoriteSite``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `FavoriteSite`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `ControllerSettingsAPI.FavoriteSite`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiFavoriteSiteRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetClientActiveTimeout

OperationResponseClientActiveTimeout GetClientActiveTimeout(ctx, omadacId).Execute()

Get client active timeout

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ControllerSettingsAPI.GetClientActiveTimeout(context.Background(), omadacId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ControllerSettingsAPI.GetClientActiveTimeout``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetClientActiveTimeout`: OperationResponseClientActiveTimeout
    fmt.Fprintf(os.Stdout, "Response from `ControllerSettingsAPI.GetClientActiveTimeout`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiGetClientActiveTimeoutRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseClientActiveTimeout

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetClientDetailInformationSetting

OperationResponseClientDetailInformationSettingVO GetClientDetailInformationSetting(ctx, omadacId).Execute()

Get client detail information settings

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ControllerSettingsAPI.GetClientDetailInformationSetting(context.Background(), omadacId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ControllerSettingsAPI.GetClientDetailInformationSetting``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetClientDetailInformationSetting`: OperationResponseClientDetailInformationSettingVO
    fmt.Fprintf(os.Stdout, "Response from `ControllerSettingsAPI.GetClientDetailInformationSetting`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiGetClientDetailInformationSettingRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseClientDetailInformationSettingVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetClientRecognitionEnable

OperationResponseClientRecognitionEnableOpenApiVO GetClientRecognitionEnable(ctx, omadacId).Execute()

Get whether client recognition is enabled

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ControllerSettingsAPI.GetClientRecognitionEnable(context.Background(), omadacId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ControllerSettingsAPI.GetClientRecognitionEnable``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetClientRecognitionEnable`: OperationResponseClientRecognitionEnableOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `ControllerSettingsAPI.GetClientRecognitionEnable`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiGetClientRecognitionEnableRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseClientRecognitionEnableOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetExpImprove

OperationResponseExperienceImprovementProgram GetExpImprove(ctx, omadacId).Execute()

Get experience improvement

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ControllerSettingsAPI.GetExpImprove(context.Background(), omadacId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ControllerSettingsAPI.GetExpImprove``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetExpImprove`: OperationResponseExperienceImprovementProgram
    fmt.Fprintf(os.Stdout, "Response from `ControllerSettingsAPI.GetExpImprove`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiGetExpImproveRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseExperienceImprovementProgram

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGernalSettings

OperationResponseGeneralSetting GetGernalSettings(ctx, omadacId).Execute()

Get general settings

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ControllerSettingsAPI.GetGernalSettings(context.Background(), omadacId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ControllerSettingsAPI.GetGernalSettings``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetGernalSettings`: OperationResponseGeneralSetting
    fmt.Fprintf(os.Stdout, "Response from `ControllerSettingsAPI.GetGernalSettings`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiGetGernalSettingsRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseGeneralSetting

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMailServerStatus

OperationResponse GetMailServerStatus(ctx, omadacId).Execute()

Get mailServer status

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ControllerSettingsAPI.GetMailServerStatus(context.Background(), omadacId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ControllerSettingsAPI.GetMailServerStatus``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetMailServerStatus`: OperationResponse
    fmt.Fprintf(os.Stdout, "Response from `ControllerSettingsAPI.GetMailServerStatus`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiGetMailServerStatusRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetOmadacDstInfo1

OperationResponseDstOpenApiVO GetOmadacDstInfo1(ctx, omadacId).Execute()

Get controller DST

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ControllerSettingsAPI.GetOmadacDstInfo1(context.Background(), omadacId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ControllerSettingsAPI.GetOmadacDstInfo1``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetOmadacDstInfo1`: OperationResponseDstOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `ControllerSettingsAPI.GetOmadacDstInfo1`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiGetOmadacDstInfo1Request struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseDstOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPrivacyPolicy

OperationResponsePrivacyPolicy GetPrivacyPolicy(ctx, omadacId).Execute()

Get privacy policy

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ControllerSettingsAPI.GetPrivacyPolicy(context.Background(), omadacId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ControllerSettingsAPI.GetPrivacyPolicy``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetPrivacyPolicy`: OperationResponsePrivacyPolicy
    fmt.Fprintf(os.Stdout, "Response from `ControllerSettingsAPI.GetPrivacyPolicy`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiGetPrivacyPolicyRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponsePrivacyPolicy

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRemoteLogging

OperationResponseRemoteLog GetRemoteLogging(ctx, omadacId).Execute()

Get remote logging

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ControllerSettingsAPI.GetRemoteLogging(context.Background(), omadacId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ControllerSettingsAPI.GetRemoteLogging``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetRemoteLogging`: OperationResponseRemoteLog
    fmt.Fprintf(os.Stdout, "Response from `ControllerSettingsAPI.GetRemoteLogging`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiGetRemoteLoggingRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseRemoteLog

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRetention

OperationResponseHistoryRetention GetRetention(ctx, omadacId).Execute()

Get retention

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ControllerSettingsAPI.GetRetention(context.Background(), omadacId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ControllerSettingsAPI.GetRetention``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetRetention`: OperationResponseHistoryRetention
    fmt.Fprintf(os.Stdout, "Response from `ControllerSettingsAPI.GetRetention`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiGetRetentionRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseHistoryRetention

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUiInterface

OperationResponseUIInterface GetUiInterface(ctx, omadacId).Execute()

Get UI interface

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ControllerSettingsAPI.GetUiInterface(context.Background(), omadacId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ControllerSettingsAPI.GetUiInterface``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetUiInterface`: OperationResponseUIInterface
    fmt.Fprintf(os.Stdout, "Response from `ControllerSettingsAPI.GetUiInterface`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiGetUiInterfaceRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseUIInterface

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModfiyClientRecognitionEnable

OperationResponseWithoutResult ModfiyClientRecognitionEnable(ctx, omadacId).ClientRecognitionEnableOpenApiVO(clientRecognitionEnableOpenApiVO).Execute()

Modify client recognition enable

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    clientRecognitionEnableOpenApiVO := *openapiclient.NewClientRecognitionEnableOpenApiVO(false) // ClientRecognitionEnableOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ControllerSettingsAPI.ModfiyClientRecognitionEnable(context.Background(), omadacId).ClientRecognitionEnableOpenApiVO(clientRecognitionEnableOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ControllerSettingsAPI.ModfiyClientRecognitionEnable``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModfiyClientRecognitionEnable`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `ControllerSettingsAPI.ModfiyClientRecognitionEnable`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiModfiyClientRecognitionEnableRequest struct via the builder pattern

Name	Type	Description	Notes

clientRecognitionEnableOpenApiVO | ClientRecognitionEnableOpenApiVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyClientActiveTimeout

OperationResponse ModifyClientActiveTimeout(ctx, omadacId).ClientActiveTimeout(clientActiveTimeout).Execute()

Modify an existing client active timeout

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    clientActiveTimeout := *openapiclient.NewClientActiveTimeout(int32(123)) // ClientActiveTimeout | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ControllerSettingsAPI.ModifyClientActiveTimeout(context.Background(), omadacId).ClientActiveTimeout(clientActiveTimeout).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ControllerSettingsAPI.ModifyClientActiveTimeout``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyClientActiveTimeout`: OperationResponse
    fmt.Fprintf(os.Stdout, "Response from `ControllerSettingsAPI.ModifyClientActiveTimeout`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiModifyClientActiveTimeoutRequest struct via the builder pattern

Name	Type	Description	Notes

clientActiveTimeout | ClientActiveTimeout | |

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyClientDetailInformationSetting

OperationResponseWithoutResult ModifyClientDetailInformationSetting(ctx, omadacId).ClientDetailInformationSettingVO(clientDetailInformationSettingVO).Execute()

Modify client detail information settings

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    clientDetailInformationSettingVO := *openapiclient.NewClientDetailInformationSettingVO() // ClientDetailInformationSettingVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ControllerSettingsAPI.ModifyClientDetailInformationSetting(context.Background(), omadacId).ClientDetailInformationSettingVO(clientDetailInformationSettingVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ControllerSettingsAPI.ModifyClientDetailInformationSetting``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyClientDetailInformationSetting`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `ControllerSettingsAPI.ModifyClientDetailInformationSetting`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiModifyClientDetailInformationSettingRequest struct via the builder pattern

Name	Type	Description	Notes

clientDetailInformationSettingVO | ClientDetailInformationSettingVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyExpImprove

OperationResponse ModifyExpImprove(ctx, omadacId).ExperienceImprovementProgram(experienceImprovementProgram).Execute()

Modify an existing experience improvement

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    experienceImprovementProgram := *openapiclient.NewExperienceImprovementProgram(false) // ExperienceImprovementProgram | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ControllerSettingsAPI.ModifyExpImprove(context.Background(), omadacId).ExperienceImprovementProgram(experienceImprovementProgram).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ControllerSettingsAPI.ModifyExpImprove``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyExpImprove`: OperationResponse
    fmt.Fprintf(os.Stdout, "Response from `ControllerSettingsAPI.ModifyExpImprove`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiModifyExpImproveRequest struct via the builder pattern

Name	Type	Description	Notes

experienceImprovementProgram | ExperienceImprovementProgram | |

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyGeneralSettings

OperationResponse ModifyGeneralSettings(ctx, omadacId).GeneralSetting(generalSetting).Execute()

Modify an existing general settings

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    generalSetting := *openapiclient.NewGeneralSetting("Name_example", "Region_example", "TimeZone_example") // GeneralSetting | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ControllerSettingsAPI.ModifyGeneralSettings(context.Background(), omadacId).GeneralSetting(generalSetting).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ControllerSettingsAPI.ModifyGeneralSettings``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyGeneralSettings`: OperationResponse
    fmt.Fprintf(os.Stdout, "Response from `ControllerSettingsAPI.ModifyGeneralSettings`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiModifyGeneralSettingsRequest struct via the builder pattern

Name	Type	Description	Notes

generalSetting | GeneralSetting | |

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyRemoteLogging

OperationResponse ModifyRemoteLogging(ctx, omadacId).RemoteLog(remoteLog).Execute()

Modify an existing remote logging

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    remoteLog := *openapiclient.NewRemoteLog(false) // RemoteLog | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ControllerSettingsAPI.ModifyRemoteLogging(context.Background(), omadacId).RemoteLog(remoteLog).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ControllerSettingsAPI.ModifyRemoteLogging``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyRemoteLogging`: OperationResponse
    fmt.Fprintf(os.Stdout, "Response from `ControllerSettingsAPI.ModifyRemoteLogging`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiModifyRemoteLoggingRequest struct via the builder pattern

Name	Type	Description	Notes

remoteLog | RemoteLog | |

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyRetention1

OperationResponse ModifyRetention1(ctx, omadacId).HistoryRetention(historyRetention).Execute()

Modify an existing retention

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    historyRetention := *openapiclient.NewHistoryRetention(false) // HistoryRetention | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ControllerSettingsAPI.ModifyRetention1(context.Background(), omadacId).HistoryRetention(historyRetention).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ControllerSettingsAPI.ModifyRetention1``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyRetention1`: OperationResponse
    fmt.Fprintf(os.Stdout, "Response from `ControllerSettingsAPI.ModifyRetention1`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiModifyRetention1Request struct via the builder pattern

Name	Type	Description	Notes

historyRetention | HistoryRetention | |

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyUiInterface

OperationResponse ModifyUiInterface(ctx, omadacId).UIInterface(uIInterface).Execute()

Modify an existing UI interface

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    uIInterface := *openapiclient.NewUIInterface(int32(123)) // UIInterface | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ControllerSettingsAPI.ModifyUiInterface(context.Background(), omadacId).UIInterface(uIInterface).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ControllerSettingsAPI.ModifyUiInterface``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyUiInterface`: OperationResponse
    fmt.Fprintf(os.Stdout, "Response from `ControllerSettingsAPI.ModifyUiInterface`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiModifyUiInterfaceRequest struct via the builder pattern

Name	Type	Description	Notes

uIInterface | UIInterface | |

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SendTestEmail

OperationResponse SendTestEmail(ctx, omadacId).SendMailServerOpenApiVO(sendMailServerOpenApiVO).Execute()

Send test mail for controller

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    sendMailServerOpenApiVO := *openapiclient.NewSendMailServerOpenApiVO(false, int32(123), "SmtpServer_example", false) // SendMailServerOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ControllerSettingsAPI.SendTestEmail(context.Background(), omadacId).SendMailServerOpenApiVO(sendMailServerOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ControllerSettingsAPI.SendTestEmail``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `SendTestEmail`: OperationResponse
    fmt.Fprintf(os.Stdout, "Response from `ControllerSettingsAPI.SendTestEmail`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiSendTestEmailRequest struct via the builder pattern

Name	Type	Description	Notes

sendMailServerOpenApiVO | SendMailServerOpenApiVO | |

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]