@planet-a/affinity-node

import { BaseAPIRequestFactory } from './baseapi.js'; import { Configuration } from '../configuration.js'; import { RequestContext, ResponseContext, HttpInfo } from '../http/http.js'; import { CompanyDataPaged } from '../models/CompanyDataPaged.js'; import { NotesNote } from '../models/NotesNote.js'; import { NotesNotesPaged } from '../models/NotesNotesPaged.js'; import { NotesRepliesPaged } from '../models/NotesRepliesPaged.js'; import { OpportunityPaged } from '../models/OpportunityPaged.js'; import { PersonDataPaged } from '../models/PersonDataPaged.js'; /** * no description */ export declare class NotesApiRequestFactory extends BaseAPIRequestFactory { /** * | ⚠️ This endpoint is currently in BETA | |--| Returns all notes, with the exception of replies. You can filter notes using the `filter` query parameter. The filter parameter is a string that you can specify conditions based on the following properties. | **Property Name** | **Description** | **Type** | **Allowed Operators** | **Examples** | |-----------------------------|-----------------------------------------------------------------|------------|--------------------------------------|---------------------------------| | `id` | Filter notes by id | `int32` | `=` | `id=1` | | `creator.id` | Filter notes by the creator of the note | `int32` | `=` | `creator.id=1` | | `createdAt` | Filter notes by when it was created | `datetime` | `>`, `<`, `>=`, `<=` | `createdAt<2025-02-04T10:48:24Z` | | `updatedAt` | Filter notes by when it was updated | `datetime` | `>`, `<`, `>=`, `<=` | `updatedAt>=2025-02-03T10:48:24Z`| * Get all Notes * @param totalCount Include total count of the collection in the pagination response * @param cursor Cursor for the next or previous page * @param limit Number of items to include in the page * @param filter Filter options * @param includes Additional properties to include in the response */ v2NotesGET(totalCount?: boolean, cursor?: string, limit?: number, filter?: string, includes?: Set<'companiesPreview' | 'personsPreview' | 'opportunitiesPreview' | 'repliesCount'>, _options?: Configuration): Promise<RequestContext>; /** * | ⚠️ This endpoint is currently in BETA | |--| Returns directly attached companies for a given Note. * Get Companies attached to a Note * @param noteId The id of the Note to get attached Companies * @param totalCount Include total count of the collection in the pagination response * @param cursor Cursor for the next or previous page * @param limit Number of items to include in the page */ v2NotesNoteIdAttachedCompaniesGET(noteId: number, totalCount?: boolean, cursor?: string, limit?: number, _options?: Configuration): Promise<RequestContext>; /** * | ⚠️ This endpoint is currently in BETA | |--| Returns directly attached opportunities for a given Note. * Get Opportunities attached to a Note * @param noteId The id of the Note to get attached Opportunities * @param totalCount Include total count of the collection in the pagination response * @param cursor Cursor for the next or previous page * @param limit Number of items to include in the page */ v2NotesNoteIdAttachedOpportunitiesGET(noteId: number, totalCount?: boolean, cursor?: string, limit?: number, _options?: Configuration): Promise<RequestContext>; /** * | ⚠️ This endpoint is currently in BETA | |--| Returns directly attached persons for a given Note. * Get Persons attached to a Note * @param noteId The id of the Note to get attached Persons * @param totalCount Include total count of the collection in the pagination response * @param cursor Cursor for the next or previous page * @param limit Number of items to include in the page */ v2NotesNoteIdAttachedPersonsGET(noteId: number, totalCount?: boolean, cursor?: string, limit?: number, _options?: Configuration): Promise<RequestContext>; /** * | ⚠️ This endpoint is currently in BETA | |--| Get a Note with a given id * Get a single Note * @param noteId The id of the Note * @param includes Additional properties to include in the response */ v2NotesNoteIdGET(noteId: number, includes?: Set<'companiesPreview' | 'personsPreview' | 'opportunitiesPreview' | 'repliesCount'>, _options?: Configuration): Promise<RequestContext>; /** * | ⚠️ This endpoint is currently in BETA | |--| This endpoint returns reply notes for a given note id. You can filter replies using the `filter` query parameter. The filter parameter is a string that you can specify conditions based on the following properties. | **Property Name** | **Description** | **Type** | **Allowed Operators** | **Examples** | |-----------------------------|-----------------------------------------------------------------|------------|--------------------------------------|---------------------------------| | `creator.id` | Filter notes by the creator of the note | `int32` | `=` | `creator.id=1` | | `createdAt` | Filter notes by when it was created | `datetime` | `>`, `<`, `>=`, `<=` | `createdAt<2025-02-04T10:48:24Z` | | `updatedAt` | Filter notes by when it was updated | `datetime` | `>`, `<`, `>=`, `<=` | `updatedAt>=2025-02-03T10:48:24Z`| * Get replies for a Note * @param noteId Note ID * @param filter Filter options * @param cursor Cursor for the next or previous page * @param limit Number of items to include in the page * @param totalCount Include total count of the collection in the pagination response */ v2NotesNoteIdRepliesGET(noteId: number, filter?: string, cursor?: string, limit?: number, totalCount?: boolean, _options?: Configuration): Promise<RequestContext>; } export declare class NotesApiResponseProcessor { /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to v2NotesGET * @throws ApiException if the response code was not in [200, 299] */ v2NotesGETWithHttpInfo(response: ResponseContext): Promise<HttpInfo<NotesNotesPaged>>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to v2NotesNoteIdAttachedCompaniesGET * @throws ApiException if the response code was not in [200, 299] */ v2NotesNoteIdAttachedCompaniesGETWithHttpInfo(response: ResponseContext): Promise<HttpInfo<CompanyDataPaged>>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to v2NotesNoteIdAttachedOpportunitiesGET * @throws ApiException if the response code was not in [200, 299] */ v2NotesNoteIdAttachedOpportunitiesGETWithHttpInfo(response: ResponseContext): Promise<HttpInfo<OpportunityPaged>>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to v2NotesNoteIdAttachedPersonsGET * @throws ApiException if the response code was not in [200, 299] */ v2NotesNoteIdAttachedPersonsGETWithHttpInfo(response: ResponseContext): Promise<HttpInfo<PersonDataPaged>>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to v2NotesNoteIdGET * @throws ApiException if the response code was not in [200, 299] */ v2NotesNoteIdGETWithHttpInfo(response: ResponseContext): Promise<HttpInfo<NotesNote>>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to v2NotesNoteIdRepliesGET * @throws ApiException if the response code was not in [200, 299] */ v2NotesNoteIdRepliesGETWithHttpInfo(response: ResponseContext): Promise<HttpInfo<NotesRepliesPaged>>; }