Class UserAccountsApi

Hierarchy

UserAccountsApi

Index

Constructors

Properties

Methods

archive replace

Constructors

constructor

new UserAccountsApi(configuration, requestFactory?, responseProcessor?): UserAccountsApi
Parameters
- configuration: Configuration
- Optional requestFactory: UserAccountsApiRequestFactory
- Optional responseProcessor: UserAccountsApiResponseProcessor
Returns UserAccountsApi
- Defined in codegen/crm/extensions/accounting/types/PromiseAPI.ts:291

Properties

`Private` api

api: ObservableUserAccountsApi

Methods

archive

archive(accountId, _options?): Promise<void>
Deletes a user account from HubSpot, meaning that HubSpot will no longer send requests to the external accounting system for this user. Delete user account
Parameters
- accountId: string
  
  The ID of the user account to delete.
- Optional _options: Configuration
Returns Promise<void>
- Defined in codegen/crm/extensions/accounting/types/PromiseAPI.ts:304

replace

replace(createUserAccountRequestExternal, _options?): Promise<void>
Creates an account which contains the information about the account in the external accounting system. This must be called after a user connects their HubSpot account to the external accounting system, as there is no other way for HubSpot to obtain the external account details. Create a user account
Parameters
- createUserAccountRequestExternal: CreateUserAccountRequestExternal
  
  The external accounting system user account information.
- Optional _options: Configuration
Returns Promise<void>
- Defined in codegen/crm/extensions/accounting/types/PromiseAPI.ts:314

Generated using TypeDoc