atrium

func (*APIClient) ChangeBasePath ¶

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

func (*AccountsApiService) ListAccountTransactions ¶

func (a *AccountsApiService) ListAccountTransactions(ctx context.Context, accountGUID string, userGUID string, localVarOptionals *ListAccountTransactionsOpts) (TransactionsResponseBody, *http.Response, error)

func (*AccountsApiService) ListUserAccounts ¶

func (a *AccountsApiService) ListUserAccounts(ctx context.Context, userGUID string, localVarOptionals *ListUserAccountsOpts) (AccountsResponseBody, *http.Response, error)

func (*AccountsApiService) ReadAccount ¶

func (a *AccountsApiService) ReadAccount(ctx context.Context, accountGUID string, userGUID string) (AccountResponseBody, *http.Response, error)

AccountsApiService Read an account Reading an account allows you to get information about a specific account that belongs to a user. That includes the account type — e.g., CHECKING, MONEY_MARKET, or PROPERTY — the balance, the date the account was started, and much more.<br> There are two endpoints for reading an account. Both will return the same information.<br> It's important to remember that balance and available_balance will normally be positive numbers — for all account types. But this should be interpreted differently for debt accounts and asset accounts.<br> An asset account, e.g., CHECKING, SAVINGS, or INVESTMENT, will have a positive balance unless it is in an overdraft condition, in which case the balance will be negative.<br> On the other hand, a debt account, e.g., CREDIT CARD, LOAN, MORTGAGE, would have a positivebalance when the user owes money on the account. It would have a negative balance if the account has been overpaid.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param accountGUID The unique identifier for an `account`.
• @param userGUID The unique identifier for a `user`.

@return AccountResponseBody

func (*AccountsApiService) ReadAccountByMemberGUID ¶

func (a *AccountsApiService) ReadAccountByMemberGUID(ctx context.Context, accountGUID string, memberGUID string, userGUID string) (AccountResponseBody, *http.Response, error)

AccountsApiService Read an account Reading an account allows you to get information about a specific account that belongs to a user. That includes the account type — e.g., CHECKING, MONEY_MARKET, or PROPERTY — the balance, the date the account was started, and much more.<br> There are two endpoints for reading an account. Both will return the same information.<br> It's important to remember that balance and available_balance will normally be positive numbers — for all account types. But this should be interpreted differently for debt accounts and asset accounts.<br> An asset account, e.g., CHECKING, SAVINGS, or INVESTMENT, will have a positive balance unless it is in an overdraft condition, in which case the balance will be negative.<br> On the other hand, a debt account, e.g., CREDIT CARD, LOAN, MORTGAGE, would have a positivebalance when the user owes money on the account. It would have a negative balance if the account has been overpaid.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param accountGUID The unique identifier for an `account`.
• @param memberGUID The unique identifier for a `member`.
• @param userGUID The unique identifier for a `user`.

@return AccountResponseBody

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

func (*ConnectWidgetApiService) GetConnectWidget ¶

func (a *ConnectWidgetApiService) GetConnectWidget(ctx context.Context, userGUID string, body ConnectWidgetRequestBody) (ConnectWidgetResponseBody, *http.Response, error)

ConnectWidgetApiService Embedding in a website This endpoint will return a URL for an embeddable version of MX Connect.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param userGUID The unique identifier for a `user`.
• @param body Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials)

@return ConnectWidgetResponseBody

func (GenericError) Body ¶

func (e GenericError) Body() []byte

Body returns the raw bytes of the response

func (GenericError) Error ¶

func (e GenericError) Error() string

Error returns non-empty string if there was an error.

func (GenericError) Model ¶

func (e GenericError) Model() interface{}

Model returns the unpacked model of the error

func (*HoldingsApiService) ListHoldings ¶

func (a *HoldingsApiService) ListHoldings(ctx context.Context, userGUID string) (HoldingsResponseBody, *http.Response, error)

HoldingsApiService List holdings Use this endpoint to read all holdings associated with a specific user.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param userGUID The unique identifier for a `user`.

@return HoldingsResponseBody

func (*HoldingsApiService) ListHoldingsByAccount ¶

