Class BasicApi

Index

Constructors

Methods

archive archiveWithHttpInfo create createWithHttpInfo getById getByIdWithHttpInfo getPage getPageWithHttpInfo update updateWithHttpInfo

Constructors

constructor

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

Methods

archiveWithHttpInfo

archiveWithHttpInfo(companyId, _options?): Promise<HttpInfo<void>>
Move an Object identified by {companyId} to the recycling bin. Archive
Parameters
- companyId: string
- Optional_options: Configuration
Returns Promise<HttpInfo<void>>
- Defined in codegen/crm/companies/types/PromiseAPI.ts:40

create

create(simplePublicObjectInputForCreate, _options?): Promise<SimplePublicObject>
Create a company with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard companies is provided. Create
Parameters
- simplePublicObjectInputForCreate: SimplePublicObjectInputForCreate
- Optional_options: Configuration
Returns Promise<SimplePublicObject>
- Defined in codegen/crm/companies/types/PromiseAPI.ts:70

createWithHttpInfo

createWithHttpInfo(simplePublicObjectInputForCreate, _options?): Promise<HttpInfo<SimplePublicObject>>
Create a company with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard companies is provided. Create
Parameters
- simplePublicObjectInputForCreate: SimplePublicObjectInputForCreate
- Optional_options: Configuration
Returns Promise<HttpInfo<SimplePublicObject>>
- Defined in codegen/crm/companies/types/PromiseAPI.ts:60

getById

getById(companyId, properties?, propertiesWithHistory?, associations?, archived?, idProperty?, _options?): Promise<SimplePublicObjectWithAssociations>
Read an Object identified by {companyId}. {companyId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param. Read
Parameters
- companyId: string
- 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: Configuration
Returns Promise<SimplePublicObjectWithAssociations>
- Defined in codegen/crm/companies/types/PromiseAPI.ts:100

getByIdWithHttpInfo

getByIdWithHttpInfo(companyId, properties?, propertiesWithHistory?, associations?, archived?, idProperty?, _options?): Promise<HttpInfo<SimplePublicObjectWithAssociations>>
Read an Object identified by {companyId}. {companyId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param. Read
Parameters
- companyId: string
- 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: Configuration
Returns Promise<HttpInfo<SimplePublicObjectWithAssociations>>
- Defined in codegen/crm/companies/types/PromiseAPI.ts:85

getPage

getPage(limit?, after?, properties?, propertiesWithHistory?, associations?, archived?, _options?): Promise<CollectionResponseSimplePublicObjectWithAssociationsForwardPaging>
Read a page of companies. Control what is returned via the properties query param. List
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: Configuration
Returns Promise<CollectionResponseSimplePublicObjectWithAssociationsForwardPaging>
- Defined in codegen/crm/companies/types/PromiseAPI.ts:130

getPageWithHttpInfo

getPageWithHttpInfo(limit?, after?, properties?, propertiesWithHistory?, associations?, archived?, _options?): Promise<HttpInfo<CollectionResponseSimplePublicObjectWithAssociationsForwardPaging>>
Read a page of companies. Control what is returned via the properties query param. List
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: Configuration
Returns Promise<HttpInfo<CollectionResponseSimplePublicObjectWithAssociationsForwardPaging>>
- Defined in codegen/crm/companies/types/PromiseAPI.ts:115

update

update(companyId, simplePublicObjectInput, idProperty?, _options?): Promise<SimplePublicObject>
Perform a partial update of an Object identified by {companyId}or optionally a unique property value as specified by the idProperty query param. {companyId} refers to the internal object ID by default, and the idProperty query param refers to a property whose values are unique for the object. 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
Parameters
- companyId: string
- simplePublicObjectInput: SimplePublicObjectInput
- OptionalidProperty: string
  The name of a property whose values are unique for this object
- Optional_options: Configuration
Returns Promise<SimplePublicObject>
- Defined in codegen/crm/companies/types/PromiseAPI.ts:154

updateWithHttpInfo

updateWithHttpInfo(companyId, simplePublicObjectInput, idProperty?, _options?): Promise<HttpInfo<SimplePublicObject>>
Perform a partial update of an Object identified by {companyId}or optionally a unique property value as specified by the idProperty query param. {companyId} refers to the internal object ID by default, and the idProperty query param refers to a property whose values are unique for the object. 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
Parameters
- companyId: string
- simplePublicObjectInput: SimplePublicObjectInput
- OptionalidProperty: string
  The name of a property whose values are unique for this object
- Optional_options: Configuration
Returns Promise<HttpInfo<SimplePublicObject>>
- Defined in codegen/crm/companies/types/PromiseAPI.ts:142

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>>

update

Parameters

Returns Promise<SimplePublicObject>

updateWithHttpInfo

Parameters

Returns Promise<HttpInfo<SimplePublicObject>>

Settings

On This Page