Class BusinessUnitApi

Index

Constructors

Methods

getByUserID getByUserIDWithHttpInfo

Constructors

constructor

new BusinessUnitApi(configuration, requestFactory?, responseProcessor?): BusinessUnitApi
Parameters
- configuration: Configuration<ObservableMiddleware>
- OptionalrequestFactory: BusinessUnitApiRequestFactory
- OptionalresponseProcessor: BusinessUnitApiResponseProcessor
Returns BusinessUnitApi
- Defined in codegen/settings/business_units/types/PromiseAPI.ts:12

Methods

getByUserID

getByUserID(userId, properties?, name?, _options?): Promise<CollectionResponsePublicBusinessUnitNoPaging>
Get Business Units identified by userId. The userId refers to the user’s ID. Get Business Units for a user
Parameters
- userId: string
  Identifier of user to retrieve.
- Optionalproperties: string[]
  The names of properties to optionally include in the response body. The only valid value is `logoMetadata`.
- Optionalname: string[]
  The names of Business Units to retrieve. If empty or not provided, then all associated Business Units will be returned.
- Optional_options: PromiseConfigurationOptions
Returns Promise<CollectionResponsePublicBusinessUnitNoPaging>
- Defined in codegen/settings/business_units/types/PromiseAPI.ts:51

getByUserIDWithHttpInfo

getByUserIDWithHttpInfo(userId, properties?, name?, _options?): Promise<HttpInfo<CollectionResponsePublicBusinessUnitNoPaging>>
Get Business Units identified by userId. The userId refers to the user’s ID. Get Business Units for a user
Parameters
- userId: string
  Identifier of user to retrieve.
- Optionalproperties: string[]
  The names of properties to optionally include in the response body. The only valid value is `logoMetadata`.
- Optionalname: string[]
  The names of Business Units to retrieve. If empty or not provided, then all associated Business Units will be returned.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<CollectionResponsePublicBusinessUnitNoPaging>>
- Defined in codegen/settings/business_units/types/PromiseAPI.ts:27