ynab 1.24.0 → 1.28.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/esm/api.d.ts CHANGED
@@ -880,7 +880,7 @@ export interface MonthSummary {
880
880
  */
881
881
  note?: string | null;
882
882
  /**
883
- * The total amount of transactions categorized to 'Inflow: To be Budgeted' in the month
883
+ * The total amount of transactions categorized to 'Inflow: Ready to Assign' in the month
884
884
  * @type {number}
885
885
  * @memberof MonthSummary
886
886
  */
@@ -892,13 +892,13 @@ export interface MonthSummary {
892
892
  */
893
893
  budgeted: number;
894
894
  /**
895
- * The total amount of transactions in the month, excluding those categorized to 'Inflow: To be Budgeted'
895
+ * The total amount of transactions in the month, excluding those categorized to 'Inflow: Ready to Assign'
896
896
  * @type {number}
897
897
  * @memberof MonthSummary
898
898
  */
899
899
  activity: number;
900
900
  /**
901
- * The available amount for 'To be Budgeted'
901
+ * The available amount for 'Ready to Assign'
902
902
  * @type {number}
903
903
  * @memberof MonthSummary
904
904
  */
@@ -2323,7 +2323,7 @@ export interface MonthDetail {
2323
2323
  */
2324
2324
  note?: string | null;
2325
2325
  /**
2326
- * The total amount of transactions categorized to 'Inflow: To be Budgeted' in the month
2326
+ * The total amount of transactions categorized to 'Inflow: Ready to Assign' in the month
2327
2327
  * @type {number}
2328
2328
  * @memberof MonthDetail
2329
2329
  */
@@ -2335,13 +2335,13 @@ export interface MonthDetail {
2335
2335
  */
2336
2336
  budgeted: number;
2337
2337
  /**
2338
- * The total amount of transactions in the month, excluding those categorized to 'Inflow: To be Budgeted'
2338
+ * The total amount of transactions in the month, excluding those categorized to 'Inflow: Ready to Assign'
2339
2339
  * @type {number}
2340
2340
  * @memberof MonthDetail
2341
2341
  */
2342
2342
  activity: number;
2343
2343
  /**
2344
- * The available amount for 'To be Budgeted'
2344
+ * The available amount for 'Ready to Assign'
2345
2345
  * @type {number}
2346
2346
  * @memberof MonthDetail
2347
2347
  */
@@ -2811,7 +2811,9 @@ export declare const AccountsApiFp: (configuration: Configuration) => {
2811
2811
  * @param {*} [options] - Override http request options.
2812
2812
  * @throws {RequiredError}
2813
2813
  */
2814
- createAccount(budget_id: string, data: SaveAccountWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<AccountResponse>;
2814
+ createAccount(budget_id: string, data: SaveAccountWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<AccountResponse & {
2815
+ rateLimit: string | null;
2816
+ }>;
2815
2817
  /**
2816
2818
  * Returns a single account
2817
2819
  * @summary Single account
@@ -2820,7 +2822,9 @@ export declare const AccountsApiFp: (configuration: Configuration) => {
2820
2822
  * @param {*} [options] - Override http request options.
2821
2823
  * @throws {RequiredError}
2822
2824
  */
2823
- getAccountById(budget_id: string, account_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<AccountResponse>;
2825
+ getAccountById(budget_id: string, account_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<AccountResponse & {
2826
+ rateLimit: string | null;
2827
+ }>;
2824
2828
  /**
2825
2829
  * Returns all accounts
2826
2830
  * @summary Account list
@@ -2829,7 +2833,9 @@ export declare const AccountsApiFp: (configuration: Configuration) => {
2829
2833
  * @param {*} [options] - Override http request options.
2830
2834
  * @throws {RequiredError}
2831
2835
  */
2832
- getAccounts(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<AccountsResponse>;
2836
+ getAccounts(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<AccountsResponse & {
2837
+ rateLimit: string | null;
2838
+ }>;
2833
2839
  };
2834
2840
  /**
2835
2841
  * AccountsApi - factory interface
@@ -2844,7 +2850,9 @@ export declare const AccountsApiFactory: (configuration: Configuration) => {
2844
2850
  * @param {*} [options] - Override http request options.
2845
2851
  * @throws {RequiredError}
2846
2852
  */
2847
- createAccount(budget_id: string, data: SaveAccountWrapper, options?: any): Promise<AccountResponse>;
2853
+ createAccount(budget_id: string, data: SaveAccountWrapper, options?: any): Promise<AccountResponse & {
2854
+ rateLimit: string | null;
2855
+ }>;
2848
2856
  /**
2849
2857
  * Returns a single account
2850
2858
  * @summary Single account
@@ -2853,7 +2861,9 @@ export declare const AccountsApiFactory: (configuration: Configuration) => {
2853
2861
  * @param {*} [options] - Override http request options.
2854
2862
  * @throws {RequiredError}
2855
2863
  */
2856
- getAccountById(budget_id: string, account_id: string, options?: any): Promise<AccountResponse>;
2864
+ getAccountById(budget_id: string, account_id: string, options?: any): Promise<AccountResponse & {
2865
+ rateLimit: string | null;
2866
+ }>;
2857
2867
  /**
2858
2868
  * Returns all accounts
2859
2869
  * @summary Account list
@@ -2862,7 +2872,9 @@ export declare const AccountsApiFactory: (configuration: Configuration) => {
2862
2872
  * @param {*} [options] - Override http request options.
2863
2873
  * @throws {RequiredError}
2864
2874
  */
2865
- getAccounts(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): Promise<AccountsResponse>;
2875
+ getAccounts(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): Promise<AccountsResponse & {
2876
+ rateLimit: string | null;
2877
+ }>;
2866
2878
  };
2867
2879
  /**
2868
2880
  * AccountsApi - object-oriented interface
@@ -2880,7 +2892,9 @@ export declare class AccountsApi extends BaseAPI {
2880
2892
  * @throws {RequiredError}
2881
2893
  * @memberof AccountsApi
2882
2894
  */
2883
- createAccount(budget_id: string, data: SaveAccountWrapper, options?: any): Promise<AccountResponse>;
2895
+ createAccount(budget_id: string, data: SaveAccountWrapper, options?: any): Promise<AccountResponse & {
2896
+ rateLimit: string | null;
2897
+ }>;
2884
2898
  /**
2885
2899
  * Returns a single account
2886
2900
  * @summary Single account
@@ -2890,7 +2904,9 @@ export declare class AccountsApi extends BaseAPI {
2890
2904
  * @throws {RequiredError}
2891
2905
  * @memberof AccountsApi
2892
2906
  */
2893
- getAccountById(budget_id: string, account_id: string, options?: any): Promise<AccountResponse>;
2907
+ getAccountById(budget_id: string, account_id: string, options?: any): Promise<AccountResponse & {
2908
+ rateLimit: string | null;
2909
+ }>;
2894
2910
  /**
2895
2911
  * Returns all accounts
2896
2912
  * @summary Account list
@@ -2900,7 +2916,9 @@ export declare class AccountsApi extends BaseAPI {
2900
2916
  * @throws {RequiredError}
2901
2917
  * @memberof AccountsApi
2902
2918
  */
2903
- getAccounts(budget_id: string, last_knowledge_of_server?: number, options?: any): Promise<AccountsResponse>;
2919
+ getAccounts(budget_id: string, last_knowledge_of_server?: number, options?: any): Promise<AccountsResponse & {
2920
+ rateLimit: string | null;
2921
+ }>;
2904
2922
  }
2905
2923
  /**
2906
2924
  * BudgetsApi - fetch parameter creator
@@ -2946,7 +2964,9 @@ export declare const BudgetsApiFp: (configuration: Configuration) => {
2946
2964
  * @param {*} [options] - Override http request options.
2947
2965
  * @throws {RequiredError}
2948
2966
  */
2949
- getBudgetById(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<BudgetDetailResponse>;
2967
+ getBudgetById(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<BudgetDetailResponse & {
2968
+ rateLimit: string | null;
2969
+ }>;
2950
2970
  /**
2951
2971
  * Returns settings for a budget
2952
2972
  * @summary Budget Settings
@@ -2954,7 +2974,9 @@ export declare const BudgetsApiFp: (configuration: Configuration) => {
2954
2974
  * @param {*} [options] - Override http request options.
2955
2975
  * @throws {RequiredError}
2956
2976
  */
2957
- getBudgetSettingsById(budget_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<BudgetSettingsResponse>;
2977
+ getBudgetSettingsById(budget_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<BudgetSettingsResponse & {
2978
+ rateLimit: string | null;
2979
+ }>;
2958
2980
  /**
2959
2981
  * Returns budgets list with summary information
2960
2982
  * @summary List budgets
@@ -2962,7 +2984,9 @@ export declare const BudgetsApiFp: (configuration: Configuration) => {
2962
2984
  * @param {*} [options] - Override http request options.
2963
2985
  * @throws {RequiredError}
2964
2986
  */
2965
- getBudgets(include_accounts?: boolean | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<BudgetSummaryResponse>;
2987
+ getBudgets(include_accounts?: boolean | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<BudgetSummaryResponse & {
2988
+ rateLimit: string | null;
2989
+ }>;
2966
2990
  };
2967
2991
  /**
2968
2992
  * BudgetsApi - factory interface
@@ -2977,7 +3001,9 @@ export declare const BudgetsApiFactory: (configuration: Configuration) => {
2977
3001
  * @param {*} [options] - Override http request options.
2978
3002
  * @throws {RequiredError}
2979
3003
  */
2980
- getBudgetById(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): Promise<BudgetDetailResponse>;
3004
+ getBudgetById(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): Promise<BudgetDetailResponse & {
3005
+ rateLimit: string | null;
3006
+ }>;
2981
3007
  /**
2982
3008
  * Returns settings for a budget
2983
3009
  * @summary Budget Settings
@@ -2985,7 +3011,9 @@ export declare const BudgetsApiFactory: (configuration: Configuration) => {
2985
3011
  * @param {*} [options] - Override http request options.
2986
3012
  * @throws {RequiredError}
2987
3013
  */
2988
- getBudgetSettingsById(budget_id: string, options?: any): Promise<BudgetSettingsResponse>;
3014
+ getBudgetSettingsById(budget_id: string, options?: any): Promise<BudgetSettingsResponse & {
3015
+ rateLimit: string | null;
3016
+ }>;
2989
3017
  /**
2990
3018
  * Returns budgets list with summary information
2991
3019
  * @summary List budgets
@@ -2993,7 +3021,9 @@ export declare const BudgetsApiFactory: (configuration: Configuration) => {
2993
3021
  * @param {*} [options] - Override http request options.
2994
3022
  * @throws {RequiredError}
2995
3023
  */
2996
- getBudgets(include_accounts?: boolean | undefined, options?: any): Promise<BudgetSummaryResponse>;
3024
+ getBudgets(include_accounts?: boolean | undefined, options?: any): Promise<BudgetSummaryResponse & {
3025
+ rateLimit: string | null;
3026
+ }>;
2997
3027
  };
2998
3028
  /**
2999
3029
  * BudgetsApi - object-oriented interface
@@ -3011,7 +3041,9 @@ export declare class BudgetsApi extends BaseAPI {
3011
3041
  * @throws {RequiredError}
3012
3042
  * @memberof BudgetsApi
3013
3043
  */
3014
- getBudgetById(budget_id: string, last_knowledge_of_server?: number, options?: any): Promise<BudgetDetailResponse>;
3044
+ getBudgetById(budget_id: string, last_knowledge_of_server?: number, options?: any): Promise<BudgetDetailResponse & {
3045
+ rateLimit: string | null;
3046
+ }>;
3015
3047
  /**
3016
3048
  * Returns settings for a budget
3017
3049
  * @summary Budget Settings
@@ -3020,7 +3052,9 @@ export declare class BudgetsApi extends BaseAPI {
3020
3052
  * @throws {RequiredError}
3021
3053
  * @memberof BudgetsApi
3022
3054
  */
3023
- getBudgetSettingsById(budget_id: string, options?: any): Promise<BudgetSettingsResponse>;
3055
+ getBudgetSettingsById(budget_id: string, options?: any): Promise<BudgetSettingsResponse & {
3056
+ rateLimit: string | null;
3057
+ }>;
3024
3058
  /**
3025
3059
  * Returns budgets list with summary information
3026
3060
  * @summary List budgets
@@ -3029,7 +3063,9 @@ export declare class BudgetsApi extends BaseAPI {
3029
3063
  * @throws {RequiredError}
3030
3064
  * @memberof BudgetsApi
3031
3065
  */
3032
- getBudgets(include_accounts?: boolean, options?: any): Promise<BudgetSummaryResponse>;
3066
+ getBudgets(include_accounts?: boolean, options?: any): Promise<BudgetSummaryResponse & {
3067
+ rateLimit: string | null;
3068
+ }>;
3033
3069
  }
3034
3070
  /**
3035
3071
  * CategoriesApi - fetch parameter creator
@@ -3089,7 +3125,9 @@ export declare const CategoriesApiFp: (configuration: Configuration) => {
3089
3125
  * @param {*} [options] - Override http request options.
3090
3126
  * @throws {RequiredError}
3091
3127
  */
3092
- getCategories(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<CategoriesResponse>;
3128
+ getCategories(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<CategoriesResponse & {
3129
+ rateLimit: string | null;
3130
+ }>;
3093
3131
  /**
3094
3132
  * Returns a single category. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
3095
3133
  * @summary Single category
@@ -3098,7 +3136,9 @@ export declare const CategoriesApiFp: (configuration: Configuration) => {
3098
3136
  * @param {*} [options] - Override http request options.
3099
3137
  * @throws {RequiredError}
3100
3138
  */
3101
- getCategoryById(budget_id: string, category_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<CategoryResponse>;
3139
+ getCategoryById(budget_id: string, category_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<CategoryResponse & {
3140
+ rateLimit: string | null;
3141
+ }>;
3102
3142
  /**
3103
3143
  * Returns a single category for a specific budget month. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
3104
3144
  * @summary Single category for a specific budget month
@@ -3108,7 +3148,9 @@ export declare const CategoriesApiFp: (configuration: Configuration) => {
3108
3148
  * @param {*} [options] - Override http request options.
3109
3149
  * @throws {RequiredError}
3110
3150
  */
3111
- getMonthCategoryById(budget_id: string, month: Date | string, category_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<CategoryResponse>;
3151
+ getMonthCategoryById(budget_id: string, month: Date | string, category_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<CategoryResponse & {
3152
+ rateLimit: string | null;
3153
+ }>;
3112
3154
  /**
3113
3155
  * Update a category for a specific month. Only `budgeted` amount can be updated.
3114
3156
  * @summary Update a category for a specific month
@@ -3119,7 +3161,9 @@ export declare const CategoriesApiFp: (configuration: Configuration) => {
3119
3161
  * @param {*} [options] - Override http request options.
3120
3162
  * @throws {RequiredError}
3121
3163
  */
3122
- updateMonthCategory(budget_id: string, month: Date | string, category_id: string, data: SaveMonthCategoryWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<SaveCategoryResponse>;
3164
+ updateMonthCategory(budget_id: string, month: Date | string, category_id: string, data: SaveMonthCategoryWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<SaveCategoryResponse & {
3165
+ rateLimit: string | null;
3166
+ }>;
3123
3167
  };
3124
3168
  /**
3125
3169
  * CategoriesApi - factory interface
@@ -3134,7 +3178,9 @@ export declare const CategoriesApiFactory: (configuration: Configuration) => {
3134
3178
  * @param {*} [options] - Override http request options.
3135
3179
  * @throws {RequiredError}
3136
3180
  */
3137
- getCategories(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): Promise<CategoriesResponse>;
3181
+ getCategories(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): Promise<CategoriesResponse & {
3182
+ rateLimit: string | null;
3183
+ }>;
3138
3184
  /**
3139
3185
  * Returns a single category. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
3140
3186
  * @summary Single category
@@ -3143,7 +3189,9 @@ export declare const CategoriesApiFactory: (configuration: Configuration) => {
3143
3189
  * @param {*} [options] - Override http request options.
3144
3190
  * @throws {RequiredError}
3145
3191
  */
3146
- getCategoryById(budget_id: string, category_id: string, options?: any): Promise<CategoryResponse>;
3192
+ getCategoryById(budget_id: string, category_id: string, options?: any): Promise<CategoryResponse & {
3193
+ rateLimit: string | null;
3194
+ }>;
3147
3195
  /**
3148
3196
  * Returns a single category for a specific budget month. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
3149
3197
  * @summary Single category for a specific budget month
@@ -3153,7 +3201,9 @@ export declare const CategoriesApiFactory: (configuration: Configuration) => {
3153
3201
  * @param {*} [options] - Override http request options.
3154
3202
  * @throws {RequiredError}
3155
3203
  */
3156
- getMonthCategoryById(budget_id: string, month: Date | string, category_id: string, options?: any): Promise<CategoryResponse>;
3204
+ getMonthCategoryById(budget_id: string, month: Date | string, category_id: string, options?: any): Promise<CategoryResponse & {
3205
+ rateLimit: string | null;
3206
+ }>;
3157
3207
  /**
3158
3208
  * Update a category for a specific month. Only `budgeted` amount can be updated.
3159
3209
  * @summary Update a category for a specific month
@@ -3164,7 +3214,9 @@ export declare const CategoriesApiFactory: (configuration: Configuration) => {
3164
3214
  * @param {*} [options] - Override http request options.
3165
3215
  * @throws {RequiredError}
3166
3216
  */
3167
- updateMonthCategory(budget_id: string, month: Date | string, category_id: string, data: SaveMonthCategoryWrapper, options?: any): Promise<SaveCategoryResponse>;
3217
+ updateMonthCategory(budget_id: string, month: Date | string, category_id: string, data: SaveMonthCategoryWrapper, options?: any): Promise<SaveCategoryResponse & {
3218
+ rateLimit: string | null;
3219
+ }>;
3168
3220
  };
3169
3221
  /**
3170
3222
  * CategoriesApi - object-oriented interface
@@ -3182,7 +3234,9 @@ export declare class CategoriesApi extends BaseAPI {
3182
3234
  * @throws {RequiredError}
3183
3235
  * @memberof CategoriesApi
3184
3236
  */
3185
- getCategories(budget_id: string, last_knowledge_of_server?: number, options?: any): Promise<CategoriesResponse>;
3237
+ getCategories(budget_id: string, last_knowledge_of_server?: number, options?: any): Promise<CategoriesResponse & {
3238
+ rateLimit: string | null;
3239
+ }>;
3186
3240
  /**
3187
3241
  * Returns a single category. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
3188
3242
  * @summary Single category
@@ -3192,7 +3246,9 @@ export declare class CategoriesApi extends BaseAPI {
3192
3246
  * @throws {RequiredError}
3193
3247
  * @memberof CategoriesApi
3194
3248
  */
3195
- getCategoryById(budget_id: string, category_id: string, options?: any): Promise<CategoryResponse>;
3249
+ getCategoryById(budget_id: string, category_id: string, options?: any): Promise<CategoryResponse & {
3250
+ rateLimit: string | null;
3251
+ }>;
3196
3252
  /**
3197
3253
  * Returns a single category for a specific budget month. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
3198
3254
  * @summary Single category for a specific budget month
@@ -3203,7 +3259,9 @@ export declare class CategoriesApi extends BaseAPI {
3203
3259
  * @throws {RequiredError}
3204
3260
  * @memberof CategoriesApi
3205
3261
  */
3206
- getMonthCategoryById(budget_id: string, month: Date | string, category_id: string, options?: any): Promise<CategoryResponse>;
3262
+ getMonthCategoryById(budget_id: string, month: Date | string, category_id: string, options?: any): Promise<CategoryResponse & {
3263
+ rateLimit: string | null;
3264
+ }>;
3207
3265
  /**
3208
3266
  * Update a category for a specific month. Only `budgeted` amount can be updated.
3209
3267
  * @summary Update a category for a specific month
@@ -3215,7 +3273,9 @@ export declare class CategoriesApi extends BaseAPI {
3215
3273
  * @throws {RequiredError}
3216
3274
  * @memberof CategoriesApi
3217
3275
  */
3218
- updateMonthCategory(budget_id: string, month: Date | string, category_id: string, data: SaveMonthCategoryWrapper, options?: any): Promise<SaveCategoryResponse>;
3276
+ updateMonthCategory(budget_id: string, month: Date | string, category_id: string, data: SaveMonthCategoryWrapper, options?: any): Promise<SaveCategoryResponse & {
3277
+ rateLimit: string | null;
3278
+ }>;
3219
3279
  }
3220
3280
  /**
3221
3281
  * DeprecatedApi - fetch parameter creator
@@ -3245,7 +3305,9 @@ export declare const DeprecatedApiFp: (configuration: Configuration) => {
3245
3305
  * @param {*} [options] - Override http request options.
3246
3306
  * @throws {RequiredError}
3247
3307
  */
3248
- bulkCreateTransactions(budget_id: string, transactions: BulkTransactions, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<BulkResponse>;
3308
+ bulkCreateTransactions(budget_id: string, transactions: BulkTransactions, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<BulkResponse & {
3309
+ rateLimit: string | null;
3310
+ }>;
3249
3311
  };
3250
3312
  /**
3251
3313
  * DeprecatedApi - factory interface
@@ -3260,7 +3322,9 @@ export declare const DeprecatedApiFactory: (configuration: Configuration) => {
3260
3322
  * @param {*} [options] - Override http request options.
3261
3323
  * @throws {RequiredError}
3262
3324
  */
3263
- bulkCreateTransactions(budget_id: string, transactions: BulkTransactions, options?: any): Promise<BulkResponse>;
3325
+ bulkCreateTransactions(budget_id: string, transactions: BulkTransactions, options?: any): Promise<BulkResponse & {
3326
+ rateLimit: string | null;
3327
+ }>;
3264
3328
  };
3265
3329
  /**
3266
3330
  * DeprecatedApi - object-oriented interface
@@ -3278,7 +3342,9 @@ export declare class DeprecatedApi extends BaseAPI {
3278
3342
  * @throws {RequiredError}
3279
3343
  * @memberof DeprecatedApi
3280
3344
  */
3281
- bulkCreateTransactions(budget_id: string, transactions: BulkTransactions, options?: any): Promise<BulkResponse>;
3345
+ bulkCreateTransactions(budget_id: string, transactions: BulkTransactions, options?: any): Promise<BulkResponse & {
3346
+ rateLimit: string | null;
3347
+ }>;
3282
3348
  }
3283
3349
  /**
3284
3350
  * MonthsApi - fetch parameter creator
@@ -3317,7 +3383,9 @@ export declare const MonthsApiFp: (configuration: Configuration) => {
3317
3383
  * @param {*} [options] - Override http request options.
3318
3384
  * @throws {RequiredError}
3319
3385
  */
3320
- getBudgetMonth(budget_id: string, month: Date | string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<MonthDetailResponse>;
3386
+ getBudgetMonth(budget_id: string, month: Date | string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<MonthDetailResponse & {
3387
+ rateLimit: string | null;
3388
+ }>;
3321
3389
  /**
3322
3390
  * Returns all budget months
3323
3391
  * @summary List budget months
@@ -3326,7 +3394,9 @@ export declare const MonthsApiFp: (configuration: Configuration) => {
3326
3394
  * @param {*} [options] - Override http request options.
3327
3395
  * @throws {RequiredError}
3328
3396
  */
3329
- getBudgetMonths(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<MonthSummariesResponse>;
3397
+ getBudgetMonths(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<MonthSummariesResponse & {
3398
+ rateLimit: string | null;
3399
+ }>;
3330
3400
  };
3331
3401
  /**
3332
3402
  * MonthsApi - factory interface
@@ -3341,7 +3411,9 @@ export declare const MonthsApiFactory: (configuration: Configuration) => {
3341
3411
  * @param {*} [options] - Override http request options.
3342
3412
  * @throws {RequiredError}
3343
3413
  */
3344
- getBudgetMonth(budget_id: string, month: Date | string, options?: any): Promise<MonthDetailResponse>;
3414
+ getBudgetMonth(budget_id: string, month: Date | string, options?: any): Promise<MonthDetailResponse & {
3415
+ rateLimit: string | null;
3416
+ }>;
3345
3417
  /**
3346
3418
  * Returns all budget months
3347
3419
  * @summary List budget months
@@ -3350,7 +3422,9 @@ export declare const MonthsApiFactory: (configuration: Configuration) => {
3350
3422
  * @param {*} [options] - Override http request options.
3351
3423
  * @throws {RequiredError}
3352
3424
  */
3353
- getBudgetMonths(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): Promise<MonthSummariesResponse>;
3425
+ getBudgetMonths(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): Promise<MonthSummariesResponse & {
3426
+ rateLimit: string | null;
3427
+ }>;
3354
3428
  };
3355
3429
  /**
3356
3430
  * MonthsApi - object-oriented interface
@@ -3368,7 +3442,9 @@ export declare class MonthsApi extends BaseAPI {
3368
3442
  * @throws {RequiredError}
3369
3443
  * @memberof MonthsApi
3370
3444
  */
3371
- getBudgetMonth(budget_id: string, month: Date | string, options?: any): Promise<MonthDetailResponse>;
3445
+ getBudgetMonth(budget_id: string, month: Date | string, options?: any): Promise<MonthDetailResponse & {
3446
+ rateLimit: string | null;
3447
+ }>;
3372
3448
  /**
3373
3449
  * Returns all budget months
3374
3450
  * @summary List budget months
@@ -3378,7 +3454,9 @@ export declare class MonthsApi extends BaseAPI {
3378
3454
  * @throws {RequiredError}
3379
3455
  * @memberof MonthsApi
3380
3456
  */
3381
- getBudgetMonths(budget_id: string, last_knowledge_of_server?: number, options?: any): Promise<MonthSummariesResponse>;
3457
+ getBudgetMonths(budget_id: string, last_knowledge_of_server?: number, options?: any): Promise<MonthSummariesResponse & {
3458
+ rateLimit: string | null;
3459
+ }>;
3382
3460
  }
3383
3461
  /**
3384
3462
  * PayeeLocationsApi - fetch parameter creator
@@ -3425,7 +3503,9 @@ export declare const PayeeLocationsApiFp: (configuration: Configuration) => {
3425
3503
  * @param {*} [options] - Override http request options.
3426
3504
  * @throws {RequiredError}
3427
3505
  */
3428
- getPayeeLocationById(budget_id: string, payee_location_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<PayeeLocationResponse>;
3506
+ getPayeeLocationById(budget_id: string, payee_location_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<PayeeLocationResponse & {
3507
+ rateLimit: string | null;
3508
+ }>;
3429
3509
  /**
3430
3510
  * Returns all payee locations
3431
3511
  * @summary List payee locations
@@ -3433,7 +3513,9 @@ export declare const PayeeLocationsApiFp: (configuration: Configuration) => {
3433
3513
  * @param {*} [options] - Override http request options.
3434
3514
  * @throws {RequiredError}
3435
3515
  */
3436
- getPayeeLocations(budget_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<PayeeLocationsResponse>;
3516
+ getPayeeLocations(budget_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<PayeeLocationsResponse & {
3517
+ rateLimit: string | null;
3518
+ }>;
3437
3519
  /**
3438
3520
  * Returns all payee locations for a specified payee
3439
3521
  * @summary List locations for a payee
@@ -3442,7 +3524,9 @@ export declare const PayeeLocationsApiFp: (configuration: Configuration) => {
3442
3524
  * @param {*} [options] - Override http request options.
3443
3525
  * @throws {RequiredError}
3444
3526
  */
3445
- getPayeeLocationsByPayee(budget_id: string, payee_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<PayeeLocationsResponse>;
3527
+ getPayeeLocationsByPayee(budget_id: string, payee_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<PayeeLocationsResponse & {
3528
+ rateLimit: string | null;
3529
+ }>;
3446
3530
  };
3447
3531
  /**
3448
3532
  * PayeeLocationsApi - factory interface
@@ -3457,7 +3541,9 @@ export declare const PayeeLocationsApiFactory: (configuration: Configuration) =>
3457
3541
  * @param {*} [options] - Override http request options.
3458
3542
  * @throws {RequiredError}
3459
3543
  */
3460
- getPayeeLocationById(budget_id: string, payee_location_id: string, options?: any): Promise<PayeeLocationResponse>;
3544
+ getPayeeLocationById(budget_id: string, payee_location_id: string, options?: any): Promise<PayeeLocationResponse & {
3545
+ rateLimit: string | null;
3546
+ }>;
3461
3547
  /**
3462
3548
  * Returns all payee locations
3463
3549
  * @summary List payee locations
@@ -3465,7 +3551,9 @@ export declare const PayeeLocationsApiFactory: (configuration: Configuration) =>
3465
3551
  * @param {*} [options] - Override http request options.
3466
3552
  * @throws {RequiredError}
3467
3553
  */
3468
- getPayeeLocations(budget_id: string, options?: any): Promise<PayeeLocationsResponse>;
3554
+ getPayeeLocations(budget_id: string, options?: any): Promise<PayeeLocationsResponse & {
3555
+ rateLimit: string | null;
3556
+ }>;
3469
3557
  /**
3470
3558
  * Returns all payee locations for a specified payee
3471
3559
  * @summary List locations for a payee
@@ -3474,7 +3562,9 @@ export declare const PayeeLocationsApiFactory: (configuration: Configuration) =>
3474
3562
  * @param {*} [options] - Override http request options.
3475
3563
  * @throws {RequiredError}
3476
3564
  */
3477
- getPayeeLocationsByPayee(budget_id: string, payee_id: string, options?: any): Promise<PayeeLocationsResponse>;
3565
+ getPayeeLocationsByPayee(budget_id: string, payee_id: string, options?: any): Promise<PayeeLocationsResponse & {
3566
+ rateLimit: string | null;
3567
+ }>;
3478
3568
  };
3479
3569
  /**
3480
3570
  * PayeeLocationsApi - object-oriented interface
@@ -3492,7 +3582,9 @@ export declare class PayeeLocationsApi extends BaseAPI {
3492
3582
  * @throws {RequiredError}
3493
3583
  * @memberof PayeeLocationsApi
3494
3584
  */
3495
- getPayeeLocationById(budget_id: string, payee_location_id: string, options?: any): Promise<PayeeLocationResponse>;
3585
+ getPayeeLocationById(budget_id: string, payee_location_id: string, options?: any): Promise<PayeeLocationResponse & {
3586
+ rateLimit: string | null;
3587
+ }>;
3496
3588
  /**
3497
3589
  * Returns all payee locations
3498
3590
  * @summary List payee locations
@@ -3501,7 +3593,9 @@ export declare class PayeeLocationsApi extends BaseAPI {
3501
3593
  * @throws {RequiredError}
3502
3594
  * @memberof PayeeLocationsApi
3503
3595
  */
3504
- getPayeeLocations(budget_id: string, options?: any): Promise<PayeeLocationsResponse>;
3596
+ getPayeeLocations(budget_id: string, options?: any): Promise<PayeeLocationsResponse & {
3597
+ rateLimit: string | null;
3598
+ }>;
3505
3599
  /**
3506
3600
  * Returns all payee locations for a specified payee
3507
3601
  * @summary List locations for a payee
@@ -3511,7 +3605,9 @@ export declare class PayeeLocationsApi extends BaseAPI {
3511
3605
  * @throws {RequiredError}
3512
3606
  * @memberof PayeeLocationsApi
3513
3607
  */
3514
- getPayeeLocationsByPayee(budget_id: string, payee_id: string, options?: any): Promise<PayeeLocationsResponse>;
3608
+ getPayeeLocationsByPayee(budget_id: string, payee_id: string, options?: any): Promise<PayeeLocationsResponse & {
3609
+ rateLimit: string | null;
3610
+ }>;
3515
3611
  }
3516
3612
  /**
3517
3613
  * PayeesApi - fetch parameter creator
@@ -3550,7 +3646,9 @@ export declare const PayeesApiFp: (configuration: Configuration) => {
3550
3646
  * @param {*} [options] - Override http request options.
3551
3647
  * @throws {RequiredError}
3552
3648
  */
3553
- getPayeeById(budget_id: string, payee_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<PayeeResponse>;
3649
+ getPayeeById(budget_id: string, payee_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<PayeeResponse & {
3650
+ rateLimit: string | null;
3651
+ }>;
3554
3652
  /**
3555
3653
  * Returns all payees
3556
3654
  * @summary List payees
@@ -3559,7 +3657,9 @@ export declare const PayeesApiFp: (configuration: Configuration) => {
3559
3657
  * @param {*} [options] - Override http request options.
3560
3658
  * @throws {RequiredError}
3561
3659
  */
3562
- getPayees(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<PayeesResponse>;
3660
+ getPayees(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<PayeesResponse & {
3661
+ rateLimit: string | null;
3662
+ }>;
3563
3663
  };
3564
3664
  /**
3565
3665
  * PayeesApi - factory interface
@@ -3574,7 +3674,9 @@ export declare const PayeesApiFactory: (configuration: Configuration) => {
3574
3674
  * @param {*} [options] - Override http request options.
3575
3675
  * @throws {RequiredError}
3576
3676
  */
3577
- getPayeeById(budget_id: string, payee_id: string, options?: any): Promise<PayeeResponse>;
3677
+ getPayeeById(budget_id: string, payee_id: string, options?: any): Promise<PayeeResponse & {
3678
+ rateLimit: string | null;
3679
+ }>;
3578
3680
  /**
3579
3681
  * Returns all payees
3580
3682
  * @summary List payees
@@ -3583,7 +3685,9 @@ export declare const PayeesApiFactory: (configuration: Configuration) => {
3583
3685
  * @param {*} [options] - Override http request options.
3584
3686
  * @throws {RequiredError}
3585
3687
  */
3586
- getPayees(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): Promise<PayeesResponse>;
3688
+ getPayees(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): Promise<PayeesResponse & {
3689
+ rateLimit: string | null;
3690
+ }>;
3587
3691
  };
3588
3692
  /**
3589
3693
  * PayeesApi - object-oriented interface
@@ -3601,7 +3705,9 @@ export declare class PayeesApi extends BaseAPI {
3601
3705
  * @throws {RequiredError}
3602
3706
  * @memberof PayeesApi
3603
3707
  */
3604
- getPayeeById(budget_id: string, payee_id: string, options?: any): Promise<PayeeResponse>;
3708
+ getPayeeById(budget_id: string, payee_id: string, options?: any): Promise<PayeeResponse & {
3709
+ rateLimit: string | null;
3710
+ }>;
3605
3711
  /**
3606
3712
  * Returns all payees
3607
3713
  * @summary List payees
@@ -3611,7 +3717,9 @@ export declare class PayeesApi extends BaseAPI {
3611
3717
  * @throws {RequiredError}
3612
3718
  * @memberof PayeesApi
3613
3719
  */
3614
- getPayees(budget_id: string, last_knowledge_of_server?: number, options?: any): Promise<PayeesResponse>;
3720
+ getPayees(budget_id: string, last_knowledge_of_server?: number, options?: any): Promise<PayeesResponse & {
3721
+ rateLimit: string | null;
3722
+ }>;
3615
3723
  }
3616
3724
  /**
3617
3725
  * ScheduledTransactionsApi - fetch parameter creator
@@ -3650,7 +3758,9 @@ export declare const ScheduledTransactionsApiFp: (configuration: Configuration)
3650
3758
  * @param {*} [options] - Override http request options.
3651
3759
  * @throws {RequiredError}
3652
3760
  */
3653
- getScheduledTransactionById(budget_id: string, scheduled_transaction_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<ScheduledTransactionResponse>;
3761
+ getScheduledTransactionById(budget_id: string, scheduled_transaction_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<ScheduledTransactionResponse & {
3762
+ rateLimit: string | null;
3763
+ }>;
3654
3764
  /**
3655
3765
  * Returns all scheduled transactions
3656
3766
  * @summary List scheduled transactions
@@ -3659,7 +3769,9 @@ export declare const ScheduledTransactionsApiFp: (configuration: Configuration)
3659
3769
  * @param {*} [options] - Override http request options.
3660
3770
  * @throws {RequiredError}
3661
3771
  */
3662
- getScheduledTransactions(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<ScheduledTransactionsResponse>;
3772
+ getScheduledTransactions(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<ScheduledTransactionsResponse & {
3773
+ rateLimit: string | null;
3774
+ }>;
3663
3775
  };
3664
3776
  /**
3665
3777
  * ScheduledTransactionsApi - factory interface
@@ -3674,7 +3786,9 @@ export declare const ScheduledTransactionsApiFactory: (configuration: Configurat
3674
3786
  * @param {*} [options] - Override http request options.
3675
3787
  * @throws {RequiredError}
3676
3788
  */
3677
- getScheduledTransactionById(budget_id: string, scheduled_transaction_id: string, options?: any): Promise<ScheduledTransactionResponse>;
3789
+ getScheduledTransactionById(budget_id: string, scheduled_transaction_id: string, options?: any): Promise<ScheduledTransactionResponse & {
3790
+ rateLimit: string | null;
3791
+ }>;
3678
3792
  /**
3679
3793
  * Returns all scheduled transactions
3680
3794
  * @summary List scheduled transactions
@@ -3683,7 +3797,9 @@ export declare const ScheduledTransactionsApiFactory: (configuration: Configurat
3683
3797
  * @param {*} [options] - Override http request options.
3684
3798
  * @throws {RequiredError}
3685
3799
  */
3686
- getScheduledTransactions(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): Promise<ScheduledTransactionsResponse>;
3800
+ getScheduledTransactions(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): Promise<ScheduledTransactionsResponse & {
3801
+ rateLimit: string | null;
3802
+ }>;
3687
3803
  };
3688
3804
  /**
3689
3805
  * ScheduledTransactionsApi - object-oriented interface
@@ -3701,7 +3817,9 @@ export declare class ScheduledTransactionsApi extends BaseAPI {
3701
3817
  * @throws {RequiredError}
3702
3818
  * @memberof ScheduledTransactionsApi
3703
3819
  */
3704
- getScheduledTransactionById(budget_id: string, scheduled_transaction_id: string, options?: any): Promise<ScheduledTransactionResponse>;
3820
+ getScheduledTransactionById(budget_id: string, scheduled_transaction_id: string, options?: any): Promise<ScheduledTransactionResponse & {
3821
+ rateLimit: string | null;
3822
+ }>;
3705
3823
  /**
3706
3824
  * Returns all scheduled transactions
3707
3825
  * @summary List scheduled transactions
@@ -3711,7 +3829,9 @@ export declare class ScheduledTransactionsApi extends BaseAPI {
3711
3829
  * @throws {RequiredError}
3712
3830
  * @memberof ScheduledTransactionsApi
3713
3831
  */
3714
- getScheduledTransactions(budget_id: string, last_knowledge_of_server?: number, options?: any): Promise<ScheduledTransactionsResponse>;
3832
+ getScheduledTransactions(budget_id: string, last_knowledge_of_server?: number, options?: any): Promise<ScheduledTransactionsResponse & {
3833
+ rateLimit: string | null;
3834
+ }>;
3715
3835
  }
3716
3836
  /**
3717
3837
  * TransactionsApi - fetch parameter creator
@@ -3824,7 +3944,9 @@ export declare const TransactionsApiFp: (configuration: Configuration) => {
3824
3944
  * @param {*} [options] - Override http request options.
3825
3945
  * @throws {RequiredError}
3826
3946
  */
3827
- createTransaction(budget_id: string, data: SaveTransactionsWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<SaveTransactionsResponse>;
3947
+ createTransaction(budget_id: string, data: SaveTransactionsWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<SaveTransactionsResponse & {
3948
+ rateLimit: string | null;
3949
+ }>;
3828
3950
  /**
3829
3951
  * Returns a single transaction
3830
3952
  * @summary Single transaction
@@ -3833,7 +3955,9 @@ export declare const TransactionsApiFp: (configuration: Configuration) => {
3833
3955
  * @param {*} [options] - Override http request options.
3834
3956
  * @throws {RequiredError}
3835
3957
  */
3836
- getTransactionById(budget_id: string, transaction_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<TransactionResponse>;
3958
+ getTransactionById(budget_id: string, transaction_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<TransactionResponse & {
3959
+ rateLimit: string | null;
3960
+ }>;
3837
3961
  /**
3838
3962
  * Returns budget transactions
3839
3963
  * @summary List transactions
@@ -3844,7 +3968,9 @@ export declare const TransactionsApiFp: (configuration: Configuration) => {
3844
3968
  * @param {*} [options] - Override http request options.
3845
3969
  * @throws {RequiredError}
3846
3970
  */
3847
- getTransactions(budget_id: string, since_date?: string | Date | undefined, type?: "uncategorized" | "unapproved" | undefined, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<TransactionsResponse>;
3971
+ getTransactions(budget_id: string, since_date?: string | Date | undefined, type?: "uncategorized" | "unapproved" | undefined, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<TransactionsResponse & {
3972
+ rateLimit: string | null;
3973
+ }>;
3848
3974
  /**
3849
3975
  * Returns all transactions for a specified account
3850
3976
  * @summary List account transactions
@@ -3856,7 +3982,9 @@ export declare const TransactionsApiFp: (configuration: Configuration) => {
3856
3982
  * @param {*} [options] - Override http request options.
3857
3983
  * @throws {RequiredError}
3858
3984
  */
3859
- getTransactionsByAccount(budget_id: string, account_id: string, since_date?: string | Date | undefined, type?: "uncategorized" | "unapproved" | undefined, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<TransactionsResponse>;
3985
+ getTransactionsByAccount(budget_id: string, account_id: string, since_date?: string | Date | undefined, type?: "uncategorized" | "unapproved" | undefined, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<TransactionsResponse & {
3986
+ rateLimit: string | null;
3987
+ }>;
3860
3988
  /**
3861
3989
  * Returns all transactions for a specified category
3862
3990
  * @summary List category transactions
@@ -3868,7 +3996,9 @@ export declare const TransactionsApiFp: (configuration: Configuration) => {
3868
3996
  * @param {*} [options] - Override http request options.
3869
3997
  * @throws {RequiredError}
3870
3998
  */
3871
- getTransactionsByCategory(budget_id: string, category_id: string, since_date?: string | Date | undefined, type?: "uncategorized" | "unapproved" | undefined, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<HybridTransactionsResponse>;
3999
+ getTransactionsByCategory(budget_id: string, category_id: string, since_date?: string | Date | undefined, type?: "uncategorized" | "unapproved" | undefined, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<HybridTransactionsResponse & {
4000
+ rateLimit: string | null;
4001
+ }>;
3872
4002
  /**
3873
4003
  * Returns all transactions for a specified payee
3874
4004
  * @summary List payee transactions
@@ -3880,7 +4010,9 @@ export declare const TransactionsApiFp: (configuration: Configuration) => {
3880
4010
  * @param {*} [options] - Override http request options.
3881
4011
  * @throws {RequiredError}
3882
4012
  */
3883
- getTransactionsByPayee(budget_id: string, payee_id: string, since_date?: string | Date | undefined, type?: "uncategorized" | "unapproved" | undefined, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<HybridTransactionsResponse>;
4013
+ getTransactionsByPayee(budget_id: string, payee_id: string, since_date?: string | Date | undefined, type?: "uncategorized" | "unapproved" | undefined, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<HybridTransactionsResponse & {
4014
+ rateLimit: string | null;
4015
+ }>;
3884
4016
  /**
3885
4017
  * Imports available transactions on all linked accounts for the given budget. Linked accounts allow transactions to be imported directly from a specified financial institution and this endpoint initiates that import. Sending a request to this endpoint is the equivalent of clicking \"Import\" on each account in the web application or tapping the \"New Transactions\" banner in the mobile applications. The response for this endpoint contains the transaction ids that have been imported.
3886
4018
  * @summary Import transactions
@@ -3888,7 +4020,9 @@ export declare const TransactionsApiFp: (configuration: Configuration) => {
3888
4020
  * @param {*} [options] - Override http request options.
3889
4021
  * @throws {RequiredError}
3890
4022
  */
3891
- importTransactions(budget_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<TransactionsImportResponse>;
4023
+ importTransactions(budget_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<TransactionsImportResponse & {
4024
+ rateLimit: string | null;
4025
+ }>;
3892
4026
  /**
3893
4027
  * Updates a single transaction
3894
4028
  * @summary Updates an existing transaction
@@ -3898,7 +4032,9 @@ export declare const TransactionsApiFp: (configuration: Configuration) => {
3898
4032
  * @param {*} [options] - Override http request options.
3899
4033
  * @throws {RequiredError}
3900
4034
  */
3901
- updateTransaction(budget_id: string, transaction_id: string, data: SaveTransactionWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<TransactionResponse>;
4035
+ updateTransaction(budget_id: string, transaction_id: string, data: SaveTransactionWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<TransactionResponse & {
4036
+ rateLimit: string | null;
4037
+ }>;
3902
4038
  /**
3903
4039
  * Updates multiple transactions, by `id` or `import_id`.
3904
4040
  * @summary Update multiple transactions
@@ -3907,7 +4043,9 @@ export declare const TransactionsApiFp: (configuration: Configuration) => {
3907
4043
  * @param {*} [options] - Override http request options.
3908
4044
  * @throws {RequiredError}
3909
4045
  */
3910
- updateTransactions(budget_id: string, data: UpdateTransactionsWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<SaveTransactionsResponse>;
4046
+ updateTransactions(budget_id: string, data: UpdateTransactionsWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<SaveTransactionsResponse & {
4047
+ rateLimit: string | null;
4048
+ }>;
3911
4049
  };
3912
4050
  /**
3913
4051
  * TransactionsApi - factory interface
@@ -3922,7 +4060,9 @@ export declare const TransactionsApiFactory: (configuration: Configuration) => {
3922
4060
  * @param {*} [options] - Override http request options.
3923
4061
  * @throws {RequiredError}
3924
4062
  */
3925
- createTransaction(budget_id: string, data: SaveTransactionsWrapper, options?: any): Promise<SaveTransactionsResponse>;
4063
+ createTransaction(budget_id: string, data: SaveTransactionsWrapper, options?: any): Promise<SaveTransactionsResponse & {
4064
+ rateLimit: string | null;
4065
+ }>;
3926
4066
  /**
3927
4067
  * Returns a single transaction
3928
4068
  * @summary Single transaction
@@ -3931,7 +4071,9 @@ export declare const TransactionsApiFactory: (configuration: Configuration) => {
3931
4071
  * @param {*} [options] - Override http request options.
3932
4072
  * @throws {RequiredError}
3933
4073
  */
3934
- getTransactionById(budget_id: string, transaction_id: string, options?: any): Promise<TransactionResponse>;
4074
+ getTransactionById(budget_id: string, transaction_id: string, options?: any): Promise<TransactionResponse & {
4075
+ rateLimit: string | null;
4076
+ }>;
3935
4077
  /**
3936
4078
  * Returns budget transactions
3937
4079
  * @summary List transactions
@@ -3942,7 +4084,9 @@ export declare const TransactionsApiFactory: (configuration: Configuration) => {
3942
4084
  * @param {*} [options] - Override http request options.
3943
4085
  * @throws {RequiredError}
3944
4086
  */
3945
- getTransactions(budget_id: string, since_date?: string | Date | undefined, type?: "uncategorized" | "unapproved" | undefined, last_knowledge_of_server?: number | undefined, options?: any): Promise<TransactionsResponse>;
4087
+ getTransactions(budget_id: string, since_date?: string | Date | undefined, type?: "uncategorized" | "unapproved" | undefined, last_knowledge_of_server?: number | undefined, options?: any): Promise<TransactionsResponse & {
4088
+ rateLimit: string | null;
4089
+ }>;
3946
4090
  /**
3947
4091
  * Returns all transactions for a specified account
3948
4092
  * @summary List account transactions
@@ -3954,7 +4098,9 @@ export declare const TransactionsApiFactory: (configuration: Configuration) => {
3954
4098
  * @param {*} [options] - Override http request options.
3955
4099
  * @throws {RequiredError}
3956
4100
  */
3957
- getTransactionsByAccount(budget_id: string, account_id: string, since_date?: string | Date | undefined, type?: "uncategorized" | "unapproved" | undefined, last_knowledge_of_server?: number | undefined, options?: any): Promise<TransactionsResponse>;
4101
+ getTransactionsByAccount(budget_id: string, account_id: string, since_date?: string | Date | undefined, type?: "uncategorized" | "unapproved" | undefined, last_knowledge_of_server?: number | undefined, options?: any): Promise<TransactionsResponse & {
4102
+ rateLimit: string | null;
4103
+ }>;
3958
4104
  /**
3959
4105
  * Returns all transactions for a specified category
3960
4106
  * @summary List category transactions
@@ -3966,7 +4112,9 @@ export declare const TransactionsApiFactory: (configuration: Configuration) => {
3966
4112
  * @param {*} [options] - Override http request options.
3967
4113
  * @throws {RequiredError}
3968
4114
  */
3969
- getTransactionsByCategory(budget_id: string, category_id: string, since_date?: string | Date | undefined, type?: "uncategorized" | "unapproved" | undefined, last_knowledge_of_server?: number | undefined, options?: any): Promise<HybridTransactionsResponse>;
4115
+ getTransactionsByCategory(budget_id: string, category_id: string, since_date?: string | Date | undefined, type?: "uncategorized" | "unapproved" | undefined, last_knowledge_of_server?: number | undefined, options?: any): Promise<HybridTransactionsResponse & {
4116
+ rateLimit: string | null;
4117
+ }>;
3970
4118
  /**
3971
4119
  * Returns all transactions for a specified payee
3972
4120
  * @summary List payee transactions
@@ -3978,7 +4126,9 @@ export declare const TransactionsApiFactory: (configuration: Configuration) => {
3978
4126
  * @param {*} [options] - Override http request options.
3979
4127
  * @throws {RequiredError}
3980
4128
  */
3981
- getTransactionsByPayee(budget_id: string, payee_id: string, since_date?: string | Date | undefined, type?: "uncategorized" | "unapproved" | undefined, last_knowledge_of_server?: number | undefined, options?: any): Promise<HybridTransactionsResponse>;
4129
+ getTransactionsByPayee(budget_id: string, payee_id: string, since_date?: string | Date | undefined, type?: "uncategorized" | "unapproved" | undefined, last_knowledge_of_server?: number | undefined, options?: any): Promise<HybridTransactionsResponse & {
4130
+ rateLimit: string | null;
4131
+ }>;
3982
4132
  /**
3983
4133
  * Imports available transactions on all linked accounts for the given budget. Linked accounts allow transactions to be imported directly from a specified financial institution and this endpoint initiates that import. Sending a request to this endpoint is the equivalent of clicking \"Import\" on each account in the web application or tapping the \"New Transactions\" banner in the mobile applications. The response for this endpoint contains the transaction ids that have been imported.
3984
4134
  * @summary Import transactions
@@ -3986,7 +4136,9 @@ export declare const TransactionsApiFactory: (configuration: Configuration) => {
3986
4136
  * @param {*} [options] - Override http request options.
3987
4137
  * @throws {RequiredError}
3988
4138
  */
3989
- importTransactions(budget_id: string, options?: any): Promise<TransactionsImportResponse>;
4139
+ importTransactions(budget_id: string, options?: any): Promise<TransactionsImportResponse & {
4140
+ rateLimit: string | null;
4141
+ }>;
3990
4142
  /**
3991
4143
  * Updates a single transaction
3992
4144
  * @summary Updates an existing transaction
@@ -3996,7 +4148,9 @@ export declare const TransactionsApiFactory: (configuration: Configuration) => {
3996
4148
  * @param {*} [options] - Override http request options.
3997
4149
  * @throws {RequiredError}
3998
4150
  */
3999
- updateTransaction(budget_id: string, transaction_id: string, data: SaveTransactionWrapper, options?: any): Promise<TransactionResponse>;
4151
+ updateTransaction(budget_id: string, transaction_id: string, data: SaveTransactionWrapper, options?: any): Promise<TransactionResponse & {
4152
+ rateLimit: string | null;
4153
+ }>;
4000
4154
  /**
4001
4155
  * Updates multiple transactions, by `id` or `import_id`.
4002
4156
  * @summary Update multiple transactions
@@ -4005,7 +4159,9 @@ export declare const TransactionsApiFactory: (configuration: Configuration) => {
4005
4159
  * @param {*} [options] - Override http request options.
4006
4160
  * @throws {RequiredError}
4007
4161
  */
4008
- updateTransactions(budget_id: string, data: UpdateTransactionsWrapper, options?: any): Promise<SaveTransactionsResponse>;
4162
+ updateTransactions(budget_id: string, data: UpdateTransactionsWrapper, options?: any): Promise<SaveTransactionsResponse & {
4163
+ rateLimit: string | null;
4164
+ }>;
4009
4165
  };
4010
4166
  /**
4011
4167
  * TransactionsApi - object-oriented interface
@@ -4023,7 +4179,9 @@ export declare class TransactionsApi extends BaseAPI {
4023
4179
  * @throws {RequiredError}
4024
4180
  * @memberof TransactionsApi
4025
4181
  */
4026
- createTransaction(budget_id: string, data: SaveTransactionsWrapper, options?: any): Promise<SaveTransactionsResponse>;
4182
+ createTransaction(budget_id: string, data: SaveTransactionsWrapper, options?: any): Promise<SaveTransactionsResponse & {
4183
+ rateLimit: string | null;
4184
+ }>;
4027
4185
  /**
4028
4186
  * Returns a single transaction
4029
4187
  * @summary Single transaction
@@ -4033,7 +4191,9 @@ export declare class TransactionsApi extends BaseAPI {
4033
4191
  * @throws {RequiredError}
4034
4192
  * @memberof TransactionsApi
4035
4193
  */
4036
- getTransactionById(budget_id: string, transaction_id: string, options?: any): Promise<TransactionResponse>;
4194
+ getTransactionById(budget_id: string, transaction_id: string, options?: any): Promise<TransactionResponse & {
4195
+ rateLimit: string | null;
4196
+ }>;
4037
4197
  /**
4038
4198
  * Returns budget transactions
4039
4199
  * @summary List transactions
@@ -4045,7 +4205,9 @@ export declare class TransactionsApi extends BaseAPI {
4045
4205
  * @throws {RequiredError}
4046
4206
  * @memberof TransactionsApi
4047
4207
  */
4048
- getTransactions(budget_id: string, since_date?: Date | string, type?: 'uncategorized' | 'unapproved', last_knowledge_of_server?: number, options?: any): Promise<TransactionsResponse>;
4208
+ getTransactions(budget_id: string, since_date?: Date | string, type?: 'uncategorized' | 'unapproved', last_knowledge_of_server?: number, options?: any): Promise<TransactionsResponse & {
4209
+ rateLimit: string | null;
4210
+ }>;
4049
4211
  /**
4050
4212
  * Returns all transactions for a specified account
4051
4213
  * @summary List account transactions
@@ -4058,7 +4220,9 @@ export declare class TransactionsApi extends BaseAPI {
4058
4220
  * @throws {RequiredError}
4059
4221
  * @memberof TransactionsApi
4060
4222
  */
4061
- getTransactionsByAccount(budget_id: string, account_id: string, since_date?: Date | string, type?: 'uncategorized' | 'unapproved', last_knowledge_of_server?: number, options?: any): Promise<TransactionsResponse>;
4223
+ getTransactionsByAccount(budget_id: string, account_id: string, since_date?: Date | string, type?: 'uncategorized' | 'unapproved', last_knowledge_of_server?: number, options?: any): Promise<TransactionsResponse & {
4224
+ rateLimit: string | null;
4225
+ }>;
4062
4226
  /**
4063
4227
  * Returns all transactions for a specified category
4064
4228
  * @summary List category transactions
@@ -4071,7 +4235,9 @@ export declare class TransactionsApi extends BaseAPI {
4071
4235
  * @throws {RequiredError}
4072
4236
  * @memberof TransactionsApi
4073
4237
  */
4074
- getTransactionsByCategory(budget_id: string, category_id: string, since_date?: Date | string, type?: 'uncategorized' | 'unapproved', last_knowledge_of_server?: number, options?: any): Promise<HybridTransactionsResponse>;
4238
+ getTransactionsByCategory(budget_id: string, category_id: string, since_date?: Date | string, type?: 'uncategorized' | 'unapproved', last_knowledge_of_server?: number, options?: any): Promise<HybridTransactionsResponse & {
4239
+ rateLimit: string | null;
4240
+ }>;
4075
4241
  /**
4076
4242
  * Returns all transactions for a specified payee
4077
4243
  * @summary List payee transactions
@@ -4084,7 +4250,9 @@ export declare class TransactionsApi extends BaseAPI {
4084
4250
  * @throws {RequiredError}
4085
4251
  * @memberof TransactionsApi
4086
4252
  */
4087
- getTransactionsByPayee(budget_id: string, payee_id: string, since_date?: Date | string, type?: 'uncategorized' | 'unapproved', last_knowledge_of_server?: number, options?: any): Promise<HybridTransactionsResponse>;
4253
+ getTransactionsByPayee(budget_id: string, payee_id: string, since_date?: Date | string, type?: 'uncategorized' | 'unapproved', last_knowledge_of_server?: number, options?: any): Promise<HybridTransactionsResponse & {
4254
+ rateLimit: string | null;
4255
+ }>;
4088
4256
  /**
4089
4257
  * Imports available transactions on all linked accounts for the given budget. Linked accounts allow transactions to be imported directly from a specified financial institution and this endpoint initiates that import. Sending a request to this endpoint is the equivalent of clicking \"Import\" on each account in the web application or tapping the \"New Transactions\" banner in the mobile applications. The response for this endpoint contains the transaction ids that have been imported.
4090
4258
  * @summary Import transactions
@@ -4093,7 +4261,9 @@ export declare class TransactionsApi extends BaseAPI {
4093
4261
  * @throws {RequiredError}
4094
4262
  * @memberof TransactionsApi
4095
4263
  */
4096
- importTransactions(budget_id: string, options?: any): Promise<TransactionsImportResponse>;
4264
+ importTransactions(budget_id: string, options?: any): Promise<TransactionsImportResponse & {
4265
+ rateLimit: string | null;
4266
+ }>;
4097
4267
  /**
4098
4268
  * Updates a single transaction
4099
4269
  * @summary Updates an existing transaction
@@ -4104,7 +4274,9 @@ export declare class TransactionsApi extends BaseAPI {
4104
4274
  * @throws {RequiredError}
4105
4275
  * @memberof TransactionsApi
4106
4276
  */
4107
- updateTransaction(budget_id: string, transaction_id: string, data: SaveTransactionWrapper, options?: any): Promise<TransactionResponse>;
4277
+ updateTransaction(budget_id: string, transaction_id: string, data: SaveTransactionWrapper, options?: any): Promise<TransactionResponse & {
4278
+ rateLimit: string | null;
4279
+ }>;
4108
4280
  /**
4109
4281
  * Updates multiple transactions, by `id` or `import_id`.
4110
4282
  * @summary Update multiple transactions
@@ -4114,7 +4286,9 @@ export declare class TransactionsApi extends BaseAPI {
4114
4286
  * @throws {RequiredError}
4115
4287
  * @memberof TransactionsApi
4116
4288
  */
4117
- updateTransactions(budget_id: string, data: UpdateTransactionsWrapper, options?: any): Promise<SaveTransactionsResponse>;
4289
+ updateTransactions(budget_id: string, data: UpdateTransactionsWrapper, options?: any): Promise<SaveTransactionsResponse & {
4290
+ rateLimit: string | null;
4291
+ }>;
4118
4292
  }
4119
4293
  /**
4120
4294
  * UserApi - fetch parameter creator
@@ -4140,7 +4314,9 @@ export declare const UserApiFp: (configuration: Configuration) => {
4140
4314
  * @param {*} [options] - Override http request options.
4141
4315
  * @throws {RequiredError}
4142
4316
  */
4143
- getUser(options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<UserResponse>;
4317
+ getUser(options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<UserResponse & {
4318
+ rateLimit: string | null;
4319
+ }>;
4144
4320
  };
4145
4321
  /**
4146
4322
  * UserApi - factory interface
@@ -4153,7 +4329,9 @@ export declare const UserApiFactory: (configuration: Configuration) => {
4153
4329
  * @param {*} [options] - Override http request options.
4154
4330
  * @throws {RequiredError}
4155
4331
  */
4156
- getUser(options?: any): Promise<UserResponse>;
4332
+ getUser(options?: any): Promise<UserResponse & {
4333
+ rateLimit: string | null;
4334
+ }>;
4157
4335
  };
4158
4336
  /**
4159
4337
  * UserApi - object-oriented interface
@@ -4169,5 +4347,7 @@ export declare class UserApi extends BaseAPI {
4169
4347
  * @throws {RequiredError}
4170
4348
  * @memberof UserApi
4171
4349
  */
4172
- getUser(options?: any): Promise<UserResponse>;
4350
+ getUser(options?: any): Promise<UserResponse & {
4351
+ rateLimit: string | null;
4352
+ }>;
4173
4353
  }