Skip to content

PlanAPI.md

Latest commit

 

History

History
441 lines (305 loc) · 14.7 KB

PlanAPI.md

File metadata and controls

441 lines (305 loc) · 14.7 KB
Raw

PlanAPI

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

Method HTTP request Description
deletePlan DELETE /plan Delete user's plan
getPlaidPlan GET /plan/plaid Get plaid plan and generate timeseries for 365 days
getPlaidPlanWithDays GET /plan/plaid/{days} Get plaid plan and generate timeseries for specified number of days
getPlan GET /plan Get plan and generate timeseries for 365 days
getPlanWithDays GET /plan/{days} Get plan and generate timeseries for specified number of days
newPlan POST /plan Creates a new plan for the user and generate timeseries for 365 days
newPlanWithDays POST /plan/{days} Creates a new plan for the user and generate timeseries for specified number of days
updatePlan PUT /plan Update plan and generate timeseries for 365 days
updatePlanWithDays PUT /plan/{days} Update plan and generate timeseries for specified number of days

deletePlan

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

Delete user's plan

Example

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


// Delete user's plan
PlanAPI.deletePlan() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

Plan

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]

getPlaidPlan

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

Get plaid plan and generate timeseries for 365 days

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 plaid plan and generate timeseries for 365 days
PlanAPI.getPlaidPlan() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

PlanResponse

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]

getPlaidPlanWithDays

    open class func getPlaidPlanWithDays(days: Int, completion: @escaping (_ data: PlanResponse?, _ error: Error?) -> Void)

Get plaid plan and generate timeseries for specified number of days

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 days = 987 // Int | Number of days to generate timeseries for

// Get plaid plan and generate timeseries for specified number of days
PlanAPI.getPlaidPlanWithDays(days: days) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
days Int Number of days to generate timeseries for

Return type

PlanResponse

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]

getPlan

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

Get plan and generate timeseries for 365 days

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 plan and generate timeseries for 365 days
PlanAPI.getPlan() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

PlanResponse

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]

getPlanWithDays

    open class func getPlanWithDays(days: Int, completion: @escaping (_ data: PlanResponse?, _ error: Error?) -> Void)

Get plan and generate timeseries for specified number of days

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 days = 987 // Int | Number of days to generate timeseries for

// Get plan and generate timeseries for specified number of days
PlanAPI.getPlanWithDays(days: days) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
days Int Number of days to generate timeseries for

Return type

PlanResponse

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]

newPlan

    open class func newPlan(planNewPayload: PlanNewPayload, completion: @escaping (_ data: PlanResponse?, _ error: Error?) -> Void)

Creates a new plan for the user and generate timeseries for 365 days

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 planNewPayload = PlanNewPayload(name: "name_example", recurrings: [Recurring(id: MongoObjectID(oid: "oid_example"), name: "name_example", start: 123, end: 123, principal: 123, amount: 123, interest: 123, frequency: TimeInterval(typ: "typ_example", content: 123))], allocations: [Allocation(id: nil, description: "description_example", date: 123, schema: [AllocationProportion(asset: Asset(name: "name_example", _class: AssetClass(typ: "typ_example", content: "content_example"), annualizedPerformance: 123), proportion: 123)])], events: [Event(id: nil, name: "name_example", start: 123, transforms: [AssetClassChange(_class: nil, change: 123)])]) // PlanNewPayload | 

// Creates a new plan for the user and generate timeseries for 365 days
PlanAPI.newPlan(planNewPayload: planNewPayload) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
planNewPayload PlanNewPayload

Return type

PlanResponse

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]

newPlanWithDays

    open class func newPlanWithDays(days: Int, planNewPayload: PlanNewPayload, completion: @escaping (_ data: PlanResponse?, _ error: Error?) -> Void)

Creates a new plan for the user and generate timeseries for specified number of days

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 days = 987 // Int | Number of days to generate timeseries for
let planNewPayload = PlanNewPayload(name: "name_example", recurrings: [Recurring(id: MongoObjectID(oid: "oid_example"), name: "name_example", start: 123, end: 123, principal: 123, amount: 123, interest: 123, frequency: TimeInterval(typ: "typ_example", content: 123))], allocations: [Allocation(id: nil, description: "description_example", date: 123, schema: [AllocationProportion(asset: Asset(name: "name_example", _class: AssetClass(typ: "typ_example", content: "content_example"), annualizedPerformance: 123), proportion: 123)])], events: [Event(id: nil, name: "name_example", start: 123, transforms: [AssetClassChange(_class: nil, change: 123)])]) // PlanNewPayload | 

// Creates a new plan for the user and generate timeseries for specified number of days
PlanAPI.newPlanWithDays(days: days, planNewPayload: planNewPayload) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
days Int Number of days to generate timeseries for
planNewPayload PlanNewPayload

Return type

PlanResponse

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]

updatePlan

    open class func updatePlan(planUpdatePayload: PlanUpdatePayload, completion: @escaping (_ data: PlanResponse?, _ error: Error?) -> Void)

Update plan and generate timeseries for 365 days

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 planUpdatePayload = PlanUpdatePayload(name: "name_example", recurrings: [Recurring(id: MongoObjectID(oid: "oid_example"), name: "name_example", start: 123, end: 123, principal: 123, amount: 123, interest: 123, frequency: TimeInterval(typ: "typ_example", content: 123))], allocations: [Allocation(id: nil, description: "description_example", date: 123, schema: [AllocationProportion(asset: Asset(name: "name_example", _class: AssetClass(typ: "typ_example", content: "content_example"), annualizedPerformance: 123), proportion: 123)])], events: [Event(id: nil, name: "name_example", start: 123, transforms: [AssetClassChange(_class: nil, change: 123)])]) // PlanUpdatePayload | 

// Update plan and generate timeseries for 365 days
PlanAPI.updatePlan(planUpdatePayload: planUpdatePayload) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
planUpdatePayload PlanUpdatePayload

Return type

PlanResponse

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]

updatePlanWithDays

    open class func updatePlanWithDays(days: Int, planUpdatePayload: PlanUpdatePayload, completion: @escaping (_ data: PlanResponse?, _ error: Error?) -> Void)

Update plan and generate timeseries for specified number of days

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 days = 987 // Int | Number of days to generate timeseries for
let planUpdatePayload = PlanUpdatePayload(name: "name_example", recurrings: [Recurring(id: MongoObjectID(oid: "oid_example"), name: "name_example", start: 123, end: 123, principal: 123, amount: 123, interest: 123, frequency: TimeInterval(typ: "typ_example", content: 123))], allocations: [Allocation(id: nil, description: "description_example", date: 123, schema: [AllocationProportion(asset: Asset(name: "name_example", _class: AssetClass(typ: "typ_example", content: "content_example"), annualizedPerformance: 123), proportion: 123)])], events: [Event(id: nil, name: "name_example", start: 123, transforms: [AssetClassChange(_class: nil, change: 123)])]) // PlanUpdatePayload | 

// Update plan and generate timeseries for specified number of days
PlanAPI.updatePlanWithDays(days: days, planUpdatePayload: planUpdatePayload) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
days Int Number of days to generate timeseries for
planUpdatePayload PlanUpdatePayload

Return type

PlanResponse

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]