func (a *HoldingsApiService) ListHoldingsByAccount(ctx context.Context, accountGUID string, userGUID string) (HoldingsResponseBody, *http.Response, error)

HoldingsApiService List holdings by account Use this endpoint to read all holdings associated with a specific account.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param accountGUID The unique identifier for an `account`.
• @param userGUID The unique identifier for a `user`.

@return HoldingsResponseBody

func (*HoldingsApiService) ListHoldingsByMember ¶

func (a *HoldingsApiService) ListHoldingsByMember(ctx context.Context, memberGUID string, userGUID string) (HoldingsResponseBody, *http.Response, error)

HoldingsApiService List holdings by member Use this endpoint to read all holdings associated with a specific member.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param memberGUID The unique identifier for a `member`.
• @param userGUID The unique identifier for a `user`.

@return HoldingsResponseBody

func (*HoldingsApiService) ReadHolding ¶

func (a *HoldingsApiService) ReadHolding(ctx context.Context, holdingGUID string, userGUID string) (HoldingResponseBody, *http.Response, error)

HoldingsApiService Read holding Use this endpoint to read the attributes of a specific holding.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param holdingGUID The unique identifier for a `holding`.
• @param userGUID The unique identifier for a `user`.

@return HoldingResponseBody

func (*IdentityApiService) IdentifyMember ¶

func (a *IdentityApiService) IdentifyMember(ctx context.Context, memberGUID string, userGUID string) (MemberResponseBody, *http.Response, error)

IdentityApiService Identify The identify endpoint begins an identification process for an already-existing member.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param memberGUID The unique identifier for a `member`.
• @param userGUID The unique identifier for a `user`.

@return MemberResponseBody

func (*IdentityApiService) ListAccountOwners ¶

func (a *IdentityApiService) ListAccountOwners(ctx context.Context, memberGUID string, userGUID string) (AccountOwnersResponseBody, *http.Response, error)

IdentityApiService List member account owners This endpoint returns an array with information about every account associated with a particular member.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param memberGUID The unique identifier for a `member`.
• @param userGUID The unique identifier for a `user`.

@return AccountOwnersResponseBody

func (*InstitutionsApiService) ListInstitutions ¶

func (a *InstitutionsApiService) ListInstitutions(ctx context.Context, localVarOptionals *ListInstitutionsOpts) (InstitutionsResponseBody, *http.Response, error)

func (*InstitutionsApiService) ReadInstitution ¶

func (a *InstitutionsApiService) ReadInstitution(ctx context.Context, institutionCode string) (InstitutionResponseBody, *http.Response, error)

InstitutionsApiService Read institution This endpoint allows you to see information for a specific institution.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param institutionCode The institution_code of the institution.

@return InstitutionResponseBody

func (*InstitutionsApiService) ReadInstitutionCredentials ¶

func (a *InstitutionsApiService) ReadInstitutionCredentials(ctx context.Context, institutionCode string) (CredentialsResponseBody, *http.Response, error)

InstitutionsApiService Read institution credentials Use this endpoint to see which credentials will be needed to create a member for a specific institution.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param institutionCode The institution_code of the institution.

@return CredentialsResponseBody

func (*MembersApiService) AggregateMember ¶

func (a *MembersApiService) AggregateMember(ctx context.Context, memberGUID string, userGUID string) (MemberResponseBody, *http.Response, error)

MembersApiService Aggregate member Calling this endpoint initiates an aggregation event for the member. This brings in the latest account and transaction data from the connected institution. If this data has recently been updated, MX may not initiate an aggregation event.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param memberGUID The unique identifier for a `member`.
• @param userGUID The unique identifier for a `user`.

@return MemberResponseBody

func (*MembersApiService) AggregateMemberBalances ¶

func (a *MembersApiService) AggregateMemberBalances(ctx context.Context, memberGUID string, userGUID string) (MemberResponseBody, *http.Response, error)

MembersApiService Aggregate member account balances This endpoint operates much like the _aggregate member_ endpoint except that it gathers only account balance information; it does not gather any transaction data at all.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param memberGUID The unique identifier for a `member`.
• @param userGUID The unique identifier for a `user`.

