goose/api_clients/swift/docs/ScheduleAPI.md

ScheduleAPI

All URIs are relative to http://localhost

Method	HTTP request	Description
createSchedule	POST /schedule/create
deleteSchedule	DELETE /schedule/delete/{id}
inspectRunningJob	GET /schedule/{id}/inspect
killRunningJob	POST /schedule/{id}/kill
listSchedules	GET /schedule/list
pauseSchedule	POST /schedule/{id}/pause
runNowHandler	POST /schedule/{id}/run_now
sessionsHandler	GET /schedule/{id}/sessions
unpauseSchedule	POST /schedule/{id}/unpause
updateSchedule	PUT /schedule/{id}

createSchedule

    open class func createSchedule(createScheduleRequest: CreateScheduleRequest, completion: @escaping (_ data: ScheduledJob?, _ error: Error?) -> Void)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import GooseAPI

let createScheduleRequest = CreateScheduleRequest(cron: "cron_example", executionMode: "executionMode_example", id: "id_example", recipeSource: "recipeSource_example") // CreateScheduleRequest | 

ScheduleAPI.createSchedule(createScheduleRequest: createScheduleRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
createScheduleRequest	CreateScheduleRequest

Return type

ScheduledJob

Authorization

No authorization required

HTTP request headers

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

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

deleteSchedule

    open class func deleteSchedule(id: String, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import GooseAPI

let id = "id_example" // String | ID of the schedule to delete

ScheduleAPI.deleteSchedule(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	String	ID of the schedule to delete

Return type

Void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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

inspectRunningJob

    open class func inspectRunningJob(id: String, completion: @escaping (_ data: InspectJobResponse?, _ error: Error?) -> Void)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import GooseAPI

let id = "id_example" // String | ID of the schedule to inspect

ScheduleAPI.inspectRunningJob(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	String	ID of the schedule to inspect

Return type

InspectJobResponse

Authorization

No authorization required

HTTP request headers

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

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

killRunningJob

    open class func killRunningJob(id: String, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import GooseAPI

let id = "id_example" // String | 

ScheduleAPI.killRunningJob(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	String

Return type

Void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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

listSchedules

    open class func listSchedules(completion: @escaping (_ data: ListSchedulesResponse?, _ error: Error?) -> Void)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import GooseAPI


ScheduleAPI.listSchedules() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

ListSchedulesResponse

Authorization

No authorization required

HTTP request headers

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

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

pauseSchedule

    open class func pauseSchedule(id: String, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import GooseAPI

let id = "id_example" // String | ID of the schedule to pause

ScheduleAPI.pauseSchedule(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	String	ID of the schedule to pause

Return type

Void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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

runNowHandler

    open class func runNowHandler(id: String, completion: @escaping (_ data: RunNowResponse?, _ error: Error?) -> Void)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import GooseAPI

let id = "id_example" // String | ID of the schedule to run

ScheduleAPI.runNowHandler(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	String	ID of the schedule to run

Return type

RunNowResponse

Authorization

No authorization required

HTTP request headers

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

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

sessionsHandler

    open class func sessionsHandler(id: String, limit: Int? = nil, completion: @escaping (_ data: [SessionDisplayInfo]?, _ error: Error?) -> Void)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import GooseAPI

let id = "id_example" // String | ID of the schedule
let limit = 987 // Int |  (optional)

ScheduleAPI.sessionsHandler(id: id, limit: limit) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	String	ID of the schedule
limit	Int		[optional]

Return type

[SessionDisplayInfo]

Authorization

No authorization required

HTTP request headers

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

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

unpauseSchedule

    open class func unpauseSchedule(id: String, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import GooseAPI

let id = "id_example" // String | ID of the schedule to unpause

ScheduleAPI.unpauseSchedule(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	String	ID of the schedule to unpause

Return type

Void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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

updateSchedule

    open class func updateSchedule(id: String, updateScheduleRequest: UpdateScheduleRequest, completion: @escaping (_ data: ScheduledJob?, _ error: Error?) -> Void)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import GooseAPI

let id = "id_example" // String | ID of the schedule to update
let updateScheduleRequest = UpdateScheduleRequest(cron: "cron_example") // UpdateScheduleRequest | 

ScheduleAPI.updateSchedule(id: id, updateScheduleRequest: updateScheduleRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	String	ID of the schedule to update
updateScheduleRequest	UpdateScheduleRequest

Return type

ScheduledJob

Authorization

No authorization required

HTTP request headers

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

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