Skip to content

RecurringAPI.md

Latest commit

 

History

History
296 lines (204 loc) · 8.24 KB

RecurringAPI.md

File metadata and controls

296 lines (204 loc) · 8.24 KB
Raw

RecurringAPI

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

Method HTTP request Description
deleteRecurring DELETE /recurring/{id} Delete one specific recurring by id
getRecurring GET /recurring/{id} Get one specific recurring by id
getRecurringExamples GET /recurring/examples Get example Recurrings
getRecurrings GET /recurrings Get all of a user's recurrings
newRecurring POST /recurring/new Creates a new recurring for the user
updateRecurring PUT /recurring/{id} Update one specific recurring by id

deleteRecurring

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

Delete one specific recurring by id

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 id = "id_example" // String | Numeric ID of the Recurring to delete

// Delete one specific recurring by id
RecurringAPI.deleteRecurring(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
id String Numeric ID of the Recurring to delete

Return type

Recurring

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]

getRecurring

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

Get one specific recurring by id

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 id = "id_example" // String | Numeric ID of the Recurring to get

// Get one specific recurring by id
RecurringAPI.getRecurring(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
id String Numeric ID of the Recurring to get

Return type

Recurring

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]

getRecurringExamples

    open class func getRecurringExamples(completion: @escaping (_ data: [RecurringNewPayload]?, _ error: Error?) -> Void)

Get example Recurrings

Example

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


// Get example Recurrings
RecurringAPI.getRecurringExamples() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

[RecurringNewPayload]

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]

getRecurrings

    open class func getRecurrings(completion: @escaping (_ data: [Recurring]?, _ error: Error?) -> Void)

Get all of a user's recurrings

Example

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


// Get all of a user's recurrings
RecurringAPI.getRecurrings() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

[Recurring]

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]

newRecurring

    open class func newRecurring(recurringNewPayload: RecurringNewPayload, completion: @escaping (_ data: Recurring?, _ error: Error?) -> Void)

Creates a new recurring for the 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 recurringNewPayload = RecurringNewPayload(name: "name_example", start: 123, end: 123, principal: 123, amount: 123, interest: 123, frequency: TimeInterval(typ: "typ_example", content: 123)) // RecurringNewPayload | 

// Creates a new recurring for the user
RecurringAPI.newRecurring(recurringNewPayload: recurringNewPayload) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
recurringNewPayload RecurringNewPayload

Return type

Recurring

Authorization

sidCookie

HTTP request headers

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

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

updateRecurring

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

Update one specific recurring by id

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 id = "id_example" // String | Numeric ID of the Recurring to update
let recurringNewPayload = RecurringNewPayload(name: "name_example", start: 123, end: 123, principal: 123, amount: 123, interest: 123, frequency: TimeInterval(typ: "typ_example", content: 123)) // RecurringNewPayload | 

// Update one specific recurring by id
RecurringAPI.updateRecurring(id: id, recurringNewPayload: recurringNewPayload) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
id String Numeric ID of the Recurring to update
recurringNewPayload RecurringNewPayload

Return type

Recurring

Authorization

sidCookie

HTTP request headers

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

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