goose/api_clients/swift/docs/SessionManagementAPI.md

SessionManagementAPI

All URIs are relative to http://localhost

Method	HTTP request	Description
deleteSession	DELETE /sessions/{session_id}
getSession	GET /sessions/{session_id}
getSessionInsights	GET /sessions/insights
listSessions	GET /sessions
updateSessionDescription	PUT /sessions/{session_id}/description

deleteSession

    open class func deleteSession(sessionId: 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 sessionId = "sessionId_example" // String | Unique identifier for the session

SessionManagementAPI.deleteSession(sessionId: sessionId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
sessionId	String	Unique identifier for the session

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]

getSession

    open class func getSession(sessionId: String, completion: @escaping (_ data: Session?, _ 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 sessionId = "sessionId_example" // String | Unique identifier for the session

SessionManagementAPI.getSession(sessionId: sessionId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
sessionId	String	Unique identifier for the session

Return type

Session

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]

getSessionInsights

    open class func getSessionInsights(completion: @escaping (_ data: SessionInsights?, _ 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


SessionManagementAPI.getSessionInsights() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

SessionInsights

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]

listSessions

    open class func listSessions(completion: @escaping (_ data: SessionListResponse?, _ 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


SessionManagementAPI.listSessions() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

SessionListResponse

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]

updateSessionDescription

    open class func updateSessionDescription(sessionId: String, updateSessionDescriptionRequest: UpdateSessionDescriptionRequest, 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 sessionId = "sessionId_example" // String | Unique identifier for the session
let updateSessionDescriptionRequest = UpdateSessionDescriptionRequest(description: "description_example") // UpdateSessionDescriptionRequest | 

SessionManagementAPI.updateSessionDescription(sessionId: sessionId, updateSessionDescriptionRequest: updateSessionDescriptionRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
sessionId	String	Unique identifier for the session
updateSessionDescriptionRequest	UpdateSessionDescriptionRequest

Return type

Void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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