Skip to content

UserAPI.md

Latest commit

 

History

History
196 lines (134 loc) · 4.82 KB

UserAPI.md

File metadata and controls

196 lines (134 loc) · 4.82 KB
Raw

UserAPI

All URIs are relative to https://finchapp.eastus.cloudapp.azure.com/api

Method HTTP request Description
getUser GET /user Gets user info
loginUser POST /login Log in a user
logoutUser POST /logout Log out a user
signupUser POST /signup Sign up a user

getUser

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

Gets user info

Example

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


// Gets user info
UserAPI.getUser() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

User

Authorization

sidCookie

HTTP request headers

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

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

loginUser

    open class func loginUser(loginPayload: LoginPayload, completion: @escaping (_ data: User?, _ error: Error?) -> Void)

Log in a user

Example

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

let loginPayload = LoginPayload(email: "email_example", password: "password_example") // LoginPayload | 

// Log in a user
UserAPI.loginUser(loginPayload: loginPayload) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
loginPayload LoginPayload

Return type

User

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]

logoutUser

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

Log out a user

Example

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


// Log out a user
UserAPI.logoutUser() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

Void (empty response body)

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]

signupUser

    open class func signupUser(signupPayload: SignupPayload, completion: @escaping (_ data: User?, _ error: Error?) -> Void)

Sign up a user

Example

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

let signupPayload = SignupPayload(email: "email_example", password: "password_example", firstName: "firstName_example", lastName: "lastName_example", income: 123, netWorth: 123, location: Location(hasLocation: false, lat: 123, lon: 123), birthday: Date()) // SignupPayload | 

// Sign up a user
UserAPI.signupUser(signupPayload: signupPayload) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
signupPayload SignupPayload

Return type

User

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]