Class BasicApi

Index

Constructors

constructor

Methods

getById getByIdWithHttpInfo getPage getPageWithHttpInfo

Constructors

constructor

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

Methods

getById

getById(feedbackSubmissionId, properties?, propertiesWithHistory?, associations?, archived?, idProperty?, _options?): Promise<SimplePublicObjectWithAssociations>
Read an Object identified by {feedbackSubmissionId}. {feedbackSubmissionId} 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
- feedbackSubmissionId: 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/objects/feedback_submissions/types/PromiseAPI.ts:50

getByIdWithHttpInfo

getByIdWithHttpInfo(feedbackSubmissionId, properties?, propertiesWithHistory?, associations?, archived?, idProperty?, _options?): Promise<HttpInfo<SimplePublicObjectWithAssociations>>
Read an Object identified by {feedbackSubmissionId}. {feedbackSubmissionId} 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
- feedbackSubmissionId: 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/objects/feedback_submissions/types/PromiseAPI.ts:35

getPage

getPage(limit?, after?, properties?, propertiesWithHistory?, associations?, archived?, _options?): Promise<CollectionResponseSimplePublicObjectWithAssociationsForwardPaging>
Read a page of feedback submissions. 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/objects/feedback_submissions/types/PromiseAPI.ts:80

getPageWithHttpInfo

getPageWithHttpInfo(limit?, after?, properties?, propertiesWithHistory?, associations?, archived?, _options?): Promise<HttpInfo<CollectionResponseSimplePublicObjectWithAssociationsForwardPaging>>
Read a page of feedback submissions. 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/objects/feedback_submissions/types/PromiseAPI.ts:65

Class BasicApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns BasicApi

Methods

getById

Parameters

Returns Promise<SimplePublicObjectWithAssociations>

getByIdWithHttpInfo

Parameters

Returns Promise<HttpInfo<SimplePublicObjectWithAssociations>>

getPage

Parameters

Returns Promise<CollectionResponseSimplePublicObjectWithAssociationsForwardPaging>

getPageWithHttpInfo

Parameters

Returns Promise<HttpInfo<CollectionResponseSimplePublicObjectWithAssociationsForwardPaging>>

Settings

On This Page