Class OwnersApi

Index

Constructors

Methods

getById getByIdWithHttpInfo getPage getPageWithHttpInfo

Constructors

constructor

new OwnersApi(configuration, requestFactory?, responseProcessor?): OwnersApi
Parameters
- configuration: Configuration<ObservableMiddleware>
- OptionalrequestFactory: OwnersApiRequestFactory
- OptionalresponseProcessor: OwnersApiResponseProcessor
Returns OwnersApi
- Defined in codegen/crm/owners/types/PromiseAPI.ts:13

Methods

getById

getById(ownerId, idProperty?, archived?, _options?): Promise<PublicOwner>
Read an owner by given id or userId
Parameters
- ownerId: number
- OptionalidProperty: "id" | "userId"
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: PromiseConfigurationOptions
Returns Promise<PublicOwner>
- Defined in codegen/crm/owners/types/PromiseAPI.ts:50

getByIdWithHttpInfo

getByIdWithHttpInfo(ownerId, idProperty?, archived?, _options?): Promise<HttpInfo<PublicOwner>>
Read an owner by given id or userId
Parameters
- ownerId: number
- OptionalidProperty: "id" | "userId"
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<PublicOwner>>
- Defined in codegen/crm/owners/types/PromiseAPI.ts:27

getPage

getPage(email?, after?, limit?, archived?, _options?): Promise<CollectionResponsePublicOwnerForwardPaging>
Get a page of owners
Parameters
- Optionalemail: string
  Filter by email address (optional)
- Optionalafter: string
  The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
- Optionallimit: number
  The maximum number of results to display per page.
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: PromiseConfigurationOptions
Returns Promise<CollectionResponsePublicOwnerForwardPaging>
- Defined in codegen/crm/owners/types/PromiseAPI.ts:98

getPageWithHttpInfo

getPageWithHttpInfo(email?, after?, limit?, archived?, _options?): Promise<HttpInfo<CollectionResponsePublicOwnerForwardPaging>>
Get a page of owners
Parameters
- Optionalemail: string
  Filter by email address (optional)
- Optionalafter: string
  The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
- Optionallimit: number
  The maximum number of results to display per page.
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<CollectionResponsePublicOwnerForwardPaging>>
- Defined in codegen/crm/owners/types/PromiseAPI.ts:74