@mft/moneyhub-api-client 5.3.0 → 5.4.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+5.3.0 / 2023-05-31
+==================
+
+**Features**
+
+* All authorisation URL generating methods use Pushed Authorisation Requests (PAR) instead of JWT Secured Authorisation Requests (JAR)
+
 5.2.1 / 2023-01-19
 ==================
 

package/dist/index.d.ts

@@ -7,40 +7,40 @@ declare const _Moneyhub: (apiClientConfig: ApiClientConfig) => Promise<{
     generators: typeof generators;
     registerUser: ({ clientUserId, }: {
         clientUserId: string;
-    }) => Promise<Users.User>;
-    getUsers: (params?: import("./request").SearchParams | undefined) => Promise<import("./request").ApiResponse<Users.User[]>>;
-    getSCIMUsers: (params?: import("./request").SearchParams | undefined) => Promise<import("./request").ApiResponse<any>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<Users.User>;
+    getUsers: (params?: import("./request").SearchParams | undefined, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Users.User[]>>;
+    getSCIMUsers: (params?: import("./request").SearchParams | undefined, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<any>>;
     getUser: ({ userId, }: {
         userId: string;
-    }) => Promise<Users.User>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<Users.User>;
     getUserConnections: ({ userId, }: {
         userId: string;
-    }) => Promise<import("./request").ApiResponse<import("./schema/connection").UserConnection[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<import("./schema/connection").UserConnection[]>>;
     deleteUserConnection: ({ userId, connectionId, }: {
         userId: string;
         connectionId: string;
-    }) => Promise<number>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<number>;
     deleteUser: ({ userId, }: {
         userId: string;
-    }) => Promise<number>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<number>;
     getConnectionSyncs: ({ userId, connectionId, params, }: {
         userId: string;
         connectionId: string;
         params?: import("./request").SearchParams | undefined;
-    }) => Promise<import("./request").ApiResponse<Syncs.ConnectionSync[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Syncs.ConnectionSync[]>>;
     getUserSyncs: ({ userId, params, }: {
         userId: string;
         params?: import("./request").SearchParams | undefined;
-    }) => Promise<import("./request").ApiResponse<Syncs.ConnectionSync[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Syncs.ConnectionSync[]>>;
     getSync: ({ userId, syncId, }: {
         userId: string;
         syncId: string;
-    }) => Promise<import("./request").ApiResponse<Syncs.ConnectionSync>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Syncs.ConnectionSync>>;
     updateUserConnection: ({ userId, connectionId, expiresAt, }: {
         userId: string;
         connectionId: string;
         expiresAt: string;
-    }) => Promise<number>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<number>;
     getGlobalCounterparties: (params?: Counterparties.GlobalCounterpartiesSearchParams | undefined) => Promise<import("./request").ApiResponse<Counterparties.GlobalCounterparty[]>>;
     listConnections: (query?: {
         clientId?: string | undefined;
@@ -59,93 +59,93 @@ declare const _Moneyhub: (apiClientConfig: ApiClientConfig) => Promise<{
     } | undefined) => Promise<import("./schema/connection").WellKnownConnection[]>;
     getOpenIdConfig: () => Promise<unknown>;
     getTransactions: ({ userId, params, }: {
-        userId: string;
+        userId?: string | undefined;
         params?: Transactions.TransactionSearchParams | undefined;
-    }) => Promise<import("./request").ApiResponse<Transactions.Transaction[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Transactions.Transaction[]>>;
     getTransaction: ({ userId, transactionId, }: {
-        userId: string;
+        userId?: string | undefined;
         transactionId: string;
-    }) => Promise<import("./request").ApiResponse<Transactions.Transaction>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Transactions.Transaction>>;
     addTransaction: ({ userId, transaction, }: {
         userId: string;
         transaction: Transactions.TransactionPost;
-    }) => Promise<import("./request").ApiResponse<Transactions.Transaction>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Transactions.Transaction>>;
     addTransactions: ({ userId, transactions, params, }: {
         userId: string;
         transactions: Transactions.TransactionPost[];
         params?: {
             categorise?: boolean | undefined;
         } | undefined;
-    }) => Promise<import("./request").ApiResponse<{
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<{
         id: string;
     }[]>>;
     updateTransaction: ({ userId, transactionId, transaction, }: {
         userId: string;
         transactionId: string;
         transaction: Partial<Transactions.TransactionPost>;
-    }) => Promise<import("./request").ApiResponse<Transactions.Transaction>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Transactions.Transaction>>;
     deleteTransaction: ({ userId, transactionId, }: {
         userId: string;
         transactionId: string;
-    }) => Promise<import("./request").ApiResponse<number>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<number>>;
     splitTransaction: ({ userId, transactionId, splits, }: {
         userId: string;
         transactionId: string;
         splits: Transactions.TransactionSplitPost[];
-    }) => Promise<import("./request").ApiResponse<Transactions.TransactionSplit[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Transactions.TransactionSplit[]>>;
     getTransactionSplits: ({ userId, transactionId, }: {
-        userId: string;
+        userId?: string | undefined;
         transactionId: string;
-    }) => Promise<import("./request").ApiResponse<Transactions.TransactionSplit[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Transactions.TransactionSplit[]>>;
     patchTransactionSplit: ({ userId, transactionId, splitId, split, }: {
         userId: string;
         transactionId: string;
         splitId: string;
         split: Transactions.TransactionSplitPatch;
-    }) => Promise<import("./request").ApiResponse<Transactions.TransactionSplit[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Transactions.TransactionSplit[]>>;
     deleteTransactionSplits: ({ userId, transactionId, }: {
         userId: string;
         transactionId: string;
-    }) => Promise<number>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<number>;
     addFileToTransaction: ({ userId, transactionId, fileData, fileName, }: {
-        userId: string;
+        userId?: string | undefined;
         transactionId: string;
         fileName: string;
         fileData: any;
-    }) => Promise<import("./request").ApiResponse<Transactions.TransactionFile>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Transactions.TransactionFile>>;
     getTransactionFiles: ({ userId, transactionId, }: {
-        userId: string;
+        userId?: string | undefined;
         transactionId: string;
-    }) => Promise<import("./request").ApiResponse<Transactions.TransactionFile[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Transactions.TransactionFile[]>>;
     getTransactionFile: ({ userId, transactionId, fileId, }: {
-        userId: string;
+        userId?: string | undefined;
         transactionId: string;
         fileId: string;
-    }) => Promise<import("./request").ApiResponse<Transactions.TransactionFile>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Transactions.TransactionFile>>;
     deleteTransactionFile: ({ userId, transactionId, fileId, }: {
-        userId: string;
+        userId?: string | undefined;
         transactionId: string;
         fileId: string;
-    }) => Promise<number>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<number>;
     getTaxReturn: ({ userId, params, }: {
-        userId: string;
+        userId?: string | undefined;
         params?: Taxes.TaxSearchParams | undefined;
-    }) => Promise<import("./request").ApiResponse<Taxes.Tax>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Taxes.Tax>>;
     syncUserConnection: ({ userId, connectionId, customerIpAddress, customerLastLoggedTime, }: {
-        userId: string;
+        userId?: string | undefined;
         connectionId: string;
         customerIpAddress?: string | undefined;
         customerLastLoggedTime?: string | undefined;
-    }) => Promise<import("./request").ApiResponse<Syncs.SyncResponse>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Syncs.SyncResponse>>;
     getStandingOrder: ({ id }: {
         id: string;
-    }) => Promise<import("./request").ApiResponse<StandingOrders.StandingOrderRequest>>;
-    getStandingOrders: (params?: StandingOrders.StandingOrderSearchParams | undefined) => Promise<import("./request").ApiResponse<StandingOrders.StandingOrderRequest[]>>;
-    getSpendingGoals: (params: import("./request").SearchParams, userId: string) => Promise<import("./request").ApiResponse<SpendingGoals.SpendingGoal[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<StandingOrders.StandingOrderRequest>>;
+    getStandingOrders: (params?: StandingOrders.StandingOrderSearchParams | undefined, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<StandingOrders.StandingOrderRequest[]>>;
+    getSpendingGoals: (params: import("./request").SearchParams, userId: string, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<SpendingGoals.SpendingGoal[]>>;
     getSpendingGoal: ({ goalId, userId, }: {
         goalId: string;
         userId: string;
-    }) => Promise<import("./request").ApiResponse<SpendingGoals.SpendingGoal>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<SpendingGoals.SpendingGoal>>;
     createSpendingGoal: ({ categoryId, periodType, periodStart, amount, userId, }: {
         categoryId: string;
         periodType?: ("monthly" | "annual") | undefined;
@@ -154,7 +154,7 @@ declare const _Moneyhub: (apiClientConfig: ApiClientConfig) => Promise<{
             value: number;
         };
         userId: string;
-    }) => Promise<import("./request").ApiResponse<SpendingGoals.SpendingGoal>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<SpendingGoals.SpendingGoal>>;
     updateSpendingGoal: ({ goalId, categoryId, amount, userId, }: {
         goalId: string;
         categoryId?: string | undefined;
@@ -162,13 +162,13 @@ declare const _Moneyhub: (apiClientConfig: ApiClientConfig) => Promise<{
             value: number;
         } | undefined;
         userId: string;
-    }) => Promise<import("./request").ApiResponse<SpendingGoals.SpendingGoal>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<SpendingGoals.SpendingGoal>>;
     deleteSpendingGoal: ({ goalId, userId, }: {
         goalId: string;
         userId: string;
-    }) => Promise<number>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<number>;
     getSpendingAnalysis: ({ userId, dates, accountIds, categoryIds, projectIds, }: {
-        userId: string;
+        userId?: string | undefined;
         dates: {
             name: string;
             from: string;
@@ -177,12 +177,12 @@ declare const _Moneyhub: (apiClientConfig: ApiClientConfig) => Promise<{
         accountIds?: string[] | undefined;
         categoryIds?: string[] | undefined;
         projectIds?: string[] | undefined;
-    }) => Promise<import("./request").ApiResponse<SpendingAnalysis.SpendingAnalysis>>;
-    getSavingsGoals: (params: import("./request").SearchParams, userId: string) => Promise<import("./request").ApiResponse<SavingsGoals.SavingsGoal[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<SpendingAnalysis.SpendingAnalysis>>;
+    getSavingsGoals: (params: import("./request").SearchParams, userId: string, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<SavingsGoals.SavingsGoal[]>>;
     getSavingsGoal: ({ goalId, userId, }: {
         goalId: string;
         userId: string;
-    }) => Promise<import("./request").ApiResponse<SavingsGoals.SavingsGoal>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<SavingsGoals.SavingsGoal>>;
     createSavingsGoal: ({ name, imageUrl, notes, accounts, amount, userId, }: {
         name: string;
         imageUrl?: string | undefined;
@@ -195,7 +195,7 @@ declare const _Moneyhub: (apiClientConfig: ApiClientConfig) => Promise<{
             currency?: string | undefined;
         };
         userId: string;
-    }) => Promise<import("./request").ApiResponse<SavingsGoals.SavingsGoal>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<SavingsGoals.SavingsGoal>>;
     updateSavingsGoal: ({ goalId, name, amount, imageUrl, notes, accounts, userId, }: {
         goalId: string;
         name?: string | undefined;
@@ -208,125 +208,125 @@ declare const _Moneyhub: (apiClientConfig: ApiClientConfig) => Promise<{
             value: number;
         } | undefined;
         userId: string;
-    }) => Promise<import("./request").ApiResponse<SavingsGoals.SavingsGoal>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<SavingsGoals.SavingsGoal>>;
     deleteSavingsGoal: ({ goalId, userId, }: {
         goalId: string;
         userId: string;
-    }) => Promise<number>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<number>;
     getRentalRecords: ({ userId, }: {
         userId: string;
-    }) => Promise<import("./request").ApiResponse<RentalRecords.RentalRecord[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<RentalRecords.RentalRecord[]>>;
     createRentalRecord: ({ userId, rentalData, }: {
         userId: string;
         rentalData: RentalRecords.RentalRecordPost;
-    }) => Promise<import("./request").ApiResponse<RentalRecords.RentalRecord>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<RentalRecords.RentalRecord>>;
     deleteRentalRecord: ({ userId, rentalId, }: {
         userId: string;
         rentalId: string;
-    }) => Promise<number>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<number>;
     getRegularTransactions: ({ userId, params, }: {
-        userId: string;
+        userId?: string | undefined;
         params?: RegularTransactions.RegularTransactionSearchParams | undefined;
-    }) => Promise<import("./request").ApiResponse<RegularTransactions.RegularTransaction[]>>;
-    getRecurringPayments: (params?: Payments.RecurringPaymentSearchParams | undefined) => Promise<import("./request").ApiResponse<Payments.RecurringPaymentRequest[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<RegularTransactions.RegularTransaction[]>>;
+    getRecurringPayments: (params?: Payments.RecurringPaymentSearchParams | undefined, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Payments.RecurringPaymentRequest[]>>;
     getRecurringPayment: ({ recurringPaymentId, }: {
         recurringPaymentId: string;
-    }) => Promise<import("./request").ApiResponse<Payments.RecurringPaymentRequest>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Payments.RecurringPaymentRequest>>;
     makeRecurringPayment: ({ recurringPaymentId, payment, }: {
         recurringPaymentId: string;
         payment: Payments.PaymentsClaims;
-    }) => Promise<import("./request").ApiResponse<Payments.RecurringPaymentRequest>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Payments.RecurringPaymentRequest>>;
     revokeRecurringPayment: ({ recurringPaymentId, }: {
         recurringPaymentId: string;
-    }) => Promise<number>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<number>;
     getProjects: ({ userId, params, }: {
         userId: string;
         params?: import("./request").SearchParams | undefined;
-    }) => Promise<import("./request").ApiResponse<Projects.Project[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Projects.Project[]>>;
     getProject: ({ userId, projectId, }: {
         userId: string;
         projectId: string;
-    }) => Promise<import("./request").ApiResponse<Projects.Project>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Projects.Project>>;
     addProject: ({ userId, project, }: {
         userId: string;
         project: Projects.ProjectPost;
-    }) => Promise<import("./request").ApiResponse<Projects.Project>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Projects.Project>>;
     updateProject: ({ userId, projectId, project, }: {
         userId: string;
         projectId: string;
         project: Projects.ProjectPatch;
-    }) => Promise<import("./request").ApiResponse<Projects.Project>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Projects.Project>>;
     deleteProject: ({ userId, projectId, }: {
         userId: string;
         projectId: string;
-    }) => Promise<number>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<number>;
     getPayment: ({ id }: {
         id: string;
-    }) => Promise<import("./request").ApiResponse<Payments.Payment>>;
-    getPayments: (params?: Payments.PaymentSearchParams | undefined) => Promise<import("./request").ApiResponse<Payments.Payment[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Payments.Payment>>;
+    getPayments: (params?: Payments.PaymentSearchParams | undefined, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Payments.Payment[]>>;
     getPaymentFromIDToken: ({ idToken }: {
         idToken: string;
-    }) => Promise<import("./request").ApiResponse<Payments.Payment>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Payments.Payment>>;
     addPayee: ({ accountNumber, sortCode, name, externalId, userId, }: {
         accountNumber: string;
         sortCode: string;
         name: string;
         externalId?: string | undefined;
         userId?: string | undefined;
-    }) => Promise<import("./request").ApiResponse<Payees.Payee>>;
-    getPayees: (params?: Payees.PayeesSearchParams | undefined) => Promise<import("./request").ApiResponse<Payees.Payee[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Payees.Payee>>;
+    getPayees: (params?: Payees.PayeesSearchParams | undefined, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Payees.Payee[]>>;
     getPayee: ({ id }: {
         id: string;
-    }) => Promise<import("./request").ApiResponse<Payees.Payee>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Payees.Payee>>;
     getCategories: ({ userId, params, }: {
-        userId: string;
+        userId?: string | undefined;
         params?: (import("./request").SearchParams & {
             type?: Categories.CategoryType | undefined;
         }) | undefined;
-    }) => Promise<import("./request").ApiResponse<Categories.Category[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Categories.Category[]>>;
     getStandardCategories: ({ params, }: {
         params?: (import("./request").SearchParams & {
             type?: Categories.CategoryType | undefined;
         }) | undefined;
-    }) => Promise<import("./request").ApiResponse<Categories.Category[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Categories.Category[]>>;
     getCategory: ({ userId, categoryId, params, }: {
-        userId: string;
+        userId?: string | undefined;
         categoryId: string;
         params?: {
             type?: Categories.CategoryType | undefined;
         } | undefined;
-    }) => Promise<import("./request").ApiResponse<Categories.Category>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Categories.Category>>;
     getCategoryGroups: ({ userId, params, }: {
-        userId: string;
+        userId?: string | undefined;
         params?: {
             type?: Categories.CategoryType | undefined;
         } | undefined;
-    }) => Promise<import("./request").ApiResponse<Categories.CategoryGroup[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Categories.CategoryGroup[]>>;
     getStandardCategoryGroups: ({ params, }: {
         params?: {
             type?: Categories.CategoryType | undefined;
         } | undefined;
-    }) => Promise<import("./request").ApiResponse<Categories.CategoryGroup[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Categories.CategoryGroup[]>>;
     createCustomCategory: ({ userId, category, }: {
-        userId: string;
+        userId?: string | undefined;
         category: Categories.CategoryPost;
-    }) => Promise<import("./request").ApiResponse<Categories.Category>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Categories.Category>>;
     getBeneficiary: ({ id, userId, }: {
         id: string;
-        userId: string;
-    }) => Promise<import("./request").ApiResponse<Beneficiaries.Beneficiary>>;
+        userId?: string | undefined;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Beneficiaries.Beneficiary>>;
     getBeneficiaryWithDetail: ({ id, userId, }: {
         id: string;
-        userId: string;
-    }) => Promise<import("./request").ApiResponse<Beneficiaries.BeneficiaryWithDetails>>;
+        userId?: string | undefined;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Beneficiaries.BeneficiaryWithDetails>>;
     getBeneficiaries: ({ params, userId, }: {
         params?: import("./request").SearchParams | undefined;
-        userId: string;
-    }) => Promise<import("./request").ApiResponse<Beneficiaries.Beneficiary[]>>;
+        userId?: string | undefined;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Beneficiaries.Beneficiary[]>>;
     getBeneficiariesWithDetail: ({ params, userId, }: {
         params?: import("./request").SearchParams | undefined;
-        userId: string;
-    }) => Promise<import("./request").ApiResponse<Beneficiaries.BeneficiaryWithDetails[]>>;
+        userId?: string | undefined;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Beneficiaries.BeneficiaryWithDetails[]>>;
     createAuthRequest: ({ redirectUri, userId, scope, connectionId, payment, standingOrder, recurringPayment, reversePayment, categorisationType, benefitsCheck, counterpartiesCheck, permissions, expirationDateTime, transactionsFromDateTime, sync, }: {
         redirectUri?: string | undefined;
         userId?: string | undefined;
@@ -345,101 +345,101 @@ declare const _Moneyhub: (apiClientConfig: ApiClientConfig) => Promise<{
         sync?: {
             enableAsync?: boolean | undefined;
         } | undefined;
-    }) => Promise<import("./request").ApiResponse<AuthRequests.AuthRequest>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<AuthRequests.AuthRequest>>;
     completeAuthRequest: ({ id, authParams, }: {
         id: string;
         authParams: AuthRequests.AuthParams;
-    }) => Promise<import("./request").ApiResponse<AuthRequests.AuthRequest>>;
-    getAllAuthRequests: (params?: import("./request").SearchParams | undefined) => Promise<import("./request").ApiResponse<AuthRequests.AuthRequest[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<AuthRequests.AuthRequest>>;
+    getAllAuthRequests: (params?: import("./request").SearchParams | undefined, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<AuthRequests.AuthRequest[]>>;
     getAuthRequest: ({ id }: {
         id: string;
-    }) => Promise<import("./request").ApiResponse<AuthRequests.AuthRequest>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<AuthRequests.AuthRequest>>;
     createAffordability: ({ userId }: {
         userId: string;
-    }) => Promise<import("./request").ApiResponse<Affordability.Affordability>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Affordability.Affordability>>;
     getAffordability: ({ userId, id }: {
         userId: string;
         id: string;
-    }) => Promise<import("./request").ApiResponse<Affordability.Affordability>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Affordability.Affordability>>;
     getAllAffordability: ({ userId, ...query }: {
         userId: string;
-    } & import("./request").SearchParams) => Promise<import("./request").ApiResponse<Affordability.AffordabilityMetadata[]>>;
-    getAccounts: ({ userId }: {
-        userId: string;
+    } & import("./request").SearchParams, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Affordability.AffordabilityMetadata[]>>;
+    getAccounts: ({ userId, params }: {
+        userId?: string | undefined;
         params?: import("./request").SearchParams | undefined;
-    }) => Promise<import("./request").ApiResponse<Accounts.Account[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Accounts.Account[]>>;
     getAccountsWithDetails: ({ userId, }: {
-        userId: string;
+        userId?: string | undefined;
         params?: import("./request").SearchParams | undefined;
-    }) => Promise<import("./request").ApiResponse<Accounts.AccountWithDetails[]>>;
-    getAccountsList: ({ userId }: {
-        userId: string;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Accounts.AccountWithDetails[]>>;
+    getAccountsList: ({ userId, params }: {
+        userId?: string | undefined;
         params?: import("./request").SearchParams | undefined;
-    }) => Promise<import("./request").ApiResponse<Accounts.Account[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Accounts.Account[]>>;
     getAccountsListWithDetails: ({ userId, }: {
-        userId: string;
+        userId?: string | undefined;
         params?: import("./request").SearchParams | undefined;
-    }) => Promise<import("./request").ApiResponse<Accounts.AccountWithDetails[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Accounts.AccountWithDetails[]>>;
     getAccount: ({ userId, accountId }: {
-        userId: string;
+        userId?: string | undefined;
         accountId: string;
-    }) => Promise<import("./request").ApiResponse<Accounts.Account>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Accounts.Account>>;
     getAccountBalances: ({ userId, accountId, }: {
-        userId: string;
+        userId?: string | undefined;
         accountId: string;
-    }) => Promise<import("./request").ApiResponse<Balances.Balance[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Balances.Balance[]>>;
     getAccountWithDetails: ({ userId, accountId, }: {
-        userId: string;
+        userId?: string | undefined;
         accountId: string;
-    }) => Promise<import("./request").ApiResponse<Accounts.AccountWithDetails>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Accounts.AccountWithDetails>>;
     getAccountHoldings: ({ userId, accountId, }: {
-        userId: string;
+        userId?: string | undefined;
         accountId: string;
-    }) => Promise<import("./request").ApiResponse<Holdings.HoldingsValuation[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Holdings.HoldingsValuation[]>>;
     getAccountHoldingsWithMatches: ({ userId, accountId, }: {
-        userId: string;
+        userId?: string | undefined;
         accountId: string;
-    }) => Promise<import("./request").ApiResponse<Holdings.HoldingWithMatches[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Holdings.HoldingWithMatches[]>>;
     getAccountCounterparties: ({ userId, accountId, }: {
-        userId: string;
+        userId?: string | undefined;
         accountId: string;
         params?: import("./request").SearchParams | undefined;
-    }) => Promise<import("./request").ApiResponse<Counterparties.Counterparty[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Counterparties.Counterparty[]>>;
     getAccountRecurringTransactions: ({ userId, accountId, }: {
-        userId: string;
+        userId?: string | undefined;
         accountId: string;
-    }) => Promise<import("./request").ApiResponse<Transactions.RecurringTransactionEstimate[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Transactions.RecurringTransactionEstimate[]>>;
     getAccountStandingOrders: ({ userId, accountId, }: {
-        userId: string;
+        userId?: string | undefined;
         accountId: string;
-    }) => Promise<import("./request").ApiResponse<StandingOrders.StandingOrder[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<StandingOrders.StandingOrder[]>>;
     createAccount: ({ userId, account }: {
         userId: string;
         account: Accounts.AccountPost;
-    }) => Promise<import("./request").ApiResponse<Accounts.Account>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Accounts.Account>>;
     deleteAccount: ({ userId, accountId }: {
         userId: string;
         accountId: string;
-    }) => Promise<number>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<number>;
     getAccountHolding: ({ userId, accountId, holdingId, }: {
-        userId: string;
+        userId?: string | undefined;
         accountId: string;
         holdingId: string;
-    }) => Promise<import("./request").ApiResponse<Holdings.HoldingWithMatchesAndHistory>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Holdings.HoldingWithMatchesAndHistory>>;
     getAccountStandingOrdersWithDetail: ({ userId, accountId, }: {
-        userId: string;
+        userId?: string | undefined;
         accountId: string;
-    }) => Promise<import("./request").ApiResponse<StandingOrders.StandingOrderWithDetail[]>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<StandingOrders.StandingOrderWithDetail[]>>;
     addAccountBalance: ({ userId, accountId, balance }: {
         userId: string;
         accountId: string;
         balance: Accounts.AccountBalancePost;
-    }) => Promise<import("./request").ApiResponse<Accounts.AccountBalancePost>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Accounts.AccountBalancePost>>;
     updateAccount: ({ userId, accountId, account }: {
         userId: string;
         accountId: string;
         account: Accounts.AccountPatch;
-    }) => Promise<import("./request").ApiResponse<Accounts.AccountWithDetails>>;
+    }, options?: import("./request").ExtraOptions | undefined) => Promise<import("./request").ApiResponse<Accounts.AccountWithDetails>>;
     exchangeCodeForTokensLegacy: ({ state, code, nonce, id_token, }: {
         state: string;
         code: string;

package/dist/request.d.ts

@@ -1,4 +1,4 @@
-import { Options } from "got";
+import { Options, Headers } from "got";
 import { Client } from "openid-client";
 import type { ApiClientConfig } from "./schema/config";
 interface RequestOptions extends Pick<Options, "method" | "headers" | "searchParams" | "json" | "form"> {
@@ -10,6 +10,7 @@ interface RequestOptions extends Pick<Options, "method" | "headers" | "searchPar
         scope: string;
         sub?: string;
     };
+    options?: ExtraOptions;
 }
 interface Links {
     next?: string;
@@ -33,6 +34,10 @@ export interface ApiResponse<T> {
     links?: Links;
     meta?: object;
 }
+export interface ExtraOptions {
+    token?: string;
+    headers?: Headers;
+}
 declare const _default: ({ client, options: { timeout }, }: {
     client: Client;
     options: {

package/dist/request.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../src/request.ts"],"names":[],"mappings":"AAAA,OAAY,EAAC,OAAO,EAAC,MAAM,KAAK,CAAA;AAChC,OAAO,EAAC,MAAM,EAAC,MAAM,eAAe,CAAA;AAIpC,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,iBAAiB,CAAA;AAEpD,UAAU,cAAe,SAAQ,IAAI,CAAC,OAAO,EAAE,QAAQ,GAAG,SAAS,GAAG,cAAc,GAAG,MAAM,GAAG,MAAM,CAAC;IACrG,YAAY,CAAC,EAAE,GAAG,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC1B,QAAQ,CAAC,EAAE,GAAG,CAAA;IACd,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,EAAE,CAAC,EAAE;QACH,KAAK,EAAE,MAAM,CAAA;QACb,GAAG,CAAC,EAAE,MAAM,CAAA;KACb,CAAA;CACF;AAED,UAAU,KAAK;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;CACb;AAED,oBAAY,OAAO,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,KAAK,OAAO,CAAC,CAAC,CAAC,CAAA;AAE3E,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,eAAe,CAAA;IACvB,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED,MAAM,WAAW,WAAW,CAAC,CAAC;IAC5B,IAAI,EAAE,CAAC,CAAA;IACP,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;;YA8BS,MAAM;;;;eAKT,MAAM,SACL,cAAc;AAVtB,wBAgDC"}
+{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../src/request.ts"],"names":[],"mappings":"AAAA,OAAY,EAAC,OAAO,EAAE,OAAO,EAA4B,MAAM,KAAK,CAAA;AACpE,OAAO,EAAC,MAAM,EAAC,MAAM,eAAe,CAAA;AAIpC,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,iBAAiB,CAAA;AAEpD,UAAU,cAAe,SAAQ,IAAI,CAAC,OAAO,EAAE,QAAQ,GAAG,SAAS,GAAG,cAAc,GAAG,MAAM,GAAG,MAAM,CAAC;IACrG,YAAY,CAAC,EAAE,GAAG,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC1B,QAAQ,CAAC,EAAE,GAAG,CAAA;IACd,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,EAAE,CAAC,EAAE;QACH,KAAK,EAAE,MAAM,CAAA;QACb,GAAG,CAAC,EAAE,MAAM,CAAA;KACb,CAAA;IACD,OAAO,CAAC,EAAE,YAAY,CAAA;CACvB;AAED,UAAU,KAAK;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;CACb;AAED,oBAAY,OAAO,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,KAAK,OAAO,CAAC,CAAC,CAAC,CAAA;AAE3E,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,eAAe,CAAA;IACvB,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED,MAAM,WAAW,WAAW,CAAC,CAAC;IAC5B,IAAI,EAAE,CAAC,CAAA;IACP,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;;YA8BS,MAAM;;;;eAMT,MAAM,SACL,cAAc;AAXtB,wBAyDC"}

package/dist/request.js

@@ -48,19 +48,26 @@ const attachErrorDetails = (err) => {
     throw err;
 };
 exports.default = ({ client, options: { timeout }, }) => async (url, opts = {}) => {
+    var _a, _b, _c;
     const gotOpts = {
         method: opts.method || "GET",
         headers: opts.headers || {},
         searchParams: query_string_1.default.stringify(opts.searchParams),
         timeout,
     };
-    if (opts.cc) {
+    if ((_a = opts.options) === null || _a === void 0 ? void 0 : _a.token) {
+        gotOpts.headers = R.assoc("Authorization", `Bearer ${opts.options.token}`, gotOpts.headers);
+    }
+    if ((_b = opts.options) === null || _b === void 0 ? void 0 : _b.headers) {
+        gotOpts.headers = R.mergeDeepRight(gotOpts.headers || {}, opts.options.headers);
+    }
+    if (!((_c = gotOpts.headers) === null || _c === void 0 ? void 0 : _c.Authorization) && opts.cc) {
         const { access_token } = await client.grant({
             grant_type: "client_credentials",
             scope: opts.cc.scope,
             sub: opts.cc.sub,
         });
-        gotOpts.headers.Authorization = `Bearer ${access_token}`;
+        gotOpts.headers = R.assoc("Authorization", `Bearer ${access_token}`, gotOpts.headers);
     }
     if (opts.body) {
         gotOpts.json = opts.body;