@return MemberResponseBody

func (*MembersApiService) CreateMember ¶

func (a *MembersApiService) CreateMember(ctx context.Context, userGUID string, body MemberCreateRequestBody) (MemberResponseBody, *http.Response, error)

MembersApiService Create member This endpoint allows you to create a new member. Members are created with the required parameters credentials and institution_code, and the optional parameters identifier and metadata.<br> When creating a member, you'll need to include the correct type of credential required by the financial institution and provided by the user. You can find out which credential type is required with the /institutions/{institution_code}/credentials endpoint.<br> If successful, Atrium will respond with the newly-created member object.<br> Once you successfully create a member, MX will immediately validate the provided credentials and attempt to aggregate data for accounts and transactions.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param userGUID The unique identifier for a `user`.
• @param body Member object to be created with optional parameters (identifier and metadata) and required parameters (credentials and institution_code)

@return MemberResponseBody

func (*MembersApiService) DeleteMember ¶

func (a *MembersApiService) DeleteMember(ctx context.Context, memberGUID string, userGUID string) (*http.Response, error)

MembersApiService Delete member Accessing this endpoint will permanently delete a member.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param memberGUID The unique identifier for a `member`.
• @param userGUID The unique identifier for a `user`.

func (*MembersApiService) ExtendHistory ¶

func (a *MembersApiService) ExtendHistory(ctx context.Context, memberGUID string, userGUID string) (MemberResponseBody, *http.Response, error)

MembersApiService Extend history The extend_history endpoint begins the process of fetching up to 24 months of data associated with a particular `member`.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param memberGUID The unique identifier for a `member`.
• @param userGUID The unique identifier for a `user`.

@return MemberResponseBody

func (*MembersApiService) ListMemberAccounts ¶

func (a *MembersApiService) ListMemberAccounts(ctx context.Context, memberGUID string, userGUID string, localVarOptionals *ListMemberAccountsOpts) (AccountsResponseBody, *http.Response, error)

func (*MembersApiService) ListMemberCredentials ¶

func (a *MembersApiService) ListMemberCredentials(ctx context.Context, memberGUID string, userGUID string) (CredentialsResponseBody, *http.Response, error)

MembersApiService List member credentials This endpoint returns an array which contains information on every non-MFA credential associated with a specific member.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param memberGUID The unique identifier for a `member`.
• @param userGUID The unique identifier for a `user`.

@return CredentialsResponseBody

func (*MembersApiService) ListMemberMFAChallenges ¶

func (a *MembersApiService) ListMemberMFAChallenges(ctx context.Context, memberGUID string, userGUID string) (ChallengesResponseBody, *http.Response, error)

MembersApiService List member MFA challenges Use this endpoint for information on what multi-factor authentication challenges need to be answered in order to aggregate a member.<br> If the aggregation is not challenged, i.e., the member does not have a connection status of CHALLENGED, then code 204 No Content will be returned.<br> If the aggregation has been challenged, i.e., the member does have a connection status of CHALLENGED, then code 200 OK will be returned — along with the corresponding credentials.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param memberGUID The unique identifier for a `member`.
• @param userGUID The unique identifier for a `user`.

@return ChallengesResponseBody

func (*MembersApiService) ListMemberTransactions ¶

func (a *MembersApiService) ListMemberTransactions(ctx context.Context, memberGUID string, userGUID string, localVarOptionals *ListMemberTransactionsOpts) (TransactionsResponseBody, *http.Response, error)

func (*MembersApiService) ListMembers ¶

func (a *MembersApiService) ListMembers(ctx context.Context, userGUID string, localVarOptionals *ListMembersOpts) (MembersResponseBody, *http.Response, error)

func (*MembersApiService) ReadMember ¶

func (a *MembersApiService) ReadMember(ctx context.Context, memberGUID string, userGUID string) (MemberResponseBody, *http.Response, error)

MembersApiService Read member Use this endpoint to read the attributes of a specific member.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param memberGUID The unique identifier for a `member`.
• @param userGUID The unique identifier for a `user`.

