diff --git a/codegen/crm/lists/apis/FoldersApi.ts b/codegen/crm/lists/apis/FoldersApi.ts index e9030b7929..6694eb9304 100644 --- a/codegen/crm/lists/apis/FoldersApi.ts +++ b/codegen/crm/lists/apis/FoldersApi.ts @@ -106,8 +106,8 @@ export class FoldersApiRequestFactory extends BaseAPIRequestFactory { /** * This moves the folder from its current location to a new location. It updates the parent of this folder to the new Id given. * Moves a folder - * @param folderId - * @param newParentFolderId + * @param folderId The ID of the folder to move + * @param newParentFolderId The ID for the target parent folder. */ public async move(folderId: string, newParentFolderId: string, _options?: Configuration): Promise { let _config = _options || this.configuration; @@ -200,7 +200,7 @@ export class FoldersApiRequestFactory extends BaseAPIRequestFactory { /** * Deletes the folder with the given Id. * Deletes a folder - * @param folderId + * @param folderId The ID of the folder to delete */ public async remove(folderId: string, _options?: Configuration): Promise { let _config = _options || this.configuration; @@ -238,8 +238,8 @@ export class FoldersApiRequestFactory extends BaseAPIRequestFactory { /** * Renames the given folderId with a new name. * Rename a folder - * @param folderId - * @param newFolderName + * @param folderId The ID of the folder to rename + * @param newFolderName The new name of the folder. */ public async rename(folderId: string, newFolderName?: string, _options?: Configuration): Promise { let _config = _options || this.configuration; diff --git a/codegen/crm/lists/apis/ListsApi.ts b/codegen/crm/lists/apis/ListsApi.ts index 9ea3f6ca85..0add15fc71 100644 --- a/codegen/crm/lists/apis/ListsApi.ts +++ b/codegen/crm/lists/apis/ListsApi.ts @@ -16,12 +16,52 @@ import { ListSearchRequest } from '../models/ListSearchRequest'; import { ListSearchResponse } from '../models/ListSearchResponse'; import { ListUpdateResponse } from '../models/ListUpdateResponse'; import { ListsByIdResponse } from '../models/ListsByIdResponse'; +import { PublicListConversionResponse } from '../models/PublicListConversionResponse'; +import { PublicListConversionTime } from '../models/PublicListConversionTime'; /** * no description */ export class ListsApiRequestFactory extends BaseAPIRequestFactory { + /** + * Delete an existing scheduled conversion for a list. + * Cancel the conversion of a list + * @param listId The ID of the list that you want to cancel the conversion for. + */ + public async cancelConversion(listId: string, _options?: Configuration): Promise { + let _config = _options || this.configuration; + + // verify required parameter 'listId' is not null or undefined + if (listId === null || listId === undefined) { + throw new RequiredError("ListsApi", "cancelConversion", "listId"); + } + + + // Path Params + const localVarPath = '/crm/v3/lists/{listId}/schedule-conversion' + .replace('{' + 'listId' + '}', encodeURIComponent(String(listId))); + + // Make Request Context + const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.DELETE); + requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") + + + let authMethod: SecurityAuthentication | undefined; + // Apply auth methods + authMethod = _config.authMethods["oauth2"] + if (authMethod?.applySecurityAuthentication) { + await authMethod?.applySecurityAuthentication(requestContext); + } + + const defaultAuth: SecurityAuthentication | undefined = _config?.authMethods?.default + if (defaultAuth?.applySecurityAuthentication) { + await defaultAuth?.applySecurityAuthentication(requestContext); + } + + return requestContext; + } + /** * Create a new list with the provided object list definition. * Create List @@ -73,7 +113,7 @@ export class ListsApiRequestFactory extends BaseAPIRequestFactory { /** * Search lists by list name or page through all lists by providing an empty `query` value. * Search Lists - * @param listSearchRequest + * @param listSearchRequest The IDs of the records to add and/or remove from the list. */ public async doSearch(listSearchRequest: ListSearchRequest, _options?: Configuration): Promise { let _config = _options || this.configuration; @@ -263,6 +303,44 @@ export class ListsApiRequestFactory extends BaseAPIRequestFactory { return requestContext; } + /** + * Retrieve the conversion details for a list. This can be used to check for an upcoming conversion, or to get the details of when a list was already converted. + * Retrieve the conversion details for a list + * @param listId The ID of the list to schedule the conversion for. + */ + public async getConversionDetails(listId: string, _options?: Configuration): Promise { + let _config = _options || this.configuration; + + // verify required parameter 'listId' is not null or undefined + if (listId === null || listId === undefined) { + throw new RequiredError("ListsApi", "getConversionDetails", "listId"); + } + + + // Path Params + const localVarPath = '/crm/v3/lists/{listId}/schedule-conversion' + .replace('{' + 'listId' + '}', encodeURIComponent(String(listId))); + + // Make Request Context + const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.GET); + requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") + + + let authMethod: SecurityAuthentication | undefined; + // Apply auth methods + authMethod = _config.authMethods["oauth2"] + if (authMethod?.applySecurityAuthentication) { + await authMethod?.applySecurityAuthentication(requestContext); + } + + const defaultAuth: SecurityAuthentication | undefined = _config?.authMethods?.default + if (defaultAuth?.applySecurityAuthentication) { + await defaultAuth?.applySecurityAuthentication(requestContext); + } + + return requestContext; + } + /** * Delete a list by **ILS list ID**. Lists deleted through this endpoint can be restored up to 90-days following the delete. After 90-days, the list is purged and can no longer be restored. * Delete a List @@ -339,6 +417,62 @@ export class ListsApiRequestFactory extends BaseAPIRequestFactory { return requestContext; } + /** + * Schedule the conversion of an active list into a static list, or update the already scheduled conversion. This can be scheduled for a specific date or based on activity. + * Schedule or update the conversion of a list to static + * @param listId The ID of the list to schedule the conversion for. + * @param publicListConversionTime + */ + public async scheduleOrUpdateConversion(listId: string, publicListConversionTime: PublicListConversionTime, _options?: Configuration): Promise { + let _config = _options || this.configuration; + + // verify required parameter 'listId' is not null or undefined + if (listId === null || listId === undefined) { + throw new RequiredError("ListsApi", "scheduleOrUpdateConversion", "listId"); + } + + + // verify required parameter 'publicListConversionTime' is not null or undefined + if (publicListConversionTime === null || publicListConversionTime === undefined) { + throw new RequiredError("ListsApi", "scheduleOrUpdateConversion", "publicListConversionTime"); + } + + + // Path Params + const localVarPath = '/crm/v3/lists/{listId}/schedule-conversion' + .replace('{' + 'listId' + '}', encodeURIComponent(String(listId))); + + // Make Request Context + const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.PUT); + requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") + + + // Body Params + const contentType = ObjectSerializer.getPreferredMediaType([ + "application/json" + ]); + requestContext.setHeaderParam("Content-Type", contentType); + const serializedBody = ObjectSerializer.stringify( + ObjectSerializer.serialize(publicListConversionTime, "PublicListConversionTime", ""), + contentType + ); + requestContext.setBody(serializedBody); + + let authMethod: SecurityAuthentication | undefined; + // Apply auth methods + authMethod = _config.authMethods["oauth2"] + if (authMethod?.applySecurityAuthentication) { + await authMethod?.applySecurityAuthentication(requestContext); + } + + const defaultAuth: SecurityAuthentication | undefined = _config?.authMethods?.default + if (defaultAuth?.applySecurityAuthentication) { + await defaultAuth?.applySecurityAuthentication(requestContext); + } + + return requestContext; + } + /** * Update the filter branch definition of a `DYNAMIC` list. Once updated, the list memberships will be re-evaluated and updated to match the new definition. * Update List Filter Definition @@ -458,6 +592,38 @@ export class ListsApiRequestFactory extends BaseAPIRequestFactory { export class ListsApiResponseProcessor { + /** + * 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 cancelConversion + * @throws ApiException if the response code was not in [200, 299] + */ + public async cancelConversionWithHttpInfo(response: ResponseContext): Promise> { + const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]); + if (isCodeInRange("204", response.httpStatusCode)) { + return new HttpInfo(response.httpStatusCode, response.headers, response.body, undefined); + } + if (isCodeInRange("0", response.httpStatusCode)) { + const body: Error = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "Error", "" + ) as Error; + throw new ApiException(response.httpStatusCode, "An error occurred.", body, response.headers); + } + + // Work around for missing responses in specification, e.g. for petstore.yaml + if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) { + const body: void = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "void", "" + ) as void; + return new HttpInfo(response.httpStatusCode, response.headers, response.body, body); + } + + throw new ApiException(response.httpStatusCode, "Unknown API Status Code!", await response.getBodyAsAny(), response.headers); + } + /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects @@ -638,6 +804,42 @@ export class ListsApiResponseProcessor { throw new ApiException(response.httpStatusCode, "Unknown API Status Code!", await response.getBodyAsAny(), response.headers); } + /** + * 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 getConversionDetails + * @throws ApiException if the response code was not in [200, 299] + */ + public async getConversionDetailsWithHttpInfo(response: ResponseContext): Promise> { + const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]); + if (isCodeInRange("200", response.httpStatusCode)) { + const body: PublicListConversionResponse = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "PublicListConversionResponse", "" + ) as PublicListConversionResponse; + return new HttpInfo(response.httpStatusCode, response.headers, response.body, body); + } + if (isCodeInRange("0", response.httpStatusCode)) { + const body: Error = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "Error", "" + ) as Error; + throw new ApiException(response.httpStatusCode, "An error occurred.", body, response.headers); + } + + // Work around for missing responses in specification, e.g. for petstore.yaml + if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) { + const body: PublicListConversionResponse = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "PublicListConversionResponse", "" + ) as PublicListConversionResponse; + return new HttpInfo(response.httpStatusCode, response.headers, response.body, body); + } + + throw new ApiException(response.httpStatusCode, "Unknown API Status Code!", await response.getBodyAsAny(), response.headers); + } + /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects @@ -702,6 +904,42 @@ export class ListsApiResponseProcessor { throw new ApiException(response.httpStatusCode, "Unknown API Status Code!", await response.getBodyAsAny(), response.headers); } + /** + * 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 scheduleOrUpdateConversion + * @throws ApiException if the response code was not in [200, 299] + */ + public async scheduleOrUpdateConversionWithHttpInfo(response: ResponseContext): Promise> { + const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]); + if (isCodeInRange("200", response.httpStatusCode)) { + const body: PublicListConversionResponse = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "PublicListConversionResponse", "" + ) as PublicListConversionResponse; + return new HttpInfo(response.httpStatusCode, response.headers, response.body, body); + } + if (isCodeInRange("0", response.httpStatusCode)) { + const body: Error = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "Error", "" + ) as Error; + throw new ApiException(response.httpStatusCode, "An error occurred.", body, response.headers); + } + + // Work around for missing responses in specification, e.g. for petstore.yaml + if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) { + const body: PublicListConversionResponse = ObjectSerializer.deserialize( + ObjectSerializer.parse(await response.body.text(), contentType), + "PublicListConversionResponse", "" + ) as PublicListConversionResponse; + return new HttpInfo(response.httpStatusCode, response.headers, response.body, body); + } + + throw new ApiException(response.httpStatusCode, "Unknown API Status Code!", await response.getBodyAsAny(), response.headers); + } + /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects diff --git a/codegen/crm/lists/apis/MembershipsApi.ts b/codegen/crm/lists/apis/MembershipsApi.ts index a10ca8d6c7..96a4443b9b 100644 --- a/codegen/crm/lists/apis/MembershipsApi.ts +++ b/codegen/crm/lists/apis/MembershipsApi.ts @@ -22,7 +22,7 @@ export class MembershipsApiRequestFactory extends BaseAPIRequestFactory { * Add the records provided to the list. Records that do not exist or that are already members of the list are ignored. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`. * Add Records to a List * @param listId The **ILS ID** of the `MANUAL` or `SNAPSHOT` list. - * @param requestBody + * @param requestBody The IDs of the records to add to the list. */ public async add(listId: string, requestBody: Array, _options?: Configuration): Promise { let _config = _options || this.configuration; @@ -124,7 +124,7 @@ export class MembershipsApiRequestFactory extends BaseAPIRequestFactory { * Add and/or remove records that have already been created in the system to and/or from a list. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`. * Add and/or Remove Records from a List * @param listId The **ILS ID** of the `MANUAL` or `SNAPSHOT` list. - * @param membershipChangeRequest + * @param membershipChangeRequest The IDs of the records to add and/or remove from the list. */ public async addAndRemove(listId: string, membershipChangeRequest: MembershipChangeRequest, _options?: Configuration): Promise { let _config = _options || this.configuration; @@ -344,7 +344,7 @@ export class MembershipsApiRequestFactory extends BaseAPIRequestFactory { * Remove the records provided from the list. Records that do not exist or that are not members of the list are ignored. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`. * Remove Records from a List * @param listId The **ILS ID** of the `MANUAL` or `SNAPSHOT` list. - * @param requestBody + * @param requestBody The IDs of the records to remove from the list. */ public async remove(listId: string, requestBody: Array, _options?: Configuration): Promise { let _config = _options || this.configuration; diff --git a/codegen/crm/lists/models/ApiCollectionResponseJoinTimeAndRecordId.ts b/codegen/crm/lists/models/ApiCollectionResponseJoinTimeAndRecordId.ts index 2459d62d8e..5cd8e1b79e 100644 --- a/codegen/crm/lists/models/ApiCollectionResponseJoinTimeAndRecordId.ts +++ b/codegen/crm/lists/models/ApiCollectionResponseJoinTimeAndRecordId.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/ApiCollectionResponseRecordListMembershipNoPaging.ts b/codegen/crm/lists/models/ApiCollectionResponseRecordListMembershipNoPaging.ts index 4cf1e9c240..3a23277140 100644 --- a/codegen/crm/lists/models/ApiCollectionResponseRecordListMembershipNoPaging.ts +++ b/codegen/crm/lists/models/ApiCollectionResponseRecordListMembershipNoPaging.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/ErrorDetail.ts b/codegen/crm/lists/models/ErrorDetail.ts index 0869cefa7d..b8770ad4f2 100644 --- a/codegen/crm/lists/models/ErrorDetail.ts +++ b/codegen/crm/lists/models/ErrorDetail.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/JoinTimeAndRecordId.ts b/codegen/crm/lists/models/JoinTimeAndRecordId.ts index 071e9f7cab..f1ab9c5835 100644 --- a/codegen/crm/lists/models/JoinTimeAndRecordId.ts +++ b/codegen/crm/lists/models/JoinTimeAndRecordId.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/ListCreateRequest.ts b/codegen/crm/lists/models/ListCreateRequest.ts index 49993dfcc1..afff6750b8 100644 --- a/codegen/crm/lists/models/ListCreateRequest.ts +++ b/codegen/crm/lists/models/ListCreateRequest.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * @@ -10,9 +10,15 @@ * Do not edit the class manually. */ +import { PublicListPermissions } from '../models/PublicListPermissions'; +import { PublicMembershipSettings } from '../models/PublicMembershipSettings'; import { PublicPropertyAssociationFilterBranchFilterBranchesInner } from '../models/PublicPropertyAssociationFilterBranchFilterBranchesInner'; +/** +* The request object used when creating a new object list. +*/ export class ListCreateRequest { + 'membershipSettings'?: PublicMembershipSettings; /** * The object type ID of the type of objects that the list will store. */ @@ -33,6 +39,7 @@ export class ListCreateRequest { * The name of the list, which must be globally unique across all public lists in the portal. */ 'name': string; + 'listPermissions'?: PublicListPermissions; 'filterBranch'?: PublicPropertyAssociationFilterBranchFilterBranchesInner; static readonly discriminator: string | undefined = undefined; @@ -40,6 +47,12 @@ export class ListCreateRequest { static readonly mapping: {[index: string]: string} | undefined = undefined; static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ + { + "name": "membershipSettings", + "baseName": "membershipSettings", + "type": "PublicMembershipSettings", + "format": "" + }, { "name": "objectTypeId", "baseName": "objectTypeId", @@ -70,6 +83,12 @@ export class ListCreateRequest { "type": "string", "format": "" }, + { + "name": "listPermissions", + "baseName": "listPermissions", + "type": "PublicListPermissions", + "format": "" + }, { "name": "filterBranch", "baseName": "filterBranch", diff --git a/codegen/crm/lists/models/ListCreateResponse.ts b/codegen/crm/lists/models/ListCreateResponse.ts index d1e66ec726..c6bf70eead 100644 --- a/codegen/crm/lists/models/ListCreateResponse.ts +++ b/codegen/crm/lists/models/ListCreateResponse.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * @@ -12,6 +12,9 @@ import { PublicObjectList } from '../models/PublicObjectList'; +/** +* The response for a list create request. +*/ export class ListCreateResponse { 'list': PublicObjectList; diff --git a/codegen/crm/lists/models/ListFetchResponse.ts b/codegen/crm/lists/models/ListFetchResponse.ts index 457e395315..97ce3bfe0c 100644 --- a/codegen/crm/lists/models/ListFetchResponse.ts +++ b/codegen/crm/lists/models/ListFetchResponse.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * @@ -12,6 +12,9 @@ import { PublicObjectList } from '../models/PublicObjectList'; +/** +* The response for a list fetch request. +*/ export class ListFetchResponse { 'list': PublicObjectList; diff --git a/codegen/crm/lists/models/ListFilterUpdateRequest.ts b/codegen/crm/lists/models/ListFilterUpdateRequest.ts index 045811ec1b..e12a127665 100644 --- a/codegen/crm/lists/models/ListFilterUpdateRequest.ts +++ b/codegen/crm/lists/models/ListFilterUpdateRequest.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * @@ -12,6 +12,9 @@ import { PublicPropertyAssociationFilterBranchFilterBranchesInner } from '../models/PublicPropertyAssociationFilterBranchFilterBranchesInner'; +/** +* The definition of the list filter branch update request. +*/ export class ListFilterUpdateRequest { 'filterBranch': PublicPropertyAssociationFilterBranchFilterBranchesInner; diff --git a/codegen/crm/lists/models/ListFolderCreateRequest.ts b/codegen/crm/lists/models/ListFolderCreateRequest.ts index 89bba6bbff..8cb89252f2 100644 --- a/codegen/crm/lists/models/ListFolderCreateRequest.ts +++ b/codegen/crm/lists/models/ListFolderCreateRequest.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/ListFolderCreateResponse.ts b/codegen/crm/lists/models/ListFolderCreateResponse.ts index c9b67202a7..18a75e898d 100644 --- a/codegen/crm/lists/models/ListFolderCreateResponse.ts +++ b/codegen/crm/lists/models/ListFolderCreateResponse.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/ListFolderFetchResponse.ts b/codegen/crm/lists/models/ListFolderFetchResponse.ts index 3c9c6c79c1..48a6f4437e 100644 --- a/codegen/crm/lists/models/ListFolderFetchResponse.ts +++ b/codegen/crm/lists/models/ListFolderFetchResponse.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/ListMoveRequest.ts b/codegen/crm/lists/models/ListMoveRequest.ts index acee74cc24..0d3bef25e9 100644 --- a/codegen/crm/lists/models/ListMoveRequest.ts +++ b/codegen/crm/lists/models/ListMoveRequest.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/ListSearchRequest.ts b/codegen/crm/lists/models/ListSearchRequest.ts index 80610ad1b9..1ccb6ff297 100644 --- a/codegen/crm/lists/models/ListSearchRequest.ts +++ b/codegen/crm/lists/models/ListSearchRequest.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * @@ -11,6 +11,9 @@ */ +/** +* The request object used for searching through lists. +*/ export class ListSearchRequest { /** * The `listIds` that will be used to filter results by `listId`. If values are provided, then the response will only include results that have a `listId` in this array. If no value is provided, or if an empty list is provided, then the results will not be filtered by `listId`. diff --git a/codegen/crm/lists/models/ListSearchResponse.ts b/codegen/crm/lists/models/ListSearchResponse.ts index 4ca91aee0e..9bd0eafb74 100644 --- a/codegen/crm/lists/models/ListSearchResponse.ts +++ b/codegen/crm/lists/models/ListSearchResponse.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * @@ -12,6 +12,9 @@ import { PublicObjectListSearchResult } from '../models/PublicObjectListSearchResult'; +/** +* The response object with the list search hits and additional information regarding pagination. +*/ export class ListSearchResponse { /** * The total number of lists that match the search criteria. diff --git a/codegen/crm/lists/models/ListUpdateResponse.ts b/codegen/crm/lists/models/ListUpdateResponse.ts index 52a0b270dc..c9fcb019ed 100644 --- a/codegen/crm/lists/models/ListUpdateResponse.ts +++ b/codegen/crm/lists/models/ListUpdateResponse.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * @@ -12,6 +12,9 @@ import { PublicObjectList } from '../models/PublicObjectList'; +/** +* The updated definition of the list in response to a list update request. +*/ export class ListUpdateResponse { 'updatedList'?: PublicObjectList; diff --git a/codegen/crm/lists/models/ListsByIdResponse.ts b/codegen/crm/lists/models/ListsByIdResponse.ts index d8a52bd7f4..6a97256732 100644 --- a/codegen/crm/lists/models/ListsByIdResponse.ts +++ b/codegen/crm/lists/models/ListsByIdResponse.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * @@ -12,6 +12,9 @@ import { PublicObjectList } from '../models/PublicObjectList'; +/** +* The response object containing the lists found for a multi-list fetch. +*/ export class ListsByIdResponse { /** * The object list definitions. diff --git a/codegen/crm/lists/models/MembershipChangeRequest.ts b/codegen/crm/lists/models/MembershipChangeRequest.ts index c41b81f849..e93e238c60 100644 --- a/codegen/crm/lists/models/MembershipChangeRequest.ts +++ b/codegen/crm/lists/models/MembershipChangeRequest.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * @@ -11,14 +11,11 @@ */ +/** +* The IDs of the records to add and/or remove from a list. +*/ export class MembershipChangeRequest { - /** - * - */ 'recordIdsToRemove': Array; - /** - * - */ 'recordIdsToAdd': Array; static readonly discriminator: string | undefined = undefined; diff --git a/codegen/crm/lists/models/MembershipsUpdateResponse.ts b/codegen/crm/lists/models/MembershipsUpdateResponse.ts index 2ed8e3723a..ea95386a8f 100644 --- a/codegen/crm/lists/models/MembershipsUpdateResponse.ts +++ b/codegen/crm/lists/models/MembershipsUpdateResponse.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * @@ -11,6 +11,9 @@ */ +/** +* The IDs of the records that were `added`, `removed`, and/or found to be `missing` as a result of the membership update request. +*/ export class MembershipsUpdateResponse { /** * The IDs of the records that were `removed` from the list. diff --git a/codegen/crm/lists/models/ModelError.ts b/codegen/crm/lists/models/ModelError.ts index a80e47dbed..6503b0b6aa 100644 --- a/codegen/crm/lists/models/ModelError.ts +++ b/codegen/crm/lists/models/ModelError.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/NextPage.ts b/codegen/crm/lists/models/NextPage.ts index d971ee7445..4a81a153b1 100644 --- a/codegen/crm/lists/models/NextPage.ts +++ b/codegen/crm/lists/models/NextPage.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * @@ -11,6 +11,9 @@ */ +/** +* The cursor for the next page of records. +*/ export class NextPage { /** * A direct link to the request for the next page of records. diff --git a/codegen/crm/lists/models/ObjectSerializer.ts b/codegen/crm/lists/models/ObjectSerializer.ts index feff1f4e3e..2d96ba1198 100644 --- a/codegen/crm/lists/models/ObjectSerializer.ts +++ b/codegen/crm/lists/models/ObjectSerializer.ts @@ -57,7 +57,14 @@ export * from '../models/PublicIndexOffset'; export * from '../models/PublicIndexedTimePoint'; export * from '../models/PublicIndexedTimePointIndexReference'; export * from '../models/PublicIntegrationEventFilter'; +export * from '../models/PublicListConversionDate'; +export * from '../models/PublicListConversionInactivity'; +export * from '../models/PublicListConversionResponse'; +export * from '../models/PublicListConversionResponseRequestedConversionTime'; +export * from '../models/PublicListConversionTime'; export * from '../models/PublicListFolder'; +export * from '../models/PublicListPermissions'; +export * from '../models/PublicMembershipSettings'; export * from '../models/PublicMigrationMapping'; export * from '../models/PublicMonthReference'; export * from '../models/PublicMultiStringPropertyOperation'; @@ -162,7 +169,14 @@ import { PublicIndexOffset } from '../models/PublicIndexOffset'; import { PublicIndexedTimePoint } from '../models/PublicIndexedTimePoint'; import { PublicIndexedTimePointIndexReferenceClass } from '../models/PublicIndexedTimePointIndexReference'; import { PublicIntegrationEventFilter } from '../models/PublicIntegrationEventFilter'; +import { PublicListConversionDate } from '../models/PublicListConversionDate'; +import { PublicListConversionInactivity } from '../models/PublicListConversionInactivity'; +import { PublicListConversionResponse } from '../models/PublicListConversionResponse'; +import { PublicListConversionResponseRequestedConversionTimeClass } from '../models/PublicListConversionResponseRequestedConversionTime'; +import { PublicListConversionTimeClass } from '../models/PublicListConversionTime'; import { PublicListFolder } from '../models/PublicListFolder'; +import { PublicListPermissions } from '../models/PublicListPermissions'; +import { PublicMembershipSettings } from '../models/PublicMembershipSettings'; import { PublicMigrationMapping } from '../models/PublicMigrationMapping'; import { PublicMonthReference } from '../models/PublicMonthReference'; import { PublicMultiStringPropertyOperation } from '../models/PublicMultiStringPropertyOperation'; @@ -258,6 +272,13 @@ let enumsMap: Set = new Set([ "PublicIndexedTimePointIndexReferenceReferenceTypeEnum", "PublicIndexedTimePointIndexReferenceDayOfWeekEnum", "PublicIntegrationEventFilterFilterTypeEnum", + "PublicListConversionDateConversionTypeEnum", + "PublicListConversionInactivityConversionTypeEnum", + "PublicListConversionInactivityTimeUnitEnum", + "PublicListConversionResponseRequestedConversionTimeConversionTypeEnum", + "PublicListConversionResponseRequestedConversionTimeTimeUnitEnum", + "PublicListConversionTimeConversionTypeEnum", + "PublicListConversionTimeTimeUnitEnum", "PublicMonthReferenceReferenceTypeEnum", "PublicMultiStringPropertyOperationOperationTypeEnum", "PublicNotAllFilterBranchFilterBranchTypeEnum", @@ -361,7 +382,14 @@ let typeMap: {[index: string]: any} = { "PublicIndexedTimePoint": PublicIndexedTimePoint, "PublicIndexedTimePointIndexReference": PublicIndexedTimePointIndexReferenceClass, "PublicIntegrationEventFilter": PublicIntegrationEventFilter, + "PublicListConversionDate": PublicListConversionDate, + "PublicListConversionInactivity": PublicListConversionInactivity, + "PublicListConversionResponse": PublicListConversionResponse, + "PublicListConversionResponseRequestedConversionTime": PublicListConversionResponseRequestedConversionTimeClass, + "PublicListConversionTime": PublicListConversionTimeClass, "PublicListFolder": PublicListFolder, + "PublicListPermissions": PublicListPermissions, + "PublicMembershipSettings": PublicMembershipSettings, "PublicMigrationMapping": PublicMigrationMapping, "PublicMonthReference": PublicMonthReference, "PublicMultiStringPropertyOperation": PublicMultiStringPropertyOperation, diff --git a/codegen/crm/lists/models/Paging.ts b/codegen/crm/lists/models/Paging.ts index 332dec8799..d78ebe2c82 100644 --- a/codegen/crm/lists/models/Paging.ts +++ b/codegen/crm/lists/models/Paging.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * @@ -13,6 +13,9 @@ import { NextPage } from '../models/NextPage'; import { PreviousPage } from '../models/PreviousPage'; +/** +* The cursor to be used for paging through records. +*/ export class Paging { 'next'?: NextPage; 'prev'?: PreviousPage; diff --git a/codegen/crm/lists/models/PreviousPage.ts b/codegen/crm/lists/models/PreviousPage.ts index d48b54e607..ebdb3e82a5 100644 --- a/codegen/crm/lists/models/PreviousPage.ts +++ b/codegen/crm/lists/models/PreviousPage.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * @@ -11,6 +11,9 @@ */ +/** +* The cursor for the previous page of records. +*/ export class PreviousPage { /** * The offset of the previous page of records. diff --git a/codegen/crm/lists/models/PublicAbsoluteComparativeTimestampRefineBy.ts b/codegen/crm/lists/models/PublicAbsoluteComparativeTimestampRefineBy.ts index 4a97883ad7..9093171915 100644 --- a/codegen/crm/lists/models/PublicAbsoluteComparativeTimestampRefineBy.ts +++ b/codegen/crm/lists/models/PublicAbsoluteComparativeTimestampRefineBy.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicAbsoluteRangedTimestampRefineBy.ts b/codegen/crm/lists/models/PublicAbsoluteRangedTimestampRefineBy.ts index d76ae038d1..c3e480d2a2 100644 --- a/codegen/crm/lists/models/PublicAbsoluteRangedTimestampRefineBy.ts +++ b/codegen/crm/lists/models/PublicAbsoluteRangedTimestampRefineBy.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicAdsSearchFilter.ts b/codegen/crm/lists/models/PublicAdsSearchFilter.ts index e5b6b0bb33..722cc5c493 100644 --- a/codegen/crm/lists/models/PublicAdsSearchFilter.ts +++ b/codegen/crm/lists/models/PublicAdsSearchFilter.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicAdsTimeFilter.ts b/codegen/crm/lists/models/PublicAdsTimeFilter.ts index 4e6e67ac4e..ff8ef65776 100644 --- a/codegen/crm/lists/models/PublicAdsTimeFilter.ts +++ b/codegen/crm/lists/models/PublicAdsTimeFilter.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicAllHistoryRefineBy.ts b/codegen/crm/lists/models/PublicAllHistoryRefineBy.ts index 8c87b9177d..fa2d364aed 100644 --- a/codegen/crm/lists/models/PublicAllHistoryRefineBy.ts +++ b/codegen/crm/lists/models/PublicAllHistoryRefineBy.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicAllPropertyTypesOperation.ts b/codegen/crm/lists/models/PublicAllPropertyTypesOperation.ts index 6c758fcd7f..6b52d14009 100644 --- a/codegen/crm/lists/models/PublicAllPropertyTypesOperation.ts +++ b/codegen/crm/lists/models/PublicAllPropertyTypesOperation.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicAndFilterBranch.ts b/codegen/crm/lists/models/PublicAndFilterBranch.ts index c2f8ca1267..dc09e01e41 100644 --- a/codegen/crm/lists/models/PublicAndFilterBranch.ts +++ b/codegen/crm/lists/models/PublicAndFilterBranch.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicAssociationFilterBranch.ts b/codegen/crm/lists/models/PublicAssociationFilterBranch.ts index a2d887b66b..f5cb14cdd8 100644 --- a/codegen/crm/lists/models/PublicAssociationFilterBranch.ts +++ b/codegen/crm/lists/models/PublicAssociationFilterBranch.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicAssociationInListFilter.ts b/codegen/crm/lists/models/PublicAssociationInListFilter.ts index cb514fcaea..cf5d7a7b16 100644 --- a/codegen/crm/lists/models/PublicAssociationInListFilter.ts +++ b/codegen/crm/lists/models/PublicAssociationInListFilter.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicBatchMigrationMapping.ts b/codegen/crm/lists/models/PublicBatchMigrationMapping.ts index aef4be41e3..0ad9d3db80 100644 --- a/codegen/crm/lists/models/PublicBatchMigrationMapping.ts +++ b/codegen/crm/lists/models/PublicBatchMigrationMapping.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicBoolPropertyOperation.ts b/codegen/crm/lists/models/PublicBoolPropertyOperation.ts index 4e05cd6b2a..f177e788c4 100644 --- a/codegen/crm/lists/models/PublicBoolPropertyOperation.ts +++ b/codegen/crm/lists/models/PublicBoolPropertyOperation.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicCalendarDatePropertyOperation.ts b/codegen/crm/lists/models/PublicCalendarDatePropertyOperation.ts index 92ab1df045..57064d9510 100644 --- a/codegen/crm/lists/models/PublicCalendarDatePropertyOperation.ts +++ b/codegen/crm/lists/models/PublicCalendarDatePropertyOperation.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicCampaignInfluencedFilter.ts b/codegen/crm/lists/models/PublicCampaignInfluencedFilter.ts index 7d482cccd0..1384530230 100644 --- a/codegen/crm/lists/models/PublicCampaignInfluencedFilter.ts +++ b/codegen/crm/lists/models/PublicCampaignInfluencedFilter.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicCommunicationSubscriptionFilter.ts b/codegen/crm/lists/models/PublicCommunicationSubscriptionFilter.ts index 86fb48b74f..c180ad5145 100644 --- a/codegen/crm/lists/models/PublicCommunicationSubscriptionFilter.ts +++ b/codegen/crm/lists/models/PublicCommunicationSubscriptionFilter.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicComparativeDatePropertyOperation.ts b/codegen/crm/lists/models/PublicComparativeDatePropertyOperation.ts index 7f2bddce66..b2e6bf550b 100644 --- a/codegen/crm/lists/models/PublicComparativeDatePropertyOperation.ts +++ b/codegen/crm/lists/models/PublicComparativeDatePropertyOperation.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicComparativePropertyUpdatedOperation.ts b/codegen/crm/lists/models/PublicComparativePropertyUpdatedOperation.ts index 971eb27c24..84ab68c144 100644 --- a/codegen/crm/lists/models/PublicComparativePropertyUpdatedOperation.ts +++ b/codegen/crm/lists/models/PublicComparativePropertyUpdatedOperation.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicConstantFilter.ts b/codegen/crm/lists/models/PublicConstantFilter.ts index 6de36ef2de..196599c09c 100644 --- a/codegen/crm/lists/models/PublicConstantFilter.ts +++ b/codegen/crm/lists/models/PublicConstantFilter.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicCtaAnalyticsFilter.ts b/codegen/crm/lists/models/PublicCtaAnalyticsFilter.ts index 87446b4699..3f84c541e4 100644 --- a/codegen/crm/lists/models/PublicCtaAnalyticsFilter.ts +++ b/codegen/crm/lists/models/PublicCtaAnalyticsFilter.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicDatePoint.ts b/codegen/crm/lists/models/PublicDatePoint.ts index a3b00cefcc..4bb915f304 100644 --- a/codegen/crm/lists/models/PublicDatePoint.ts +++ b/codegen/crm/lists/models/PublicDatePoint.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicDatePropertyOperation.ts b/codegen/crm/lists/models/PublicDatePropertyOperation.ts index 6fa288a31b..467b924875 100644 --- a/codegen/crm/lists/models/PublicDatePropertyOperation.ts +++ b/codegen/crm/lists/models/PublicDatePropertyOperation.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicDateTimePropertyOperation.ts b/codegen/crm/lists/models/PublicDateTimePropertyOperation.ts index 7df230406e..dd0409af04 100644 --- a/codegen/crm/lists/models/PublicDateTimePropertyOperation.ts +++ b/codegen/crm/lists/models/PublicDateTimePropertyOperation.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicEmailEventFilter.ts b/codegen/crm/lists/models/PublicEmailEventFilter.ts index a2a785f2db..77ae5fc833 100644 --- a/codegen/crm/lists/models/PublicEmailEventFilter.ts +++ b/codegen/crm/lists/models/PublicEmailEventFilter.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicEmailSubscriptionFilter.ts b/codegen/crm/lists/models/PublicEmailSubscriptionFilter.ts index 01a0bc3b89..d9c8e79b31 100644 --- a/codegen/crm/lists/models/PublicEmailSubscriptionFilter.ts +++ b/codegen/crm/lists/models/PublicEmailSubscriptionFilter.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicEnumerationPropertyOperation.ts b/codegen/crm/lists/models/PublicEnumerationPropertyOperation.ts index 30bb11b9f2..32d3776de1 100644 --- a/codegen/crm/lists/models/PublicEnumerationPropertyOperation.ts +++ b/codegen/crm/lists/models/PublicEnumerationPropertyOperation.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicEventAnalyticsFilter.ts b/codegen/crm/lists/models/PublicEventAnalyticsFilter.ts index a6cbb1ee08..3dd8c10e23 100644 --- a/codegen/crm/lists/models/PublicEventAnalyticsFilter.ts +++ b/codegen/crm/lists/models/PublicEventAnalyticsFilter.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicEventFilterMetadata.ts b/codegen/crm/lists/models/PublicEventFilterMetadata.ts index 4e88734189..75e2d1d7a5 100644 --- a/codegen/crm/lists/models/PublicEventFilterMetadata.ts +++ b/codegen/crm/lists/models/PublicEventFilterMetadata.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicFiscalQuarterReference.ts b/codegen/crm/lists/models/PublicFiscalQuarterReference.ts index dd033ad00c..4a617c33c9 100644 --- a/codegen/crm/lists/models/PublicFiscalQuarterReference.ts +++ b/codegen/crm/lists/models/PublicFiscalQuarterReference.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicFiscalYearReference.ts b/codegen/crm/lists/models/PublicFiscalYearReference.ts index 9678f51d8e..9a3aad5167 100644 --- a/codegen/crm/lists/models/PublicFiscalYearReference.ts +++ b/codegen/crm/lists/models/PublicFiscalYearReference.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicFormSubmissionFilter.ts b/codegen/crm/lists/models/PublicFormSubmissionFilter.ts index c884a35854..14a431cd6c 100644 --- a/codegen/crm/lists/models/PublicFormSubmissionFilter.ts +++ b/codegen/crm/lists/models/PublicFormSubmissionFilter.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicFormSubmissionFilterCoalescingRefineBy.ts b/codegen/crm/lists/models/PublicFormSubmissionFilterCoalescingRefineBy.ts index e2a5274c91..ab13814f7e 100644 --- a/codegen/crm/lists/models/PublicFormSubmissionFilterCoalescingRefineBy.ts +++ b/codegen/crm/lists/models/PublicFormSubmissionFilterCoalescingRefineBy.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * @@ -32,9 +32,19 @@ export type PublicFormSubmissionFilterCoalescingRefineBy = PublicAbsoluteCompara * @export */ export class PublicFormSubmissionFilterCoalescingRefineByClass { - static readonly discriminator: string | undefined = undefined; - - static readonly mapping: {[index: string]: string} | undefined = undefined; + static readonly discriminator: string | undefined = "type"; + + static readonly mapping: {[index: string]: string} | undefined = { + "ABSOLUTE_COMPARATIVE": "PublicAbsoluteComparativeTimestampRefineBy", + "ABSOLUTE_RANGED": "PublicAbsoluteRangedTimestampRefineBy", + "ALL_HISTORY": "PublicAllHistoryRefineBy", + "NUM_OCCURRENCES": "PublicNumOccurrencesRefineBy", + "RELATIVE_COMPARATIVE": "PublicRelativeComparativeTimestampRefineBy", + "RELATIVE_RANGED": "PublicRelativeRangedTimestampRefineBy", + "SET_OCCURRENCES": "PublicSetOccurrencesRefineBy", + "TIME_POINT": "PublicTimePointOperation", + "TIME_RANGED": "PublicRangedTimeOperation", + }; } diff --git a/codegen/crm/lists/models/PublicFormSubmissionOnPageFilter.ts b/codegen/crm/lists/models/PublicFormSubmissionOnPageFilter.ts index c1a7419b13..41ee3e5fff 100644 --- a/codegen/crm/lists/models/PublicFormSubmissionOnPageFilter.ts +++ b/codegen/crm/lists/models/PublicFormSubmissionOnPageFilter.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicInListFilter.ts b/codegen/crm/lists/models/PublicInListFilter.ts index dcbd91d52c..f8e94785e4 100644 --- a/codegen/crm/lists/models/PublicInListFilter.ts +++ b/codegen/crm/lists/models/PublicInListFilter.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicInListFilterMetadata.ts b/codegen/crm/lists/models/PublicInListFilterMetadata.ts index 4849925fc9..24d6405642 100644 --- a/codegen/crm/lists/models/PublicInListFilterMetadata.ts +++ b/codegen/crm/lists/models/PublicInListFilterMetadata.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicIndexOffset.ts b/codegen/crm/lists/models/PublicIndexOffset.ts index bf13ef5032..eeed36cc0c 100644 --- a/codegen/crm/lists/models/PublicIndexOffset.ts +++ b/codegen/crm/lists/models/PublicIndexOffset.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicIndexedTimePoint.ts b/codegen/crm/lists/models/PublicIndexedTimePoint.ts index 301121a17e..306ae8c9df 100644 --- a/codegen/crm/lists/models/PublicIndexedTimePoint.ts +++ b/codegen/crm/lists/models/PublicIndexedTimePoint.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicIndexedTimePointIndexReference.ts b/codegen/crm/lists/models/PublicIndexedTimePointIndexReference.ts index 374afc134f..9dd7576204 100644 --- a/codegen/crm/lists/models/PublicIndexedTimePointIndexReference.ts +++ b/codegen/crm/lists/models/PublicIndexedTimePointIndexReference.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * @@ -31,9 +31,18 @@ export type PublicIndexedTimePointIndexReference = PublicFiscalQuarterReference * @export */ export class PublicIndexedTimePointIndexReferenceClass { - static readonly discriminator: string | undefined = undefined; - - static readonly mapping: {[index: string]: string} | undefined = undefined; + static readonly discriminator: string | undefined = "referenceType"; + + static readonly mapping: {[index: string]: string} | undefined = { + "FISCAL_QUARTER": "PublicFiscalQuarterReference", + "FISCAL_YEAR": "PublicFiscalYearReference", + "MONTH": "PublicMonthReference", + "NOW": "PublicNowReference", + "QUARTER": "PublicQuarterReference", + "TODAY": "PublicTodayReference", + "WEEK": "PublicWeekReference", + "YEAR": "PublicYearReference", + }; } diff --git a/codegen/crm/lists/models/PublicIntegrationEventFilter.ts b/codegen/crm/lists/models/PublicIntegrationEventFilter.ts index 3a8fd4eb5e..b9a701183a 100644 --- a/codegen/crm/lists/models/PublicIntegrationEventFilter.ts +++ b/codegen/crm/lists/models/PublicIntegrationEventFilter.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicListConversionDate.ts b/codegen/crm/lists/models/PublicListConversionDate.ts new file mode 100644 index 0000000000..9d1acd6e39 --- /dev/null +++ b/codegen/crm/lists/models/PublicListConversionDate.ts @@ -0,0 +1,61 @@ +/** + * CRM Lists + * CRUD operations to manage lists and list memberships + * + * OpenAPI spec version: v3 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +export class PublicListConversionDate { + 'month': number; + 'year': number; + 'conversionType': PublicListConversionDateConversionTypeEnum; + 'day': number; + + static readonly discriminator: string | undefined = undefined; + + static readonly mapping: {[index: string]: string} | undefined = undefined; + + static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ + { + "name": "month", + "baseName": "month", + "type": "number", + "format": "int32" + }, + { + "name": "year", + "baseName": "year", + "type": "number", + "format": "int32" + }, + { + "name": "conversionType", + "baseName": "conversionType", + "type": "PublicListConversionDateConversionTypeEnum", + "format": "" + }, + { + "name": "day", + "baseName": "day", + "type": "number", + "format": "int32" + } ]; + + static getAttributeTypeMap() { + return PublicListConversionDate.attributeTypeMap; + } + + public constructor() { + } +} + +export enum PublicListConversionDateConversionTypeEnum { + ConversionDate = 'CONVERSION_DATE' +} + diff --git a/codegen/crm/lists/models/PublicListConversionInactivity.ts b/codegen/crm/lists/models/PublicListConversionInactivity.ts new file mode 100644 index 0000000000..e6f2bc6456 --- /dev/null +++ b/codegen/crm/lists/models/PublicListConversionInactivity.ts @@ -0,0 +1,59 @@ +/** + * CRM Lists + * CRUD operations to manage lists and list memberships + * + * OpenAPI spec version: v3 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +export class PublicListConversionInactivity { + 'offset': number; + 'conversionType': PublicListConversionInactivityConversionTypeEnum; + 'timeUnit': PublicListConversionInactivityTimeUnitEnum; + + static readonly discriminator: string | undefined = undefined; + + static readonly mapping: {[index: string]: string} | undefined = undefined; + + static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ + { + "name": "offset", + "baseName": "offset", + "type": "number", + "format": "int32" + }, + { + "name": "conversionType", + "baseName": "conversionType", + "type": "PublicListConversionInactivityConversionTypeEnum", + "format": "" + }, + { + "name": "timeUnit", + "baseName": "timeUnit", + "type": "PublicListConversionInactivityTimeUnitEnum", + "format": "" + } ]; + + static getAttributeTypeMap() { + return PublicListConversionInactivity.attributeTypeMap; + } + + public constructor() { + } +} + +export enum PublicListConversionInactivityConversionTypeEnum { + Inactivity = 'INACTIVITY' +} +export enum PublicListConversionInactivityTimeUnitEnum { + Day = 'DAY', + Week = 'WEEK', + Month = 'MONTH' +} + diff --git a/codegen/crm/lists/models/PublicListConversionResponse.ts b/codegen/crm/lists/models/PublicListConversionResponse.ts new file mode 100644 index 0000000000..4477b3d115 --- /dev/null +++ b/codegen/crm/lists/models/PublicListConversionResponse.ts @@ -0,0 +1,50 @@ +/** + * CRM Lists + * CRUD operations to manage lists and list memberships + * + * OpenAPI spec version: v3 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import { PublicListConversionResponseRequestedConversionTime } from '../models/PublicListConversionResponseRequestedConversionTime'; + +export class PublicListConversionResponse { + 'listId': string; + 'requestedConversionTime'?: PublicListConversionResponseRequestedConversionTime; + 'convertedAt'?: Date; + + static readonly discriminator: string | undefined = undefined; + + static readonly mapping: {[index: string]: string} | undefined = undefined; + + static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ + { + "name": "listId", + "baseName": "listId", + "type": "string", + "format": "" + }, + { + "name": "requestedConversionTime", + "baseName": "requestedConversionTime", + "type": "PublicListConversionResponseRequestedConversionTime", + "format": "" + }, + { + "name": "convertedAt", + "baseName": "convertedAt", + "type": "Date", + "format": "date-time" + } ]; + + static getAttributeTypeMap() { + return PublicListConversionResponse.attributeTypeMap; + } + + public constructor() { + } +} diff --git a/codegen/crm/lists/models/PublicListConversionResponseRequestedConversionTime.ts b/codegen/crm/lists/models/PublicListConversionResponseRequestedConversionTime.ts new file mode 100644 index 0000000000..9cde64a724 --- /dev/null +++ b/codegen/crm/lists/models/PublicListConversionResponseRequestedConversionTime.ts @@ -0,0 +1,35 @@ +/** + * CRM Lists + * CRUD operations to manage lists and list memberships + * + * OpenAPI spec version: v3 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import { PublicListConversionDate } from '../models/PublicListConversionDate'; +import { PublicListConversionInactivity } from '../models/PublicListConversionInactivity'; + +/** + * @type PublicListConversionResponseRequestedConversionTime + * Type + * @export + */ +export type PublicListConversionResponseRequestedConversionTime = PublicListConversionDate | PublicListConversionInactivity; + +/** +* @type PublicListConversionResponseRequestedConversionTimeClass +* @export +*/ +export class PublicListConversionResponseRequestedConversionTimeClass { + static readonly discriminator: string | undefined = "conversionType"; + + static readonly mapping: {[index: string]: string} | undefined = { + "CONVERSION_DATE": "PublicListConversionDate", + "INACTIVITY": "PublicListConversionInactivity", + }; +} + diff --git a/codegen/crm/lists/models/PublicListConversionTime.ts b/codegen/crm/lists/models/PublicListConversionTime.ts new file mode 100644 index 0000000000..e68f0a599d --- /dev/null +++ b/codegen/crm/lists/models/PublicListConversionTime.ts @@ -0,0 +1,35 @@ +/** + * CRM Lists + * CRUD operations to manage lists and list memberships + * + * OpenAPI spec version: v3 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import { PublicListConversionDate } from '../models/PublicListConversionDate'; +import { PublicListConversionInactivity } from '../models/PublicListConversionInactivity'; + +/** + * @type PublicListConversionTime + * Type + * @export + */ +export type PublicListConversionTime = PublicListConversionDate | PublicListConversionInactivity; + +/** +* @type PublicListConversionTimeClass +* @export +*/ +export class PublicListConversionTimeClass { + static readonly discriminator: string | undefined = "conversionType"; + + static readonly mapping: {[index: string]: string} | undefined = { + "CONVERSION_DATE": "PublicListConversionDate", + "INACTIVITY": "PublicListConversionInactivity", + }; +} + diff --git a/codegen/crm/lists/models/PublicListFolder.ts b/codegen/crm/lists/models/PublicListFolder.ts index 4927633b4d..85e62a2df4 100644 --- a/codegen/crm/lists/models/PublicListFolder.ts +++ b/codegen/crm/lists/models/PublicListFolder.ts @@ -1,9 +1,9 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 - * + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/codegen/crm/lists/models/PublicListPermissions.ts b/codegen/crm/lists/models/PublicListPermissions.ts new file mode 100644 index 0000000000..f283048db1 --- /dev/null +++ b/codegen/crm/lists/models/PublicListPermissions.ts @@ -0,0 +1,42 @@ +/** + * CRM Lists + * CRUD operations to manage lists and list memberships + * + * OpenAPI spec version: v3 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +export class PublicListPermissions { + 'teamsWithEditAccess': Array; + 'usersWithEditAccess': Array; + + static readonly discriminator: string | undefined = undefined; + + static readonly mapping: {[index: string]: string} | undefined = undefined; + + static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ + { + "name": "teamsWithEditAccess", + "baseName": "teamsWithEditAccess", + "type": "Array", + "format": "int32" + }, + { + "name": "usersWithEditAccess", + "baseName": "usersWithEditAccess", + "type": "Array", + "format": "int32" + } ]; + + static getAttributeTypeMap() { + return PublicListPermissions.attributeTypeMap; + } + + public constructor() { + } +} diff --git a/codegen/crm/lists/models/PublicMembershipSettings.ts b/codegen/crm/lists/models/PublicMembershipSettings.ts new file mode 100644 index 0000000000..ed2269a7de --- /dev/null +++ b/codegen/crm/lists/models/PublicMembershipSettings.ts @@ -0,0 +1,42 @@ +/** + * CRM Lists + * CRUD operations to manage lists and list memberships + * + * OpenAPI spec version: v3 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +export class PublicMembershipSettings { + 'membershipTeamId'?: number; + 'includeUnassigned'?: boolean; + + static readonly discriminator: string | undefined = undefined; + + static readonly mapping: {[index: string]: string} | undefined = undefined; + + static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ + { + "name": "membershipTeamId", + "baseName": "membershipTeamId", + "type": "number", + "format": "int32" + }, + { + "name": "includeUnassigned", + "baseName": "includeUnassigned", + "type": "boolean", + "format": "" + } ]; + + static getAttributeTypeMap() { + return PublicMembershipSettings.attributeTypeMap; + } + + public constructor() { + } +} diff --git a/codegen/crm/lists/models/PublicMigrationMapping.ts b/codegen/crm/lists/models/PublicMigrationMapping.ts index 9825618114..7f78c2f053 100644 --- a/codegen/crm/lists/models/PublicMigrationMapping.ts +++ b/codegen/crm/lists/models/PublicMigrationMapping.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicMonthReference.ts b/codegen/crm/lists/models/PublicMonthReference.ts index 8fcfabe4e8..db9707e314 100644 --- a/codegen/crm/lists/models/PublicMonthReference.ts +++ b/codegen/crm/lists/models/PublicMonthReference.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicMultiStringPropertyOperation.ts b/codegen/crm/lists/models/PublicMultiStringPropertyOperation.ts index b53e4774b9..d06ac527a9 100644 --- a/codegen/crm/lists/models/PublicMultiStringPropertyOperation.ts +++ b/codegen/crm/lists/models/PublicMultiStringPropertyOperation.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicNotAllFilterBranch.ts b/codegen/crm/lists/models/PublicNotAllFilterBranch.ts index ef0ac321aa..f605f5ad34 100644 --- a/codegen/crm/lists/models/PublicNotAllFilterBranch.ts +++ b/codegen/crm/lists/models/PublicNotAllFilterBranch.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicNotAnyFilterBranch.ts b/codegen/crm/lists/models/PublicNotAnyFilterBranch.ts index 4ea924ee39..bf1e041170 100644 --- a/codegen/crm/lists/models/PublicNotAnyFilterBranch.ts +++ b/codegen/crm/lists/models/PublicNotAnyFilterBranch.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicNowReference.ts b/codegen/crm/lists/models/PublicNowReference.ts index 264c06b58f..40462f26bc 100644 --- a/codegen/crm/lists/models/PublicNowReference.ts +++ b/codegen/crm/lists/models/PublicNowReference.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicNumAssociationsFilter.ts b/codegen/crm/lists/models/PublicNumAssociationsFilter.ts index c5adf8f2b3..5fe46394c7 100644 --- a/codegen/crm/lists/models/PublicNumAssociationsFilter.ts +++ b/codegen/crm/lists/models/PublicNumAssociationsFilter.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicNumOccurrencesRefineBy.ts b/codegen/crm/lists/models/PublicNumOccurrencesRefineBy.ts index 8fade455be..7634d954de 100644 --- a/codegen/crm/lists/models/PublicNumOccurrencesRefineBy.ts +++ b/codegen/crm/lists/models/PublicNumOccurrencesRefineBy.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicNumberPropertyOperation.ts b/codegen/crm/lists/models/PublicNumberPropertyOperation.ts index 1bed15c284..e0fc6ac3c2 100644 --- a/codegen/crm/lists/models/PublicNumberPropertyOperation.ts +++ b/codegen/crm/lists/models/PublicNumberPropertyOperation.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicObjectList.ts b/codegen/crm/lists/models/PublicObjectList.ts index 415d1dbe23..76ae2af9e4 100644 --- a/codegen/crm/lists/models/PublicObjectList.ts +++ b/codegen/crm/lists/models/PublicObjectList.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * @@ -10,9 +10,15 @@ * Do not edit the class manually. */ +import { PublicListPermissions } from '../models/PublicListPermissions'; +import { PublicMembershipSettings } from '../models/PublicMembershipSettings'; import { PublicPropertyAssociationFilterBranchFilterBranchesInner } from '../models/PublicPropertyAssociationFilterBranchFilterBranchesInner'; +/** +* An object list definition. +*/ export class PublicObjectList { + 'membershipSettings'?: PublicMembershipSettings; /** * The processing type of the list. */ @@ -49,11 +55,15 @@ export class PublicObjectList { * The version of the list. */ 'listVersion': number; + /** + * Size of the list + */ 'size'?: number; /** * The name of the list. */ 'name': string; + 'listPermissions'?: PublicListPermissions; /** * The ID of the user that created the list. */ @@ -69,6 +79,12 @@ export class PublicObjectList { static readonly mapping: {[index: string]: string} | undefined = undefined; static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ + { + "name": "membershipSettings", + "baseName": "membershipSettings", + "type": "PublicMembershipSettings", + "format": "" + }, { "name": "processingType", "baseName": "processingType", @@ -135,6 +151,12 @@ export class PublicObjectList { "type": "string", "format": "" }, + { + "name": "listPermissions", + "baseName": "listPermissions", + "type": "PublicListPermissions", + "format": "" + }, { "name": "createdById", "baseName": "createdById", diff --git a/codegen/crm/lists/models/PublicObjectListSearchResult.ts b/codegen/crm/lists/models/PublicObjectListSearchResult.ts index e52b8cfdf0..b7a3e81ff2 100644 --- a/codegen/crm/lists/models/PublicObjectListSearchResult.ts +++ b/codegen/crm/lists/models/PublicObjectListSearchResult.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicOrFilterBranch.ts b/codegen/crm/lists/models/PublicOrFilterBranch.ts index 34c2331ce5..8b50f403da 100644 --- a/codegen/crm/lists/models/PublicOrFilterBranch.ts +++ b/codegen/crm/lists/models/PublicOrFilterBranch.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicPageViewAnalyticsFilter.ts b/codegen/crm/lists/models/PublicPageViewAnalyticsFilter.ts index 65a395e7b3..c958139c0e 100644 --- a/codegen/crm/lists/models/PublicPageViewAnalyticsFilter.ts +++ b/codegen/crm/lists/models/PublicPageViewAnalyticsFilter.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicPrivacyAnalyticsFilter.ts b/codegen/crm/lists/models/PublicPrivacyAnalyticsFilter.ts index 031a3b2251..23a5c332f8 100644 --- a/codegen/crm/lists/models/PublicPrivacyAnalyticsFilter.ts +++ b/codegen/crm/lists/models/PublicPrivacyAnalyticsFilter.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicPropertyAssociationFilterBranch.ts b/codegen/crm/lists/models/PublicPropertyAssociationFilterBranch.ts index d5b91f23e3..939cf44bfc 100644 --- a/codegen/crm/lists/models/PublicPropertyAssociationFilterBranch.ts +++ b/codegen/crm/lists/models/PublicPropertyAssociationFilterBranch.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicPropertyAssociationFilterBranchFilterBranchesInner.ts b/codegen/crm/lists/models/PublicPropertyAssociationFilterBranchFilterBranchesInner.ts index 56e5d8bf01..14e01a536a 100644 --- a/codegen/crm/lists/models/PublicPropertyAssociationFilterBranchFilterBranchesInner.ts +++ b/codegen/crm/lists/models/PublicPropertyAssociationFilterBranchFilterBranchesInner.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * @@ -31,9 +31,18 @@ export type PublicPropertyAssociationFilterBranchFilterBranchesInner = PublicAnd * @export */ export class PublicPropertyAssociationFilterBranchFilterBranchesInnerClass { - static readonly discriminator: string | undefined = undefined; - - static readonly mapping: {[index: string]: string} | undefined = undefined; + static readonly discriminator: string | undefined = "filterBranchType"; + + static readonly mapping: {[index: string]: string} | undefined = { + "AND": "PublicAndFilterBranch", + "ASSOCIATION": "PublicAssociationFilterBranch", + "NOT_ALL": "PublicNotAllFilterBranch", + "NOT_ANY": "PublicNotAnyFilterBranch", + "OR": "PublicOrFilterBranch", + "PROPERTY_ASSOCIATION": "PublicPropertyAssociationFilterBranch", + "RESTRICTED": "PublicRestrictedFilterBranch", + "UNIFIED_EVENTS": "PublicUnifiedEventsFilterBranch", + }; } diff --git a/codegen/crm/lists/models/PublicPropertyAssociationFilterBranchFiltersInner.ts b/codegen/crm/lists/models/PublicPropertyAssociationFilterBranchFiltersInner.ts index 0a10d22747..97a593034b 100644 --- a/codegen/crm/lists/models/PublicPropertyAssociationFilterBranchFiltersInner.ts +++ b/codegen/crm/lists/models/PublicPropertyAssociationFilterBranchFiltersInner.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * @@ -46,9 +46,33 @@ export type PublicPropertyAssociationFilterBranchFiltersInner = PublicAdsSearchF * @export */ export class PublicPropertyAssociationFilterBranchFiltersInnerClass { - static readonly discriminator: string | undefined = undefined; - - static readonly mapping: {[index: string]: string} | undefined = undefined; + static readonly discriminator: string | undefined = "filterType"; + + static readonly mapping: {[index: string]: string} | undefined = { + "ADS_SEARCH": "PublicAdsSearchFilter", + "ADS_TIME": "PublicAdsTimeFilter", + "ASSOCIATION": "PublicAssociationInListFilter", + "CAMPAIGN_INFLUENCED": "PublicCampaignInfluencedFilter", + "COMMUNICATION_SUBSCRIPTION": "PublicCommunicationSubscriptionFilter", + "CONSTANT": "PublicConstantFilter", + "CTA": "PublicCtaAnalyticsFilter", + "EMAIL_EVENT": "PublicEmailEventFilter", + "EMAIL_SUBSCRIPTION": "PublicEmailSubscriptionFilter", + "EVENT": "PublicEventAnalyticsFilter", + "FORM_SUBMISSION": "PublicFormSubmissionFilter", + "FORM_SUBMISSION_ON_PAGE": "PublicFormSubmissionOnPageFilter", + "INTEGRATION_EVENT": "PublicIntegrationEventFilter", + "IN_LIST": "PublicInListFilter", + "NUM_ASSOCIATIONS": "PublicNumAssociationsFilter", + "PAGE_VIEW": "PublicPageViewAnalyticsFilter", + "PRIVACY": "PublicPrivacyAnalyticsFilter", + "PROPERTY": "PublicPropertyFilter", + "PROPERTY_ASSOCIATION": "PublicPropertyAssociationInListFilter", + "SURVEY_MONKEY": "PublicSurveyMonkeyFilter", + "SURVEY_MONKEY_VALUE": "PublicSurveyMonkeyValueFilter", + "UNIFIED_EVENTS": "PublicUnifiedEventsFilter", + "WEBINAR": "PublicWebinarFilter", + }; } diff --git a/codegen/crm/lists/models/PublicPropertyAssociationInListFilter.ts b/codegen/crm/lists/models/PublicPropertyAssociationInListFilter.ts index 71954dc5bd..13f16f17e8 100644 --- a/codegen/crm/lists/models/PublicPropertyAssociationInListFilter.ts +++ b/codegen/crm/lists/models/PublicPropertyAssociationInListFilter.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicPropertyFilter.ts b/codegen/crm/lists/models/PublicPropertyFilter.ts index e437de9a58..361c892e2a 100644 --- a/codegen/crm/lists/models/PublicPropertyFilter.ts +++ b/codegen/crm/lists/models/PublicPropertyFilter.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicPropertyReferencedTime.ts b/codegen/crm/lists/models/PublicPropertyReferencedTime.ts index 4f197112df..fce82720cc 100644 --- a/codegen/crm/lists/models/PublicPropertyReferencedTime.ts +++ b/codegen/crm/lists/models/PublicPropertyReferencedTime.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicQuarterReference.ts b/codegen/crm/lists/models/PublicQuarterReference.ts index 8b155eccfd..e0067886df 100644 --- a/codegen/crm/lists/models/PublicQuarterReference.ts +++ b/codegen/crm/lists/models/PublicQuarterReference.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicRangedDatePropertyOperation.ts b/codegen/crm/lists/models/PublicRangedDatePropertyOperation.ts index b03d901d68..30f02dcc5b 100644 --- a/codegen/crm/lists/models/PublicRangedDatePropertyOperation.ts +++ b/codegen/crm/lists/models/PublicRangedDatePropertyOperation.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicRangedNumberPropertyOperation.ts b/codegen/crm/lists/models/PublicRangedNumberPropertyOperation.ts index cdcb02b1d1..bb4336017b 100644 --- a/codegen/crm/lists/models/PublicRangedNumberPropertyOperation.ts +++ b/codegen/crm/lists/models/PublicRangedNumberPropertyOperation.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicRangedTimeOperation.ts b/codegen/crm/lists/models/PublicRangedTimeOperation.ts index 4386fd98cb..068d0e24ac 100644 --- a/codegen/crm/lists/models/PublicRangedTimeOperation.ts +++ b/codegen/crm/lists/models/PublicRangedTimeOperation.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicRelativeComparativeTimestampRefineBy.ts b/codegen/crm/lists/models/PublicRelativeComparativeTimestampRefineBy.ts index fffa674df3..446e83dfa9 100644 --- a/codegen/crm/lists/models/PublicRelativeComparativeTimestampRefineBy.ts +++ b/codegen/crm/lists/models/PublicRelativeComparativeTimestampRefineBy.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicRelativeRangedTimestampRefineBy.ts b/codegen/crm/lists/models/PublicRelativeRangedTimestampRefineBy.ts index 4f79606118..bcf406682d 100644 --- a/codegen/crm/lists/models/PublicRelativeRangedTimestampRefineBy.ts +++ b/codegen/crm/lists/models/PublicRelativeRangedTimestampRefineBy.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicRestrictedFilterBranch.ts b/codegen/crm/lists/models/PublicRestrictedFilterBranch.ts index c442727176..e776f9647a 100644 --- a/codegen/crm/lists/models/PublicRestrictedFilterBranch.ts +++ b/codegen/crm/lists/models/PublicRestrictedFilterBranch.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicRollingDateRangePropertyOperation.ts b/codegen/crm/lists/models/PublicRollingDateRangePropertyOperation.ts index a951261b5a..a6d7cb927e 100644 --- a/codegen/crm/lists/models/PublicRollingDateRangePropertyOperation.ts +++ b/codegen/crm/lists/models/PublicRollingDateRangePropertyOperation.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicRollingPropertyUpdatedOperation.ts b/codegen/crm/lists/models/PublicRollingPropertyUpdatedOperation.ts index 947696c78d..f71e3f8415 100644 --- a/codegen/crm/lists/models/PublicRollingPropertyUpdatedOperation.ts +++ b/codegen/crm/lists/models/PublicRollingPropertyUpdatedOperation.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicSetOccurrencesRefineBy.ts b/codegen/crm/lists/models/PublicSetOccurrencesRefineBy.ts index df9e4e89b4..4da67dbdb0 100644 --- a/codegen/crm/lists/models/PublicSetOccurrencesRefineBy.ts +++ b/codegen/crm/lists/models/PublicSetOccurrencesRefineBy.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicStringPropertyOperation.ts b/codegen/crm/lists/models/PublicStringPropertyOperation.ts index 85e79e4302..94b76ec675 100644 --- a/codegen/crm/lists/models/PublicStringPropertyOperation.ts +++ b/codegen/crm/lists/models/PublicStringPropertyOperation.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicSurveyMonkeyFilter.ts b/codegen/crm/lists/models/PublicSurveyMonkeyFilter.ts index 0a0dfdcbf1..7789691bed 100644 --- a/codegen/crm/lists/models/PublicSurveyMonkeyFilter.ts +++ b/codegen/crm/lists/models/PublicSurveyMonkeyFilter.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicSurveyMonkeyValueFilter.ts b/codegen/crm/lists/models/PublicSurveyMonkeyValueFilter.ts index 60682e3c1e..b45a394bad 100644 --- a/codegen/crm/lists/models/PublicSurveyMonkeyValueFilter.ts +++ b/codegen/crm/lists/models/PublicSurveyMonkeyValueFilter.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicSurveyMonkeyValueFilterValueComparison.ts b/codegen/crm/lists/models/PublicSurveyMonkeyValueFilterValueComparison.ts index 42beb5af61..b958a37639 100644 --- a/codegen/crm/lists/models/PublicSurveyMonkeyValueFilterValueComparison.ts +++ b/codegen/crm/lists/models/PublicSurveyMonkeyValueFilterValueComparison.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * @@ -40,9 +40,27 @@ export type PublicSurveyMonkeyValueFilterValueComparison = PublicAllPropertyType * @export */ export class PublicSurveyMonkeyValueFilterValueComparisonClass { - static readonly discriminator: string | undefined = undefined; - - static readonly mapping: {[index: string]: string} | undefined = undefined; + static readonly discriminator: string | undefined = "operationType"; + + static readonly mapping: {[index: string]: string} | undefined = { + "ALL_PROPERTY": "PublicAllPropertyTypesOperation", + "BOOL": "PublicBoolPropertyOperation", + "CALENDAR_DATE": "PublicCalendarDatePropertyOperation", + "COMPARATIVE_DATE": "PublicComparativeDatePropertyOperation", + "COMPARATIVE_PROPERTY_UPDATED": "PublicComparativePropertyUpdatedOperation", + "DATE": "PublicDatePropertyOperation", + "DATETIME": "PublicDateTimePropertyOperation", + "ENUMERATION": "PublicEnumerationPropertyOperation", + "MULTISTRING": "PublicMultiStringPropertyOperation", + "NUMBER": "PublicNumberPropertyOperation", + "NUMBER_RANGED": "PublicRangedNumberPropertyOperation", + "RANGED_DATE": "PublicRangedDatePropertyOperation", + "ROLLING_DATE_RANGE": "PublicRollingDateRangePropertyOperation", + "ROLLING_PROPERTY_UPDATED": "PublicRollingPropertyUpdatedOperation", + "STRING": "PublicStringPropertyOperation", + "TIME_POINT": "PublicTimePointOperation", + "TIME_RANGED": "PublicRangedTimeOperation", + }; } diff --git a/codegen/crm/lists/models/PublicTimeOffset.ts b/codegen/crm/lists/models/PublicTimeOffset.ts index 75ae6b5aea..361dadf567 100644 --- a/codegen/crm/lists/models/PublicTimeOffset.ts +++ b/codegen/crm/lists/models/PublicTimeOffset.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicTimePointOperation.ts b/codegen/crm/lists/models/PublicTimePointOperation.ts index ccca8ba13c..d3720e1d65 100644 --- a/codegen/crm/lists/models/PublicTimePointOperation.ts +++ b/codegen/crm/lists/models/PublicTimePointOperation.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicTimePointOperationTimePoint.ts b/codegen/crm/lists/models/PublicTimePointOperationTimePoint.ts index 48a74b025e..74d9904f52 100644 --- a/codegen/crm/lists/models/PublicTimePointOperationTimePoint.ts +++ b/codegen/crm/lists/models/PublicTimePointOperationTimePoint.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * @@ -26,9 +26,13 @@ export type PublicTimePointOperationTimePoint = PublicDatePoint | PublicIndexedT * @export */ export class PublicTimePointOperationTimePointClass { - static readonly discriminator: string | undefined = undefined; + static readonly discriminator: string | undefined = "timeType"; - static readonly mapping: {[index: string]: string} | undefined = undefined; + static readonly mapping: {[index: string]: string} | undefined = { + "DATE": "PublicDatePoint", + "INDEXED": "PublicIndexedTimePoint", + "PROPERTY_REFERENCED": "PublicPropertyReferencedTime", + }; } diff --git a/codegen/crm/lists/models/PublicTodayReference.ts b/codegen/crm/lists/models/PublicTodayReference.ts index 1ab62938b1..04ec0badff 100644 --- a/codegen/crm/lists/models/PublicTodayReference.ts +++ b/codegen/crm/lists/models/PublicTodayReference.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicUnifiedEventsFilter.ts b/codegen/crm/lists/models/PublicUnifiedEventsFilter.ts index 71913801fa..b15b8dccf5 100644 --- a/codegen/crm/lists/models/PublicUnifiedEventsFilter.ts +++ b/codegen/crm/lists/models/PublicUnifiedEventsFilter.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicUnifiedEventsFilterBranch.ts b/codegen/crm/lists/models/PublicUnifiedEventsFilterBranch.ts index 0fd8a424be..b8e859ba1b 100644 --- a/codegen/crm/lists/models/PublicUnifiedEventsFilterBranch.ts +++ b/codegen/crm/lists/models/PublicUnifiedEventsFilterBranch.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicWebinarFilter.ts b/codegen/crm/lists/models/PublicWebinarFilter.ts index 922ef47442..bfdd90ff71 100644 --- a/codegen/crm/lists/models/PublicWebinarFilter.ts +++ b/codegen/crm/lists/models/PublicWebinarFilter.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicWeekReference.ts b/codegen/crm/lists/models/PublicWeekReference.ts index 279ad12c78..cae9013aad 100644 --- a/codegen/crm/lists/models/PublicWeekReference.ts +++ b/codegen/crm/lists/models/PublicWeekReference.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/PublicYearReference.ts b/codegen/crm/lists/models/PublicYearReference.ts index 6859df9496..8cf0e08e23 100644 --- a/codegen/crm/lists/models/PublicYearReference.ts +++ b/codegen/crm/lists/models/PublicYearReference.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * diff --git a/codegen/crm/lists/models/RecordListMembership.ts b/codegen/crm/lists/models/RecordListMembership.ts index 434989d32e..d7210b6d9a 100644 --- a/codegen/crm/lists/models/RecordListMembership.ts +++ b/codegen/crm/lists/models/RecordListMembership.ts @@ -1,6 +1,6 @@ /** - * Lists - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * CRM Lists + * CRUD operations to manage lists and list memberships * * OpenAPI spec version: v3 * @@ -11,10 +11,14 @@ */ +/** +* Lists record is member of +*/ export class RecordListMembership { 'listId': string; 'listVersion': number; 'lastAddedTimestamp': Date; + 'isPublicList'?: boolean; 'firstAddedTimestamp': Date; static readonly discriminator: string | undefined = undefined; @@ -40,6 +44,12 @@ export class RecordListMembership { "type": "Date", "format": "date-time" }, + { + "name": "isPublicList", + "baseName": "isPublicList", + "type": "boolean", + "format": "" + }, { "name": "firstAddedTimestamp", "baseName": "firstAddedTimestamp", diff --git a/codegen/crm/lists/models/all.ts b/codegen/crm/lists/models/all.ts index 9e0150a6dd..003ed715eb 100644 --- a/codegen/crm/lists/models/all.ts +++ b/codegen/crm/lists/models/all.ts @@ -57,7 +57,14 @@ export * from '../models/PublicIndexOffset' export * from '../models/PublicIndexedTimePoint' export * from '../models/PublicIndexedTimePointIndexReference' export * from '../models/PublicIntegrationEventFilter' +export * from '../models/PublicListConversionDate' +export * from '../models/PublicListConversionInactivity' +export * from '../models/PublicListConversionResponse' +export * from '../models/PublicListConversionResponseRequestedConversionTime' +export * from '../models/PublicListConversionTime' export * from '../models/PublicListFolder' +export * from '../models/PublicListPermissions' +export * from '../models/PublicMembershipSettings' export * from '../models/PublicMigrationMapping' export * from '../models/PublicMonthReference' export * from '../models/PublicMultiStringPropertyOperation' diff --git a/codegen/crm/lists/types/ObjectParamAPI.ts b/codegen/crm/lists/types/ObjectParamAPI.ts index 6f067acec3..4d33c95a85 100644 --- a/codegen/crm/lists/types/ObjectParamAPI.ts +++ b/codegen/crm/lists/types/ObjectParamAPI.ts @@ -18,6 +18,8 @@ import { ListsByIdResponse } from '../models/ListsByIdResponse'; import { MembershipChangeRequest } from '../models/MembershipChangeRequest'; import { MembershipsUpdateResponse } from '../models/MembershipsUpdateResponse'; import { PublicBatchMigrationMapping } from '../models/PublicBatchMigrationMapping'; +import { PublicListConversionResponse } from '../models/PublicListConversionResponse'; +import { PublicListConversionTime } from '../models/PublicListConversionTime'; import { PublicMigrationMapping } from '../models/PublicMigrationMapping'; import { ObservableFoldersApi } from "./ObservableAPI"; @@ -44,14 +46,14 @@ export interface FoldersApiGetAllRequest { export interface FoldersApiMoveRequest { /** - * + * The ID of the folder to move * Defaults to: undefined * @type string * @memberof FoldersApimove */ folderId: string /** - * + * The ID for the target parent folder. * Defaults to: undefined * @type string * @memberof FoldersApimove @@ -70,7 +72,7 @@ export interface FoldersApiMoveListRequest { export interface FoldersApiRemoveRequest { /** - * + * The ID of the folder to delete * Defaults to: undefined * @type string * @memberof FoldersApiremove @@ -80,14 +82,14 @@ export interface FoldersApiRemoveRequest { export interface FoldersApiRenameRequest { /** - * + * The ID of the folder to rename * Defaults to: undefined * @type string * @memberof FoldersApirename */ folderId: string /** - * + * The new name of the folder. * Defaults to: undefined * @type string * @memberof FoldersApirename @@ -215,6 +217,16 @@ export class ObjectFoldersApi { import { ObservableListsApi } from "./ObservableAPI"; import { ListsApiRequestFactory, ListsApiResponseProcessor} from "../apis/ListsApi"; +export interface ListsApiCancelConversionRequest { + /** + * The ID of the list that you want to cancel the conversion for. + * Defaults to: undefined + * @type string + * @memberof ListsApicancelConversion + */ + listId: string +} + export interface ListsApiCreateRequest { /** * @@ -226,7 +238,7 @@ export interface ListsApiCreateRequest { export interface ListsApiDoSearchRequest { /** - * + * The IDs of the records to add and/or remove from the list. * @type ListSearchRequest * @memberof ListsApidoSearch */ @@ -291,6 +303,16 @@ export interface ListsApiGetByNameRequest { includeFilters?: boolean } +export interface ListsApiGetConversionDetailsRequest { + /** + * The ID of the list to schedule the conversion for. + * Defaults to: undefined + * @type string + * @memberof ListsApigetConversionDetails + */ + listId: string +} + export interface ListsApiRemoveRequest { /** * The **ILS ID** of the list to delete. @@ -311,6 +333,22 @@ export interface ListsApiRestoreRequest { listId: string } +export interface ListsApiScheduleOrUpdateConversionRequest { + /** + * The ID of the list to schedule the conversion for. + * Defaults to: undefined + * @type string + * @memberof ListsApischeduleOrUpdateConversion + */ + listId: string + /** + * + * @type PublicListConversionTime + * @memberof ListsApischeduleOrUpdateConversion + */ + publicListConversionTime: PublicListConversionTime +} + export interface ListsApiUpdateListFiltersRequest { /** * The **ILS ID** of the list to update. @@ -365,6 +403,24 @@ export class ObjectListsApi { this.api = new ObservableListsApi(configuration, requestFactory, responseProcessor); } + /** + * Delete an existing scheduled conversion for a list. + * Cancel the conversion of a list + * @param param the request object + */ + public cancelConversionWithHttpInfo(param: ListsApiCancelConversionRequest, options?: ConfigurationOptions): Promise> { + return this.api.cancelConversionWithHttpInfo(param.listId, options).toPromise(); + } + + /** + * Delete an existing scheduled conversion for a list. + * Cancel the conversion of a list + * @param param the request object + */ + public cancelConversion(param: ListsApiCancelConversionRequest, options?: ConfigurationOptions): Promise { + return this.api.cancelConversion(param.listId, options).toPromise(); + } + /** * Create a new list with the provided object list definition. * Create List @@ -455,6 +511,24 @@ export class ObjectListsApi { return this.api.getByName(param.listName, param.objectTypeId, param.includeFilters, options).toPromise(); } + /** + * Retrieve the conversion details for a list. This can be used to check for an upcoming conversion, or to get the details of when a list was already converted. + * Retrieve the conversion details for a list + * @param param the request object + */ + public getConversionDetailsWithHttpInfo(param: ListsApiGetConversionDetailsRequest, options?: ConfigurationOptions): Promise> { + return this.api.getConversionDetailsWithHttpInfo(param.listId, options).toPromise(); + } + + /** + * Retrieve the conversion details for a list. This can be used to check for an upcoming conversion, or to get the details of when a list was already converted. + * Retrieve the conversion details for a list + * @param param the request object + */ + public getConversionDetails(param: ListsApiGetConversionDetailsRequest, options?: ConfigurationOptions): Promise { + return this.api.getConversionDetails(param.listId, options).toPromise(); + } + /** * Delete a list by **ILS list ID**. Lists deleted through this endpoint can be restored up to 90-days following the delete. After 90-days, the list is purged and can no longer be restored. * Delete a List @@ -491,6 +565,24 @@ export class ObjectListsApi { return this.api.restore(param.listId, options).toPromise(); } + /** + * Schedule the conversion of an active list into a static list, or update the already scheduled conversion. This can be scheduled for a specific date or based on activity. + * Schedule or update the conversion of a list to static + * @param param the request object + */ + public scheduleOrUpdateConversionWithHttpInfo(param: ListsApiScheduleOrUpdateConversionRequest, options?: ConfigurationOptions): Promise> { + return this.api.scheduleOrUpdateConversionWithHttpInfo(param.listId, param.publicListConversionTime, options).toPromise(); + } + + /** + * Schedule the conversion of an active list into a static list, or update the already scheduled conversion. This can be scheduled for a specific date or based on activity. + * Schedule or update the conversion of a list to static + * @param param the request object + */ + public scheduleOrUpdateConversion(param: ListsApiScheduleOrUpdateConversionRequest, options?: ConfigurationOptions): Promise { + return this.api.scheduleOrUpdateConversion(param.listId, param.publicListConversionTime, options).toPromise(); + } + /** * Update the filter branch definition of a `DYNAMIC` list. Once updated, the list memberships will be re-evaluated and updated to match the new definition. * Update List Filter Definition @@ -608,7 +700,7 @@ export interface MembershipsApiAddRequest { */ listId: string /** - * + * The IDs of the records to add to the list. * @type Array<string> * @memberof MembershipsApiadd */ @@ -641,7 +733,7 @@ export interface MembershipsApiAddAndRemoveRequest { */ listId: string /** - * + * The IDs of the records to add and/or remove from the list. * @type MembershipChangeRequest * @memberof MembershipsApiaddAndRemove */ @@ -736,7 +828,7 @@ export interface MembershipsApiRemoveRequest { */ listId: string /** - * + * The IDs of the records to remove from the list. * @type Array<string> * @memberof MembershipsApiremove */ diff --git a/codegen/crm/lists/types/ObservableAPI.ts b/codegen/crm/lists/types/ObservableAPI.ts index 73e74193bd..66714835a4 100644 --- a/codegen/crm/lists/types/ObservableAPI.ts +++ b/codegen/crm/lists/types/ObservableAPI.ts @@ -20,6 +20,8 @@ import { ListsByIdResponse } from '../models/ListsByIdResponse'; import { MembershipChangeRequest } from '../models/MembershipChangeRequest'; import { MembershipsUpdateResponse } from '../models/MembershipsUpdateResponse'; import { PublicBatchMigrationMapping } from '../models/PublicBatchMigrationMapping'; +import { PublicListConversionResponse } from '../models/PublicListConversionResponse'; +import { PublicListConversionTime } from '../models/PublicListConversionTime'; import { PublicMigrationMapping } from '../models/PublicMigrationMapping'; import { FoldersApiRequestFactory, FoldersApiResponseProcessor} from "../apis/FoldersApi"; @@ -165,8 +167,8 @@ export class ObservableFoldersApi { /** * This moves the folder from its current location to a new location. It updates the parent of this folder to the new Id given. * Moves a folder - * @param folderId - * @param newParentFolderId + * @param folderId The ID of the folder to move + * @param newParentFolderId The ID for the target parent folder. */ public moveWithHttpInfo(folderId: string, newParentFolderId: string, _options?: ConfigurationOptions): Observable> { let _config = this.configuration; @@ -219,8 +221,8 @@ export class ObservableFoldersApi { /** * This moves the folder from its current location to a new location. It updates the parent of this folder to the new Id given. * Moves a folder - * @param folderId - * @param newParentFolderId + * @param folderId The ID of the folder to move + * @param newParentFolderId The ID for the target parent folder. */ public move(folderId: string, newParentFolderId: string, _options?: ConfigurationOptions): Observable { return this.moveWithHttpInfo(folderId, newParentFolderId, _options).pipe(map((apiResponse: HttpInfo) => apiResponse.data)); @@ -291,7 +293,7 @@ export class ObservableFoldersApi { /** * Deletes the folder with the given Id. * Deletes a folder - * @param folderId + * @param folderId The ID of the folder to delete */ public removeWithHttpInfo(folderId: string, _options?: ConfigurationOptions): Observable> { let _config = this.configuration; @@ -344,7 +346,7 @@ export class ObservableFoldersApi { /** * Deletes the folder with the given Id. * Deletes a folder - * @param folderId + * @param folderId The ID of the folder to delete */ public remove(folderId: string, _options?: ConfigurationOptions): Observable { return this.removeWithHttpInfo(folderId, _options).pipe(map((apiResponse: HttpInfo) => apiResponse.data)); @@ -353,8 +355,8 @@ export class ObservableFoldersApi { /** * Renames the given folderId with a new name. * Rename a folder - * @param folderId - * @param [newFolderName] + * @param folderId The ID of the folder to rename + * @param [newFolderName] The new name of the folder. */ public renameWithHttpInfo(folderId: string, newFolderName?: string, _options?: ConfigurationOptions): Observable> { let _config = this.configuration; @@ -407,8 +409,8 @@ export class ObservableFoldersApi { /** * Renames the given folderId with a new name. * Rename a folder - * @param folderId - * @param [newFolderName] + * @param folderId The ID of the folder to rename + * @param [newFolderName] The new name of the folder. */ public rename(folderId: string, newFolderName?: string, _options?: ConfigurationOptions): Observable { return this.renameWithHttpInfo(folderId, newFolderName, _options).pipe(map((apiResponse: HttpInfo) => apiResponse.data)); @@ -432,6 +434,68 @@ export class ObservableListsApi { this.responseProcessor = responseProcessor || new ListsApiResponseProcessor(); } + /** + * Delete an existing scheduled conversion for a list. + * Cancel the conversion of a list + * @param listId The ID of the list that you want to cancel the conversion for. + */ + public cancelConversionWithHttpInfo(listId: string, _options?: ConfigurationOptions): Observable> { + let _config = this.configuration; + let allMiddleware: Middleware[] = []; + if (_options && _options.middleware){ + const middlewareMergeStrategy = _options.middlewareMergeStrategy || 'replace' // default to replace behavior + // call-time middleware provided + const calltimeMiddleware: Middleware[] = _options.middleware; + + switch(middlewareMergeStrategy){ + case 'append': + allMiddleware = this.configuration.middleware.concat(calltimeMiddleware); + break; + case 'prepend': + allMiddleware = calltimeMiddleware.concat(this.configuration.middleware) + break; + case 'replace': + allMiddleware = calltimeMiddleware + break; + default: + throw new Error(`unrecognized middleware merge strategy '${middlewareMergeStrategy}'`) + } + } + if (_options){ + _config = { + baseServer: _options.baseServer || this.configuration.baseServer, + httpApi: _options.httpApi || this.configuration.httpApi, + authMethods: _options.authMethods || this.configuration.authMethods, + middleware: allMiddleware || this.configuration.middleware + }; + } + + const requestContextPromise = this.requestFactory.cancelConversion(listId, _config); + // build promise chain + let middlewarePreObservable = from(requestContextPromise); + for (const middleware of allMiddleware) { + middlewarePreObservable = middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => middleware.pre(ctx))); + } + + return middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => this.configuration.httpApi.send(ctx))). + pipe(mergeMap((response: ResponseContext) => { + let middlewarePostObservable = of(response); + for (const middleware of allMiddleware.reverse()) { + middlewarePostObservable = middlewarePostObservable.pipe(mergeMap((rsp: ResponseContext) => middleware.post(rsp))); + } + return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.cancelConversionWithHttpInfo(rsp))); + })); + } + + /** + * Delete an existing scheduled conversion for a list. + * Cancel the conversion of a list + * @param listId The ID of the list that you want to cancel the conversion for. + */ + public cancelConversion(listId: string, _options?: ConfigurationOptions): Observable { + return this.cancelConversionWithHttpInfo(listId, _options).pipe(map((apiResponse: HttpInfo) => apiResponse.data)); + } + /** * Create a new list with the provided object list definition. * Create List @@ -497,7 +561,7 @@ export class ObservableListsApi { /** * Search lists by list name or page through all lists by providing an empty `query` value. * Search Lists - * @param listSearchRequest + * @param listSearchRequest The IDs of the records to add and/or remove from the list. */ public doSearchWithHttpInfo(listSearchRequest: ListSearchRequest, _options?: ConfigurationOptions): Observable> { let _config = this.configuration; @@ -550,7 +614,7 @@ export class ObservableListsApi { /** * Search lists by list name or page through all lists by providing an empty `query` value. * Search Lists - * @param listSearchRequest + * @param listSearchRequest The IDs of the records to add and/or remove from the list. */ public doSearch(listSearchRequest: ListSearchRequest, _options?: ConfigurationOptions): Observable { return this.doSearchWithHttpInfo(listSearchRequest, _options).pipe(map((apiResponse: HttpInfo) => apiResponse.data)); @@ -750,6 +814,68 @@ export class ObservableListsApi { return this.getByNameWithHttpInfo(listName, objectTypeId, includeFilters, _options).pipe(map((apiResponse: HttpInfo) => apiResponse.data)); } + /** + * Retrieve the conversion details for a list. This can be used to check for an upcoming conversion, or to get the details of when a list was already converted. + * Retrieve the conversion details for a list + * @param listId The ID of the list to schedule the conversion for. + */ + public getConversionDetailsWithHttpInfo(listId: string, _options?: ConfigurationOptions): Observable> { + let _config = this.configuration; + let allMiddleware: Middleware[] = []; + if (_options && _options.middleware){ + const middlewareMergeStrategy = _options.middlewareMergeStrategy || 'replace' // default to replace behavior + // call-time middleware provided + const calltimeMiddleware: Middleware[] = _options.middleware; + + switch(middlewareMergeStrategy){ + case 'append': + allMiddleware = this.configuration.middleware.concat(calltimeMiddleware); + break; + case 'prepend': + allMiddleware = calltimeMiddleware.concat(this.configuration.middleware) + break; + case 'replace': + allMiddleware = calltimeMiddleware + break; + default: + throw new Error(`unrecognized middleware merge strategy '${middlewareMergeStrategy}'`) + } + } + if (_options){ + _config = { + baseServer: _options.baseServer || this.configuration.baseServer, + httpApi: _options.httpApi || this.configuration.httpApi, + authMethods: _options.authMethods || this.configuration.authMethods, + middleware: allMiddleware || this.configuration.middleware + }; + } + + const requestContextPromise = this.requestFactory.getConversionDetails(listId, _config); + // build promise chain + let middlewarePreObservable = from(requestContextPromise); + for (const middleware of allMiddleware) { + middlewarePreObservable = middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => middleware.pre(ctx))); + } + + return middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => this.configuration.httpApi.send(ctx))). + pipe(mergeMap((response: ResponseContext) => { + let middlewarePostObservable = of(response); + for (const middleware of allMiddleware.reverse()) { + middlewarePostObservable = middlewarePostObservable.pipe(mergeMap((rsp: ResponseContext) => middleware.post(rsp))); + } + return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.getConversionDetailsWithHttpInfo(rsp))); + })); + } + + /** + * Retrieve the conversion details for a list. This can be used to check for an upcoming conversion, or to get the details of when a list was already converted. + * Retrieve the conversion details for a list + * @param listId The ID of the list to schedule the conversion for. + */ + public getConversionDetails(listId: string, _options?: ConfigurationOptions): Observable { + return this.getConversionDetailsWithHttpInfo(listId, _options).pipe(map((apiResponse: HttpInfo) => apiResponse.data)); + } + /** * Delete a list by **ILS list ID**. Lists deleted through this endpoint can be restored up to 90-days following the delete. After 90-days, the list is purged and can no longer be restored. * Delete a List @@ -874,6 +1000,70 @@ export class ObservableListsApi { return this.restoreWithHttpInfo(listId, _options).pipe(map((apiResponse: HttpInfo) => apiResponse.data)); } + /** + * Schedule the conversion of an active list into a static list, or update the already scheduled conversion. This can be scheduled for a specific date or based on activity. + * Schedule or update the conversion of a list to static + * @param listId The ID of the list to schedule the conversion for. + * @param publicListConversionTime + */ + public scheduleOrUpdateConversionWithHttpInfo(listId: string, publicListConversionTime: PublicListConversionTime, _options?: ConfigurationOptions): Observable> { + let _config = this.configuration; + let allMiddleware: Middleware[] = []; + if (_options && _options.middleware){ + const middlewareMergeStrategy = _options.middlewareMergeStrategy || 'replace' // default to replace behavior + // call-time middleware provided + const calltimeMiddleware: Middleware[] = _options.middleware; + + switch(middlewareMergeStrategy){ + case 'append': + allMiddleware = this.configuration.middleware.concat(calltimeMiddleware); + break; + case 'prepend': + allMiddleware = calltimeMiddleware.concat(this.configuration.middleware) + break; + case 'replace': + allMiddleware = calltimeMiddleware + break; + default: + throw new Error(`unrecognized middleware merge strategy '${middlewareMergeStrategy}'`) + } + } + if (_options){ + _config = { + baseServer: _options.baseServer || this.configuration.baseServer, + httpApi: _options.httpApi || this.configuration.httpApi, + authMethods: _options.authMethods || this.configuration.authMethods, + middleware: allMiddleware || this.configuration.middleware + }; + } + + const requestContextPromise = this.requestFactory.scheduleOrUpdateConversion(listId, publicListConversionTime, _config); + // build promise chain + let middlewarePreObservable = from(requestContextPromise); + for (const middleware of allMiddleware) { + middlewarePreObservable = middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => middleware.pre(ctx))); + } + + return middlewarePreObservable.pipe(mergeMap((ctx: RequestContext) => this.configuration.httpApi.send(ctx))). + pipe(mergeMap((response: ResponseContext) => { + let middlewarePostObservable = of(response); + for (const middleware of allMiddleware.reverse()) { + middlewarePostObservable = middlewarePostObservable.pipe(mergeMap((rsp: ResponseContext) => middleware.post(rsp))); + } + return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.scheduleOrUpdateConversionWithHttpInfo(rsp))); + })); + } + + /** + * Schedule the conversion of an active list into a static list, or update the already scheduled conversion. This can be scheduled for a specific date or based on activity. + * Schedule or update the conversion of a list to static + * @param listId The ID of the list to schedule the conversion for. + * @param publicListConversionTime + */ + public scheduleOrUpdateConversion(listId: string, publicListConversionTime: PublicListConversionTime, _options?: ConfigurationOptions): Observable { + return this.scheduleOrUpdateConversionWithHttpInfo(listId, publicListConversionTime, _options).pipe(map((apiResponse: HttpInfo) => apiResponse.data)); + } + /** * Update the filter branch definition of a `DYNAMIC` list. Once updated, the list memberships will be re-evaluated and updated to match the new definition. * Update List Filter Definition @@ -1170,7 +1360,7 @@ export class ObservableMembershipsApi { * Add the records provided to the list. Records that do not exist or that are already members of the list are ignored. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`. * Add Records to a List * @param listId The **ILS ID** of the `MANUAL` or `SNAPSHOT` list. - * @param requestBody + * @param requestBody The IDs of the records to add to the list. */ public addWithHttpInfo(listId: string, requestBody: Array, _options?: ConfigurationOptions): Observable> { let _config = this.configuration; @@ -1224,7 +1414,7 @@ export class ObservableMembershipsApi { * Add the records provided to the list. Records that do not exist or that are already members of the list are ignored. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`. * Add Records to a List * @param listId The **ILS ID** of the `MANUAL` or `SNAPSHOT` list. - * @param requestBody + * @param requestBody The IDs of the records to add to the list. */ public add(listId: string, requestBody: Array, _options?: ConfigurationOptions): Observable { return this.addWithHttpInfo(listId, requestBody, _options).pipe(map((apiResponse: HttpInfo) => apiResponse.data)); @@ -1298,7 +1488,7 @@ export class ObservableMembershipsApi { * Add and/or remove records that have already been created in the system to and/or from a list. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`. * Add and/or Remove Records from a List * @param listId The **ILS ID** of the `MANUAL` or `SNAPSHOT` list. - * @param membershipChangeRequest + * @param membershipChangeRequest The IDs of the records to add and/or remove from the list. */ public addAndRemoveWithHttpInfo(listId: string, membershipChangeRequest: MembershipChangeRequest, _options?: ConfigurationOptions): Observable> { let _config = this.configuration; @@ -1352,7 +1542,7 @@ export class ObservableMembershipsApi { * Add and/or remove records that have already been created in the system to and/or from a list. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`. * Add and/or Remove Records from a List * @param listId The **ILS ID** of the `MANUAL` or `SNAPSHOT` list. - * @param membershipChangeRequest + * @param membershipChangeRequest The IDs of the records to add and/or remove from the list. */ public addAndRemove(listId: string, membershipChangeRequest: MembershipChangeRequest, _options?: ConfigurationOptions): Observable { return this.addAndRemoveWithHttpInfo(listId, membershipChangeRequest, _options).pipe(map((apiResponse: HttpInfo) => apiResponse.data)); @@ -1562,7 +1752,7 @@ export class ObservableMembershipsApi { * Remove the records provided from the list. Records that do not exist or that are not members of the list are ignored. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`. * Remove Records from a List * @param listId The **ILS ID** of the `MANUAL` or `SNAPSHOT` list. - * @param requestBody + * @param requestBody The IDs of the records to remove from the list. */ public removeWithHttpInfo(listId: string, requestBody: Array, _options?: ConfigurationOptions): Observable> { let _config = this.configuration; @@ -1616,7 +1806,7 @@ export class ObservableMembershipsApi { * Remove the records provided from the list. Records that do not exist or that are not members of the list are ignored. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`. * Remove Records from a List * @param listId The **ILS ID** of the `MANUAL` or `SNAPSHOT` list. - * @param requestBody + * @param requestBody The IDs of the records to remove from the list. */ public remove(listId: string, requestBody: Array, _options?: ConfigurationOptions): Observable { return this.removeWithHttpInfo(listId, requestBody, _options).pipe(map((apiResponse: HttpInfo) => apiResponse.data)); diff --git a/codegen/crm/lists/types/PromiseAPI.ts b/codegen/crm/lists/types/PromiseAPI.ts index 958fe5e82e..b961e35017 100644 --- a/codegen/crm/lists/types/PromiseAPI.ts +++ b/codegen/crm/lists/types/PromiseAPI.ts @@ -19,6 +19,8 @@ import { ListsByIdResponse } from '../models/ListsByIdResponse'; import { MembershipChangeRequest } from '../models/MembershipChangeRequest'; import { MembershipsUpdateResponse } from '../models/MembershipsUpdateResponse'; import { PublicBatchMigrationMapping } from '../models/PublicBatchMigrationMapping'; +import { PublicListConversionResponse } from '../models/PublicListConversionResponse'; +import { PublicListConversionTime } from '../models/PublicListConversionTime'; import { PublicMigrationMapping } from '../models/PublicMigrationMapping'; import { ObservableFoldersApi } from './ObservableAPI'; @@ -125,8 +127,8 @@ export class PromiseFoldersApi { /** * This moves the folder from its current location to a new location. It updates the parent of this folder to the new Id given. * Moves a folder - * @param folderId - * @param newParentFolderId + * @param folderId The ID of the folder to move + * @param newParentFolderId The ID for the target parent folder. */ public moveWithHttpInfo(folderId: string, newParentFolderId: string, _options?: PromiseConfigurationOptions): Promise> { let observableOptions: undefined | ConfigurationOptions @@ -148,8 +150,8 @@ export class PromiseFoldersApi { /** * This moves the folder from its current location to a new location. It updates the parent of this folder to the new Id given. * Moves a folder - * @param folderId - * @param newParentFolderId + * @param folderId The ID of the folder to move + * @param newParentFolderId The ID for the target parent folder. */ public move(folderId: string, newParentFolderId: string, _options?: PromiseConfigurationOptions): Promise { let observableOptions: undefined | ConfigurationOptions @@ -215,7 +217,7 @@ export class PromiseFoldersApi { /** * Deletes the folder with the given Id. * Deletes a folder - * @param folderId + * @param folderId The ID of the folder to delete */ public removeWithHttpInfo(folderId: string, _options?: PromiseConfigurationOptions): Promise> { let observableOptions: undefined | ConfigurationOptions @@ -237,7 +239,7 @@ export class PromiseFoldersApi { /** * Deletes the folder with the given Id. * Deletes a folder - * @param folderId + * @param folderId The ID of the folder to delete */ public remove(folderId: string, _options?: PromiseConfigurationOptions): Promise { let observableOptions: undefined | ConfigurationOptions @@ -259,8 +261,8 @@ export class PromiseFoldersApi { /** * Renames the given folderId with a new name. * Rename a folder - * @param folderId - * @param [newFolderName] + * @param folderId The ID of the folder to rename + * @param [newFolderName] The new name of the folder. */ public renameWithHttpInfo(folderId: string, newFolderName?: string, _options?: PromiseConfigurationOptions): Promise> { let observableOptions: undefined | ConfigurationOptions @@ -282,8 +284,8 @@ export class PromiseFoldersApi { /** * Renames the given folderId with a new name. * Rename a folder - * @param folderId - * @param [newFolderName] + * @param folderId The ID of the folder to rename + * @param [newFolderName] The new name of the folder. */ public rename(folderId: string, newFolderName?: string, _options?: PromiseConfigurationOptions): Promise { let observableOptions: undefined | ConfigurationOptions @@ -321,6 +323,50 @@ export class PromiseListsApi { this.api = new ObservableListsApi(configuration, requestFactory, responseProcessor); } + /** + * Delete an existing scheduled conversion for a list. + * Cancel the conversion of a list + * @param listId The ID of the list that you want to cancel the conversion for. + */ + public cancelConversionWithHttpInfo(listId: string, _options?: PromiseConfigurationOptions): Promise> { + let observableOptions: undefined | ConfigurationOptions + if (_options){ + observableOptions = { + baseServer: _options.baseServer, + httpApi: _options.httpApi, + middleware: _options.middleware?.map( + m => new PromiseMiddlewareWrapper(m) + ), + middlewareMergeStrategy: _options.middlewareMergeStrategy, + authMethods: _options.authMethods + } + } + const result = this.api.cancelConversionWithHttpInfo(listId, observableOptions); + return result.toPromise(); + } + + /** + * Delete an existing scheduled conversion for a list. + * Cancel the conversion of a list + * @param listId The ID of the list that you want to cancel the conversion for. + */ + public cancelConversion(listId: string, _options?: PromiseConfigurationOptions): Promise { + let observableOptions: undefined | ConfigurationOptions + if (_options){ + observableOptions = { + baseServer: _options.baseServer, + httpApi: _options.httpApi, + middleware: _options.middleware?.map( + m => new PromiseMiddlewareWrapper(m) + ), + middlewareMergeStrategy: _options.middlewareMergeStrategy, + authMethods: _options.authMethods + } + } + const result = this.api.cancelConversion(listId, observableOptions); + return result.toPromise(); + } + /** * Create a new list with the provided object list definition. * Create List @@ -368,7 +414,7 @@ export class PromiseListsApi { /** * Search lists by list name or page through all lists by providing an empty `query` value. * Search Lists - * @param listSearchRequest + * @param listSearchRequest The IDs of the records to add and/or remove from the list. */ public doSearchWithHttpInfo(listSearchRequest: ListSearchRequest, _options?: PromiseConfigurationOptions): Promise> { let observableOptions: undefined | ConfigurationOptions @@ -390,7 +436,7 @@ export class PromiseListsApi { /** * Search lists by list name or page through all lists by providing an empty `query` value. * Search Lists - * @param listSearchRequest + * @param listSearchRequest The IDs of the records to add and/or remove from the list. */ public doSearch(listSearchRequest: ListSearchRequest, _options?: PromiseConfigurationOptions): Promise { let observableOptions: undefined | ConfigurationOptions @@ -549,6 +595,50 @@ export class PromiseListsApi { return result.toPromise(); } + /** + * Retrieve the conversion details for a list. This can be used to check for an upcoming conversion, or to get the details of when a list was already converted. + * Retrieve the conversion details for a list + * @param listId The ID of the list to schedule the conversion for. + */ + public getConversionDetailsWithHttpInfo(listId: string, _options?: PromiseConfigurationOptions): Promise> { + let observableOptions: undefined | ConfigurationOptions + if (_options){ + observableOptions = { + baseServer: _options.baseServer, + httpApi: _options.httpApi, + middleware: _options.middleware?.map( + m => new PromiseMiddlewareWrapper(m) + ), + middlewareMergeStrategy: _options.middlewareMergeStrategy, + authMethods: _options.authMethods + } + } + const result = this.api.getConversionDetailsWithHttpInfo(listId, observableOptions); + return result.toPromise(); + } + + /** + * Retrieve the conversion details for a list. This can be used to check for an upcoming conversion, or to get the details of when a list was already converted. + * Retrieve the conversion details for a list + * @param listId The ID of the list to schedule the conversion for. + */ + public getConversionDetails(listId: string, _options?: PromiseConfigurationOptions): Promise { + let observableOptions: undefined | ConfigurationOptions + if (_options){ + observableOptions = { + baseServer: _options.baseServer, + httpApi: _options.httpApi, + middleware: _options.middleware?.map( + m => new PromiseMiddlewareWrapper(m) + ), + middlewareMergeStrategy: _options.middlewareMergeStrategy, + authMethods: _options.authMethods + } + } + const result = this.api.getConversionDetails(listId, observableOptions); + return result.toPromise(); + } + /** * Delete a list by **ILS list ID**. Lists deleted through this endpoint can be restored up to 90-days following the delete. After 90-days, the list is purged and can no longer be restored. * Delete a List @@ -637,6 +727,52 @@ export class PromiseListsApi { return result.toPromise(); } + /** + * Schedule the conversion of an active list into a static list, or update the already scheduled conversion. This can be scheduled for a specific date or based on activity. + * Schedule or update the conversion of a list to static + * @param listId The ID of the list to schedule the conversion for. + * @param publicListConversionTime + */ + public scheduleOrUpdateConversionWithHttpInfo(listId: string, publicListConversionTime: PublicListConversionTime, _options?: PromiseConfigurationOptions): Promise> { + let observableOptions: undefined | ConfigurationOptions + if (_options){ + observableOptions = { + baseServer: _options.baseServer, + httpApi: _options.httpApi, + middleware: _options.middleware?.map( + m => new PromiseMiddlewareWrapper(m) + ), + middlewareMergeStrategy: _options.middlewareMergeStrategy, + authMethods: _options.authMethods + } + } + const result = this.api.scheduleOrUpdateConversionWithHttpInfo(listId, publicListConversionTime, observableOptions); + return result.toPromise(); + } + + /** + * Schedule the conversion of an active list into a static list, or update the already scheduled conversion. This can be scheduled for a specific date or based on activity. + * Schedule or update the conversion of a list to static + * @param listId The ID of the list to schedule the conversion for. + * @param publicListConversionTime + */ + public scheduleOrUpdateConversion(listId: string, publicListConversionTime: PublicListConversionTime, _options?: PromiseConfigurationOptions): Promise { + let observableOptions: undefined | ConfigurationOptions + if (_options){ + observableOptions = { + baseServer: _options.baseServer, + httpApi: _options.httpApi, + middleware: _options.middleware?.map( + m => new PromiseMiddlewareWrapper(m) + ), + middlewareMergeStrategy: _options.middlewareMergeStrategy, + authMethods: _options.authMethods + } + } + const result = this.api.scheduleOrUpdateConversion(listId, publicListConversionTime, observableOptions); + return result.toPromise(); + } + /** * Update the filter branch definition of a `DYNAMIC` list. Once updated, the list memberships will be re-evaluated and updated to match the new definition. * Update List Filter Definition @@ -863,7 +999,7 @@ export class PromiseMembershipsApi { * Add the records provided to the list. Records that do not exist or that are already members of the list are ignored. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`. * Add Records to a List * @param listId The **ILS ID** of the `MANUAL` or `SNAPSHOT` list. - * @param requestBody + * @param requestBody The IDs of the records to add to the list. */ public addWithHttpInfo(listId: string, requestBody: Array, _options?: PromiseConfigurationOptions): Promise> { let observableOptions: undefined | ConfigurationOptions @@ -886,7 +1022,7 @@ export class PromiseMembershipsApi { * Add the records provided to the list. Records that do not exist or that are already members of the list are ignored. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`. * Add Records to a List * @param listId The **ILS ID** of the `MANUAL` or `SNAPSHOT` list. - * @param requestBody + * @param requestBody The IDs of the records to add to the list. */ public add(listId: string, requestBody: Array, _options?: PromiseConfigurationOptions): Promise { let observableOptions: undefined | ConfigurationOptions @@ -955,7 +1091,7 @@ export class PromiseMembershipsApi { * Add and/or remove records that have already been created in the system to and/or from a list. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`. * Add and/or Remove Records from a List * @param listId The **ILS ID** of the `MANUAL` or `SNAPSHOT` list. - * @param membershipChangeRequest + * @param membershipChangeRequest The IDs of the records to add and/or remove from the list. */ public addAndRemoveWithHttpInfo(listId: string, membershipChangeRequest: MembershipChangeRequest, _options?: PromiseConfigurationOptions): Promise> { let observableOptions: undefined | ConfigurationOptions @@ -978,7 +1114,7 @@ export class PromiseMembershipsApi { * Add and/or remove records that have already been created in the system to and/or from a list. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`. * Add and/or Remove Records from a List * @param listId The **ILS ID** of the `MANUAL` or `SNAPSHOT` list. - * @param membershipChangeRequest + * @param membershipChangeRequest The IDs of the records to add and/or remove from the list. */ public addAndRemove(listId: string, membershipChangeRequest: MembershipChangeRequest, _options?: PromiseConfigurationOptions): Promise { let observableOptions: undefined | ConfigurationOptions @@ -1147,7 +1283,7 @@ export class PromiseMembershipsApi { * Remove the records provided from the list. Records that do not exist or that are not members of the list are ignored. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`. * Remove Records from a List * @param listId The **ILS ID** of the `MANUAL` or `SNAPSHOT` list. - * @param requestBody + * @param requestBody The IDs of the records to remove from the list. */ public removeWithHttpInfo(listId: string, requestBody: Array, _options?: PromiseConfigurationOptions): Promise> { let observableOptions: undefined | ConfigurationOptions @@ -1170,7 +1306,7 @@ export class PromiseMembershipsApi { * Remove the records provided from the list. Records that do not exist or that are not members of the list are ignored. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`. * Remove Records from a List * @param listId The **ILS ID** of the `MANUAL` or `SNAPSHOT` list. - * @param requestBody + * @param requestBody The IDs of the records to remove from the list. */ public remove(listId: string, requestBody: Array, _options?: PromiseConfigurationOptions): Promise { let observableOptions: undefined | ConfigurationOptions