Skip to content

Latest commit

 

History

History
269 lines (167 loc) · 6.67 KB

SyncJobsApi.md

File metadata and controls

269 lines (167 loc) · 6.67 KB
Raw

\SyncJobsApi

All URIs are relative to http://localhost

Method HTTP request Description
CreateSyncJob Post /api/v1/add/syncjob Create sync job
DeleteSyncJob Post /api/v1/delete/syncjob Delete sync job
GetSyncJobs Get /api/v1/get/syncjobs/all/no_log Get sync jobs
UpdateSyncJob Post /api/v1/edit/syncjob Update sync job

CreateSyncJob

CreateAlias200Response CreateSyncJob(ctx).CreateSyncJobRequest(createSyncJobRequest).Execute()

Create sync job

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/shoopea/mailcow-go"
)

func main() {
    createSyncJobRequest := *openapiclient.NewCreateSyncJobRequest() // CreateSyncJobRequest |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
createSyncJobRequest CreateSyncJobRequest

Return type

CreateAlias200Response

Authorization

ApiKeyAuth

HTTP request headers

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

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

DeleteSyncJob

CreateAlias200Response DeleteSyncJob(ctx).DeleteSyncJobRequest(deleteSyncJobRequest).Execute()

Delete sync job

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/shoopea/mailcow-go"
)

func main() {
    deleteSyncJobRequest := *openapiclient.NewDeleteSyncJobRequest() // DeleteSyncJobRequest |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
deleteSyncJobRequest DeleteSyncJobRequest

Return type

CreateAlias200Response

Authorization

ApiKeyAuth

HTTP request headers

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

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

GetSyncJobs

GetSyncJobs(ctx).Execute()

Get sync jobs

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/shoopea/mailcow-go"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.SyncJobsApi.GetSyncJobs(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SyncJobsApi.GetSyncJobs``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

(empty response body)

Authorization

ApiKeyAuth

HTTP request headers

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

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

UpdateSyncJob

CreateAlias200Response UpdateSyncJob(ctx).UpdateSyncJobRequest(updateSyncJobRequest).Execute()

Update sync job

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/shoopea/mailcow-go"
)

func main() {
    updateSyncJobRequest := *openapiclient.NewUpdateSyncJobRequest() // UpdateSyncJobRequest |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
updateSyncJobRequest UpdateSyncJobRequest

Return type

CreateAlias200Response

Authorization

ApiKeyAuth

HTTP request headers

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

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