@return MemberResponseBody

func (*MembersApiService) ReadMemberStatus ¶

func (a *MembersApiService) ReadMemberStatus(ctx context.Context, memberGUID string, userGUID string) (MemberConnectionStatusResponseBody, *http.Response, error)

MembersApiService Read member connection status This endpoint provides the status of the member's most recent aggregation event. This is an important step in the aggregation process, and the results returned by this endpoint should determine what you do next in order to successfully aggregate a member.<br> MX has introduced new, more detailed information on the current status of a member's connection to a financial institution and the state of its aggregation: the connection_status field. These are intended to replace and expand upon the information provided in the status field, which will soon be deprecated; support for the status field remains for the time being.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param memberGUID The unique identifier for a `member`.
• @param userGUID The unique identifier for a `user`.

@return MemberConnectionStatusResponseBody

func (*MembersApiService) ResumeMember ¶

func (a *MembersApiService) ResumeMember(ctx context.Context, memberGUID string, userGUID string, body MemberResumeRequestBody) (MemberResponseBody, *http.Response, error)

MembersApiService Resume aggregation from MFA This endpoint answers the challenges needed when a member has been challenged by multi-factor authentication.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param memberGUID The unique identifier for a `member`.
• @param userGUID The unique identifier for a `user`.
• @param body Member object with MFA challenge answers

@return MemberResponseBody

func (*MembersApiService) UpdateMember ¶

func (a *MembersApiService) UpdateMember(ctx context.Context, memberGUID string, userGUID string, localVarOptionals *UpdateMemberOpts) (MemberResponseBody, *http.Response, error)

func (*MerchantsApiService) ReadMerchant ¶

func (a *MerchantsApiService) ReadMerchant(ctx context.Context, merchantGUID string) (MerchantResponseBody, *http.Response, error)

MerchantsApiService Read merchant Returns information about a particular merchant, such as a logo, name, and website.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param merchantGUID The unique identifier for a `merchant`.

@return MerchantResponseBody

func (*StatementsApiService) DownloadStatementPdf ¶

func (a *StatementsApiService) DownloadStatementPdf(ctx context.Context, memberGUID string, userGUID string, statementGUID string) (*os.File, *http.Response, error)

StatementsApiService Download statement PDF Use this endpoint to download a specified statement. The endpoint URL is the same as the URI given in each `statement` object.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param memberGUID The unique identifier for a `member`.
• @param userGUID The unique identifier for a `user`.
• @param statementGUID The unique identifier for an `statement`.

@return *os.File

func (*StatementsApiService) FetchStatements ¶

func (a *StatementsApiService) FetchStatements(ctx context.Context, memberGUID string, userGUID string) (MemberResponseBody, *http.Response, error)

StatementsApiService Fetch statements The fetch statements endpoint begins fetching statements for a member.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param memberGUID The unique identifier for a `member`.
• @param userGUID The unique identifier for a `user`.

@return MemberResponseBody

func (*StatementsApiService) ListMemberStatements ¶

func (a *StatementsApiService) ListMemberStatements(ctx context.Context, memberGUID string, userGUID string, localVarOptionals *ListMemberStatementsOpts) (StatementsResponseBody, *http.Response, error)

func (*StatementsApiService) ReadMemberStatement ¶

func (a *StatementsApiService) ReadMemberStatement(ctx context.Context, memberGUID string, userGUID string, statementGUID string) (StatementResponseBody, *http.Response, error)

StatementsApiService Read statement JSON Use this endpoint to download a specified statement. The endpoint URL is the same as the URI given in each `statement` object.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param memberGUID The unique identifier for a `member`.
• @param userGUID The unique identifier for a `user`.
• @param statementGUID The unique identifier for an `statement`.

@return StatementResponseBody

func (*TransactionsApiService) CleanseAndCategorizeTransactions ¶

func (a *TransactionsApiService) CleanseAndCategorizeTransactions(ctx context.Context, body TransactionsCleanseAndCategorizeRequestBody) (TransactionsCleanseAndCategorizeResponseBody, *http.Response, error)

