Class BasicApi

Index

Constructors

Methods

archive archiveWithHttpInfo create createWithHttpInfo getById getByIdWithHttpInfo getPage getPageWithHttpInfo merge mergeWithHttpInfo update updateWithHttpInfo

Constructors

constructor

new BasicApi(configuration, requestFactory?, responseProcessor?): BasicApi
Parameters
- configuration: Configuration<ObservableMiddleware>
- OptionalrequestFactory: BasicApiRequestFactory
- OptionalresponseProcessor: BasicApiResponseProcessor
Returns BasicApi
- Defined in codegen/crm/companies/types/PromiseAPI.ts:28

Methods

archiveWithHttpInfo

archiveWithHttpInfo(companyId, _options?): Promise<HttpInfo<void>>
Delete a company by ID. Deleted companies can be restored within 90 days of deletion. Learn more about restoring records. Archive a company
Parameters
- companyId: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/crm/companies/types/PromiseAPI.ts:41

create

create(simplePublicObjectInputForCreate, _options?): Promise<SimplePublicObject>
Create a single company. Include a properties object to define property values for the company, along with an associations array to define associations with other CRM records. Create a company
Parameters
- simplePublicObjectInputForCreate: SimplePublicObjectInputForCreate
- Optional_options: PromiseConfigurationOptions
Returns Promise<SimplePublicObject>
- Defined in codegen/crm/companies/types/PromiseAPI.ts:107

createWithHttpInfo

createWithHttpInfo(simplePublicObjectInputForCreate, _options?): Promise<HttpInfo<SimplePublicObject>>
Create a single company. Include a properties object to define property values for the company, along with an associations array to define associations with other CRM records. Create a company
Parameters
- simplePublicObjectInputForCreate: SimplePublicObjectInputForCreate
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<SimplePublicObject>>
- Defined in codegen/crm/companies/types/PromiseAPI.ts:85

getById

getById(companyId, properties?, propertiesWithHistory?, associations?, archived?, idProperty?, _options?): Promise<SimplePublicObjectWithAssociations>
Retrieve a company by its ID (companyId) or by a unique property (idProperty). You can specify what is returned using the properties query parameter. Retrieve a company
Parameters
- companyId: string
  The ID of the company
- Optionalproperties: string[]
  A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
- OptionalpropertiesWithHistory: string[]
  A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
- Optionalassociations: string[]
  A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- OptionalidProperty: string
  The name of a property whose values are unique for this object
- Optional_options: PromiseConfigurationOptions
Returns Promise<SimplePublicObjectWithAssociations>
- Defined in codegen/crm/companies/types/PromiseAPI.ts:161

getByIdWithHttpInfo

getByIdWithHttpInfo(companyId, properties?, propertiesWithHistory?, associations?, archived?, idProperty?, _options?): Promise<HttpInfo<SimplePublicObjectWithAssociations>>
Retrieve a company by its ID (companyId) or by a unique property (idProperty). You can specify what is returned using the properties query parameter. Retrieve a company
Parameters
- companyId: string
  The ID of the company
- Optionalproperties: string[]
  A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
- OptionalpropertiesWithHistory: string[]
  A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
- Optionalassociations: string[]
  A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- OptionalidProperty: string
  The name of a property whose values are unique for this object
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<SimplePublicObjectWithAssociations>>
- Defined in codegen/crm/companies/types/PromiseAPI.ts:134

getPage

getPage(limit?, after?, properties?, propertiesWithHistory?, associations?, archived?, _options?): Promise<CollectionResponseSimplePublicObjectWithAssociationsForwardPaging>
Retrieve all companies, using query parameters to control the information that gets returned. Retrieve companies
Parameters
- Optionallimit: number
  The maximum number of results to display per page.
- 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.
- Optionalproperties: string[]
  A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
- OptionalpropertiesWithHistory: string[]
  A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
- Optionalassociations: string[]
  A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: PromiseConfigurationOptions
Returns Promise<CollectionResponseSimplePublicObjectWithAssociationsForwardPaging>
- Defined in codegen/crm/companies/types/PromiseAPI.ts:215

getPageWithHttpInfo

getPageWithHttpInfo(limit?, after?, properties?, propertiesWithHistory?, associations?, archived?, _options?): Promise<HttpInfo<CollectionResponseSimplePublicObjectWithAssociationsForwardPaging>>
Retrieve all companies, using query parameters to control the information that gets returned. Retrieve companies
Parameters
- Optionallimit: number
  The maximum number of results to display per page.
- 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.
- Optionalproperties: string[]
  A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
- OptionalpropertiesWithHistory: string[]
  A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
- Optionalassociations: string[]
  A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<CollectionResponseSimplePublicObjectWithAssociationsForwardPaging>>
- Defined in codegen/crm/companies/types/PromiseAPI.ts:188

merge

merge(publicMergeInput, _options?): Promise<SimplePublicObject>
Merge two company records. Learn more about merging records. Merge two companies
Parameters
- publicMergeInput: PublicMergeInput
- Optional_options: PromiseConfigurationOptions
Returns Promise<SimplePublicObject>
- Defined in codegen/crm/companies/types/PromiseAPI.ts:259

mergeWithHttpInfo

mergeWithHttpInfo(publicMergeInput, _options?): Promise<HttpInfo<SimplePublicObject>>
Merge two company records. Learn more about merging records. Merge two companies
Parameters
- publicMergeInput: PublicMergeInput
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<SimplePublicObject>>
- Defined in codegen/crm/companies/types/PromiseAPI.ts:237

update

update(companyId, simplePublicObjectInput, idProperty?, _options?): Promise<SimplePublicObject>
Update a company by ID (companyId) or unique property value (idProperty). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Update a company
Parameters
- companyId: string
- simplePublicObjectInput: SimplePublicObjectInput
- OptionalidProperty: string
  The name of a property whose values are unique for this object
- Optional_options: PromiseConfigurationOptions
Returns Promise<SimplePublicObject>
- Defined in codegen/crm/companies/types/PromiseAPI.ts:307

updateWithHttpInfo

updateWithHttpInfo(companyId, simplePublicObjectInput, idProperty?, _options?): Promise<HttpInfo<SimplePublicObject>>
Update a company by ID (companyId) or unique property value (idProperty). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Update a company
Parameters
- companyId: string
- simplePublicObjectInput: SimplePublicObjectInput
- OptionalidProperty: string
  The name of a property whose values are unique for this object
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<SimplePublicObject>>
- Defined in codegen/crm/companies/types/PromiseAPI.ts:283

Class BasicApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns BasicApi

Methods

archive

Parameters

Returns Promise<void>

archiveWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

create

Parameters

Returns Promise<SimplePublicObject>

createWithHttpInfo

Parameters

Returns Promise<HttpInfo<SimplePublicObject>>

getById

Parameters

Returns Promise<SimplePublicObjectWithAssociations>

getByIdWithHttpInfo

Parameters

Returns Promise<HttpInfo<SimplePublicObjectWithAssociations>>

getPage

Parameters

Returns Promise<CollectionResponseSimplePublicObjectWithAssociationsForwardPaging>

getPageWithHttpInfo

Parameters

Returns Promise<HttpInfo<CollectionResponseSimplePublicObjectWithAssociationsForwardPaging>>

merge

Parameters

Returns Promise<SimplePublicObject>

mergeWithHttpInfo

Parameters

Returns Promise<HttpInfo<SimplePublicObject>>

update

Parameters

Returns Promise<SimplePublicObject>

updateWithHttpInfo

Parameters

Returns Promise<HttpInfo<SimplePublicObject>>

Settings

On This Page