@planet-a/affinity-node
Version:
API wrapper for the affinity.co API
461 lines (460 loc) • 34.3 kB
JavaScript
import { ObservableAuthApi } from "./ObservableAPI.js";
export class ObjectAuthApi {
constructor(configuration, requestFactory, responseProcessor) {
Object.defineProperty(this, "api", {
enumerable: true,
configurable: true,
writable: true,
value: void 0
});
this.api = new ObservableAuthApi(configuration, requestFactory, responseProcessor);
}
/**
* Returns metadata about the current user.
* Get current user
* @param param the request object
*/
getV2AuthWhoamiWithHttpInfo(param = {}, options) {
return this.api.getV2AuthWhoamiWithHttpInfo(options).toPromise();
}
/**
* Returns metadata about the current user.
* Get current user
* @param param the request object
*/
getV2AuthWhoami(param = {}, options) {
return this.api.getV2AuthWhoami(options).toPromise();
}
}
import { ObservableCompaniesApi } from "./ObservableAPI.js";
export class ObjectCompaniesApi {
constructor(configuration, requestFactory, responseProcessor) {
Object.defineProperty(this, "api", {
enumerable: true,
configurable: true,
writable: true,
value: void 0
});
this.api = new ObservableCompaniesApi(configuration, requestFactory, responseProcessor);
}
/**
* Paginate through Companies in Affinity. Returns basic information and non-list-specific field data on each Company. To retrieve field data, you must use either the `fieldIds` or the `fieldTypes` parameter to specify the Fields for which you want data returned. These Field IDs and Types can be found using the GET `/v2/companies/fields` endpoint. When no `fieldIds` or `fieldTypes` are provided, Companies will be returned without any field data attached. To supply multiple `fieldIds` or `fieldTypes` parameters, generate a query string that looks like this: `?fieldIds=field-1234&fieldIds=affinity-data-location` or `?fieldTypes=enriched&fieldTypes=global`. Requires the \"Export All Organizations directory\" [permission](#section/Getting-Started/Permissions).
* Get all Companies
* @param param the request object
*/
getV2CompaniesWithHttpInfo(param = {}, options) {
return this.api.getV2CompaniesWithHttpInfo(param.cursor, param.limit, param.ids, param.fieldIds, param.fieldTypes, options).toPromise();
}
/**
* Paginate through Companies in Affinity. Returns basic information and non-list-specific field data on each Company. To retrieve field data, you must use either the `fieldIds` or the `fieldTypes` parameter to specify the Fields for which you want data returned. These Field IDs and Types can be found using the GET `/v2/companies/fields` endpoint. When no `fieldIds` or `fieldTypes` are provided, Companies will be returned without any field data attached. To supply multiple `fieldIds` or `fieldTypes` parameters, generate a query string that looks like this: `?fieldIds=field-1234&fieldIds=affinity-data-location` or `?fieldTypes=enriched&fieldTypes=global`. Requires the \"Export All Organizations directory\" [permission](#section/Getting-Started/Permissions).
* Get all Companies
* @param param the request object
*/
getV2Companies(param = {}, options) {
return this.api.getV2Companies(param.cursor, param.limit, param.ids, param.fieldIds, param.fieldTypes, options).toPromise();
}
/**
* Returns metadata on non-list-specific Company Fields. Use the returned Field IDs to request field data from the GET `/v2/companies` and GET `/v2/companies/{id}` endpoints.
* Get metadata on Company Fields
* @param param the request object
*/
getV2CompaniesFieldsWithHttpInfo(param = {}, options) {
return this.api.getV2CompaniesFieldsWithHttpInfo(param.cursor, param.limit, options).toPromise();
}
/**
* Returns metadata on non-list-specific Company Fields. Use the returned Field IDs to request field data from the GET `/v2/companies` and GET `/v2/companies/{id}` endpoints.
* Get metadata on Company Fields
* @param param the request object
*/
getV2CompaniesFields(param = {}, options) {
return this.api.getV2CompaniesFields(param.cursor, param.limit, options).toPromise();
}
/**
* Returns basic information and non-list-specific field data on the requested Company. To retrieve field data, you must use either the `fieldIds` or the `fieldTypes` parameter to specify the Fields for which you want data returned. These Field IDs and Types can be found using the GET `/v2/companies/fields` endpoint. When no `fieldIds` or `fieldTypes` are provided, Companies will be returned without any field data attached. To supply multiple `fieldIds` or `fieldTypes` parameters, generate a query string that looks like this: `?fieldIds=field-1234&fieldIds=affinity-data-location` or `?fieldTypes=enriched&fieldTypes=global`. Requires the \"Export All Organizations directory\" [permission](#section/Getting-Started/Permissions).
* Get a single Company
* @param param the request object
*/
getV2CompaniesIdWithHttpInfo(param, options) {
return this.api.getV2CompaniesIdWithHttpInfo(param.id, param.fieldIds, param.fieldTypes, options).toPromise();
}
/**
* Returns basic information and non-list-specific field data on the requested Company. To retrieve field data, you must use either the `fieldIds` or the `fieldTypes` parameter to specify the Fields for which you want data returned. These Field IDs and Types can be found using the GET `/v2/companies/fields` endpoint. When no `fieldIds` or `fieldTypes` are provided, Companies will be returned without any field data attached. To supply multiple `fieldIds` or `fieldTypes` parameters, generate a query string that looks like this: `?fieldIds=field-1234&fieldIds=affinity-data-location` or `?fieldTypes=enriched&fieldTypes=global`. Requires the \"Export All Organizations directory\" [permission](#section/Getting-Started/Permissions).
* Get a single Company
* @param param the request object
*/
getV2CompaniesId(param, options) {
return this.api.getV2CompaniesId(param.id, param.fieldIds, param.fieldTypes, options).toPromise();
}
/**
* Paginate through the List Entries (AKA rows) for the given Company across all Lists. Each List Entry includes field data for the Company, including list-specific field data. Each List Entry also includes metadata about its creation, i.e., when it was added to the List and by whom. Requires the \"Export data from Lists\" [permission](#section/Getting-Started/Permissions).
* Get a Company\'s List Entries
* @param param the request object
*/
getV2CompaniesIdListEntriesWithHttpInfo(param, options) {
return this.api.getV2CompaniesIdListEntriesWithHttpInfo(param.id, param.cursor, param.limit, options).toPromise();
}
/**
* Paginate through the List Entries (AKA rows) for the given Company across all Lists. Each List Entry includes field data for the Company, including list-specific field data. Each List Entry also includes metadata about its creation, i.e., when it was added to the List and by whom. Requires the \"Export data from Lists\" [permission](#section/Getting-Started/Permissions).
* Get a Company\'s List Entries
* @param param the request object
*/
getV2CompaniesIdListEntries(param, options) {
return this.api.getV2CompaniesIdListEntries(param.id, param.cursor, param.limit, options).toPromise();
}
/**
* Returns metadata for all the Lists on which the given Company appears.
* Get a Company\'s Lists
* @param param the request object
*/
getV2CompaniesIdListsWithHttpInfo(param, options) {
return this.api.getV2CompaniesIdListsWithHttpInfo(param.id, param.cursor, param.limit, options).toPromise();
}
/**
* Returns metadata for all the Lists on which the given Company appears.
* Get a Company\'s Lists
* @param param the request object
*/
getV2CompaniesIdLists(param, options) {
return this.api.getV2CompaniesIdLists(param.id, param.cursor, param.limit, options).toPromise();
}
}
import { ObservableListsApi } from "./ObservableAPI.js";
export class ObjectListsApi {
constructor(configuration, requestFactory, responseProcessor) {
Object.defineProperty(this, "api", {
enumerable: true,
configurable: true,
writable: true,
value: void 0
});
this.api = new ObservableListsApi(configuration, requestFactory, responseProcessor);
}
/**
* Returns metadata on the Saved Views on a List.
* Get metadata on Saved Views
* @param param the request object
*/
getV2ListsListidSavedViewsWithHttpInfo(param, options) {
return this.api.getV2ListsListidSavedViewsWithHttpInfo(param.listId, param.cursor, param.limit, options).toPromise();
}
/**
* Returns metadata on the Saved Views on a List.
* Get metadata on Saved Views
* @param param the request object
*/
getV2ListsListidSavedViews(param, options) {
return this.api.getV2ListsListidSavedViews(param.listId, param.cursor, param.limit, options).toPromise();
}
/**
* Returns metadata on a single Saved View.
* Get metadata on a single Saved View
* @param param the request object
*/
getV2ListsListidSavedViewsViewidWithHttpInfo(param, options) {
return this.api.getV2ListsListidSavedViewsViewidWithHttpInfo(param.listId, param.viewId, options).toPromise();
}
/**
* Returns metadata on a single Saved View.
* Get metadata on a single Saved View
* @param param the request object
*/
getV2ListsListidSavedViewsViewid(param, options) {
return this.api.getV2ListsListidSavedViewsViewid(param.listId, param.viewId, options).toPromise();
}
/**
* Paginate through the List Entries (AKA rows) on a given Saved View. Use this endpoint when you need to filter entities or only want **some** field data to be returned: This endpoint respects the filters set on a Saved View via web app, and only returns field data corresponding to the columns that have been pulled into the Saved View via web app. Though this endpoint respects the Saved View\'s filters and column/Field selection, it does not yet preserve sort order. This endpoint also only supports **sheet-type Saved Views**, and not board- or dashboard-type Saved Views. See the [Data Model](#section/Data-Model) section for more information about Saved Views. Requires the \"Export data from Lists\" [permission](#section/Getting-Started/Permissions).
* Get all List Entries on a Saved View
* @param param the request object
*/
getV2ListsListidSavedViewsViewidListEntriesWithHttpInfo(param, options) {
return this.api.getV2ListsListidSavedViewsViewidListEntriesWithHttpInfo(param.listId, param.viewId, param.cursor, param.limit, options).toPromise();
}
/**
* Paginate through the List Entries (AKA rows) on a given Saved View. Use this endpoint when you need to filter entities or only want **some** field data to be returned: This endpoint respects the filters set on a Saved View via web app, and only returns field data corresponding to the columns that have been pulled into the Saved View via web app. Though this endpoint respects the Saved View\'s filters and column/Field selection, it does not yet preserve sort order. This endpoint also only supports **sheet-type Saved Views**, and not board- or dashboard-type Saved Views. See the [Data Model](#section/Data-Model) section for more information about Saved Views. Requires the \"Export data from Lists\" [permission](#section/Getting-Started/Permissions).
* Get all List Entries on a Saved View
* @param param the request object
*/
getV2ListsListidSavedViewsViewidListEntries(param, options) {
return this.api.getV2ListsListidSavedViewsViewidListEntries(param.listId, param.viewId, param.cursor, param.limit, options).toPromise();
}
/**
* Returns metadata on Lists.
* Get metadata on all Lists
* @param param the request object
*/
v2ListsGETWithHttpInfo(param = {}, options) {
return this.api.v2ListsGETWithHttpInfo(param.cursor, param.limit, options).toPromise();
}
/**
* Returns metadata on Lists.
* Get metadata on all Lists
* @param param the request object
*/
v2ListsGET(param = {}, options) {
return this.api.v2ListsGET(param.cursor, param.limit, options).toPromise();
}
/**
* Returns metadata on the Fields available on a single List. Use the returned Field IDs to request field data from the GET `/v2/lists/{listId}/list-entries` endpoint.
* Get metadata on a single List\'s Fields
* @param param the request object
*/
v2ListsListIdFieldsGETWithHttpInfo(param, options) {
return this.api.v2ListsListIdFieldsGETWithHttpInfo(param.listId, param.cursor, param.limit, options).toPromise();
}
/**
* Returns metadata on the Fields available on a single List. Use the returned Field IDs to request field data from the GET `/v2/lists/{listId}/list-entries` endpoint.
* Get metadata on a single List\'s Fields
* @param param the request object
*/
v2ListsListIdFieldsGET(param, options) {
return this.api.v2ListsListIdFieldsGET(param.listId, param.cursor, param.limit, options).toPromise();
}
/**
* Returns metadata on a single List.
* Get metadata on a single List
* @param param the request object
*/
v2ListsListIdGETWithHttpInfo(param, options) {
return this.api.v2ListsListIdGETWithHttpInfo(param.listId, options).toPromise();
}
/**
* Returns metadata on a single List.
* Get metadata on a single List
* @param param the request object
*/
v2ListsListIdGET(param, options) {
return this.api.v2ListsListIdGET(param.listId, options).toPromise();
}
/**
* Paginate through the List Entries (AKA rows) on a given List. Returns basic information and field data, including list-specific field data, on each Company, Person, or Opportunity on the List. List Entries also include metadata about their creation, i.e., when they were added to the List and by whom. To retrieve field data, you must use either the `fieldIds` or the `fieldTypes` parameter to specify the Fields for which you want data returned. These Field IDs and Types can be found using the GET `/v2/lists/{listId}/fields` endpoint. When no `fieldIds` or `fieldTypes` are provided, List Entries will be returned without any field data attached. To supply multiple `fieldIds` or `fieldTypes` parameters, generate a query string that looks like this: `?fieldIds=field-1234&fieldIds=affinity-data-location` or `?fieldTypes=enriched&fieldTypes=global`. Requires the \"Export data from Lists\" [permission](#section/Getting-Started/Permissions).
* Get all List Entries on a List
* @param param the request object
*/
v2ListsListIdListEntriesGETWithHttpInfo(param, options) {
return this.api.v2ListsListIdListEntriesGETWithHttpInfo(param.listId, param.cursor, param.limit, param.fieldIds, param.fieldTypes, options).toPromise();
}
/**
* Paginate through the List Entries (AKA rows) on a given List. Returns basic information and field data, including list-specific field data, on each Company, Person, or Opportunity on the List. List Entries also include metadata about their creation, i.e., when they were added to the List and by whom. To retrieve field data, you must use either the `fieldIds` or the `fieldTypes` parameter to specify the Fields for which you want data returned. These Field IDs and Types can be found using the GET `/v2/lists/{listId}/fields` endpoint. When no `fieldIds` or `fieldTypes` are provided, List Entries will be returned without any field data attached. To supply multiple `fieldIds` or `fieldTypes` parameters, generate a query string that looks like this: `?fieldIds=field-1234&fieldIds=affinity-data-location` or `?fieldTypes=enriched&fieldTypes=global`. Requires the \"Export data from Lists\" [permission](#section/Getting-Started/Permissions).
* Get all List Entries on a List
* @param param the request object
*/
v2ListsListIdListEntriesGET(param, options) {
return this.api.v2ListsListIdListEntriesGET(param.listId, param.cursor, param.limit, param.fieldIds, param.fieldTypes, options).toPromise();
}
/**
* | ⚠️ This endpoint is currently in BETA | |--| Returns a single field value on a list entry. Requires the \"Export data from Lists\" [permission](#section/Getting-Started/Permissions).
* Get a single field value [BETA]
* @param param the request object
*/
v2ListsListIdListEntriesListEntryIdFieldsFieldIdGETWithHttpInfo(param, options) {
return this.api.v2ListsListIdListEntriesListEntryIdFieldsFieldIdGETWithHttpInfo(param.listId, param.listEntryId, param.fieldId, options).toPromise();
}
/**
* | ⚠️ This endpoint is currently in BETA | |--| Returns a single field value on a list entry. Requires the \"Export data from Lists\" [permission](#section/Getting-Started/Permissions).
* Get a single field value [BETA]
* @param param the request object
*/
v2ListsListIdListEntriesListEntryIdFieldsFieldIdGET(param, options) {
return this.api.v2ListsListIdListEntriesListEntryIdFieldsFieldIdGET(param.listId, param.listEntryId, param.fieldId, options).toPromise();
}
/**
* | ⚠️ This endpoint is currently in BETA | |--| Update a single field value. Requires the \"Export data from Lists\" [permission](#section/Getting-Started/Permissions).
* Update a single field value on a List Entry [BETA]
* @param param the request object
*/
v2ListsListIdListEntriesListEntryIdFieldsFieldIdPOSTWithHttpInfo(param, options) {
return this.api.v2ListsListIdListEntriesListEntryIdFieldsFieldIdPOSTWithHttpInfo(param.listId, param.listEntryId, param.fieldId, param.fieldUpdate, options).toPromise();
}
/**
* | ⚠️ This endpoint is currently in BETA | |--| Update a single field value. Requires the \"Export data from Lists\" [permission](#section/Getting-Started/Permissions).
* Update a single field value on a List Entry [BETA]
* @param param the request object
*/
v2ListsListIdListEntriesListEntryIdFieldsFieldIdPOST(param, options) {
return this.api.v2ListsListIdListEntriesListEntryIdFieldsFieldIdPOST(param.listId, param.listEntryId, param.fieldId, param.fieldUpdate, options).toPromise();
}
/**
* | ⚠️ This endpoint is currently in BETA | |--| Paginate through all field values on a single list entry. All fields will be included by default. The `ids` and `types` parameters can be used to filter the collection. Requires the \"Export data from Lists\" [permission](#section/Getting-Started/Permissions).
* Get field values on a single List Entry [BETA]
* @param param the request object
*/
v2ListsListIdListEntriesListEntryIdFieldsGETWithHttpInfo(param, options) {
return this.api.v2ListsListIdListEntriesListEntryIdFieldsGETWithHttpInfo(param.listId, param.listEntryId, param.ids, param.types, param.cursor, param.limit, options).toPromise();
}
/**
* | ⚠️ This endpoint is currently in BETA | |--| Paginate through all field values on a single list entry. All fields will be included by default. The `ids` and `types` parameters can be used to filter the collection. Requires the \"Export data from Lists\" [permission](#section/Getting-Started/Permissions).
* Get field values on a single List Entry [BETA]
* @param param the request object
*/
v2ListsListIdListEntriesListEntryIdFieldsGET(param, options) {
return this.api.v2ListsListIdListEntriesListEntryIdFieldsGET(param.listId, param.listEntryId, param.ids, param.types, param.cursor, param.limit, options).toPromise();
}
/**
* | ⚠️ This endpoint is currently in BETA | |--| Perform batch operations on a list entry\'s fields. Currently the only operation at the endpoint is `update-fields`, which allows you to update multiple field values with a single request. This is equivalent to calling [the single field update](#operation/v2_lists_listId_list-entries_listEntryId_fields_fieldId__POST) endpoint multiple times. Requires the \"Export data from Lists\" [permission](#section/Getting-Started/Permissions).
* Perform batch operations on a list entry\'s fields [BETA]
* @param param the request object
*/
v2ListsListIdListEntriesListEntryIdFieldsPATCHWithHttpInfo(param, options) {
return this.api.v2ListsListIdListEntriesListEntryIdFieldsPATCHWithHttpInfo(param.listId, param.listEntryId, param.body, options).toPromise();
}
/**
* | ⚠️ This endpoint is currently in BETA | |--| Perform batch operations on a list entry\'s fields. Currently the only operation at the endpoint is `update-fields`, which allows you to update multiple field values with a single request. This is equivalent to calling [the single field update](#operation/v2_lists_listId_list-entries_listEntryId_fields_fieldId__POST) endpoint multiple times. Requires the \"Export data from Lists\" [permission](#section/Getting-Started/Permissions).
* Perform batch operations on a list entry\'s fields [BETA]
* @param param the request object
*/
v2ListsListIdListEntriesListEntryIdFieldsPATCH(param, options) {
return this.api.v2ListsListIdListEntriesListEntryIdFieldsPATCH(param.listId, param.listEntryId, param.body, options).toPromise();
}
/**
* | ⚠️ This endpoint is currently in BETA | |--| Retrieve a single list entry. Returns basic information and field data, including list-specific field data. To retrieve field data, you must use either the `fieldIds` or the `fieldTypes` parameter to specify the Fields for which you want data returned. These Field IDs and Types can be found using the GET `/v2/lists/{listId}/fields` endpoint. When no `fieldIds` or `fieldTypes` are provided, the List Entry will be returned without any field data attached. To supply multiple `fieldIds` or `fieldTypes` parameters, generate a query string that looks like this: `?fieldIds=field-1234&fieldIds=affinity-data-location` or `?fieldTypes=enriched&fieldTypes=global`. Requires the \"Export data from Lists\" [permission](#section/Getting-Started/Permissions).
* Get a single List Entry on a List [BETA]
* @param param the request object
*/
v2ListsListIdListEntriesListEntryIdGETWithHttpInfo(param, options) {
return this.api.v2ListsListIdListEntriesListEntryIdGETWithHttpInfo(param.listId, param.listEntryId, param.fieldIds, param.fieldTypes, options).toPromise();
}
/**
* | ⚠️ This endpoint is currently in BETA | |--| Retrieve a single list entry. Returns basic information and field data, including list-specific field data. To retrieve field data, you must use either the `fieldIds` or the `fieldTypes` parameter to specify the Fields for which you want data returned. These Field IDs and Types can be found using the GET `/v2/lists/{listId}/fields` endpoint. When no `fieldIds` or `fieldTypes` are provided, the List Entry will be returned without any field data attached. To supply multiple `fieldIds` or `fieldTypes` parameters, generate a query string that looks like this: `?fieldIds=field-1234&fieldIds=affinity-data-location` or `?fieldTypes=enriched&fieldTypes=global`. Requires the \"Export data from Lists\" [permission](#section/Getting-Started/Permissions).
* Get a single List Entry on a List [BETA]
* @param param the request object
*/
v2ListsListIdListEntriesListEntryIdGET(param, options) {
return this.api.v2ListsListIdListEntriesListEntryIdGET(param.listId, param.listEntryId, param.fieldIds, param.fieldTypes, options).toPromise();
}
}
import { ObservableOpportunitiesApi } from "./ObservableAPI.js";
export class ObjectOpportunitiesApi {
constructor(configuration, requestFactory, responseProcessor) {
Object.defineProperty(this, "api", {
enumerable: true,
configurable: true,
writable: true,
value: void 0
});
this.api = new ObservableOpportunitiesApi(configuration, requestFactory, responseProcessor);
}
/**
* Paginate through Opportunities in Affinity. Returns basic information but **not** field data on each Opportunity. To access field data on Opportunities, use the `/lists/{list_id}/list-entries` or the `/v2/lists/{list_id}/saved-views/{view_id}/list-entries` GET endpoint. Requires the \"Export data from Lists\" [permission](#section/Getting-Started/Permissions).
* Get all Opportunities
* @param param the request object
*/
getV2OpportunitiesWithHttpInfo(param = {}, options) {
return this.api.getV2OpportunitiesWithHttpInfo(param.cursor, param.limit, param.ids, options).toPromise();
}
/**
* Paginate through Opportunities in Affinity. Returns basic information but **not** field data on each Opportunity. To access field data on Opportunities, use the `/lists/{list_id}/list-entries` or the `/v2/lists/{list_id}/saved-views/{view_id}/list-entries` GET endpoint. Requires the \"Export data from Lists\" [permission](#section/Getting-Started/Permissions).
* Get all Opportunities
* @param param the request object
*/
getV2Opportunities(param = {}, options) {
return this.api.getV2Opportunities(param.cursor, param.limit, param.ids, options).toPromise();
}
/**
* Returns basic information but **not** field data on the requested Opportunity. To access field data on Opportunities, use the `/lists/{list_id}/list-entries` or the `/v2/lists/{list_id}/saved-views/{view_id}/list-entries` GET endpoint. Requires the \"Export data from Lists\" [permission](#section/Getting-Started/Permissions).
* Get a single Opportunity
* @param param the request object
*/
getV2OpportunitiesIdWithHttpInfo(param, options) {
return this.api.getV2OpportunitiesIdWithHttpInfo(param.id, options).toPromise();
}
/**
* Returns basic information but **not** field data on the requested Opportunity. To access field data on Opportunities, use the `/lists/{list_id}/list-entries` or the `/v2/lists/{list_id}/saved-views/{view_id}/list-entries` GET endpoint. Requires the \"Export data from Lists\" [permission](#section/Getting-Started/Permissions).
* Get a single Opportunity
* @param param the request object
*/
getV2OpportunitiesId(param, options) {
return this.api.getV2OpportunitiesId(param.id, options).toPromise();
}
}
import { ObservablePersonsApi } from "./ObservableAPI.js";
export class ObjectPersonsApi {
constructor(configuration, requestFactory, responseProcessor) {
Object.defineProperty(this, "api", {
enumerable: true,
configurable: true,
writable: true,
value: void 0
});
this.api = new ObservablePersonsApi(configuration, requestFactory, responseProcessor);
}
/**
* Paginate through Persons in Affinity. Returns basic information and non-list-specific field data on each Person. To retrieve field data, you must use either the `fieldIds` or the `fieldTypes` parameter to specify the Fields for which you want data returned. These Field IDs and Types can be found using the GET `/v2/persons/fields` endpoint. When no `fieldIds` or `fieldTypes` are provided, Persons will be returned without any field data attached. To supply multiple `fieldIds` or `fieldTypes` parameters, generate a query string that looks like this: `?fieldIds=field-1234&fieldIds=affinity-data-location` or `?fieldTypes=enriched&fieldTypes=global`. Requires the \"Export All People directory\" [permission](#section/Getting-Started/Permissions).
* Get all Persons
* @param param the request object
*/
getV2PersonsWithHttpInfo(param = {}, options) {
return this.api.getV2PersonsWithHttpInfo(param.cursor, param.limit, param.ids, param.fieldIds, param.fieldTypes, options).toPromise();
}
/**
* Paginate through Persons in Affinity. Returns basic information and non-list-specific field data on each Person. To retrieve field data, you must use either the `fieldIds` or the `fieldTypes` parameter to specify the Fields for which you want data returned. These Field IDs and Types can be found using the GET `/v2/persons/fields` endpoint. When no `fieldIds` or `fieldTypes` are provided, Persons will be returned without any field data attached. To supply multiple `fieldIds` or `fieldTypes` parameters, generate a query string that looks like this: `?fieldIds=field-1234&fieldIds=affinity-data-location` or `?fieldTypes=enriched&fieldTypes=global`. Requires the \"Export All People directory\" [permission](#section/Getting-Started/Permissions).
* Get all Persons
* @param param the request object
*/
getV2Persons(param = {}, options) {
return this.api.getV2Persons(param.cursor, param.limit, param.ids, param.fieldIds, param.fieldTypes, options).toPromise();
}
/**
* Returns metadata on non-list-specific Person Fields. Use the returned Field IDs to request field data from the GET `/v2/persons` and GET `/v2/persons/{id}` endpoints.
* Get metadata on Person Fields
* @param param the request object
*/
getV2PersonsFieldsWithHttpInfo(param = {}, options) {
return this.api.getV2PersonsFieldsWithHttpInfo(param.cursor, param.limit, options).toPromise();
}
/**
* Returns metadata on non-list-specific Person Fields. Use the returned Field IDs to request field data from the GET `/v2/persons` and GET `/v2/persons/{id}` endpoints.
* Get metadata on Person Fields
* @param param the request object
*/
getV2PersonsFields(param = {}, options) {
return this.api.getV2PersonsFields(param.cursor, param.limit, options).toPromise();
}
/**
* Returns basic information and non-list-specific field data on the requested Person. To retrieve field data, you must use either the `fieldIds` or the `fieldTypes` parameter to specify the Fields for which you want data returned. These Field IDs and Types can be found using the GET `/v2/persons/fields` endpoint. When no `fieldIds` or `fieldTypes` are provided, Persons will be returned without any field data attached. To supply multiple `fieldIds` or `fieldTypes` parameters, generate a query string that looks like this: `?fieldIds=field-1234&fieldIds=affinity-data-location` or `?fieldTypes=enriched&fieldTypes=global`. Requires the \"Export All People directory\" [permission](#section/Getting-Started/Permissions).
* Get a single Person
* @param param the request object
*/
getV2PersonsIdWithHttpInfo(param, options) {
return this.api.getV2PersonsIdWithHttpInfo(param.id, param.fieldIds, param.fieldTypes, options).toPromise();
}
/**
* Returns basic information and non-list-specific field data on the requested Person. To retrieve field data, you must use either the `fieldIds` or the `fieldTypes` parameter to specify the Fields for which you want data returned. These Field IDs and Types can be found using the GET `/v2/persons/fields` endpoint. When no `fieldIds` or `fieldTypes` are provided, Persons will be returned without any field data attached. To supply multiple `fieldIds` or `fieldTypes` parameters, generate a query string that looks like this: `?fieldIds=field-1234&fieldIds=affinity-data-location` or `?fieldTypes=enriched&fieldTypes=global`. Requires the \"Export All People directory\" [permission](#section/Getting-Started/Permissions).
* Get a single Person
* @param param the request object
*/
getV2PersonsId(param, options) {
return this.api.getV2PersonsId(param.id, param.fieldIds, param.fieldTypes, options).toPromise();
}
/**
* Paginate through the List Entries (AKA rows) for the given Person across all Lists. Each List Entry includes field data for the Person, including list-specific field data. Each List Entry also includes metadata about its creation, i.e., when it was added to the List and by whom. Requires the \"Export data from Lists\" [permission](#section/Getting-Started/Permissions).
* Get a Person\'s List Entries
* @param param the request object
*/
getV2PersonsIdListEntriesWithHttpInfo(param, options) {
return this.api.getV2PersonsIdListEntriesWithHttpInfo(param.id, param.cursor, param.limit, options).toPromise();
}
/**
* Paginate through the List Entries (AKA rows) for the given Person across all Lists. Each List Entry includes field data for the Person, including list-specific field data. Each List Entry also includes metadata about its creation, i.e., when it was added to the List and by whom. Requires the \"Export data from Lists\" [permission](#section/Getting-Started/Permissions).
* Get a Person\'s List Entries
* @param param the request object
*/
getV2PersonsIdListEntries(param, options) {
return this.api.getV2PersonsIdListEntries(param.id, param.cursor, param.limit, options).toPromise();
}
/**
* Returns metadata for all the Lists on which the given Person appears.
* Get a Person\'s Lists
* @param param the request object
*/
getV2PersonsIdListsWithHttpInfo(param, options) {
return this.api.getV2PersonsIdListsWithHttpInfo(param.id, param.cursor, param.limit, options).toPromise();
}
/**
* Returns metadata for all the Lists on which the given Person appears.
* Get a Person\'s Lists
* @param param the request object
*/
getV2PersonsIdLists(param, options) {
return this.api.getV2PersonsIdLists(param.id, param.cursor, param.limit, options).toPromise();
}
}