TransactionsApiService Categorize transactions Use this endpoint to categorize, cleanse, and classify transactions. These transactions are not persisted or stored on the MX platform.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body User object to be created with optional parameters (amount, type) amd required parameters (description, identifier)

@return TransactionsCleanseAndCategorizeResponseBody

func (*TransactionsApiService) ListUserTransactions ¶

func (a *TransactionsApiService) ListUserTransactions(ctx context.Context, userGUID string, localVarOptionals *ListUserTransactionsOpts) (TransactionsResponseBody, *http.Response, error)

func (*TransactionsApiService) ReadTransaction ¶

func (a *TransactionsApiService) ReadTransaction(ctx context.Context, transactionGUID string, userGUID string) (TransactionResponseBody, *http.Response, error)

TransactionsApiService Read a transaction This endpoint allows you to view information about a specific transaction that belongs to a user.<br>

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param transactionGUID The unique identifier for a `transaction`.
• @param userGUID The unique identifier for a `user`.

@return TransactionResponseBody

func (*UsersApiService) CreateUser ¶

func (a *UsersApiService) CreateUser(ctx context.Context, body UserCreateRequestBody) (UserResponseBody, *http.Response, error)

UsersApiService Create user Call this endpoint to create a new user. Atrium will respond with the newly-created user object if successful. This endpoint accepts several parameters: identifier, metadata, and is_disabled.<br> Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that user's data until they are no longer disabled. Users who are disabled for the entirety of an Atrium billing period will not be factored into that month's bill.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body User object to be created with optional parameters (identifier, is_disabled, metadata)

@return UserResponseBody

func (*UsersApiService) DeleteUser ¶

func (a *UsersApiService) DeleteUser(ctx context.Context, userGUID string) (*http.Response, error)

UsersApiService Delete user Calling this endpoint will permanently delete a user from Atrium. If successful, the API will respond with Status: 204 No Content.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param userGUID The unique identifier for a `user`.

func (*UsersApiService) ListUsers ¶

func (a *UsersApiService) ListUsers(ctx context.Context, localVarOptionals *ListUsersOpts) (UsersResponseBody, *http.Response, error)

func (*UsersApiService) ReadUser ¶

func (a *UsersApiService) ReadUser(ctx context.Context, userGUID string) (UserResponseBody, *http.Response, error)

UsersApiService Read user Use this endpoint to read the attributes of a specific user.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param userGUID The unique identifier for a `user`.

@return UserResponseBody

func (*UsersApiService) UpdateUser ¶

func (a *UsersApiService) UpdateUser(ctx context.Context, userGUID string, localVarOptionals *UpdateUserOpts) (UserResponseBody, *http.Response, error)

func (*VerificationApiService) ListAccountNumbers ¶

func (a *VerificationApiService) ListAccountNumbers(ctx context.Context, memberGUID string, userGUID string) (AccountNumbersResponseBody, *http.Response, error)

VerificationApiService Read account numbers Use this endpoint to check whether account and routing numbers are available for accounts associated with a particular member. It returns the account_numbers object, which contains account and routing number data for each account associated with the member.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param memberGUID The unique identifier for a `member`.
• @param userGUID The unique identifier for a `user`.

@return AccountNumbersResponseBody

func (*VerificationApiService) ListAccountNumbersByAccount ¶

func (a *VerificationApiService) ListAccountNumbersByAccount(ctx context.Context, accountGUID string, userGUID string) (AccountNumbersResponseBody, *http.Response, error)

VerificationApiService Read account numbers by account GUID Use this endpoint to check whether account and routing numbers are available for a specific account. It returns the account_numbers object, which contains account and routing number data.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param accountGUID The unique identifier for an `account`.
• @param userGUID The unique identifier for a `user`.

@return AccountNumbersResponseBody

func (*VerificationApiService) VerifyMember ¶

func (a *VerificationApiService) VerifyMember(ctx context.Context, memberGUID string, userGUID string) (MemberResponseBody, *http.Response, error)

VerificationApiService Verify The verify endpoint begins a verification process for a member.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param memberGUID The unique identifier for a `member`.
• @param userGUID The unique identifier for a `user`.

@return MemberResponseBody