From 6bc2717608c858876ab0887935821696265e8d2c Mon Sep 17 00:00:00 2001 From: ballerina-bot Date: Wed, 9 Apr 2025 10:13:50 +0000 Subject: [PATCH 1/7] [AUTOMATED] Update OpenAPI spec --- docs/spec/openapi.yaml | 8670 ++++++++++++++++++---------------------- 1 file changed, 3901 insertions(+), 4769 deletions(-) diff --git a/docs/spec/openapi.yaml b/docs/spec/openapi.yaml index 666de33..ad9f624 100644 --- a/docs/spec/openapi.yaml +++ b/docs/spec/openapi.yaml @@ -1,4770 +1,3902 @@ -{ - "openapi" : "3.0.1", - "info" : { - "title" : "Lists", - "version" : "v3", - "x-hubspot-product-tier-requirements" : { - "marketing" : "STARTER", - "cms" : "STARTER" - }, - "x-hubspot-documentation-banner" : "NONE", - "x-hubspot-api-use-case" : "You want to bulk add contacts to a particular list, or remove company records from a company list.", - "x-hubspot-related-documentation" : [ { - "name" : "Lists Guide", - "url" : "https://developers.hubspot.com/beta-docs/guides/api/crm/lists/overview" - } ], - "x-hubspot-introduction" : "Use the lists API to manage list memberships for object lists." - }, - "servers" : [ { - "url" : "https://api.hubapi.com/crm/v3/lists" - } ], - "tags" : [ { - "name" : "Lists" - }, { - "name" : "Memberships" - }, { - "name" : "Folders" - }, { - "name" : "Mapping" - } ], - "paths" : { - "/{listId}/update-list-name" : { - "put" : { - "tags" : [ "Lists" ], - "summary" : "Update List Name", - "description" : "Update the name of a list. The name must be globally unique relative to all other public lists in the portal.", - "operationId" : "put-/{listId}/update-list-name_updateName", - "parameters" : [ { - "name" : "listId", - "in" : "path", - "description" : "The **ILS ID** of the list to update.", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - }, { - "name" : "listName", - "in" : "query", - "description" : "The name to update the list to.", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "string" - } - }, { - "name" : "includeFilters", - "in" : "query", - "description" : "A flag indicating whether or not the response object list definition should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response.", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "boolean", - "default" : false - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ListUpdateResponse" - } - } - } - }, - "default" : { - "$ref" : "#/components/responses/Error" - } - }, - "security" : [ { - "oauth2" : [ "cms.membership.access_groups.write", "crm.lists.read" ] - }, { - "private_apps" : [ "crm.lists.write", "crm.lists.read" ] - }, { - "oauth2" : [ "crm.lists.write", "crm.lists.read" ] - }, { - "private_apps" : [ "cms.membership.access_groups.write", "crm.lists.read" ] - } ] - } - }, - "/{listId}/memberships/add-and-remove" : { - "put" : { - "tags" : [ "Memberships" ], - "summary" : "Add and/or Remove Records from a List", - "description" : "Add and/or remove records that have already been created in the system to and/or from a list.\n\nThis endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`.", - "operationId" : "put-/{listId}/memberships/add-and-remove_addAndRemove", - "parameters" : [ { - "name" : "listId", - "in" : "path", - "description" : "The **ILS ID** of the `MANUAL` or `SNAPSHOT` list.", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/MembershipChangeRequest" - } - } - }, - "required" : true - }, - "responses" : { - "200" : { - "description" : "successful operation", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/MembershipsUpdateResponse" - } - } - } - }, - "default" : { - "$ref" : "#/components/responses/Error" - } - }, - "security" : [ { - "oauth2" : [ "cms.membership.access_groups.write", "crm.lists.read" ] - }, { - "private_apps" : [ "crm.lists.write", "crm.lists.read" ] - }, { - "oauth2" : [ "crm.lists.write", "crm.lists.read" ] - }, { - "private_apps" : [ "cms.membership.access_groups.write", "crm.lists.read" ] - } ] - } - }, - "/{listId}" : { - "get" : { - "tags" : [ "Lists" ], - "summary" : "Fetch List by ID", - "description" : "Fetch a single list by **ILS list ID**.", - "operationId" : "get-/{listId}_getById", - "parameters" : [ { - "name" : "listId", - "in" : "path", - "description" : "The **ILS ID** of the list to fetch.", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - }, { - "name" : "includeFilters", - "in" : "query", - "description" : "A flag indicating whether or not the response object list definition should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response.", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "boolean", - "default" : false - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ListFetchResponse" - } - } - } - }, - "default" : { - "$ref" : "#/components/responses/Error" - } - }, - "security" : [ { - "private_apps" : [ "crm.lists.read" ] - }, { - "oauth2" : [ "crm.lists.read" ] - } ] - }, - "delete" : { - "tags" : [ "Lists" ], - "summary" : "Delete a List", - "description" : "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.", - "operationId" : "delete-/{listId}_remove", - "parameters" : [ { - "name" : "listId", - "in" : "path", - "description" : "The **ILS ID** of the list to delete.", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "204" : { - "description" : "No content", - "content" : { } - }, - "default" : { - "$ref" : "#/components/responses/Error" - } - }, - "security" : [ { - "oauth2" : [ "cms.membership.access_groups.write", "crm.lists.read" ] - }, { - "private_apps" : [ "crm.lists.write", "crm.lists.read" ] - }, { - "oauth2" : [ "crm.lists.write", "crm.lists.read" ] - }, { - "private_apps" : [ "cms.membership.access_groups.write", "crm.lists.read" ] - } ] - } - }, - "/{listId}/update-list-filters" : { - "put" : { - "tags" : [ "Lists" ], - "summary" : "Update List Filter Definition", - "description" : "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.", - "operationId" : "put-/{listId}/update-list-filters_updateListFilters", - "parameters" : [ { - "name" : "listId", - "in" : "path", - "description" : "The **ILS ID** of the list to update.", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - }, { - "name" : "enrollObjectsInWorkflows", - "in" : "query", - "description" : "A flag indicating whether or not the memberships added to the list as a result of the filter change should be enrolled in workflows that are relevant to this list.", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "boolean", - "default" : false - } - } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ListFilterUpdateRequest" - } - } - }, - "required" : true - }, - "responses" : { - "200" : { - "description" : "successful operation", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ListUpdateResponse" - } - } - } - }, - "default" : { - "$ref" : "#/components/responses/Error" - } - }, - "security" : [ { - "oauth2" : [ "cms.membership.access_groups.write", "crm.lists.read" ] - }, { - "private_apps" : [ "crm.lists.write", "crm.lists.read" ] - }, { - "oauth2" : [ "crm.lists.write", "crm.lists.read" ] - }, { - "private_apps" : [ "cms.membership.access_groups.write", "crm.lists.read" ] - } ] - } - }, - "/search" : { - "post" : { - "tags" : [ "Lists" ], - "summary" : "Search Lists", - "description" : "Search lists by list name or page through all lists by providing an empty `query` value.", - "operationId" : "post-/search_doSearch", - "parameters" : [ ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ListSearchRequest" - } - } - }, - "required" : true - }, - "responses" : { - "200" : { - "description" : "successful operation", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ListSearchResponse" - } - } - } - }, - "default" : { - "$ref" : "#/components/responses/Error" - } - }, - "security" : [ { - "private_apps" : [ "crm.lists.read" ] - }, { - "oauth2" : [ "crm.lists.read" ] - } ] - } - }, - "/folders/move-list" : { - "put" : { - "tags" : [ "Folders" ], - "summary" : "Moves a list to a given folder", - "description" : "Given a list and a folder, the list will be moved to that folder.", - "operationId" : "put-/folders/move-list_moveList", - "parameters" : [ ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ListMoveRequest" - } - } - }, - "required" : true - }, - "responses" : { - "204" : { - "description" : "No content", - "content" : { } - }, - "default" : { - "$ref" : "#/components/responses/Error" - } - }, - "security" : [ { - "oauth2" : [ "cms.membership.access_groups.write", "crm.lists.read" ] - }, { - "private_apps" : [ "crm.lists.write", "crm.lists.read" ] - }, { - "oauth2" : [ "crm.lists.write", "crm.lists.read" ] - }, { - "private_apps" : [ "cms.membership.access_groups.write", "crm.lists.read" ] - } ] - } - }, - "/{listId}/memberships/add" : { - "put" : { - "tags" : [ "Memberships" ], - "summary" : "Add Records to a List", - "description" : "Add the records provided to the list. Records that do not exist or that are already members of the list are ignored.\n\nThis endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`.", - "operationId" : "put-/{listId}/memberships/add_add", - "parameters" : [ { - "name" : "listId", - "in" : "path", - "description" : "The **ILS ID** of the `MANUAL` or `SNAPSHOT` list.", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - } - }, - "required" : true - }, - "responses" : { - "200" : { - "description" : "successful operation", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/MembershipsUpdateResponse" - } - } - } - }, - "default" : { - "$ref" : "#/components/responses/Error" - } - }, - "security" : [ { - "oauth2" : [ "cms.membership.access_groups.write", "crm.lists.read" ] - }, { - "private_apps" : [ "crm.lists.write", "crm.lists.read" ] - }, { - "oauth2" : [ "crm.lists.write", "crm.lists.read" ] - }, { - "private_apps" : [ "cms.membership.access_groups.write", "crm.lists.read" ] - } ] - } - }, - "/object-type-id/{objectTypeId}/name/{listName}" : { - "get" : { - "tags" : [ "Lists" ], - "summary" : "Fetch List by Name", - "description" : "Fetch a single list by list name and object type.", - "operationId" : "get-/object-type-id/{objectTypeId}/name/{listName}_getByName", - "parameters" : [ { - "name" : "listName", - "in" : "path", - "description" : "The name of the list to fetch. This is **not** case sensitive.", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - }, { - "name" : "objectTypeId", - "in" : "path", - "description" : "The object type ID of the object types stored by the list to fetch. For example, `0-1` for a `CONTACT` list.", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - }, { - "name" : "includeFilters", - "in" : "query", - "description" : "A flag indicating whether or not the response object list definition should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response.", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "boolean", - "default" : false - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ListFetchResponse" - } - } - } - }, - "default" : { - "$ref" : "#/components/responses/Error" - } - }, - "security" : [ { - "private_apps" : [ "crm.lists.read" ] - }, { - "oauth2" : [ "crm.lists.read" ] - } ] - } - }, - "/folders/{folderId}/move/{newParentFolderId}" : { - "put" : { - "tags" : [ "Folders" ], - "summary" : "Moves a folder", - "description" : "This moves the folder from its current location to a new location. It updates the parent of this folder to the new Id given.", - "operationId" : "put-/folders/{folderId}/move/{newParentFolderId}_move", - "parameters" : [ { - "name" : "folderId", - "in" : "path", - "description" : "", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - }, { - "name" : "newParentFolderId", - "in" : "path", - "description" : "", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ListFolderFetchResponse" - } - } - } - }, - "default" : { - "$ref" : "#/components/responses/Error" - } - }, - "security" : [ { - "oauth2" : [ "cms.membership.access_groups.write", "crm.lists.read" ] - }, { - "private_apps" : [ "crm.lists.write", "crm.lists.read" ] - }, { - "oauth2" : [ "crm.lists.write", "crm.lists.read" ] - }, { - "private_apps" : [ "cms.membership.access_groups.write", "crm.lists.read" ] - } ] - } - }, - "/idmapping" : { - "get" : { - "tags" : [ "Mapping" ], - "summary" : "Translate Legacy List Id to Modern List Id", - "description" : "This API allows translation of legacy list id to list id. This is a temporary API allowed for mapping old id's to new id's and will expire on May 30th, 2025.", - "operationId" : "get-/idmapping_translateLegacyListIdToListId", - "parameters" : [ { - "name" : "legacyListId", - "in" : "query", - "description" : "The legacy list id from lists v1 API.", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PublicMigrationMapping" - } - } - } - }, - "default" : { - "$ref" : "#/components/responses/Error" - } - }, - "security" : [ { - "private_apps" : [ "crm.lists.read" ] - }, { - "oauth2" : [ "crm.lists.read" ] - } ] - }, - "post" : { - "tags" : [ "Mapping" ], - "summary" : "Translate Legacy List Id to Modern List Id in Batch", - "description" : "This API allows translation of a batch of legacy list id's to list id's. This allows for a maximum of 10,000 id's. This is a temporary API allowed for mapping old id's to new id's and will expire on May 30th, 2025.", - "operationId" : "post-/idmapping_translateLegacyListIdToListIdBatch", - "parameters" : [ ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - } - }, - "required" : true - }, - "responses" : { - "200" : { - "description" : "successful operation", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PublicBatchMigrationMapping" - } - } - } - }, - "default" : { - "$ref" : "#/components/responses/Error" - } - }, - "security" : [ { - "private_apps" : [ "crm.lists.read" ] - }, { - "oauth2" : [ "crm.lists.read" ] - } ] - } - }, - "/{listId}/restore" : { - "put" : { - "tags" : [ "Lists" ], - "summary" : "Restore a List", - "description" : "Restore a previously deleted list by **ILS list ID**. Deleted lists are eligible to be restored up-to 90-days after the list has been deleted.", - "operationId" : "put-/{listId}/restore_restore", - "parameters" : [ { - "name" : "listId", - "in" : "path", - "description" : "The **ILS ID** of the list to restore.", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "204" : { - "description" : "No content", - "content" : { } - }, - "default" : { - "$ref" : "#/components/responses/Error" - } - }, - "security" : [ { - "oauth2" : [ "cms.membership.access_groups.write", "crm.lists.read" ] - }, { - "private_apps" : [ "crm.lists.write", "crm.lists.read" ] - }, { - "oauth2" : [ "crm.lists.write", "crm.lists.read" ] - }, { - "private_apps" : [ "cms.membership.access_groups.write", "crm.lists.read" ] - } ] - } - }, - "/folders/{folderId}/rename" : { - "put" : { - "tags" : [ "Folders" ], - "summary" : "Rename a folder", - "description" : "Renames the given folderId with a new name.", - "operationId" : "put-/folders/{folderId}/rename_rename", - "parameters" : [ { - "name" : "folderId", - "in" : "path", - "description" : "", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - }, { - "name" : "newFolderName", - "in" : "query", - "description" : "", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ListFolderFetchResponse" - } - } - } - }, - "default" : { - "$ref" : "#/components/responses/Error" - } - }, - "security" : [ { - "oauth2" : [ "cms.membership.access_groups.write", "crm.lists.read" ] - }, { - "private_apps" : [ "crm.lists.write", "crm.lists.read" ] - }, { - "oauth2" : [ "crm.lists.write", "crm.lists.read" ] - }, { - "private_apps" : [ "cms.membership.access_groups.write", "crm.lists.read" ] - } ] - } - }, - "/{listId}/memberships/join-order" : { - "get" : { - "tags" : [ "Memberships" ], - "summary" : "Fetch List Memberships Ordered by Added to List Date", - "description" : "Fetch the memberships of a list in order sorted by the time the records were added to the list.\n\nThe `recordId`s are sorted in *ascending* order if an `after` offset or no offset is provided. If only a `before` offset is provided, then the records are sorted in *descending* order.\n\nThe `after` offset parameter will take precedence over the `before` offset in a case where both are provided.", - "operationId" : "get-/{listId}/memberships/join-order_getPageOrderedByAddedToListDate", - "parameters" : [ { - "name" : "listId", - "in" : "path", - "description" : "The **ILS ID** of the list.", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - }, { - "name" : "after", - "in" : "query", - "description" : "The paging offset token for the page that comes `after` the previously requested records.\n\nIf provided, then the records in the response will be the records following the offset, sorted in *ascending* order. Takes precedence over the `before` offset.", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "string" - } - }, { - "name" : "before", - "in" : "query", - "description" : "The paging offset token for the page that comes `before` the previously requested records.\n\nIf provided, then the records in the response will be the records preceding the offset, sorted in *descending* order.", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "string" - } - }, { - "name" : "limit", - "in" : "query", - "description" : "The number of records to return in the response. The maximum `limit` is 250.", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "integer", - "format" : "int32", - "default" : 100 - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ApiCollectionResponseJoinTimeAndRecordId" - } - } - } - }, - "default" : { - "$ref" : "#/components/responses/Error" - } - }, - "security" : [ { - "private_apps" : [ "crm.lists.read" ] - }, { - "oauth2" : [ "crm.lists.read" ] - } ] - } - }, - "/{listId}/memberships/add-from/{sourceListId}" : { - "put" : { - "tags" : [ "Memberships" ], - "summary" : "Add All Records from a Source List to a Destination List", - "description" : "Add all of the records from a *source list* (specified by the `sourceListId`) to a *destination list* (specified by the `listId`). Records that are already members of the *destination list* will be ignored. The *destination* and *source list* IDs must be different. The *destination* and *source lists* must contain records of the same type (e.g. contacts, companies, etc.).\n\nThis endpoint only works for *destination lists* that have a `processingType` of `MANUAL` or `SNAPSHOT`. The *source list* can have any `processingType`.\n\nThis endpoint only supports a `sourceListId` for lists with less than 100,000 memberships.", - "operationId" : "put-/{listId}/memberships/add-from/{sourceListId}_addAllFromList", - "parameters" : [ { - "name" : "listId", - "in" : "path", - "description" : "The **ILS ID** of the `MANUAL` or `SNAPSHOT` *destination list*, which the *source list* records are added to.", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - }, { - "name" : "sourceListId", - "in" : "path", - "description" : "The **ILS ID** of the *source list* to grab the records from, which are then added to the *destination list*.", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "204" : { - "description" : "No content", - "content" : { } - }, - "default" : { - "$ref" : "#/components/responses/Error" - } - }, - "security" : [ { - "oauth2" : [ "cms.membership.access_groups.write", "crm.lists.read" ] - }, { - "private_apps" : [ "crm.lists.write", "crm.lists.read" ] - }, { - "oauth2" : [ "crm.lists.write", "crm.lists.read" ] - }, { - "private_apps" : [ "cms.membership.access_groups.write", "crm.lists.read" ] - } ] - } - }, - "/records/{objectTypeId}/{recordId}/memberships" : { - "get" : { - "tags" : [ "Memberships" ], - "summary" : "Get lists record is member of", - "description" : "For given record provide lists this record is member of.", - "operationId" : "get-/records/{objectTypeId}/{recordId}/memberships_getLists", - "parameters" : [ { - "name" : "objectTypeId", - "in" : "path", - "description" : "Object type id of the record", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - }, { - "name" : "recordId", - "in" : "path", - "description" : "Id of the record", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ApiCollectionResponseRecordListMembershipNoPaging" - } - } - } - }, - "default" : { - "$ref" : "#/components/responses/Error" - } - }, - "security" : [ { - "private_apps" : [ "crm.lists.read" ] - }, { - "oauth2" : [ "crm.lists.read" ] - } ] - } - }, - "/" : { - "get" : { - "tags" : [ "Lists" ], - "summary" : "Fetch Multiple Lists", - "description" : "Fetch multiple lists in a single request by **ILS list ID**. The response will include the definitions of all lists that exist for the `listIds` provided.", - "operationId" : "get-/_getAll", - "parameters" : [ { - "name" : "listIds", - "in" : "query", - "description" : "The **ILS IDs** of the lists to fetch.", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - }, { - "name" : "includeFilters", - "in" : "query", - "description" : "A flag indicating whether or not the response object list definitions should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response.", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "boolean", - "default" : false - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ListsByIdResponse" - } - } - } - }, - "default" : { - "$ref" : "#/components/responses/Error" - } - }, - "security" : [ { - "private_apps" : [ "crm.lists.read" ] - }, { - "oauth2" : [ "crm.lists.read" ] - } ] - }, - "post" : { - "tags" : [ "Lists" ], - "summary" : "Create List", - "description" : "Create a new list with the provided object list definition.", - "operationId" : "post-/_create", - "parameters" : [ ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ListCreateRequest" - } - } - }, - "required" : true - }, - "responses" : { - "200" : { - "description" : "successful operation", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ListCreateResponse" - } - } - } - }, - "default" : { - "$ref" : "#/components/responses/Error" - } - }, - "security" : [ { - "private_apps" : [ "cms.membership.access_groups.write" ] - }, { - "oauth2" : [ "cms.membership.access_groups.write" ] - }, { - "oauth2" : [ "crm.lists.write" ] - }, { - "private_apps" : [ "crm.lists.write" ] - } ] - } - }, - "/folders" : { - "get" : { - "tags" : [ "Folders" ], - "summary" : "Retrieves a folder.", - "description" : "Retrieves a folder and recursively includes all folders via the childNodes attribute. The child lists field will be empty in all child nodes. Only the folder retrieved will include the child lists in that folder.", - "operationId" : "get-/folders_getAll", - "parameters" : [ { - "name" : "folderId", - "in" : "query", - "description" : "The Id of the folder to retrieve.", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "string", - "default" : "0" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ListFolderFetchResponse" - } - } - } - }, - "default" : { - "$ref" : "#/components/responses/Error" - } - }, - "security" : [ { - "private_apps" : [ "crm.lists.read" ] - }, { - "oauth2" : [ "crm.lists.read" ] - } ] - }, - "post" : { - "tags" : [ "Folders" ], - "summary" : "Creates a folder", - "description" : "Creates a folder with the given information.", - "operationId" : "post-/folders_create", - "parameters" : [ ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ListFolderCreateRequest" - } - } - }, - "required" : true - }, - "responses" : { - "200" : { - "description" : "successful operation", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ListFolderCreateResponse" - } - } - } - }, - "default" : { - "$ref" : "#/components/responses/Error" - } - }, - "security" : [ { - "oauth2" : [ "cms.membership.access_groups.write", "crm.lists.read" ] - }, { - "private_apps" : [ "crm.lists.write", "crm.lists.read" ] - }, { - "oauth2" : [ "crm.lists.write", "crm.lists.read" ] - }, { - "private_apps" : [ "cms.membership.access_groups.write", "crm.lists.read" ] - } ] - } - }, - "/folders/{folderId}" : { - "delete" : { - "tags" : [ "Folders" ], - "summary" : "Deletes a folder", - "description" : "Deletes the folder with the given Id.", - "operationId" : "delete-/folders/{folderId}_remove", - "parameters" : [ { - "name" : "folderId", - "in" : "path", - "description" : "", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "204" : { - "description" : "No content", - "content" : { } - }, - "default" : { - "$ref" : "#/components/responses/Error" - } - }, - "security" : [ { - "oauth2" : [ "cms.membership.access_groups.write", "crm.lists.read" ] - }, { - "private_apps" : [ "crm.lists.write", "crm.lists.read" ] - }, { - "oauth2" : [ "crm.lists.write", "crm.lists.read" ] - }, { - "private_apps" : [ "cms.membership.access_groups.write", "crm.lists.read" ] - } ] - } - }, - "/{listId}/memberships" : { - "get" : { - "tags" : [ "Memberships" ], - "summary" : "Fetch List Memberships Ordered by ID", - "description" : "Fetch the memberships of a list in order sorted by the `recordId` of the records in the list.\n\nThe `recordId`s are sorted in *ascending* order if an `after` offset or no offset is provided. If only a `before` offset is provided, then the records are sorted in *descending* order.\n\nThe `after` offset parameter will take precedence over the `before` offset in a case where both are provided.", - "operationId" : "get-/{listId}/memberships_getPage", - "parameters" : [ { - "name" : "listId", - "in" : "path", - "description" : "The **ILS ID** of the list.", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - }, { - "name" : "after", - "in" : "query", - "description" : "The paging offset token for the page that comes `after` the previously requested records.\n\nIf provided, then the records in the response will be the records following the offset, sorted in *ascending* order. Takes precedence over the `before` offset.", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "string" - } - }, { - "name" : "before", - "in" : "query", - "description" : "The paging offset token for the page that comes `before` the previously requested records.\n\nIf provided, then the records in the response will be the records preceding the offset, sorted in *descending* order.", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "string" - } - }, { - "name" : "limit", - "in" : "query", - "description" : "The number of records to return in the response. The maximum `limit` is 250.", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "integer", - "format" : "int32", - "default" : 100 - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ApiCollectionResponseJoinTimeAndRecordId" - } - } - } - }, - "default" : { - "$ref" : "#/components/responses/Error" - } - }, - "security" : [ { - "private_apps" : [ "crm.lists.read" ] - }, { - "oauth2" : [ "crm.lists.read" ] - } ] - }, - "delete" : { - "tags" : [ "Memberships" ], - "summary" : "Delete All Records from a List", - "description" : "Remove **all** of the records from a list. ***Note:*** *The list is not deleted.*\n\nThis endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`.\n\nThis endpoint only supports lists that have less than 100,000 memberships.", - "operationId" : "delete-/{listId}/memberships_removeAll", - "parameters" : [ { - "name" : "listId", - "in" : "path", - "description" : "The **ILS ID** of the `MANUAL` or `SNAPSHOT` list.", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "204" : { - "description" : "No content", - "content" : { } - }, - "default" : { - "$ref" : "#/components/responses/Error" - } - }, - "security" : [ { - "oauth2" : [ "cms.membership.access_groups.write", "crm.lists.read" ] - }, { - "private_apps" : [ "crm.lists.write", "crm.lists.read" ] - }, { - "oauth2" : [ "crm.lists.write", "crm.lists.read" ] - }, { - "private_apps" : [ "cms.membership.access_groups.write", "crm.lists.read" ] - } ] - } - }, - "/{listId}/memberships/remove" : { - "put" : { - "tags" : [ "Memberships" ], - "summary" : "Remove Records from a List", - "description" : "Remove the records provided from the list. Records that do not exist or that are not members of the list are ignored.\n\nThis endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`.", - "operationId" : "put-/{listId}/memberships/remove_remove", - "parameters" : [ { - "name" : "listId", - "in" : "path", - "description" : "The **ILS ID** of the `MANUAL` or `SNAPSHOT` list.", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - } - }, - "required" : true - }, - "responses" : { - "200" : { - "description" : "successful operation", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/MembershipsUpdateResponse" - } - } - } - }, - "default" : { - "$ref" : "#/components/responses/Error" - } - }, - "security" : [ { - "oauth2" : [ "cms.membership.access_groups.write", "crm.lists.read" ] - }, { - "private_apps" : [ "crm.lists.write", "crm.lists.read" ] - }, { - "oauth2" : [ "crm.lists.write", "crm.lists.read" ] - }, { - "private_apps" : [ "cms.membership.access_groups.write", "crm.lists.read" ] - } ] - } - } - }, - "components" : { - "schemas" : { - "PublicPropertyAssociationFilterBranch" : { - "title" : "PROPERTY_ASSOCIATION", - "required" : [ "filterBranchOperator", "filterBranchType", "filterBranches", "filters", "objectTypeId", "operator", "propertyWithObjectId" ], - "type" : "object", - "properties" : { - "filterBranchType" : { - "type" : "string", - "default" : "PROPERTY_ASSOCIATION", - "enum" : [ "PROPERTY_ASSOCIATION" ] - }, - "filterBranches" : { - "type" : "array", - "items" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicOrFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicAndFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicNotAllFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicNotAnyFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicRestrictedFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicUnifiedEventsFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicPropertyAssociationFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicAssociationFilterBranch" - } ] - } - }, - "objectTypeId" : { - "type" : "string" - }, - "filterBranchOperator" : { - "type" : "string" - }, - "filters" : { - "type" : "array", - "items" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicPropertyFilter" - }, { - "$ref" : "#/components/schemas/PublicAssociationInListFilter" - }, { - "$ref" : "#/components/schemas/PublicPageViewAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicCtaAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicEventAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicFormSubmissionFilter" - }, { - "$ref" : "#/components/schemas/PublicFormSubmissionOnPageFilter" - }, { - "$ref" : "#/components/schemas/PublicIntegrationEventFilter" - }, { - "$ref" : "#/components/schemas/PublicEmailSubscriptionFilter" - }, { - "$ref" : "#/components/schemas/PublicCommunicationSubscriptionFilter" - }, { - "$ref" : "#/components/schemas/PublicCampaignInfluencedFilter" - }, { - "$ref" : "#/components/schemas/PublicSurveyMonkeyFilter" - }, { - "$ref" : "#/components/schemas/PublicSurveyMonkeyValueFilter" - }, { - "$ref" : "#/components/schemas/PublicWebinarFilter" - }, { - "$ref" : "#/components/schemas/PublicEmailEventFilter" - }, { - "$ref" : "#/components/schemas/PublicPrivacyAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicAdsSearchFilter" - }, { - "$ref" : "#/components/schemas/PublicAdsTimeFilter" - }, { - "$ref" : "#/components/schemas/PublicInListFilter" - }, { - "$ref" : "#/components/schemas/PublicNumAssociationsFilter" - }, { - "$ref" : "#/components/schemas/PublicUnifiedEventsFilter" - }, { - "$ref" : "#/components/schemas/PublicPropertyAssociationInListFilter" - }, { - "$ref" : "#/components/schemas/PublicConstantFilter" - } ] - } - }, - "propertyWithObjectId" : { - "type" : "string" - }, - "operator" : { - "type" : "string" - } - } - }, - "PublicNumberPropertyOperation" : { - "title" : "NUMBER", - "required" : [ "includeObjectsWithNoValueSet", "operationType", "operator", "value" ], - "type" : "object", - "properties" : { - "includeObjectsWithNoValueSet" : { - "type" : "boolean" - }, - "operationType" : { - "type" : "string", - "default" : "NUMBER", - "enum" : [ "NUMBER" ] - }, - "value" : { - "type" : "number" - }, - "operator" : { - "type" : "string" - } - } - }, - "PublicYearReference" : { - "title" : "YEAR", - "required" : [ "day", "month", "referenceType" ], - "type" : "object", - "properties" : { - "hour" : { - "type" : "integer", - "format" : "int32" - }, - "month" : { - "type" : "integer", - "format" : "int32" - }, - "millisecond" : { - "type" : "integer", - "format" : "int32" - }, - "referenceType" : { - "type" : "string", - "default" : "YEAR", - "enum" : [ "YEAR" ] - }, - "day" : { - "type" : "integer", - "format" : "int32" - }, - "minute" : { - "type" : "integer", - "format" : "int32" - }, - "second" : { - "type" : "integer", - "format" : "int32" - } - } - }, - "PublicInListFilterMetadata" : { - "required" : [ "id", "inListType" ], - "type" : "object", - "properties" : { - "id" : { - "type" : "string" - }, - "inListType" : { - "type" : "string" - } - } - }, - "ListFolderFetchResponse" : { - "required" : [ "folder" ], - "type" : "object", - "properties" : { - "folder" : { - "$ref" : "#/components/schemas/PublicListFolder" - } - } - }, - "PublicRangedDatePropertyOperation" : { - "title" : "RANGED_DATE", - "required" : [ "includeObjectsWithNoValueSet", "lowerBound", "operationType", "operator", "requiresTimeZoneConversion", "upperBound" ], - "type" : "object", - "properties" : { - "includeObjectsWithNoValueSet" : { - "type" : "boolean" - }, - "upperBound" : { - "type" : "integer", - "format" : "int32" - }, - "requiresTimeZoneConversion" : { - "type" : "boolean" - }, - "operationType" : { - "type" : "string", - "default" : "RANGED_DATE", - "enum" : [ "RANGED_DATE" ] - }, - "lowerBound" : { - "type" : "integer", - "format" : "int32" - }, - "operator" : { - "type" : "string" - } - } - }, - "ListSearchRequest" : { - "type" : "object", - "properties" : { - "listIds" : { - "type" : "array", - "description" : "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.\n\nIf no value is provided, or if an empty list is provided, then the results will not be filtered by `listId`.", - "items" : { - "type" : "string" - } - }, - "offset" : { - "type" : "integer", - "description" : "Value used to paginate through lists. The `offset` provided in the response can be used in the next request to fetch the next page of results. Defaults to `0` if no offset is provided.", - "format" : "int32" - }, - "query" : { - "type" : "string", - "description" : "The `query` that will be used to search for lists by list name. If no `query` is provided, then the results will include all lists." - }, - "count" : { - "type" : "integer", - "description" : "The number of lists to include in the response. Defaults to `20` if no value is provided. The max `count` is `500`.", - "format" : "int32" - }, - "processingTypes" : { - "type" : "array", - "description" : "The `processingTypes` that will be used to filter results by `processingType`. If values are provided, then the response will only include results that have a `processingType` in this array.\n\nIf no value is provided, or if an empty list is provided, then results will not be filtered by `processingType`.\n\nValid `processingTypes` are: `MANUAL`, `SNAPSHOT`, or `DYNAMIC`.", - "items" : { - "type" : "string" - } - }, - "additionalProperties" : { - "type" : "array", - "description" : "The property names of any additional list properties to include in the response. Properties that do not exist or that are empty for a particular list are not included in the response.\n\nBy default, all requests will fetch the following properties for each list: `hs_list_size`, `hs_last_record_added_at`, `hs_last_record_removed_at`, `hs_folder_name`, and `hs_list_reference_count`.", - "items" : { - "type" : "string" - } - }, - "sort" : { - "type" : "string" - } - } - }, - "ListSearchResponse" : { - "required" : [ "hasMore", "lists", "offset", "total" ], - "type" : "object", - "properties" : { - "total" : { - "type" : "integer", - "description" : "The total number of lists that match the search criteria.", - "format" : "int32" - }, - "offset" : { - "type" : "integer", - "description" : "Value to be passed in a future request to paginate through list search results.", - "format" : "int32" - }, - "lists" : { - "type" : "array", - "description" : "The lists that matched the search criteria.", - "items" : { - "$ref" : "#/components/schemas/PublicObjectListSearchResult" - } - }, - "hasMore" : { - "type" : "boolean", - "description" : "Whether or not there are more results to page through." - } - } - }, - "PublicInListFilter" : { - "title" : "IN_LIST", - "required" : [ "filterType", "listId", "operator" ], - "type" : "object", - "properties" : { - "listId" : { - "type" : "string" - }, - "metadata" : { - "$ref" : "#/components/schemas/PublicInListFilterMetadata" - }, - "filterType" : { - "type" : "string", - "default" : "IN_LIST", - "enum" : [ "IN_LIST" ] - }, - "operator" : { - "type" : "string" - } - } - }, - "PublicSurveyMonkeyValueFilter" : { - "title" : "SURVEY_MONKEY_VALUE", - "required" : [ "filterType", "operator", "surveyId", "surveyQuestion", "valueComparison" ], - "type" : "object", - "properties" : { - "valueComparison" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicBoolPropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicNumberPropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicStringPropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicDateTimePropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicRangedDatePropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicComparativePropertyUpdatedOperation" - }, { - "$ref" : "#/components/schemas/PublicComparativeDatePropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicRollingDateRangePropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicRollingPropertyUpdatedOperation" - }, { - "$ref" : "#/components/schemas/PublicEnumerationPropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicAllPropertyTypesOperation" - }, { - "$ref" : "#/components/schemas/PublicRangedNumberPropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicMultiStringPropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicDatePropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicCalendarDatePropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicTimePointOperation" - }, { - "$ref" : "#/components/schemas/PublicRangedTimeOperation" - } ] - }, - "surveyId" : { - "type" : "string" - }, - "surveyQuestion" : { - "type" : "string" - }, - "filterType" : { - "type" : "string", - "default" : "SURVEY_MONKEY_VALUE", - "enum" : [ "SURVEY_MONKEY_VALUE" ] - }, - "surveyAnswerRowId" : { - "type" : "string" - }, - "surveyAnswerColId" : { - "type" : "string" - }, - "operator" : { - "type" : "string" - } - } - }, - "PublicRelativeComparativeTimestampRefineBy" : { - "title" : "RELATIVE_COMPARATIVE", - "required" : [ "comparison", "timeOffset", "type" ], - "type" : "object", - "properties" : { - "comparison" : { - "type" : "string" - }, - "timeOffset" : { - "$ref" : "#/components/schemas/PublicTimeOffset" - }, - "type" : { - "type" : "string", - "default" : "RELATIVE_COMPARATIVE", - "enum" : [ "RELATIVE_COMPARATIVE" ] - } - } - }, - "ListsByIdResponse" : { - "required" : [ "lists" ], - "type" : "object", - "properties" : { - "lists" : { - "type" : "array", - "description" : "The object list definitions.", - "items" : { - "$ref" : "#/components/schemas/PublicObjectList" - } - } - } - }, - "PublicCommunicationSubscriptionFilter" : { - "title" : "COMMUNICATION_SUBSCRIPTION", - "required" : [ "acceptedOptStates", "channel", "filterType", "subscriptionIds", "subscriptionType" ], - "type" : "object", - "properties" : { - "subscriptionType" : { - "type" : "string" - }, - "subscriptionIds" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "channel" : { - "type" : "string" - }, - "acceptedOptStates" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "filterType" : { - "type" : "string", - "default" : "COMMUNICATION_SUBSCRIPTION", - "enum" : [ "COMMUNICATION_SUBSCRIPTION" ] - }, - "businessUnitId" : { - "type" : "string" - } - } - }, - "PublicObjectListSearchResult" : { - "required" : [ "additionalProperties", "listId", "listVersion", "name", "objectTypeId", "processingStatus", "processingType" ], - "type" : "object", - "properties" : { - "processingType" : { - "type" : "string", - "description" : "The processing type of the list." - }, - "objectTypeId" : { - "type" : "string", - "description" : "The object type of the list." - }, - "updatedById" : { - "type" : "string", - "description" : "The ID of the user that last updated the list." - }, - "filtersUpdatedAt" : { - "type" : "string", - "description" : "The time when the filters for this list were last updated.", - "format" : "datetime" - }, - "listId" : { - "type" : "string", - "description" : "The **ILS ID** of the list." - }, - "createdAt" : { - "type" : "string", - "description" : "The time when the list was created.", - "format" : "datetime" - }, - "processingStatus" : { - "type" : "string", - "description" : "The processing status of the list." - }, - "deletedAt" : { - "type" : "string", - "description" : "The time when the list was deleted.", - "format" : "datetime" - }, - "listVersion" : { - "type" : "integer", - "description" : "The version of the list.", - "format" : "int32" - }, - "name" : { - "type" : "string", - "description" : "The name of the list." - }, - "additionalProperties" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - }, - "description" : "The name and value of any additional properties that exist for this list and that were included in the search request." - }, - "createdById" : { - "type" : "string", - "description" : "The ID of the user that created the list." - }, - "updatedAt" : { - "type" : "string", - "description" : "The time the list was last updated.", - "format" : "datetime" - } - } - }, - "PublicRelativeRangedTimestampRefineBy" : { - "title" : "RELATIVE_RANGED", - "required" : [ "lowerBoundOffset", "rangeType", "type", "upperBoundOffset" ], - "type" : "object", - "properties" : { - "upperBoundOffset" : { - "$ref" : "#/components/schemas/PublicTimeOffset" - }, - "rangeType" : { - "type" : "string" - }, - "lowerBoundOffset" : { - "$ref" : "#/components/schemas/PublicTimeOffset" - }, - "type" : { - "type" : "string", - "default" : "RELATIVE_RANGED", - "enum" : [ "RELATIVE_RANGED" ] - } - } - }, - "PublicIndexOffset" : { - "type" : "object", - "properties" : { - "milliseconds" : { - "type" : "integer", - "format" : "int32" - }, - "hours" : { - "type" : "integer", - "format" : "int32" - }, - "seconds" : { - "type" : "integer", - "format" : "int32" - }, - "months" : { - "type" : "integer", - "format" : "int32" - }, - "weeks" : { - "type" : "integer", - "format" : "int32" - }, - "minutes" : { - "type" : "integer", - "format" : "int32" - }, - "quarters" : { - "type" : "integer", - "format" : "int32" - }, - "days" : { - "type" : "integer", - "format" : "int32" - }, - "years" : { - "type" : "integer", - "format" : "int32" - } - } - }, - "PublicNotAllFilterBranch" : { - "title" : "NOT_ALL", - "required" : [ "filterBranchOperator", "filterBranchType", "filterBranches", "filters" ], - "type" : "object", - "properties" : { - "filterBranchType" : { - "type" : "string", - "default" : "NOT_ALL", - "enum" : [ "NOT_ALL" ] - }, - "filterBranches" : { - "type" : "array", - "items" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicOrFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicAndFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicNotAllFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicNotAnyFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicRestrictedFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicUnifiedEventsFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicPropertyAssociationFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicAssociationFilterBranch" - } ] - } - }, - "filterBranchOperator" : { - "type" : "string" - }, - "filters" : { - "type" : "array", - "items" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicPropertyFilter" - }, { - "$ref" : "#/components/schemas/PublicAssociationInListFilter" - }, { - "$ref" : "#/components/schemas/PublicPageViewAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicCtaAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicEventAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicFormSubmissionFilter" - }, { - "$ref" : "#/components/schemas/PublicFormSubmissionOnPageFilter" - }, { - "$ref" : "#/components/schemas/PublicIntegrationEventFilter" - }, { - "$ref" : "#/components/schemas/PublicEmailSubscriptionFilter" - }, { - "$ref" : "#/components/schemas/PublicCommunicationSubscriptionFilter" - }, { - "$ref" : "#/components/schemas/PublicCampaignInfluencedFilter" - }, { - "$ref" : "#/components/schemas/PublicSurveyMonkeyFilter" - }, { - "$ref" : "#/components/schemas/PublicSurveyMonkeyValueFilter" - }, { - "$ref" : "#/components/schemas/PublicWebinarFilter" - }, { - "$ref" : "#/components/schemas/PublicEmailEventFilter" - }, { - "$ref" : "#/components/schemas/PublicPrivacyAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicAdsSearchFilter" - }, { - "$ref" : "#/components/schemas/PublicAdsTimeFilter" - }, { - "$ref" : "#/components/schemas/PublicInListFilter" - }, { - "$ref" : "#/components/schemas/PublicNumAssociationsFilter" - }, { - "$ref" : "#/components/schemas/PublicUnifiedEventsFilter" - }, { - "$ref" : "#/components/schemas/PublicPropertyAssociationInListFilter" - }, { - "$ref" : "#/components/schemas/PublicConstantFilter" - } ] - } - } - } - }, - "PublicBatchMigrationMapping" : { - "required" : [ "legacyListIdsToIdsMapping", "missingLegacyListIds" ], - "type" : "object", - "properties" : { - "legacyListIdsToIdsMapping" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PublicMigrationMapping" - } - }, - "missingLegacyListIds" : { - "type" : "array", - "description" : "A list of legacy list ids that were passed in but not found. It will be empty if no id's are missing", - "items" : { - "type" : "string" - } - } - } - }, - "PublicFormSubmissionFilter" : { - "title" : "FORM_SUBMISSION", - "required" : [ "filterType", "operator" ], - "type" : "object", - "properties" : { - "formId" : { - "type" : "string" - }, - "coalescingRefineBy" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicNumOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicSetOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAllHistoryRefineBy" - }, { - "$ref" : "#/components/schemas/PublicTimePointOperation" - }, { - "$ref" : "#/components/schemas/PublicRangedTimeOperation" - } ] - }, - "pruningRefineBy" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicNumOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicSetOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAllHistoryRefineBy" - }, { - "$ref" : "#/components/schemas/PublicTimePointOperation" - }, { - "$ref" : "#/components/schemas/PublicRangedTimeOperation" - } ] - }, - "filterType" : { - "type" : "string", - "default" : "FORM_SUBMISSION", - "enum" : [ "FORM_SUBMISSION" ] - }, - "operator" : { - "type" : "string", - "enum" : [ "FILLED_OUT", "NOT_FILLED_OUT" ] - } - } - }, - "PublicRollingDateRangePropertyOperation" : { - "title" : "ROLLING_DATE_RANGE", - "required" : [ "includeObjectsWithNoValueSet", "numberOfDays", "operationType", "operator", "requiresTimeZoneConversion" ], - "type" : "object", - "properties" : { - "includeObjectsWithNoValueSet" : { - "type" : "boolean" - }, - "requiresTimeZoneConversion" : { - "type" : "boolean" - }, - "operationType" : { - "type" : "string", - "default" : "ROLLING_DATE_RANGE", - "enum" : [ "ROLLING_DATE_RANGE" ] - }, - "numberOfDays" : { - "type" : "integer", - "format" : "int32" - }, - "operator" : { - "type" : "string" - } - } - }, - "ApiCollectionResponseJoinTimeAndRecordId" : { - "required" : [ "results" ], - "type" : "object", - "properties" : { - "total" : { - "type" : "integer", - "format" : "int64" - }, - "paging" : { - "$ref" : "#/components/schemas/Paging" - }, - "results" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/JoinTimeAndRecordId" - } - } - } - }, - "PublicAssociationFilterBranch" : { - "title" : "ASSOCIATION", - "required" : [ "associationCategory", "associationTypeId", "filterBranchOperator", "filterBranchType", "filterBranches", "filters", "objectTypeId", "operator" ], - "type" : "object", - "properties" : { - "filterBranchType" : { - "type" : "string", - "default" : "ASSOCIATION", - "enum" : [ "ASSOCIATION" ] - }, - "filterBranches" : { - "type" : "array", - "items" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicOrFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicAndFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicNotAllFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicNotAnyFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicRestrictedFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicUnifiedEventsFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicPropertyAssociationFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicAssociationFilterBranch" - } ] - } - }, - "objectTypeId" : { - "type" : "string" - }, - "filterBranchOperator" : { - "type" : "string" - }, - "associationTypeId" : { - "type" : "integer", - "format" : "int32" - }, - "associationCategory" : { - "type" : "string" - }, - "filters" : { - "type" : "array", - "items" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicPropertyFilter" - }, { - "$ref" : "#/components/schemas/PublicAssociationInListFilter" - }, { - "$ref" : "#/components/schemas/PublicPageViewAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicCtaAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicEventAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicFormSubmissionFilter" - }, { - "$ref" : "#/components/schemas/PublicFormSubmissionOnPageFilter" - }, { - "$ref" : "#/components/schemas/PublicIntegrationEventFilter" - }, { - "$ref" : "#/components/schemas/PublicEmailSubscriptionFilter" - }, { - "$ref" : "#/components/schemas/PublicCommunicationSubscriptionFilter" - }, { - "$ref" : "#/components/schemas/PublicCampaignInfluencedFilter" - }, { - "$ref" : "#/components/schemas/PublicSurveyMonkeyFilter" - }, { - "$ref" : "#/components/schemas/PublicSurveyMonkeyValueFilter" - }, { - "$ref" : "#/components/schemas/PublicWebinarFilter" - }, { - "$ref" : "#/components/schemas/PublicEmailEventFilter" - }, { - "$ref" : "#/components/schemas/PublicPrivacyAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicAdsSearchFilter" - }, { - "$ref" : "#/components/schemas/PublicAdsTimeFilter" - }, { - "$ref" : "#/components/schemas/PublicInListFilter" - }, { - "$ref" : "#/components/schemas/PublicNumAssociationsFilter" - }, { - "$ref" : "#/components/schemas/PublicUnifiedEventsFilter" - }, { - "$ref" : "#/components/schemas/PublicPropertyAssociationInListFilter" - }, { - "$ref" : "#/components/schemas/PublicConstantFilter" - } ] - } - }, - "operator" : { - "type" : "string" - } - } - }, - "PublicQuarterReference" : { - "title" : "QUARTER", - "required" : [ "day", "month", "referenceType" ], - "type" : "object", - "properties" : { - "hour" : { - "type" : "integer", - "format" : "int32" - }, - "month" : { - "type" : "integer", - "format" : "int32" - }, - "millisecond" : { - "type" : "integer", - "format" : "int32" - }, - "referenceType" : { - "type" : "string", - "default" : "QUARTER", - "enum" : [ "QUARTER" ] - }, - "day" : { - "type" : "integer", - "format" : "int32" - }, - "minute" : { - "type" : "integer", - "format" : "int32" - }, - "second" : { - "type" : "integer", - "format" : "int32" - } - } - }, - "PublicEmailSubscriptionFilter" : { - "title" : "EMAIL_SUBSCRIPTION", - "required" : [ "acceptedStatuses", "filterType", "subscriptionIds" ], - "type" : "object", - "properties" : { - "subscriptionType" : { - "type" : "string" - }, - "subscriptionIds" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "filterType" : { - "type" : "string", - "default" : "EMAIL_SUBSCRIPTION", - "enum" : [ "EMAIL_SUBSCRIPTION" ] - }, - "acceptedStatuses" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - } - }, - "PublicEnumerationPropertyOperation" : { - "title" : "ENUMERATION", - "required" : [ "includeObjectsWithNoValueSet", "operationType", "operator", "values" ], - "type" : "object", - "properties" : { - "includeObjectsWithNoValueSet" : { - "type" : "boolean" - }, - "values" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "operationType" : { - "type" : "string", - "default" : "ENUMERATION", - "enum" : [ "ENUMERATION" ] - }, - "operator" : { - "type" : "string" - } - } - }, - "ListFolderCreateResponse" : { - "required" : [ "folder" ], - "type" : "object", - "properties" : { - "folder" : { - "$ref" : "#/components/schemas/PublicListFolder" - } - } - }, - "PublicTimePointOperation" : { - "title" : "TIME_POINT", - "required" : [ "includeObjectsWithNoValueSet", "operationType", "operator", "timePoint", "type" ], - "type" : "object", - "properties" : { - "endpointBehavior" : { - "type" : "string" - }, - "includeObjectsWithNoValueSet" : { - "type" : "boolean" - }, - "propertyParser" : { - "type" : "string" - }, - "operationType" : { - "type" : "string", - "default" : "TIME_POINT", - "enum" : [ "TIME_POINT" ] - }, - "timePoint" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicDatePoint" - }, { - "$ref" : "#/components/schemas/PublicIndexedTimePoint" - }, { - "$ref" : "#/components/schemas/PublicPropertyReferencedTime" - } ] - }, - "type" : { - "type" : "string" - }, - "operator" : { - "type" : "string" - } - } - }, - "ListUpdateResponse" : { - "type" : "object", - "properties" : { - "updatedList" : { - "$ref" : "#/components/schemas/PublicObjectList" - } - } - }, - "PublicAllHistoryRefineBy" : { - "title" : "ALL_HISTORY", - "required" : [ "type" ], - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "default" : "ALL_HISTORY", - "enum" : [ "ALL_HISTORY" ] - } - } - }, - "PublicNotAnyFilterBranch" : { - "title" : "NOT_ANY", - "required" : [ "filterBranchOperator", "filterBranchType", "filterBranches", "filters" ], - "type" : "object", - "properties" : { - "filterBranchType" : { - "type" : "string", - "default" : "NOT_ANY", - "enum" : [ "NOT_ANY" ] - }, - "filterBranches" : { - "type" : "array", - "items" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicOrFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicAndFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicNotAllFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicNotAnyFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicRestrictedFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicUnifiedEventsFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicPropertyAssociationFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicAssociationFilterBranch" - } ] - } - }, - "filterBranchOperator" : { - "type" : "string" - }, - "filters" : { - "type" : "array", - "items" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicPropertyFilter" - }, { - "$ref" : "#/components/schemas/PublicAssociationInListFilter" - }, { - "$ref" : "#/components/schemas/PublicPageViewAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicCtaAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicEventAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicFormSubmissionFilter" - }, { - "$ref" : "#/components/schemas/PublicFormSubmissionOnPageFilter" - }, { - "$ref" : "#/components/schemas/PublicIntegrationEventFilter" - }, { - "$ref" : "#/components/schemas/PublicEmailSubscriptionFilter" - }, { - "$ref" : "#/components/schemas/PublicCommunicationSubscriptionFilter" - }, { - "$ref" : "#/components/schemas/PublicCampaignInfluencedFilter" - }, { - "$ref" : "#/components/schemas/PublicSurveyMonkeyFilter" - }, { - "$ref" : "#/components/schemas/PublicSurveyMonkeyValueFilter" - }, { - "$ref" : "#/components/schemas/PublicWebinarFilter" - }, { - "$ref" : "#/components/schemas/PublicEmailEventFilter" - }, { - "$ref" : "#/components/schemas/PublicPrivacyAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicAdsSearchFilter" - }, { - "$ref" : "#/components/schemas/PublicAdsTimeFilter" - }, { - "$ref" : "#/components/schemas/PublicInListFilter" - }, { - "$ref" : "#/components/schemas/PublicNumAssociationsFilter" - }, { - "$ref" : "#/components/schemas/PublicUnifiedEventsFilter" - }, { - "$ref" : "#/components/schemas/PublicPropertyAssociationInListFilter" - }, { - "$ref" : "#/components/schemas/PublicConstantFilter" - } ] - } - } - } - }, - "PublicIndexedTimePoint" : { - "title" : "INDEXED", - "required" : [ "indexReference", "timeType", "zoneId" ], - "type" : "object", - "properties" : { - "offset" : { - "$ref" : "#/components/schemas/PublicIndexOffset" - }, - "timezoneSource" : { - "type" : "string" - }, - "indexReference" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicNowReference" - }, { - "$ref" : "#/components/schemas/PublicTodayReference" - }, { - "$ref" : "#/components/schemas/PublicWeekReference" - }, { - "$ref" : "#/components/schemas/PublicFiscalQuarterReference" - }, { - "$ref" : "#/components/schemas/PublicFiscalYearReference" - }, { - "$ref" : "#/components/schemas/PublicYearReference" - }, { - "$ref" : "#/components/schemas/PublicQuarterReference" - }, { - "$ref" : "#/components/schemas/PublicMonthReference" - } ] - }, - "timeType" : { - "type" : "string", - "default" : "INDEXED", - "enum" : [ "INDEXED" ] - }, - "zoneId" : { - "type" : "string" - } - } - }, - "PublicRangedTimeOperation" : { - "title" : "TIME_RANGED", - "required" : [ "includeObjectsWithNoValueSet", "lowerBoundTimePoint", "operationType", "operator", "type", "upperBoundTimePoint" ], - "type" : "object", - "properties" : { - "upperBoundEndpointBehavior" : { - "type" : "string" - }, - "includeObjectsWithNoValueSet" : { - "type" : "boolean" - }, - "upperBoundTimePoint" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicDatePoint" - }, { - "$ref" : "#/components/schemas/PublicIndexedTimePoint" - }, { - "$ref" : "#/components/schemas/PublicPropertyReferencedTime" - } ] - }, - "propertyParser" : { - "type" : "string" - }, - "operationType" : { - "type" : "string" - }, - "type" : { - "type" : "string", - "default" : "TIME_RANGED", - "enum" : [ "TIME_RANGED" ] - }, - "lowerBoundEndpointBehavior" : { - "type" : "string" - }, - "operator" : { - "type" : "string" - }, - "lowerBoundTimePoint" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicDatePoint" - }, { - "$ref" : "#/components/schemas/PublicIndexedTimePoint" - }, { - "$ref" : "#/components/schemas/PublicPropertyReferencedTime" - } ] - } - } - }, - "PublicWebinarFilter" : { - "title" : "WEBINAR", - "required" : [ "filterType", "operator" ], - "type" : "object", - "properties" : { - "webinarId" : { - "type" : "string" - }, - "filterType" : { - "type" : "string", - "default" : "WEBINAR", - "enum" : [ "WEBINAR" ] - }, - "operator" : { - "type" : "string" - } - } - }, - "ListCreateResponse" : { - "required" : [ "list" ], - "type" : "object", - "properties" : { - "list" : { - "$ref" : "#/components/schemas/PublicObjectList" - } - } - }, - "MembershipsUpdateResponse" : { - "type" : "object", - "properties" : { - "recordIdsRemoved" : { - "type" : "array", - "description" : "The IDs of the records that were `removed` from the list.", - "items" : { - "type" : "string" - } - }, - "recordsIdsAdded" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "recordIdsMissing" : { - "type" : "array", - "description" : "The IDs of the records that were `missing` (e.g. did not exist in the portal) and so were not `added` or `removed`.", - "items" : { - "type" : "string" - } - } - } - }, - "PublicUnifiedEventsFilterBranch" : { - "title" : "UNIFIED_EVENTS", - "required" : [ "eventTypeId", "filterBranchOperator", "filterBranchType", "filterBranches", "filters", "operator" ], - "type" : "object", - "properties" : { - "filterBranchType" : { - "type" : "string", - "default" : "UNIFIED_EVENTS", - "enum" : [ "UNIFIED_EVENTS" ] - }, - "filterBranches" : { - "type" : "array", - "items" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicOrFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicAndFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicNotAllFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicNotAnyFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicRestrictedFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicUnifiedEventsFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicPropertyAssociationFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicAssociationFilterBranch" - } ] - } - }, - "eventTypeId" : { - "type" : "string" - }, - "coalescingRefineBy" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicNumOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicSetOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAllHistoryRefineBy" - }, { - "$ref" : "#/components/schemas/PublicTimePointOperation" - }, { - "$ref" : "#/components/schemas/PublicRangedTimeOperation" - } ] - }, - "filterBranchOperator" : { - "type" : "string" - }, - "filters" : { - "type" : "array", - "items" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicPropertyFilter" - }, { - "$ref" : "#/components/schemas/PublicAssociationInListFilter" - }, { - "$ref" : "#/components/schemas/PublicPageViewAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicCtaAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicEventAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicFormSubmissionFilter" - }, { - "$ref" : "#/components/schemas/PublicFormSubmissionOnPageFilter" - }, { - "$ref" : "#/components/schemas/PublicIntegrationEventFilter" - }, { - "$ref" : "#/components/schemas/PublicEmailSubscriptionFilter" - }, { - "$ref" : "#/components/schemas/PublicCommunicationSubscriptionFilter" - }, { - "$ref" : "#/components/schemas/PublicCampaignInfluencedFilter" - }, { - "$ref" : "#/components/schemas/PublicSurveyMonkeyFilter" - }, { - "$ref" : "#/components/schemas/PublicSurveyMonkeyValueFilter" - }, { - "$ref" : "#/components/schemas/PublicWebinarFilter" - }, { - "$ref" : "#/components/schemas/PublicEmailEventFilter" - }, { - "$ref" : "#/components/schemas/PublicPrivacyAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicAdsSearchFilter" - }, { - "$ref" : "#/components/schemas/PublicAdsTimeFilter" - }, { - "$ref" : "#/components/schemas/PublicInListFilter" - }, { - "$ref" : "#/components/schemas/PublicNumAssociationsFilter" - }, { - "$ref" : "#/components/schemas/PublicUnifiedEventsFilter" - }, { - "$ref" : "#/components/schemas/PublicPropertyAssociationInListFilter" - }, { - "$ref" : "#/components/schemas/PublicConstantFilter" - } ] - } - }, - "operator" : { - "type" : "string", - "enum" : [ "HAS_COMPLETED", "HAS_NOT_COMPLETED" ] - } - } - }, - "PublicNumOccurrencesRefineBy" : { - "title" : "NUM_OCCURRENCES", - "required" : [ "type" ], - "type" : "object", - "properties" : { - "maxOccurrences" : { - "type" : "integer", - "format" : "int32" - }, - "type" : { - "type" : "string", - "default" : "NUM_OCCURRENCES", - "enum" : [ "NUM_OCCURRENCES" ] - }, - "minOccurrences" : { - "type" : "integer", - "format" : "int32" - } - } - }, - "PublicObjectList" : { - "required" : [ "listId", "listVersion", "name", "objectTypeId", "processingStatus", "processingType" ], - "type" : "object", - "properties" : { - "processingType" : { - "type" : "string", - "description" : "The processing type of the list." - }, - "objectTypeId" : { - "type" : "string", - "description" : "The object type of the list." - }, - "updatedById" : { - "type" : "string", - "description" : "The ID of the user that last updated the list." - }, - "filtersUpdatedAt" : { - "type" : "string", - "description" : "The time when the filters for this list were last updated.", - "format" : "datetime" - }, - "listId" : { - "type" : "string", - "description" : "The **ILS ID** of the list." - }, - "createdAt" : { - "type" : "string", - "description" : "The time when the list was created.", - "format" : "datetime" - }, - "processingStatus" : { - "type" : "string", - "description" : "The processing status of the list." - }, - "deletedAt" : { - "type" : "string", - "description" : "The time when the list was deleted.", - "format" : "datetime" - }, - "listVersion" : { - "type" : "integer", - "description" : "The version of the list.", - "format" : "int32" - }, - "size" : { - "type" : "integer", - "format" : "int64" - }, - "name" : { - "type" : "string", - "description" : "The name of the list." - }, - "createdById" : { - "type" : "string", - "description" : "The ID of the user that created the list." - }, - "filterBranch" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicOrFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicAndFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicNotAllFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicNotAnyFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicRestrictedFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicUnifiedEventsFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicPropertyAssociationFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicAssociationFilterBranch" - } ] - }, - "updatedAt" : { - "type" : "string", - "description" : "The time the list was last updated.", - "format" : "datetime" - } - } - }, - "RecordListMembership" : { - "required" : [ "firstAddedTimestamp", "lastAddedTimestamp", "listId", "listVersion" ], - "type" : "object", - "properties" : { - "listId" : { - "type" : "string" - }, - "listVersion" : { - "type" : "integer", - "format" : "int32" - }, - "lastAddedTimestamp" : { - "type" : "string", - "format" : "datetime" - }, - "firstAddedTimestamp" : { - "type" : "string", - "format" : "datetime" - } - } - }, - "PublicCtaAnalyticsFilter" : { - "title" : "CTA", - "required" : [ "ctaName", "filterType", "operator" ], - "type" : "object", - "properties" : { - "coalescingRefineBy" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicNumOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicSetOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAllHistoryRefineBy" - }, { - "$ref" : "#/components/schemas/PublicTimePointOperation" - }, { - "$ref" : "#/components/schemas/PublicRangedTimeOperation" - } ] - }, - "pruningRefineBy" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicNumOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicSetOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAllHistoryRefineBy" - }, { - "$ref" : "#/components/schemas/PublicTimePointOperation" - }, { - "$ref" : "#/components/schemas/PublicRangedTimeOperation" - } ] - }, - "filterType" : { - "type" : "string", - "default" : "CTA", - "enum" : [ "CTA" ] - }, - "ctaName" : { - "type" : "string" - }, - "operator" : { - "type" : "string" - } - } - }, - "ListFetchResponse" : { - "required" : [ "list" ], - "type" : "object", - "properties" : { - "list" : { - "$ref" : "#/components/schemas/PublicObjectList" - } - } - }, - "PublicConstantFilter" : { - "title" : "CONSTANT", - "required" : [ "filterType", "shouldAccept" ], - "type" : "object", - "properties" : { - "shouldAccept" : { - "type" : "boolean" - }, - "source" : { - "type" : "string" - }, - "filterType" : { - "type" : "string", - "default" : "CONSTANT", - "enum" : [ "CONSTANT" ] - } - } - }, - "PublicSetOccurrencesRefineBy" : { - "title" : "SET_OCCURRENCES", - "required" : [ "setType", "type" ], - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "default" : "SET_OCCURRENCES", - "enum" : [ "SET_OCCURRENCES" ] - }, - "setType" : { - "type" : "string" - } - } - }, - "PublicListFolder" : { - "required" : [ "childLists", "childNodes", "id", "parentFolderId" ], - "type" : "object", - "properties" : { - "createdAt" : { - "type" : "string", - "description" : "The time the folder was created at.", - "format" : "datetime" - }, - "parentFolderId" : { - "type" : "integer", - "description" : "The Id of the folder this folder is in, the root folder is represented as 0.", - "format" : "int32" - }, - "childNodes" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PublicListFolder" - } - }, - "name" : { - "type" : "string", - "description" : "The name of the folder." - }, - "id" : { - "type" : "integer", - "description" : "The Id of the folder.", - "format" : "int32" - }, - "childLists" : { - "type" : "array", - "description" : "An array of list Id's contained in this folder.", - "items" : { - "type" : "integer", - "format" : "int32" - } - }, - "updatedContentsAt" : { - "type" : "string", - "description" : "The time that the contents of the folder was last updated at.", - "format" : "datetime" - }, - "userId" : { - "type" : "integer", - "description" : "The user Id of the owner of the folder.", - "format" : "int32" - }, - "updatedAt" : { - "type" : "string", - "description" : "The time the folder was last updated at.", - "format" : "datetime" - } - } - }, - "ApiCollectionResponseRecordListMembershipNoPaging" : { - "required" : [ "results" ], - "type" : "object", - "properties" : { - "total" : { - "type" : "integer", - "format" : "int64" - }, - "results" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/RecordListMembership" - } - } - } - }, - "PublicComparativeDatePropertyOperation" : { - "title" : "COMPARATIVE_DATE", - "required" : [ "comparisonPropertyName", "includeObjectsWithNoValueSet", "operationType", "operator" ], - "type" : "object", - "properties" : { - "includeObjectsWithNoValueSet" : { - "type" : "boolean" - }, - "defaultComparisonValue" : { - "type" : "string" - }, - "operationType" : { - "type" : "string", - "default" : "COMPARATIVE_DATE", - "enum" : [ "COMPARATIVE_DATE" ] - }, - "comparisonPropertyName" : { - "type" : "string" - }, - "operator" : { - "type" : "string" - } - } - }, - "PublicRangedNumberPropertyOperation" : { - "title" : "NUMBER_RANGED", - "required" : [ "includeObjectsWithNoValueSet", "lowerBound", "operationType", "operator", "upperBound" ], - "type" : "object", - "properties" : { - "includeObjectsWithNoValueSet" : { - "type" : "boolean" - }, - "upperBound" : { - "type" : "integer", - "format" : "int32" - }, - "operationType" : { - "type" : "string", - "default" : "NUMBER_RANGED", - "enum" : [ "NUMBER_RANGED" ] - }, - "lowerBound" : { - "type" : "integer", - "format" : "int32" - }, - "operator" : { - "type" : "string" - } - } - }, - "PublicPageViewAnalyticsFilter" : { - "title" : "PAGE_VIEW", - "required" : [ "filterType", "operator", "pageUrl" ], - "type" : "object", - "properties" : { - "coalescingRefineBy" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicNumOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicSetOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAllHistoryRefineBy" - }, { - "$ref" : "#/components/schemas/PublicTimePointOperation" - }, { - "$ref" : "#/components/schemas/PublicRangedTimeOperation" - } ] - }, - "enableTracking" : { - "type" : "boolean" - }, - "pruningRefineBy" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicNumOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicSetOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAllHistoryRefineBy" - }, { - "$ref" : "#/components/schemas/PublicTimePointOperation" - }, { - "$ref" : "#/components/schemas/PublicRangedTimeOperation" - } ] - }, - "pageUrl" : { - "type" : "string" - }, - "filterType" : { - "type" : "string", - "default" : "PAGE_VIEW", - "enum" : [ "PAGE_VIEW" ] - }, - "operator" : { - "type" : "string" - } - } - }, - "MembershipChangeRequest" : { - "required" : [ "recordIdsToAdd", "recordIdsToRemove" ], - "type" : "object", - "properties" : { - "recordIdsToRemove" : { - "type" : "array", - "description" : "", - "example" : [ 654 ], - "items" : { - "type" : "string" - } - }, - "recordIdsToAdd" : { - "type" : "array", - "description" : "", - "example" : [ 123, 456, 789 ], - "items" : { - "type" : "string" - } - } - } - }, - "PublicComparativePropertyUpdatedOperation" : { - "title" : "COMPARATIVE_PROPERTY_UPDATED", - "required" : [ "comparisonPropertyName", "includeObjectsWithNoValueSet", "operationType", "operator" ], - "type" : "object", - "properties" : { - "includeObjectsWithNoValueSet" : { - "type" : "boolean" - }, - "defaultComparisonValue" : { - "type" : "string" - }, - "operationType" : { - "type" : "string", - "default" : "COMPARATIVE_PROPERTY_UPDATED", - "enum" : [ "COMPARATIVE_PROPERTY_UPDATED" ] - }, - "comparisonPropertyName" : { - "type" : "string" - }, - "operator" : { - "type" : "string" - } - } - }, - "PreviousPage" : { - "required" : [ "before" ], - "type" : "object", - "properties" : { - "before" : { - "type" : "string", - "description" : "The offset of the previous page of records." - }, - "link" : { - "type" : "string", - "description" : "A direct link to the request for the previous page of records." - } - } - }, - "PublicAndFilterBranch" : { - "title" : "AND", - "required" : [ "filterBranchOperator", "filterBranchType", "filterBranches", "filters" ], - "type" : "object", - "properties" : { - "filterBranchType" : { - "type" : "string", - "default" : "AND", - "enum" : [ "AND" ] - }, - "filterBranches" : { - "type" : "array", - "items" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicOrFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicAndFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicNotAllFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicNotAnyFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicRestrictedFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicUnifiedEventsFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicPropertyAssociationFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicAssociationFilterBranch" - } ] - } - }, - "filterBranchOperator" : { - "type" : "string" - }, - "filters" : { - "type" : "array", - "items" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicPropertyFilter" - }, { - "$ref" : "#/components/schemas/PublicAssociationInListFilter" - }, { - "$ref" : "#/components/schemas/PublicPageViewAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicCtaAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicEventAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicFormSubmissionFilter" - }, { - "$ref" : "#/components/schemas/PublicFormSubmissionOnPageFilter" - }, { - "$ref" : "#/components/schemas/PublicIntegrationEventFilter" - }, { - "$ref" : "#/components/schemas/PublicEmailSubscriptionFilter" - }, { - "$ref" : "#/components/schemas/PublicCommunicationSubscriptionFilter" - }, { - "$ref" : "#/components/schemas/PublicCampaignInfluencedFilter" - }, { - "$ref" : "#/components/schemas/PublicSurveyMonkeyFilter" - }, { - "$ref" : "#/components/schemas/PublicSurveyMonkeyValueFilter" - }, { - "$ref" : "#/components/schemas/PublicWebinarFilter" - }, { - "$ref" : "#/components/schemas/PublicEmailEventFilter" - }, { - "$ref" : "#/components/schemas/PublicPrivacyAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicAdsSearchFilter" - }, { - "$ref" : "#/components/schemas/PublicAdsTimeFilter" - }, { - "$ref" : "#/components/schemas/PublicInListFilter" - }, { - "$ref" : "#/components/schemas/PublicNumAssociationsFilter" - }, { - "$ref" : "#/components/schemas/PublicUnifiedEventsFilter" - }, { - "$ref" : "#/components/schemas/PublicPropertyAssociationInListFilter" - }, { - "$ref" : "#/components/schemas/PublicConstantFilter" - } ] - } - } - } - }, - "PublicIntegrationEventFilter" : { - "title" : "INTEGRATION_EVENT", - "required" : [ "eventTypeId", "filterLines", "filterType" ], - "type" : "object", - "properties" : { - "eventTypeId" : { - "type" : "integer", - "format" : "int32" - }, - "filterLines" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PublicEventFilterMetadata" - } - }, - "filterType" : { - "type" : "string", - "default" : "INTEGRATION_EVENT", - "enum" : [ "INTEGRATION_EVENT" ] - } - } - }, - "PublicAbsoluteComparativeTimestampRefineBy" : { - "title" : "ABSOLUTE_COMPARATIVE", - "required" : [ "comparison", "timestamp", "type" ], - "type" : "object", - "properties" : { - "comparison" : { - "type" : "string" - }, - "type" : { - "type" : "string", - "default" : "ABSOLUTE_COMPARATIVE", - "enum" : [ "ABSOLUTE_COMPARATIVE" ] - }, - "timestamp" : { - "type" : "integer", - "format" : "int64" - } - } - }, - "PublicSurveyMonkeyFilter" : { - "title" : "SURVEY_MONKEY", - "required" : [ "filterType", "operator", "surveyId" ], - "type" : "object", - "properties" : { - "surveyId" : { - "type" : "string" - }, - "filterType" : { - "type" : "string", - "default" : "SURVEY_MONKEY", - "enum" : [ "SURVEY_MONKEY" ] - }, - "operator" : { - "type" : "string" - } - } - }, - "PublicAbsoluteRangedTimestampRefineBy" : { - "title" : "ABSOLUTE_RANGED", - "required" : [ "lowerTimestamp", "rangeType", "type", "upperTimestamp" ], - "type" : "object", - "properties" : { - "rangeType" : { - "type" : "string" - }, - "upperTimestamp" : { - "type" : "integer", - "format" : "int64" - }, - "lowerTimestamp" : { - "type" : "integer", - "format" : "int64" - }, - "type" : { - "type" : "string", - "default" : "ABSOLUTE_RANGED", - "enum" : [ "ABSOLUTE_RANGED" ] - } - } - }, - "PublicDatePropertyOperation" : { - "title" : "DATE", - "required" : [ "day", "includeObjectsWithNoValueSet", "month", "operationType", "operator", "year" ], - "type" : "object", - "properties" : { - "includeObjectsWithNoValueSet" : { - "type" : "boolean" - }, - "month" : { - "type" : "string" - }, - "year" : { - "type" : "integer", - "format" : "int32" - }, - "operationType" : { - "type" : "string", - "default" : "DATE", - "enum" : [ "DATE" ] - }, - "day" : { - "type" : "integer", - "format" : "int32" - }, - "operator" : { - "type" : "string" - } - } - }, - "PublicEventAnalyticsFilter" : { - "title" : "EVENT", - "required" : [ "eventId", "filterType", "operator" ], - "type" : "object", - "properties" : { - "eventId" : { - "type" : "string" - }, - "coalescingRefineBy" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicNumOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicSetOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAllHistoryRefineBy" - }, { - "$ref" : "#/components/schemas/PublicTimePointOperation" - }, { - "$ref" : "#/components/schemas/PublicRangedTimeOperation" - } ] - }, - "pruningRefineBy" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicNumOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicSetOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAllHistoryRefineBy" - }, { - "$ref" : "#/components/schemas/PublicTimePointOperation" - }, { - "$ref" : "#/components/schemas/PublicRangedTimeOperation" - } ] - }, - "filterType" : { - "type" : "string", - "default" : "EVENT", - "enum" : [ "EVENT" ] - }, - "operator" : { - "type" : "string" - } - } - }, - "PublicUnifiedEventsFilter" : { - "title" : "UNIFIED_EVENTS", - "required" : [ "filterLines", "filterType" ], - "type" : "object", - "properties" : { - "coalescingRefineBy" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicNumOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicSetOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAllHistoryRefineBy" - }, { - "$ref" : "#/components/schemas/PublicTimePointOperation" - }, { - "$ref" : "#/components/schemas/PublicRangedTimeOperation" - } ] - }, - "eventTypeId" : { - "type" : "string" - }, - "filterLines" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PublicEventFilterMetadata" - } - }, - "pruningRefineBy" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicNumOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicSetOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAllHistoryRefineBy" - }, { - "$ref" : "#/components/schemas/PublicTimePointOperation" - }, { - "$ref" : "#/components/schemas/PublicRangedTimeOperation" - } ] - }, - "filterType" : { - "type" : "string", - "default" : "UNIFIED_EVENTS", - "enum" : [ "UNIFIED_EVENTS" ] - } - } - }, - "PublicFiscalYearReference" : { - "title" : "FISCAL_YEAR", - "required" : [ "day", "month", "referenceType" ], - "type" : "object", - "properties" : { - "hour" : { - "type" : "integer", - "format" : "int32" - }, - "month" : { - "type" : "integer", - "format" : "int32" - }, - "millisecond" : { - "type" : "integer", - "format" : "int32" - }, - "referenceType" : { - "type" : "string", - "default" : "FISCAL_YEAR", - "enum" : [ "FISCAL_YEAR" ] - }, - "day" : { - "type" : "integer", - "format" : "int32" - }, - "minute" : { - "type" : "integer", - "format" : "int32" - }, - "second" : { - "type" : "integer", - "format" : "int32" - } - } - }, - "PublicCalendarDatePropertyOperation" : { - "title" : "CALENDAR_DATE", - "required" : [ "includeObjectsWithNoValueSet", "operationType", "operator", "timeUnit" ], - "type" : "object", - "properties" : { - "useFiscalYear" : { - "type" : "boolean" - }, - "fiscalYearStart" : { - "type" : "string", - "enum" : [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ] - }, - "includeObjectsWithNoValueSet" : { - "type" : "boolean" - }, - "operationType" : { - "type" : "string", - "default" : "CALENDAR_DATE", - "enum" : [ "CALENDAR_DATE" ] - }, - "timeUnitCount" : { - "type" : "integer", - "format" : "int32" - }, - "operator" : { - "type" : "string" - }, - "timeUnit" : { - "type" : "string" - } - } - }, - "PublicPropertyFilter" : { - "title" : "PROPERTY", - "required" : [ "filterType", "operation", "property" ], - "type" : "object", - "properties" : { - "property" : { - "type" : "string" - }, - "filterType" : { - "type" : "string", - "default" : "PROPERTY", - "enum" : [ "PROPERTY" ] - }, - "operation" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicBoolPropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicNumberPropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicStringPropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicDateTimePropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicRangedDatePropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicComparativePropertyUpdatedOperation" - }, { - "$ref" : "#/components/schemas/PublicComparativeDatePropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicRollingDateRangePropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicRollingPropertyUpdatedOperation" - }, { - "$ref" : "#/components/schemas/PublicEnumerationPropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicAllPropertyTypesOperation" - }, { - "$ref" : "#/components/schemas/PublicRangedNumberPropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicMultiStringPropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicDatePropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicCalendarDatePropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicTimePointOperation" - }, { - "$ref" : "#/components/schemas/PublicRangedTimeOperation" - } ] - } - } - }, - "ErrorDetail" : { - "required" : [ "message" ], - "type" : "object", - "properties" : { - "subCategory" : { - "type" : "string", - "description" : "A specific category that contains more specific detail about the error" - }, - "code" : { - "type" : "string", - "description" : "The status code associated with the error detail" - }, - "in" : { - "type" : "string", - "description" : "The name of the field or parameter in which the error was found." - }, - "context" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "description" : "Context about the error condition", - "example" : { - "missingScopes" : [ "scope1", "scope2" ] - } - }, - "message" : { - "type" : "string", - "description" : "A human readable message describing the error along with remediation steps where appropriate" - } - } - }, - "PublicNumAssociationsFilter" : { - "title" : "NUM_ASSOCIATIONS", - "required" : [ "associationCategory", "associationTypeId", "coalescingRefineBy", "filterType" ], - "type" : "object", - "properties" : { - "coalescingRefineBy" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicNumOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicSetOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAllHistoryRefineBy" - }, { - "$ref" : "#/components/schemas/PublicTimePointOperation" - }, { - "$ref" : "#/components/schemas/PublicRangedTimeOperation" - } ] - }, - "associationTypeId" : { - "type" : "integer", - "format" : "int32" - }, - "associationCategory" : { - "type" : "string" - }, - "filterType" : { - "type" : "string", - "default" : "NUM_ASSOCIATIONS", - "enum" : [ "NUM_ASSOCIATIONS" ] - } - } - }, - "PublicAssociationInListFilter" : { - "title" : "ASSOCIATION", - "required" : [ "associationCategory", "associationTypeId", "coalescingRefineBy", "filterType", "listId", "operator" ], - "type" : "object", - "properties" : { - "listId" : { - "type" : "string" - }, - "coalescingRefineBy" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicNumOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicSetOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAllHistoryRefineBy" - }, { - "$ref" : "#/components/schemas/PublicTimePointOperation" - }, { - "$ref" : "#/components/schemas/PublicRangedTimeOperation" - } ] - }, - "toObjectType" : { - "type" : "string" - }, - "associationTypeId" : { - "type" : "integer", - "format" : "int32" - }, - "associationCategory" : { - "type" : "string" - }, - "filterType" : { - "type" : "string", - "default" : "ASSOCIATION", - "enum" : [ "ASSOCIATION" ] - }, - "toObjectTypeId" : { - "type" : "string" - }, - "operator" : { - "type" : "string" - } - } - }, - "PublicEmailEventFilter" : { - "title" : "EMAIL_EVENT", - "required" : [ "appId", "emailId", "filterType", "level", "operator" ], - "type" : "object", - "properties" : { - "clickUrl" : { - "type" : "string" - }, - "level" : { - "type" : "string" - }, - "pruningRefineBy" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicNumOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicSetOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAllHistoryRefineBy" - }, { - "$ref" : "#/components/schemas/PublicTimePointOperation" - }, { - "$ref" : "#/components/schemas/PublicRangedTimeOperation" - } ] - }, - "appId" : { - "type" : "string" - }, - "emailId" : { - "type" : "string" - }, - "filterType" : { - "type" : "string", - "default" : "EMAIL_EVENT", - "enum" : [ "EMAIL_EVENT" ] - }, - "operator" : { - "type" : "string", - "enum" : [ "LINK_CLICKED", "MARKED_SPAM", "OPENED", "OPENED_BUT_LINK_NOT_CLICKED", "OPENED_BUT_NOT_REPLIED", "REPLIED", "UNSUBSCRIBED", "BOUNCED", "RECEIVED", "RECEIVED_BUT_NOT_OPENED", "SENT", "SENT_BUT_LINK_NOT_CLICKED", "SENT_BUT_NOT_RECEIVED" ] - } - } - }, - "PublicOrFilterBranch" : { - "title" : "OR", - "required" : [ "filterBranchOperator", "filterBranchType", "filterBranches", "filters" ], - "type" : "object", - "properties" : { - "filterBranchType" : { - "type" : "string", - "default" : "OR", - "enum" : [ "OR" ] - }, - "filterBranches" : { - "type" : "array", - "items" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicOrFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicAndFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicNotAllFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicNotAnyFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicRestrictedFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicUnifiedEventsFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicPropertyAssociationFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicAssociationFilterBranch" - } ] - } - }, - "filterBranchOperator" : { - "type" : "string" - }, - "filters" : { - "type" : "array", - "items" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicPropertyFilter" - }, { - "$ref" : "#/components/schemas/PublicAssociationInListFilter" - }, { - "$ref" : "#/components/schemas/PublicPageViewAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicCtaAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicEventAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicFormSubmissionFilter" - }, { - "$ref" : "#/components/schemas/PublicFormSubmissionOnPageFilter" - }, { - "$ref" : "#/components/schemas/PublicIntegrationEventFilter" - }, { - "$ref" : "#/components/schemas/PublicEmailSubscriptionFilter" - }, { - "$ref" : "#/components/schemas/PublicCommunicationSubscriptionFilter" - }, { - "$ref" : "#/components/schemas/PublicCampaignInfluencedFilter" - }, { - "$ref" : "#/components/schemas/PublicSurveyMonkeyFilter" - }, { - "$ref" : "#/components/schemas/PublicSurveyMonkeyValueFilter" - }, { - "$ref" : "#/components/schemas/PublicWebinarFilter" - }, { - "$ref" : "#/components/schemas/PublicEmailEventFilter" - }, { - "$ref" : "#/components/schemas/PublicPrivacyAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicAdsSearchFilter" - }, { - "$ref" : "#/components/schemas/PublicAdsTimeFilter" - }, { - "$ref" : "#/components/schemas/PublicInListFilter" - }, { - "$ref" : "#/components/schemas/PublicNumAssociationsFilter" - }, { - "$ref" : "#/components/schemas/PublicUnifiedEventsFilter" - }, { - "$ref" : "#/components/schemas/PublicPropertyAssociationInListFilter" - }, { - "$ref" : "#/components/schemas/PublicConstantFilter" - } ] - } - } - } - }, - "PublicAdsTimeFilter" : { - "title" : "ADS_TIME", - "required" : [ "filterType", "pruningRefineBy" ], - "type" : "object", - "properties" : { - "pruningRefineBy" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicNumOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicSetOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAllHistoryRefineBy" - }, { - "$ref" : "#/components/schemas/PublicTimePointOperation" - }, { - "$ref" : "#/components/schemas/PublicRangedTimeOperation" - } ] - }, - "filterType" : { - "type" : "string", - "default" : "ADS_TIME", - "enum" : [ "ADS_TIME" ] - } - } - }, - "PublicFormSubmissionOnPageFilter" : { - "title" : "FORM_SUBMISSION_ON_PAGE", - "required" : [ "filterType", "operator", "pageId" ], - "type" : "object", - "properties" : { - "formId" : { - "type" : "string" - }, - "coalescingRefineBy" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicNumOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicSetOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAllHistoryRefineBy" - }, { - "$ref" : "#/components/schemas/PublicTimePointOperation" - }, { - "$ref" : "#/components/schemas/PublicRangedTimeOperation" - } ] - }, - "pruningRefineBy" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicNumOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicSetOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAllHistoryRefineBy" - }, { - "$ref" : "#/components/schemas/PublicTimePointOperation" - }, { - "$ref" : "#/components/schemas/PublicRangedTimeOperation" - } ] - }, - "filterType" : { - "type" : "string", - "default" : "FORM_SUBMISSION_ON_PAGE", - "enum" : [ "FORM_SUBMISSION_ON_PAGE" ] - }, - "pageId" : { - "type" : "string" - }, - "operator" : { - "type" : "string", - "enum" : [ "FILLED_OUT", "NOT_FILLED_OUT" ] - } - } - }, - "PublicPropertyAssociationInListFilter" : { - "title" : "PROPERTY_ASSOCIATION", - "required" : [ "coalescingRefineBy", "filterType", "listId", "operator", "propertyWithObjectId" ], - "type" : "object", - "properties" : { - "listId" : { - "type" : "string" - }, - "coalescingRefineBy" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicNumOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicSetOccurrencesRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicRelativeRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAbsoluteRangedTimestampRefineBy" - }, { - "$ref" : "#/components/schemas/PublicAllHistoryRefineBy" - }, { - "$ref" : "#/components/schemas/PublicTimePointOperation" - }, { - "$ref" : "#/components/schemas/PublicRangedTimeOperation" - } ] - }, - "propertyWithObjectId" : { - "type" : "string" - }, - "filterType" : { - "type" : "string", - "default" : "PROPERTY_ASSOCIATION", - "enum" : [ "PROPERTY_ASSOCIATION" ] - }, - "toObjectTypeId" : { - "type" : "string" - }, - "operator" : { - "type" : "string" - } - } - }, - "PublicStringPropertyOperation" : { - "title" : "STRING", - "required" : [ "includeObjectsWithNoValueSet", "operationType", "operator", "value" ], - "type" : "object", - "properties" : { - "includeObjectsWithNoValueSet" : { - "type" : "boolean" - }, - "operationType" : { - "type" : "string", - "default" : "STRING", - "enum" : [ "STRING" ] - }, - "value" : { - "type" : "string" - }, - "operator" : { - "type" : "string" - } - } - }, - "PublicPropertyReferencedTime" : { - "title" : "PROPERTY_REFERENCED", - "required" : [ "property", "referenceType", "timeType", "zoneId" ], - "type" : "object", - "properties" : { - "timezoneSource" : { - "type" : "string" - }, - "property" : { - "type" : "string" - }, - "timeType" : { - "type" : "string", - "default" : "PROPERTY_REFERENCED", - "enum" : [ "PROPERTY_REFERENCED" ] - }, - "zoneId" : { - "type" : "string" - }, - "referenceType" : { - "type" : "string" - } - } - }, - "Paging" : { - "type" : "object", - "properties" : { - "next" : { - "$ref" : "#/components/schemas/NextPage" - }, - "prev" : { - "$ref" : "#/components/schemas/PreviousPage" - } - } - }, - "PublicPrivacyAnalyticsFilter" : { - "title" : "PRIVACY", - "required" : [ "filterType", "operator", "privacyName" ], - "type" : "object", - "properties" : { - "privacyName" : { - "type" : "string" - }, - "filterType" : { - "type" : "string", - "default" : "PRIVACY", - "enum" : [ "PRIVACY" ] - }, - "operator" : { - "type" : "string" - } - } - }, - "ListFilterUpdateRequest" : { - "required" : [ "filterBranch" ], - "type" : "object", - "properties" : { - "filterBranch" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicOrFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicAndFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicNotAllFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicNotAnyFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicRestrictedFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicUnifiedEventsFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicPropertyAssociationFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicAssociationFilterBranch" - } ] - } - } - }, - "PublicMultiStringPropertyOperation" : { - "title" : "MULTISTRING", - "required" : [ "includeObjectsWithNoValueSet", "operationType", "operator", "values" ], - "type" : "object", - "properties" : { - "includeObjectsWithNoValueSet" : { - "type" : "boolean" - }, - "values" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "operationType" : { - "type" : "string", - "default" : "MULTISTRING", - "enum" : [ "MULTISTRING" ] - }, - "operator" : { - "type" : "string" - } - } - }, - "PublicWeekReference" : { - "title" : "WEEK", - "required" : [ "dayOfWeek", "referenceType" ], - "type" : "object", - "properties" : { - "dayOfWeek" : { - "type" : "string", - "enum" : [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] - }, - "hour" : { - "type" : "integer", - "format" : "int32" - }, - "millisecond" : { - "type" : "integer", - "format" : "int32" - }, - "referenceType" : { - "type" : "string", - "default" : "WEEK", - "enum" : [ "WEEK" ] - }, - "minute" : { - "type" : "integer", - "format" : "int32" - }, - "second" : { - "type" : "integer", - "format" : "int32" - } - } - }, - "PublicAdsSearchFilter" : { - "title" : "ADS_SEARCH", - "required" : [ "adNetwork", "entityType", "filterType", "operator", "searchTermType", "searchTerms" ], - "type" : "object", - "properties" : { - "searchTerms" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "entityType" : { - "type" : "string" - }, - "adNetwork" : { - "type" : "string" - }, - "searchTermType" : { - "type" : "string" - }, - "filterType" : { - "type" : "string", - "default" : "ADS_SEARCH", - "enum" : [ "ADS_SEARCH" ] - }, - "operator" : { - "type" : "string" - } - } - }, - "PublicTodayReference" : { - "title" : "TODAY", - "required" : [ "referenceType" ], - "type" : "object", - "properties" : { - "hour" : { - "type" : "integer", - "format" : "int32" - }, - "millisecond" : { - "type" : "integer", - "format" : "int32" - }, - "referenceType" : { - "type" : "string", - "default" : "TODAY", - "enum" : [ "TODAY" ] - }, - "minute" : { - "type" : "integer", - "format" : "int32" - }, - "second" : { - "type" : "integer", - "format" : "int32" - } - } - }, - "PublicNowReference" : { - "title" : "NOW", - "required" : [ "referenceType" ], - "type" : "object", - "properties" : { - "hour" : { - "type" : "integer", - "format" : "int32" - }, - "millisecond" : { - "type" : "integer", - "format" : "int32" - }, - "referenceType" : { - "type" : "string", - "default" : "NOW", - "enum" : [ "NOW" ] - }, - "minute" : { - "type" : "integer", - "format" : "int32" - }, - "second" : { - "type" : "integer", - "format" : "int32" - } - } - }, - "ListFolderCreateRequest" : { - "required" : [ "name" ], - "type" : "object", - "properties" : { - "parentFolderId" : { - "type" : "string", - "description" : "The folder this should be created in, if not specified will be created in the root folder 0." - }, - "name" : { - "type" : "string", - "description" : "The name of the folder to be created." - } - } - }, - "JoinTimeAndRecordId" : { - "required" : [ "membershipTimestamp", "recordId" ], - "type" : "object", - "properties" : { - "recordId" : { - "type" : "string" - }, - "membershipTimestamp" : { - "type" : "string", - "format" : "datetime" - } - } - }, - "PublicRestrictedFilterBranch" : { - "title" : "RESTRICTED", - "required" : [ "filterBranchOperator", "filterBranchType", "filterBranches", "filters" ], - "type" : "object", - "properties" : { - "filterBranchType" : { - "type" : "string", - "default" : "RESTRICTED", - "enum" : [ "RESTRICTED" ] - }, - "filterBranches" : { - "type" : "array", - "items" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicOrFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicAndFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicNotAllFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicNotAnyFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicRestrictedFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicUnifiedEventsFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicPropertyAssociationFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicAssociationFilterBranch" - } ] - } - }, - "filterBranchOperator" : { - "type" : "string" - }, - "filters" : { - "type" : "array", - "items" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicPropertyFilter" - }, { - "$ref" : "#/components/schemas/PublicAssociationInListFilter" - }, { - "$ref" : "#/components/schemas/PublicPageViewAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicCtaAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicEventAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicFormSubmissionFilter" - }, { - "$ref" : "#/components/schemas/PublicFormSubmissionOnPageFilter" - }, { - "$ref" : "#/components/schemas/PublicIntegrationEventFilter" - }, { - "$ref" : "#/components/schemas/PublicEmailSubscriptionFilter" - }, { - "$ref" : "#/components/schemas/PublicCommunicationSubscriptionFilter" - }, { - "$ref" : "#/components/schemas/PublicCampaignInfluencedFilter" - }, { - "$ref" : "#/components/schemas/PublicSurveyMonkeyFilter" - }, { - "$ref" : "#/components/schemas/PublicSurveyMonkeyValueFilter" - }, { - "$ref" : "#/components/schemas/PublicWebinarFilter" - }, { - "$ref" : "#/components/schemas/PublicEmailEventFilter" - }, { - "$ref" : "#/components/schemas/PublicPrivacyAnalyticsFilter" - }, { - "$ref" : "#/components/schemas/PublicAdsSearchFilter" - }, { - "$ref" : "#/components/schemas/PublicAdsTimeFilter" - }, { - "$ref" : "#/components/schemas/PublicInListFilter" - }, { - "$ref" : "#/components/schemas/PublicNumAssociationsFilter" - }, { - "$ref" : "#/components/schemas/PublicUnifiedEventsFilter" - }, { - "$ref" : "#/components/schemas/PublicPropertyAssociationInListFilter" - }, { - "$ref" : "#/components/schemas/PublicConstantFilter" - } ] - } - } - } - }, - "PublicMonthReference" : { - "title" : "MONTH", - "required" : [ "day", "referenceType" ], - "type" : "object", - "properties" : { - "hour" : { - "type" : "integer", - "format" : "int32" - }, - "millisecond" : { - "type" : "integer", - "format" : "int32" - }, - "referenceType" : { - "type" : "string", - "default" : "MONTH", - "enum" : [ "MONTH" ] - }, - "day" : { - "type" : "integer", - "format" : "int32" - }, - "minute" : { - "type" : "integer", - "format" : "int32" - }, - "second" : { - "type" : "integer", - "format" : "int32" - } - } - }, - "PublicDateTimePropertyOperation" : { - "title" : "DATETIME", - "required" : [ "includeObjectsWithNoValueSet", "operationType", "operator", "requiresTimeZoneConversion", "timestamp" ], - "type" : "object", - "properties" : { - "includeObjectsWithNoValueSet" : { - "type" : "boolean" - }, - "requiresTimeZoneConversion" : { - "type" : "boolean" - }, - "operationType" : { - "type" : "string", - "default" : "DATETIME", - "enum" : [ "DATETIME" ] - }, - "operator" : { - "type" : "string" - }, - "timestamp" : { - "type" : "integer", - "format" : "int32" - } - } - }, - "PublicCampaignInfluencedFilter" : { - "title" : "CAMPAIGN_INFLUENCED", - "required" : [ "campaignId", "filterType" ], - "type" : "object", - "properties" : { - "campaignId" : { - "type" : "string" - }, - "filterType" : { - "type" : "string", - "default" : "CAMPAIGN_INFLUENCED", - "enum" : [ "CAMPAIGN_INFLUENCED" ] - } - } - }, - "ListMoveRequest" : { - "required" : [ "listId", "newFolderId" ], - "type" : "object", - "properties" : { - "listId" : { - "type" : "string", - "description" : "The Id of the list to move." - }, - "newFolderId" : { - "type" : "string", - "description" : "The Id of folder to move the list to, the root folder is Id 0." - } - } - }, - "PublicFiscalQuarterReference" : { - "title" : "FISCAL_QUARTER", - "required" : [ "day", "month", "referenceType" ], - "type" : "object", - "properties" : { - "hour" : { - "type" : "integer", - "format" : "int32" - }, - "month" : { - "type" : "integer", - "format" : "int32" - }, - "millisecond" : { - "type" : "integer", - "format" : "int32" - }, - "referenceType" : { - "type" : "string", - "default" : "FISCAL_QUARTER", - "enum" : [ "FISCAL_QUARTER" ] - }, - "day" : { - "type" : "integer", - "format" : "int32" - }, - "minute" : { - "type" : "integer", - "format" : "int32" - }, - "second" : { - "type" : "integer", - "format" : "int32" - } - } - }, - "Error" : { - "required" : [ "category", "correlationId", "message" ], - "type" : "object", - "properties" : { - "subCategory" : { - "type" : "string", - "description" : "A specific category that contains more specific detail about the error" - }, - "context" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "description" : "Context about the error condition", - "example" : { - "missingScopes" : [ "scope1", "scope2" ], - "invalidPropertyName" : [ "propertyValue" ] - } - }, - "correlationId" : { - "type" : "string", - "description" : "A unique identifier for the request. Include this value with any error reports or support tickets", - "format" : "uuid", - "example" : "aeb5f871-7f07-4993-9211-075dc63e7cbf" - }, - "links" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - }, - "description" : "A map of link names to associated URIs containing documentation about the error or recommended remediation steps", - "example" : { - "knowledge-base" : "https://www.hubspot.com/products/service/knowledge-base" - } - }, - "message" : { - "type" : "string", - "description" : "A human readable message describing the error along with remediation steps where appropriate", - "example" : "Invalid input (details will vary based on the error)" - }, - "category" : { - "type" : "string", - "description" : "The error category", - "example" : "VALIDATION_ERROR" - }, - "errors" : { - "type" : "array", - "description" : "further information about the error", - "items" : { - "$ref" : "#/components/schemas/ErrorDetail" - } - } - }, - "example" : { - "message" : "Invalid input (details will vary based on the error)", - "correlationId" : "aeb5f871-7f07-4993-9211-075dc63e7cbf", - "category" : "VALIDATION_ERROR", - "links" : { - "knowledge-base" : "https://www.hubspot.com/products/service/knowledge-base" - } - } - }, - "PublicMigrationMapping" : { - "required" : [ "legacyListId", "listId" ], - "type" : "object", - "properties" : { - "listId" : { - "type" : "string", - "description" : "The V3 list id for the list" - }, - "legacyListId" : { - "type" : "string", - "description" : "The legacy list id for the list" - } - } - }, - "ListCreateRequest" : { - "required" : [ "name", "objectTypeId", "processingType" ], - "type" : "object", - "properties" : { - "objectTypeId" : { - "type" : "string", - "description" : "The object type ID of the type of objects that the list will store." - }, - "processingType" : { - "type" : "string", - "description" : "The processing type of the list. One of: `SNAPSHOT`, `MANUAL`, or `DYNAMIC`." - }, - "customProperties" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - }, - "description" : "The list of custom properties to tie to the list. Custom property name is the key, the value is the value." - }, - "listFolderId" : { - "type" : "integer", - "description" : "The ID of the folder that the list should be created in. If left blank, then the list will be created in the root of the list folder structure.", - "format" : "int32" - }, - "name" : { - "type" : "string", - "description" : "The name of the list, which must be globally unique across all public lists in the portal." - }, - "filterBranch" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicOrFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicAndFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicNotAllFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicNotAnyFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicRestrictedFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicUnifiedEventsFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicPropertyAssociationFilterBranch" - }, { - "$ref" : "#/components/schemas/PublicAssociationFilterBranch" - } ] - } - } - }, - "PublicBoolPropertyOperation" : { - "title" : "BOOL", - "required" : [ "includeObjectsWithNoValueSet", "operationType", "operator", "value" ], - "type" : "object", - "properties" : { - "includeObjectsWithNoValueSet" : { - "type" : "boolean" - }, - "operationType" : { - "type" : "string", - "default" : "BOOL", - "enum" : [ "BOOL" ] - }, - "value" : { - "type" : "boolean" - }, - "operator" : { - "type" : "string" - } - } - }, - "PublicAllPropertyTypesOperation" : { - "title" : "ALL_PROPERTY", - "required" : [ "includeObjectsWithNoValueSet", "operationType", "operator" ], - "type" : "object", - "properties" : { - "includeObjectsWithNoValueSet" : { - "type" : "boolean" - }, - "operationType" : { - "type" : "string", - "default" : "ALL_PROPERTY", - "enum" : [ "ALL_PROPERTY" ] - }, - "operator" : { - "type" : "string" - } - } - }, - "PublicEventFilterMetadata" : { - "required" : [ "operation", "property" ], - "type" : "object", - "properties" : { - "property" : { - "type" : "string" - }, - "operation" : { - "oneOf" : [ { - "$ref" : "#/components/schemas/PublicBoolPropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicNumberPropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicStringPropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicDateTimePropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicRangedDatePropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicComparativePropertyUpdatedOperation" - }, { - "$ref" : "#/components/schemas/PublicComparativeDatePropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicRollingDateRangePropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicRollingPropertyUpdatedOperation" - }, { - "$ref" : "#/components/schemas/PublicEnumerationPropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicAllPropertyTypesOperation" - }, { - "$ref" : "#/components/schemas/PublicRangedNumberPropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicMultiStringPropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicDatePropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicCalendarDatePropertyOperation" - }, { - "$ref" : "#/components/schemas/PublicTimePointOperation" - }, { - "$ref" : "#/components/schemas/PublicRangedTimeOperation" - } ] - } - } - }, - "PublicDatePoint" : { - "title" : "DATE", - "required" : [ "day", "month", "timeType", "year", "zoneId" ], - "type" : "object", - "properties" : { - "month" : { - "type" : "integer", - "format" : "int32" - }, - "hour" : { - "type" : "integer", - "format" : "int32" - }, - "year" : { - "type" : "integer", - "format" : "int32" - }, - "timezoneSource" : { - "type" : "string" - }, - "millisecond" : { - "type" : "integer", - "format" : "int32" - }, - "timeType" : { - "type" : "string", - "default" : "DATE", - "enum" : [ "DATE" ] - }, - "zoneId" : { - "type" : "string" - }, - "day" : { - "type" : "integer", - "format" : "int32" - }, - "minute" : { - "type" : "integer", - "format" : "int32" - }, - "second" : { - "type" : "integer", - "format" : "int32" - } - } - }, - "PublicTimeOffset" : { - "required" : [ "amount", "offsetDirection", "timeUnit" ], - "type" : "object", - "properties" : { - "amount" : { - "type" : "integer", - "format" : "int64" - }, - "offsetDirection" : { - "type" : "string" - }, - "timeUnit" : { - "type" : "string" - } - } - }, - "NextPage" : { - "required" : [ "after" ], - "type" : "object", - "properties" : { - "link" : { - "type" : "string", - "description" : "A direct link to the request for the next page of records." - }, - "after" : { - "type" : "string", - "description" : "The offset for the next page of records." - } - } - }, - "PublicRollingPropertyUpdatedOperation" : { - "title" : "ROLLING_PROPERTY_UPDATED", - "required" : [ "includeObjectsWithNoValueSet", "numberOfDays", "operationType", "operator" ], - "type" : "object", - "properties" : { - "includeObjectsWithNoValueSet" : { - "type" : "boolean" - }, - "operationType" : { - "type" : "string", - "default" : "ROLLING_PROPERTY_UPDATED", - "enum" : [ "ROLLING_PROPERTY_UPDATED" ] - }, - "numberOfDays" : { - "type" : "integer", - "format" : "int32" - }, - "operator" : { - "type" : "string" - } - } - } - }, - "responses" : { - "Error" : { - "description" : "An error occurred.", - "content" : { - "*/*" : { - "schema" : { - "$ref" : "#/components/schemas/Error" - } - } - } - } - }, - "securitySchemes" : { - "oauth2" : { - "type" : "oauth2", - "flows" : { - "authorizationCode" : { - "authorizationUrl" : "https://app.hubspot.com/oauth/authorize", - "tokenUrl" : "https://api.hubapi.com/oauth/v1/token", - "scopes" : { - "crm.lists.read" : " ", - "cms.membership.access_groups.write" : "Write membership access groups.", - "crm.lists.write" : " " - } - } - } - }, - "private_apps" : { - "type" : "apiKey", - "name" : "private-app", - "in" : "header" - } - } - }, - "x-hubspot-available-client-libraries" : [ "PHP", "Node", "Ruby", "Python" ], - "x-hubspot-product-tier-requirements" : { - "marketing" : "STARTER", - "cms" : "STARTER" - }, - "x-hubspot-documentation-banner" : "NONE" -} +openapi: 3.0.1 +info: + title: Lists + version: v3 + x-hubspot-product-tier-requirements: + marketing: STARTER + cms: STARTER + x-hubspot-documentation-banner: NONE + x-hubspot-api-use-case: "You want to bulk add contacts to a particular list, or\ + \ remove company records from a company list." + x-hubspot-related-documentation: + - name: Lists Guide + url: https://developers.hubspot.com/beta-docs/guides/api/crm/lists/overview + x-hubspot-introduction: Use the lists API to manage list memberships for object + lists. +servers: +- url: https://api.hubapi.com/crm/v3/lists +tags: +- name: Lists +- name: Memberships +- name: Folders +- name: Mapping +paths: + /{listId}/update-list-name: + put: + tags: + - Lists + summary: Update List Name + description: Update the name of a list. The name must be globally unique relative + to all other public lists in the portal. + operationId: "put-/{listId}/update-list-name_updateName" + parameters: + - name: listId + in: path + description: The **ILS ID** of the list to update + required: true + style: simple + explode: false + schema: + type: string + - name: listName + in: query + description: The name to update the list to + required: false + style: form + explode: true + schema: + type: string + - name: includeFilters + in: query + description: "A flag indicating whether or not the response object list definition\ + \ should include a filter branch definition. By default, object list definitions\ + \ will not have their filter branch definitions included in the response" + required: false + style: form + explode: true + schema: + type: boolean + default: false + responses: + "200": + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/ListUpdateResponse' + default: + $ref: '#/components/responses/Error' + security: + - oauth2: + - cms.membership.access_groups.write + - crm.lists.read + - private_apps: + - crm.lists.write + - crm.lists.read + - oauth2: + - crm.lists.write + - crm.lists.read + - private_apps: + - cms.membership.access_groups.write + - crm.lists.read + /{listId}/memberships/add-and-remove: + put: + tags: + - Memberships + summary: Add and/or Remove Records from a List + description: |- + 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`. + operationId: "put-/{listId}/memberships/add-and-remove_addAndRemove" + parameters: + - name: listId + in: path + description: The **ILS ID** of the `MANUAL` or `SNAPSHOT` list + required: true + style: simple + explode: false + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MembershipChangeRequest' + required: true + responses: + "200": + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/MembershipsUpdateResponse' + default: + $ref: '#/components/responses/Error' + security: + - oauth2: + - cms.membership.access_groups.write + - crm.lists.read + - private_apps: + - crm.lists.write + - crm.lists.read + - oauth2: + - crm.lists.write + - crm.lists.read + - private_apps: + - cms.membership.access_groups.write + - crm.lists.read + /{listId}: + get: + tags: + - Lists + summary: Fetch List by ID + description: Fetch a single list by **ILS list ID**. + operationId: "get-/{listId}_getById" + parameters: + - name: listId + in: path + description: The **ILS ID** of the list to fetch + required: true + style: simple + explode: false + schema: + type: string + - name: includeFilters + in: query + description: "A flag indicating whether or not the response object list definition\ + \ should include a filter branch definition. By default, object list definitions\ + \ will not have their filter branch definitions included in the response" + required: false + style: form + explode: true + schema: + type: boolean + default: false + responses: + "200": + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/ListFetchResponse' + default: + $ref: '#/components/responses/Error' + security: + - private_apps: + - crm.lists.read + - oauth2: + - crm.lists.read + delete: + tags: + - Lists + summary: Delete a List + description: "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." + operationId: "delete-/{listId}_remove" + parameters: + - name: listId + in: path + description: The **ILS ID** of the list to delete + required: true + style: simple + explode: false + schema: + type: string + responses: + "204": + description: No content + content: {} + default: + $ref: '#/components/responses/Error' + security: + - oauth2: + - cms.membership.access_groups.write + - crm.lists.read + - private_apps: + - crm.lists.write + - crm.lists.read + - oauth2: + - crm.lists.write + - crm.lists.read + - private_apps: + - cms.membership.access_groups.write + - crm.lists.read + /{listId}/update-list-filters: + put: + tags: + - Lists + summary: Update List Filter Definition + description: "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." + operationId: "put-/{listId}/update-list-filters_updateListFilters" + parameters: + - name: listId + in: path + description: The **ILS ID** of the list to update + required: true + style: simple + explode: false + schema: + type: string + - name: enrollObjectsInWorkflows + in: query + description: A flag indicating whether or not the memberships added to the + list as a result of the filter change should be enrolled in workflows that + are relevant to this list + required: false + style: form + explode: true + schema: + type: boolean + default: false + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ListFilterUpdateRequest' + required: true + responses: + "200": + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/ListUpdateResponse' + default: + $ref: '#/components/responses/Error' + security: + - oauth2: + - cms.membership.access_groups.write + - crm.lists.read + - private_apps: + - crm.lists.write + - crm.lists.read + - oauth2: + - crm.lists.write + - crm.lists.read + - private_apps: + - cms.membership.access_groups.write + - crm.lists.read + /search: + post: + tags: + - Lists + summary: Search Lists + description: Search lists by list name or page through all lists by providing + an empty `query` value. + operationId: post-/search_doSearch + parameters: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ListSearchRequest' + required: true + responses: + "200": + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/ListSearchResponse' + default: + $ref: '#/components/responses/Error' + security: + - private_apps: + - crm.lists.read + - oauth2: + - crm.lists.read + /folders/move-list: + put: + tags: + - Folders + summary: Moves a list to a given folder + description: "Given a list and a folder, the list will be moved to that folder." + operationId: put-/folders/move-list_moveList + parameters: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ListMoveRequest' + required: true + responses: + "204": + description: No content + content: {} + default: + $ref: '#/components/responses/Error' + security: + - oauth2: + - cms.membership.access_groups.write + - crm.lists.read + - private_apps: + - crm.lists.write + - crm.lists.read + - oauth2: + - crm.lists.write + - crm.lists.read + - private_apps: + - cms.membership.access_groups.write + - crm.lists.read + /{listId}/memberships/add: + put: + tags: + - Memberships + summary: Add Records to a List + description: |- + 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`. + operationId: "put-/{listId}/memberships/add_add" + parameters: + - name: listId + in: path + description: The **ILS ID** of the `MANUAL` or `SNAPSHOT` list + required: true + style: simple + explode: false + schema: + type: string + requestBody: + content: + application/json: + schema: + type: array + items: + type: string + required: true + responses: + "200": + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/MembershipsUpdateResponse' + default: + $ref: '#/components/responses/Error' + security: + - oauth2: + - cms.membership.access_groups.write + - crm.lists.read + - private_apps: + - crm.lists.write + - crm.lists.read + - oauth2: + - crm.lists.write + - crm.lists.read + - private_apps: + - cms.membership.access_groups.write + - crm.lists.read + /object-type-id/{objectTypeId}/name/{listName}: + get: + tags: + - Lists + summary: Fetch List by Name + description: Fetch a single list by list name and object type. + operationId: "get-/object-type-id/{objectTypeId}/name/{listName}_getByName" + parameters: + - name: listName + in: path + description: The name of the list to fetch. This is **not** case sensitive + required: true + style: simple + explode: false + schema: + type: string + - name: objectTypeId + in: path + description: "The object type ID of the object types stored by the list to\ + \ fetch. For example, `0-1` for a `CONTACT` list" + required: true + style: simple + explode: false + schema: + type: string + - name: includeFilters + in: query + description: "A flag indicating whether or not the response object list definition\ + \ should include a filter branch definition. By default, object list definitions\ + \ will not have their filter branch definitions included in the response" + required: false + style: form + explode: true + schema: + type: boolean + default: false + responses: + "200": + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/ListFetchResponse' + default: + $ref: '#/components/responses/Error' + security: + - private_apps: + - crm.lists.read + - oauth2: + - crm.lists.read + /folders/{folderId}/move/{newParentFolderId}: + put: + tags: + - Folders + summary: Moves a folder + description: This moves the folder from its current location to a new location. + It updates the parent of this folder to the new Id given. + operationId: "put-/folders/{folderId}/move/{newParentFolderId}_move" + parameters: + - name: folderId + in: path + description: "" + required: true + style: simple + explode: false + schema: + type: string + - name: newParentFolderId + in: path + description: "" + required: true + style: simple + explode: false + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/ListFolderFetchResponse' + default: + $ref: '#/components/responses/Error' + security: + - oauth2: + - cms.membership.access_groups.write + - crm.lists.read + - private_apps: + - crm.lists.write + - crm.lists.read + - oauth2: + - crm.lists.write + - crm.lists.read + - private_apps: + - cms.membership.access_groups.write + - crm.lists.read + /idmapping: + get: + tags: + - Mapping + summary: Translate Legacy List Id to Modern List Id + description: "This API allows translation of legacy list id to list id. This\ + \ is a temporary API allowed for mapping old id's to new id's and will expire\ + \ on May 30th, 2025." + operationId: get-/idmapping_translateLegacyListIdToListId + parameters: + - name: legacyListId + in: query + description: The legacy list id from lists v1 API + required: false + style: form + explode: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/PublicMigrationMapping' + default: + $ref: '#/components/responses/Error' + security: + - private_apps: + - crm.lists.read + - oauth2: + - crm.lists.read + post: + tags: + - Mapping + summary: Translate Legacy List Id to Modern List Id in Batch + description: "This API allows translation of a batch of legacy list id's to\ + \ list id's. This allows for a maximum of 10,000 id's. This is a temporary\ + \ API allowed for mapping old id's to new id's and will expire on May 30th,\ + \ 2025." + operationId: post-/idmapping_translateLegacyListIdToListIdBatch + parameters: [] + requestBody: + content: + application/json: + schema: + type: array + items: + type: string + required: true + responses: + "200": + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/PublicBatchMigrationMapping' + default: + $ref: '#/components/responses/Error' + security: + - private_apps: + - crm.lists.read + - oauth2: + - crm.lists.read + /{listId}/restore: + put: + tags: + - Lists + summary: Restore a List + description: Restore a previously deleted list by **ILS list ID**. Deleted lists + are eligible to be restored up-to 90-days after the list has been deleted. + operationId: "put-/{listId}/restore_restore" + parameters: + - name: listId + in: path + description: The **ILS ID** of the list to restore + required: true + style: simple + explode: false + schema: + type: string + responses: + "204": + description: No content + content: {} + default: + $ref: '#/components/responses/Error' + security: + - oauth2: + - cms.membership.access_groups.write + - crm.lists.read + - private_apps: + - crm.lists.write + - crm.lists.read + - oauth2: + - crm.lists.write + - crm.lists.read + - private_apps: + - cms.membership.access_groups.write + - crm.lists.read + /folders/{folderId}/rename: + put: + tags: + - Folders + summary: Rename a folder + description: Renames the given folderId with a new name. + operationId: "put-/folders/{folderId}/rename_rename" + parameters: + - name: folderId + in: path + description: "" + required: true + style: simple + explode: false + schema: + type: string + - name: newFolderName + in: query + description: "" + required: false + style: form + explode: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/ListFolderFetchResponse' + default: + $ref: '#/components/responses/Error' + security: + - oauth2: + - cms.membership.access_groups.write + - crm.lists.read + - private_apps: + - crm.lists.write + - crm.lists.read + - oauth2: + - crm.lists.write + - crm.lists.read + - private_apps: + - cms.membership.access_groups.write + - crm.lists.read + /{listId}/memberships/join-order: + get: + tags: + - Memberships + summary: Fetch List Memberships Ordered by Added to List Date + description: |- + Fetch the memberships of a list in order sorted by the time the records were added to the list. + + The `recordId`s are sorted in *ascending* order if an `after` offset or no offset is provided. If only a `before` offset is provided, then the records are sorted in *descending* order. + + The `after` offset parameter will take precedence over the `before` offset in a case where both are provided. + operationId: "get-/{listId}/memberships/join-order_getPageOrderedByAddedToListDate" + parameters: + - name: listId + in: path + description: The **ILS ID** of the list + required: true + style: simple + explode: false + schema: + type: string + - name: after + in: query + description: |- + The paging offset token for the page that comes `after` the previously requested records. + + If provided, then the records in the response will be the records following the offset, sorted in *ascending* order. Takes precedence over the `before` offset + required: false + style: form + explode: true + schema: + type: string + - name: before + in: query + description: |- + The paging offset token for the page that comes `before` the previously requested records. + + If provided, then the records in the response will be the records preceding the offset, sorted in *descending* order + required: false + style: form + explode: true + schema: + type: string + - name: limit + in: query + description: The number of records to return in the response. The maximum + `limit` is 250 + required: false + style: form + explode: true + schema: + type: integer + format: int32 + default: 100 + responses: + "200": + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/ApiCollectionResponseJoinTimeAndRecordId' + default: + $ref: '#/components/responses/Error' + security: + - private_apps: + - crm.lists.read + - oauth2: + - crm.lists.read + /{listId}/memberships/add-from/{sourceListId}: + put: + tags: + - Memberships + summary: Add All Records from a Source List to a Destination List + description: |- + Add all of the records from a *source list* (specified by the `sourceListId`) to a *destination list* (specified by the `listId`). Records that are already members of the *destination list* will be ignored. The *destination* and *source list* IDs must be different. The *destination* and *source lists* must contain records of the same type (e.g. contacts, companies, etc.). + + This endpoint only works for *destination lists* that have a `processingType` of `MANUAL` or `SNAPSHOT`. The *source list* can have any `processingType`. + + This endpoint only supports a `sourceListId` for lists with less than 100,000 memberships. + operationId: "put-/{listId}/memberships/add-from/{sourceListId}_addAllFromList" + parameters: + - name: listId + in: path + description: "The **ILS ID** of the `MANUAL` or `SNAPSHOT` *destination list*,\ + \ which the *source list* records are added to" + required: true + style: simple + explode: false + schema: + type: string + - name: sourceListId + in: path + description: "The **ILS ID** of the *source list* to grab the records from,\ + \ which are then added to the *destination list*" + required: true + style: simple + explode: false + schema: + type: string + responses: + "204": + description: No content + content: {} + default: + $ref: '#/components/responses/Error' + security: + - oauth2: + - cms.membership.access_groups.write + - crm.lists.read + - private_apps: + - crm.lists.write + - crm.lists.read + - oauth2: + - crm.lists.write + - crm.lists.read + - private_apps: + - cms.membership.access_groups.write + - crm.lists.read + /records/{objectTypeId}/{recordId}/memberships: + get: + tags: + - Memberships + summary: Get lists record is member of + description: For given record provide lists this record is member of. + operationId: "get-/records/{objectTypeId}/{recordId}/memberships_getLists" + parameters: + - name: objectTypeId + in: path + description: Object type id of the record + required: true + style: simple + explode: false + schema: + type: string + - name: recordId + in: path + description: Id of the record + required: true + style: simple + explode: false + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/ApiCollectionResponseRecordListMembershipNoPaging' + default: + $ref: '#/components/responses/Error' + security: + - private_apps: + - crm.lists.read + - oauth2: + - crm.lists.read + /: + get: + tags: + - Lists + summary: Fetch Multiple Lists + description: Fetch multiple lists in a single request by **ILS list ID**. The + response will include the definitions of all lists that exist for the `listIds` + provided. + operationId: get-/_getAll + parameters: + - name: listIds + in: query + description: The **ILS IDs** of the lists to fetch + required: false + style: form + explode: true + schema: + type: array + items: + type: string + - name: includeFilters + in: query + description: "A flag indicating whether or not the response object list definitions\ + \ should include a filter branch definition. By default, object list definitions\ + \ will not have their filter branch definitions included in the response" + required: false + style: form + explode: true + schema: + type: boolean + default: false + responses: + "200": + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/ListsByIdResponse' + default: + $ref: '#/components/responses/Error' + security: + - private_apps: + - crm.lists.read + - oauth2: + - crm.lists.read + post: + tags: + - Lists + summary: Create List + description: Create a new list with the provided object list definition. + operationId: post-/_create + parameters: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ListCreateRequest' + required: true + responses: + "200": + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/ListCreateResponse' + default: + $ref: '#/components/responses/Error' + security: + - private_apps: + - cms.membership.access_groups.write + - oauth2: + - cms.membership.access_groups.write + - oauth2: + - crm.lists.write + - private_apps: + - crm.lists.write + /folders: + get: + tags: + - Folders + summary: Retrieves a folder. + description: Retrieves a folder and recursively includes all folders via the + childNodes attribute. The child lists field will be empty in all child nodes. + Only the folder retrieved will include the child lists in that folder. + operationId: get-/folders_getAll + parameters: + - name: folderId + in: query + description: The Id of the folder to retrieve + required: false + style: form + explode: true + schema: + type: string + default: "0" + responses: + "200": + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/ListFolderFetchResponse' + default: + $ref: '#/components/responses/Error' + security: + - private_apps: + - crm.lists.read + - oauth2: + - crm.lists.read + post: + tags: + - Folders + summary: Creates a folder + description: Creates a folder with the given information. + operationId: post-/folders_create + parameters: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ListFolderCreateRequest' + required: true + responses: + "200": + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/ListFolderCreateResponse' + default: + $ref: '#/components/responses/Error' + security: + - oauth2: + - cms.membership.access_groups.write + - crm.lists.read + - private_apps: + - crm.lists.write + - crm.lists.read + - oauth2: + - crm.lists.write + - crm.lists.read + - private_apps: + - cms.membership.access_groups.write + - crm.lists.read + /folders/{folderId}: + delete: + tags: + - Folders + summary: Deletes a folder + description: Deletes the folder with the given Id. + operationId: "delete-/folders/{folderId}_remove" + parameters: + - name: folderId + in: path + description: "" + required: true + style: simple + explode: false + schema: + type: string + responses: + "204": + description: No content + content: {} + default: + $ref: '#/components/responses/Error' + security: + - oauth2: + - cms.membership.access_groups.write + - crm.lists.read + - private_apps: + - crm.lists.write + - crm.lists.read + - oauth2: + - crm.lists.write + - crm.lists.read + - private_apps: + - cms.membership.access_groups.write + - crm.lists.read + /{listId}/memberships: + get: + tags: + - Memberships + summary: Fetch List Memberships Ordered by ID + description: |- + Fetch the memberships of a list in order sorted by the `recordId` of the records in the list. + + The `recordId`s are sorted in *ascending* order if an `after` offset or no offset is provided. If only a `before` offset is provided, then the records are sorted in *descending* order. + + The `after` offset parameter will take precedence over the `before` offset in a case where both are provided. + operationId: "get-/{listId}/memberships_getPage" + parameters: + - name: listId + in: path + description: The **ILS ID** of the list + required: true + style: simple + explode: false + schema: + type: string + - name: after + in: query + description: |- + The paging offset token for the page that comes `after` the previously requested records. + + If provided, then the records in the response will be the records following the offset, sorted in *ascending* order. Takes precedence over the `before` offset + required: false + style: form + explode: true + schema: + type: string + - name: before + in: query + description: |- + The paging offset token for the page that comes `before` the previously requested records. + + If provided, then the records in the response will be the records preceding the offset, sorted in *descending* order + required: false + style: form + explode: true + schema: + type: string + - name: limit + in: query + description: The number of records to return in the response. The maximum + `limit` is 250 + required: false + style: form + explode: true + schema: + type: integer + format: int32 + default: 100 + responses: + "200": + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/ApiCollectionResponseJoinTimeAndRecordId' + default: + $ref: '#/components/responses/Error' + security: + - private_apps: + - crm.lists.read + - oauth2: + - crm.lists.read + delete: + tags: + - Memberships + summary: Delete All Records from a List + description: |- + Remove **all** of the records from a list. ***Note:*** *The list is not deleted.* + + This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`. + + This endpoint only supports lists that have less than 100,000 memberships. + operationId: "delete-/{listId}/memberships_removeAll" + parameters: + - name: listId + in: path + description: The **ILS ID** of the `MANUAL` or `SNAPSHOT` list + required: true + style: simple + explode: false + schema: + type: string + responses: + "204": + description: No content + content: {} + default: + $ref: '#/components/responses/Error' + security: + - oauth2: + - cms.membership.access_groups.write + - crm.lists.read + - private_apps: + - crm.lists.write + - crm.lists.read + - oauth2: + - crm.lists.write + - crm.lists.read + - private_apps: + - cms.membership.access_groups.write + - crm.lists.read + /{listId}/memberships/remove: + put: + tags: + - Memberships + summary: Remove Records from a List + description: |- + 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`. + operationId: "put-/{listId}/memberships/remove_remove" + parameters: + - name: listId + in: path + description: The **ILS ID** of the `MANUAL` or `SNAPSHOT` list + required: true + style: simple + explode: false + schema: + type: string + requestBody: + content: + application/json: + schema: + type: array + items: + type: string + required: true + responses: + "200": + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/MembershipsUpdateResponse' + default: + $ref: '#/components/responses/Error' + security: + - oauth2: + - cms.membership.access_groups.write + - crm.lists.read + - private_apps: + - crm.lists.write + - crm.lists.read + - oauth2: + - crm.lists.write + - crm.lists.read + - private_apps: + - cms.membership.access_groups.write + - crm.lists.read +components: + schemas: + PublicPropertyAssociationFilterBranch: + title: PROPERTY_ASSOCIATION + required: + - filterBranchOperator + - filterBranchType + - filterBranches + - filters + - objectTypeId + - operator + - propertyWithObjectId + type: object + properties: + filterBranchType: + type: string + default: PROPERTY_ASSOCIATION + enum: + - PROPERTY_ASSOCIATION + filterBranches: + type: array + items: + $ref: '#/components/schemas/PublicPropertyAssociationFilterBranchFilterBranches' + objectTypeId: + type: string + filterBranchOperator: + type: string + filters: + type: array + items: + $ref: '#/components/schemas/PublicPropertyAssociationFilterBranchFilters' + propertyWithObjectId: + type: string + operator: + type: string + PublicAssociationFilterBranchFilters: + oneOf: + - $ref: '#/components/schemas/PublicPropertyFilter' + - $ref: '#/components/schemas/PublicAssociationInListFilter' + - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' + - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' + - $ref: '#/components/schemas/PublicEventAnalyticsFilter' + - $ref: '#/components/schemas/PublicFormSubmissionFilter' + - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' + - $ref: '#/components/schemas/PublicIntegrationEventFilter' + - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' + - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' + - $ref: '#/components/schemas/PublicCampaignInfluencedFilter' + - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' + - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' + - $ref: '#/components/schemas/PublicWebinarFilter' + - $ref: '#/components/schemas/PublicEmailEventFilter' + - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' + - $ref: '#/components/schemas/PublicAdsSearchFilter' + - $ref: '#/components/schemas/PublicAdsTimeFilter' + - $ref: '#/components/schemas/PublicInListFilter' + - $ref: '#/components/schemas/PublicNumAssociationsFilter' + - $ref: '#/components/schemas/PublicUnifiedEventsFilter' + - $ref: '#/components/schemas/PublicPropertyAssociationInListFilter' + - $ref: '#/components/schemas/PublicConstantFilter' + PublicNumberPropertyOperation: + title: NUMBER + required: + - includeObjectsWithNoValueSet + - operationType + - operator + - value + type: object + properties: + includeObjectsWithNoValueSet: + type: boolean + operationType: + type: string + default: NUMBER + enum: + - NUMBER + value: + type: number + operator: + type: string + PublicUnifiedEventsFilterBranchFilterBranches: + oneOf: + - $ref: '#/components/schemas/PublicOrFilterBranch' + - $ref: '#/components/schemas/PublicAndFilterBranch' + - $ref: '#/components/schemas/PublicNotAllFilterBranch' + - $ref: '#/components/schemas/PublicNotAnyFilterBranch' + - $ref: '#/components/schemas/PublicRestrictedFilterBranch' + - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' + - $ref: '#/components/schemas/PublicPropertyAssociationFilterBranch' + - $ref: '#/components/schemas/PublicAssociationFilterBranch' + PublicYearReference: + title: YEAR + required: + - day + - month + - referenceType + type: object + properties: + hour: + type: integer + format: int32 + month: + type: integer + format: int32 + millisecond: + type: integer + format: int32 + referenceType: + type: string + default: YEAR + enum: + - YEAR + day: + type: integer + format: int32 + minute: + type: integer + format: int32 + second: + type: integer + format: int32 + PublicInListFilterMetadata: + required: + - id + - inListType + type: object + properties: + id: + type: string + inListType: + type: string + ListFolderFetchResponse: + required: + - folder + type: object + properties: + folder: + $ref: '#/components/schemas/PublicListFolder' + PublicRangedDatePropertyOperation: + title: RANGED_DATE + required: + - includeObjectsWithNoValueSet + - lowerBound + - operationType + - operator + - requiresTimeZoneConversion + - upperBound + type: object + properties: + includeObjectsWithNoValueSet: + type: boolean + upperBound: + type: integer + format: int32 + requiresTimeZoneConversion: + type: boolean + operationType: + type: string + default: RANGED_DATE + enum: + - RANGED_DATE + lowerBound: + type: integer + format: int32 + operator: + type: string + ListSearchRequest: + type: object + properties: + listIds: + type: array + description: |- + 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` + items: + type: string + offset: + type: integer + description: Value used to paginate through lists. The `offset` provided + in the response can be used in the next request to fetch the next page + of results. Defaults to `0` if no offset is provided + format: int32 + query: + type: string + description: "The `query` that will be used to search for lists by list\ + \ name. If no `query` is provided, then the results will include all lists" + count: + type: integer + description: The number of lists to include in the response. Defaults to + `20` if no value is provided. The max `count` is `500` + format: int32 + processingTypes: + type: array + description: |- + The `processingTypes` that will be used to filter results by `processingType`. If values are provided, then the response will only include results that have a `processingType` in this array. + + If no value is provided, or if an empty list is provided, then results will not be filtered by `processingType`. + + Valid `processingTypes` are: `MANUAL`, `SNAPSHOT`, or `DYNAMIC` + items: + type: string + additionalProperties: + type: array + description: |- + The property names of any additional list properties to include in the response. Properties that do not exist or that are empty for a particular list are not included in the response. + + By default, all requests will fetch the following properties for each list: `hs_list_size`, `hs_last_record_added_at`, `hs_last_record_removed_at`, `hs_folder_name`, and `hs_list_reference_count` + items: + type: string + sort: + type: string + ListSearchResponse: + required: + - hasMore + - lists + - offset + - total + type: object + properties: + total: + type: integer + description: The total number of lists that match the search criteria + format: int32 + offset: + type: integer + description: Value to be passed in a future request to paginate through + list search results + format: int32 + lists: + type: array + description: The lists that matched the search criteria + items: + $ref: '#/components/schemas/PublicObjectListSearchResult' + hasMore: + type: boolean + description: Whether or not there are more results to page through + PublicInListFilter: + title: IN_LIST + required: + - filterType + - listId + - operator + type: object + properties: + listId: + type: string + metadata: + $ref: '#/components/schemas/PublicInListFilterMetadata' + filterType: + type: string + default: IN_LIST + enum: + - IN_LIST + operator: + type: string + PublicSurveyMonkeyValueFilter: + title: SURVEY_MONKEY_VALUE + required: + - filterType + - operator + - surveyId + - surveyQuestion + - valueComparison + type: object + properties: + valueComparison: + oneOf: + - $ref: '#/components/schemas/PublicBoolPropertyOperation' + - $ref: '#/components/schemas/PublicNumberPropertyOperation' + - $ref: '#/components/schemas/PublicStringPropertyOperation' + - $ref: '#/components/schemas/PublicDateTimePropertyOperation' + - $ref: '#/components/schemas/PublicRangedDatePropertyOperation' + - $ref: '#/components/schemas/PublicComparativePropertyUpdatedOperation' + - $ref: '#/components/schemas/PublicComparativeDatePropertyOperation' + - $ref: '#/components/schemas/PublicRollingDateRangePropertyOperation' + - $ref: '#/components/schemas/PublicRollingPropertyUpdatedOperation' + - $ref: '#/components/schemas/PublicEnumerationPropertyOperation' + - $ref: '#/components/schemas/PublicAllPropertyTypesOperation' + - $ref: '#/components/schemas/PublicRangedNumberPropertyOperation' + - $ref: '#/components/schemas/PublicMultiStringPropertyOperation' + - $ref: '#/components/schemas/PublicDatePropertyOperation' + - $ref: '#/components/schemas/PublicCalendarDatePropertyOperation' + - $ref: '#/components/schemas/PublicTimePointOperation' + - $ref: '#/components/schemas/PublicRangedTimeOperation' + surveyId: + type: string + surveyQuestion: + type: string + filterType: + type: string + default: SURVEY_MONKEY_VALUE + enum: + - SURVEY_MONKEY_VALUE + surveyAnswerRowId: + type: string + surveyAnswerColId: + type: string + operator: + type: string + PublicRelativeComparativeTimestampRefineBy: + title: RELATIVE_COMPARATIVE + required: + - comparison + - timeOffset + - type + type: object + properties: + comparison: + type: string + timeOffset: + $ref: '#/components/schemas/PublicTimeOffset' + type: + type: string + default: RELATIVE_COMPARATIVE + enum: + - RELATIVE_COMPARATIVE + ListsByIdResponse: + required: + - lists + type: object + properties: + lists: + type: array + description: The object list definitions + items: + $ref: '#/components/schemas/PublicObjectList' + PublicCommunicationSubscriptionFilter: + title: COMMUNICATION_SUBSCRIPTION + required: + - acceptedOptStates + - channel + - filterType + - subscriptionIds + - subscriptionType + type: object + properties: + subscriptionType: + type: string + subscriptionIds: + type: array + items: + type: string + channel: + type: string + acceptedOptStates: + type: array + items: + type: string + filterType: + type: string + default: COMMUNICATION_SUBSCRIPTION + enum: + - COMMUNICATION_SUBSCRIPTION + businessUnitId: + type: string + PublicNotAllFilterBranchFilters: + oneOf: + - $ref: '#/components/schemas/PublicPropertyFilter' + - $ref: '#/components/schemas/PublicAssociationInListFilter' + - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' + - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' + - $ref: '#/components/schemas/PublicEventAnalyticsFilter' + - $ref: '#/components/schemas/PublicFormSubmissionFilter' + - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' + - $ref: '#/components/schemas/PublicIntegrationEventFilter' + - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' + - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' + - $ref: '#/components/schemas/PublicCampaignInfluencedFilter' + - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' + - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' + - $ref: '#/components/schemas/PublicWebinarFilter' + - $ref: '#/components/schemas/PublicEmailEventFilter' + - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' + - $ref: '#/components/schemas/PublicAdsSearchFilter' + - $ref: '#/components/schemas/PublicAdsTimeFilter' + - $ref: '#/components/schemas/PublicInListFilter' + - $ref: '#/components/schemas/PublicNumAssociationsFilter' + - $ref: '#/components/schemas/PublicUnifiedEventsFilter' + - $ref: '#/components/schemas/PublicPropertyAssociationInListFilter' + - $ref: '#/components/schemas/PublicConstantFilter' + PublicObjectListSearchResult: + required: + - additionalProperties + - listId + - listVersion + - name + - objectTypeId + - processingStatus + - processingType + type: object + properties: + processingType: + type: string + description: The processing type of the list + objectTypeId: + type: string + description: The object type of the list + updatedById: + type: string + description: The ID of the user that last updated the list + filtersUpdatedAt: + type: string + description: The time when the filters for this list were last updated + format: datetime + listId: + type: string + description: The **ILS ID** of the list + createdAt: + type: string + description: The time when the list was created + format: datetime + processingStatus: + type: string + description: The processing status of the list + deletedAt: + type: string + description: The time when the list was deleted + format: datetime + listVersion: + type: integer + description: The version of the list + format: int32 + name: + type: string + description: The name of the list + additionalProperties: + type: object + additionalProperties: + type: string + description: The name and value of any additional properties that exist + for this list and that were included in the search request + createdById: + type: string + description: The ID of the user that created the list + updatedAt: + type: string + description: The time the list was last updated + format: datetime + PublicRelativeRangedTimestampRefineBy: + title: RELATIVE_RANGED + required: + - lowerBoundOffset + - rangeType + - type + - upperBoundOffset + type: object + properties: + upperBoundOffset: + $ref: '#/components/schemas/PublicTimeOffset' + rangeType: + type: string + lowerBoundOffset: + $ref: '#/components/schemas/PublicTimeOffset' + type: + type: string + default: RELATIVE_RANGED + enum: + - RELATIVE_RANGED + PublicIndexOffset: + type: object + properties: + milliseconds: + type: integer + format: int32 + hours: + type: integer + format: int32 + seconds: + type: integer + format: int32 + months: + type: integer + format: int32 + weeks: + type: integer + format: int32 + minutes: + type: integer + format: int32 + quarters: + type: integer + format: int32 + days: + type: integer + format: int32 + years: + type: integer + format: int32 + PublicNotAllFilterBranch: + title: NOT_ALL + required: + - filterBranchOperator + - filterBranchType + - filterBranches + - filters + type: object + properties: + filterBranchType: + type: string + default: NOT_ALL + enum: + - NOT_ALL + filterBranches: + type: array + items: + $ref: '#/components/schemas/PublicNotAllFilterBranchFilterBranches' + filterBranchOperator: + type: string + filters: + type: array + items: + $ref: '#/components/schemas/PublicNotAllFilterBranchFilters' + PublicBatchMigrationMapping: + required: + - legacyListIdsToIdsMapping + - missingLegacyListIds + type: object + properties: + legacyListIdsToIdsMapping: + type: array + items: + $ref: '#/components/schemas/PublicMigrationMapping' + missingLegacyListIds: + type: array + description: A list of legacy list ids that were passed in but not found. + It will be empty if no id's are missing + items: + type: string + PublicFormSubmissionFilter: + title: FORM_SUBMISSION + required: + - filterType + - operator + type: object + properties: + formId: + type: string + coalescingRefineBy: + oneOf: + - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAllHistoryRefineBy' + - $ref: '#/components/schemas/PublicTimePointOperation' + - $ref: '#/components/schemas/PublicRangedTimeOperation' + pruningRefineBy: + oneOf: + - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAllHistoryRefineBy' + - $ref: '#/components/schemas/PublicTimePointOperation' + - $ref: '#/components/schemas/PublicRangedTimeOperation' + filterType: + type: string + default: FORM_SUBMISSION + enum: + - FORM_SUBMISSION + operator: + type: string + enum: + - FILLED_OUT + - NOT_FILLED_OUT + PublicRollingDateRangePropertyOperation: + title: ROLLING_DATE_RANGE + required: + - includeObjectsWithNoValueSet + - numberOfDays + - operationType + - operator + - requiresTimeZoneConversion + type: object + properties: + includeObjectsWithNoValueSet: + type: boolean + requiresTimeZoneConversion: + type: boolean + operationType: + type: string + default: ROLLING_DATE_RANGE + enum: + - ROLLING_DATE_RANGE + numberOfDays: + type: integer + format: int32 + operator: + type: string + ApiCollectionResponseJoinTimeAndRecordId: + required: + - results + type: object + properties: + total: + type: integer + format: int64 + paging: + $ref: '#/components/schemas/Paging' + results: + type: array + items: + $ref: '#/components/schemas/JoinTimeAndRecordId' + PublicAssociationFilterBranch: + title: ASSOCIATION + required: + - associationCategory + - associationTypeId + - filterBranchOperator + - filterBranchType + - filterBranches + - filters + - objectTypeId + - operator + type: object + properties: + filterBranchType: + type: string + default: ASSOCIATION + enum: + - ASSOCIATION + filterBranches: + type: array + items: + $ref: '#/components/schemas/PublicAssociationFilterBranchFilterBranches' + objectTypeId: + type: string + filterBranchOperator: + type: string + associationTypeId: + type: integer + format: int32 + associationCategory: + type: string + filters: + type: array + items: + $ref: '#/components/schemas/PublicAssociationFilterBranchFilters' + operator: + type: string + PublicQuarterReference: + title: QUARTER + required: + - day + - month + - referenceType + type: object + properties: + hour: + type: integer + format: int32 + month: + type: integer + format: int32 + millisecond: + type: integer + format: int32 + referenceType: + type: string + default: QUARTER + enum: + - QUARTER + day: + type: integer + format: int32 + minute: + type: integer + format: int32 + second: + type: integer + format: int32 + PublicEmailSubscriptionFilter: + title: EMAIL_SUBSCRIPTION + required: + - acceptedStatuses + - filterType + - subscriptionIds + type: object + properties: + subscriptionType: + type: string + subscriptionIds: + type: array + items: + type: string + filterType: + type: string + default: EMAIL_SUBSCRIPTION + enum: + - EMAIL_SUBSCRIPTION + acceptedStatuses: + type: array + items: + type: string + PublicEnumerationPropertyOperation: + title: ENUMERATION + required: + - includeObjectsWithNoValueSet + - operationType + - operator + - values + type: object + properties: + includeObjectsWithNoValueSet: + type: boolean + values: + type: array + items: + type: string + operationType: + type: string + default: ENUMERATION + enum: + - ENUMERATION + operator: + type: string + PublicUnifiedEventsFilterBranchFilters: + oneOf: + - $ref: '#/components/schemas/PublicPropertyFilter' + - $ref: '#/components/schemas/PublicAssociationInListFilter' + - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' + - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' + - $ref: '#/components/schemas/PublicEventAnalyticsFilter' + - $ref: '#/components/schemas/PublicFormSubmissionFilter' + - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' + - $ref: '#/components/schemas/PublicIntegrationEventFilter' + - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' + - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' + - $ref: '#/components/schemas/PublicCampaignInfluencedFilter' + - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' + - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' + - $ref: '#/components/schemas/PublicWebinarFilter' + - $ref: '#/components/schemas/PublicEmailEventFilter' + - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' + - $ref: '#/components/schemas/PublicAdsSearchFilter' + - $ref: '#/components/schemas/PublicAdsTimeFilter' + - $ref: '#/components/schemas/PublicInListFilter' + - $ref: '#/components/schemas/PublicNumAssociationsFilter' + - $ref: '#/components/schemas/PublicUnifiedEventsFilter' + - $ref: '#/components/schemas/PublicPropertyAssociationInListFilter' + - $ref: '#/components/schemas/PublicConstantFilter' + ListFolderCreateResponse: + required: + - folder + type: object + properties: + folder: + $ref: '#/components/schemas/PublicListFolder' + PublicTimePointOperation: + title: TIME_POINT + required: + - includeObjectsWithNoValueSet + - operationType + - operator + - timePoint + - type + type: object + properties: + endpointBehavior: + type: string + includeObjectsWithNoValueSet: + type: boolean + propertyParser: + type: string + operationType: + type: string + default: TIME_POINT + enum: + - TIME_POINT + timePoint: + oneOf: + - $ref: '#/components/schemas/PublicDatePoint' + - $ref: '#/components/schemas/PublicIndexedTimePoint' + - $ref: '#/components/schemas/PublicPropertyReferencedTime' + type: + type: string + operator: + type: string + ListUpdateResponse: + type: object + properties: + updatedList: + $ref: '#/components/schemas/PublicObjectList' + PublicAllHistoryRefineBy: + title: ALL_HISTORY + required: + - type + type: object + properties: + type: + type: string + default: ALL_HISTORY + enum: + - ALL_HISTORY + PublicNotAnyFilterBranch: + title: NOT_ANY + required: + - filterBranchOperator + - filterBranchType + - filterBranches + - filters + type: object + properties: + filterBranchType: + type: string + default: NOT_ANY + enum: + - NOT_ANY + filterBranches: + type: array + items: + $ref: '#/components/schemas/PublicNotAnyFilterBranchFilterBranches' + filterBranchOperator: + type: string + filters: + type: array + items: + $ref: '#/components/schemas/PublicNotAnyFilterBranchFilters' + PublicIndexedTimePoint: + title: INDEXED + required: + - indexReference + - timeType + - zoneId + type: object + properties: + offset: + $ref: '#/components/schemas/PublicIndexOffset' + timezoneSource: + type: string + indexReference: + oneOf: + - $ref: '#/components/schemas/PublicNowReference' + - $ref: '#/components/schemas/PublicTodayReference' + - $ref: '#/components/schemas/PublicWeekReference' + - $ref: '#/components/schemas/PublicFiscalQuarterReference' + - $ref: '#/components/schemas/PublicFiscalYearReference' + - $ref: '#/components/schemas/PublicYearReference' + - $ref: '#/components/schemas/PublicQuarterReference' + - $ref: '#/components/schemas/PublicMonthReference' + timeType: + type: string + default: INDEXED + enum: + - INDEXED + zoneId: + type: string + PublicOrFilterBranchFilterBranches: + oneOf: + - $ref: '#/components/schemas/PublicOrFilterBranch' + - $ref: '#/components/schemas/PublicAndFilterBranch' + - $ref: '#/components/schemas/PublicNotAllFilterBranch' + - $ref: '#/components/schemas/PublicNotAnyFilterBranch' + - $ref: '#/components/schemas/PublicRestrictedFilterBranch' + - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' + - $ref: '#/components/schemas/PublicPropertyAssociationFilterBranch' + - $ref: '#/components/schemas/PublicAssociationFilterBranch' + PublicRestrictedFilterBranchFilters: + oneOf: + - $ref: '#/components/schemas/PublicPropertyFilter' + - $ref: '#/components/schemas/PublicAssociationInListFilter' + - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' + - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' + - $ref: '#/components/schemas/PublicEventAnalyticsFilter' + - $ref: '#/components/schemas/PublicFormSubmissionFilter' + - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' + - $ref: '#/components/schemas/PublicIntegrationEventFilter' + - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' + - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' + - $ref: '#/components/schemas/PublicCampaignInfluencedFilter' + - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' + - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' + - $ref: '#/components/schemas/PublicWebinarFilter' + - $ref: '#/components/schemas/PublicEmailEventFilter' + - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' + - $ref: '#/components/schemas/PublicAdsSearchFilter' + - $ref: '#/components/schemas/PublicAdsTimeFilter' + - $ref: '#/components/schemas/PublicInListFilter' + - $ref: '#/components/schemas/PublicNumAssociationsFilter' + - $ref: '#/components/schemas/PublicUnifiedEventsFilter' + - $ref: '#/components/schemas/PublicPropertyAssociationInListFilter' + - $ref: '#/components/schemas/PublicConstantFilter' + PublicRangedTimeOperation: + title: TIME_RANGED + required: + - includeObjectsWithNoValueSet + - lowerBoundTimePoint + - operationType + - operator + - type + - upperBoundTimePoint + type: object + properties: + upperBoundEndpointBehavior: + type: string + includeObjectsWithNoValueSet: + type: boolean + upperBoundTimePoint: + oneOf: + - $ref: '#/components/schemas/PublicDatePoint' + - $ref: '#/components/schemas/PublicIndexedTimePoint' + - $ref: '#/components/schemas/PublicPropertyReferencedTime' + propertyParser: + type: string + operationType: + type: string + type: + type: string + default: TIME_RANGED + enum: + - TIME_RANGED + lowerBoundEndpointBehavior: + type: string + operator: + type: string + lowerBoundTimePoint: + oneOf: + - $ref: '#/components/schemas/PublicDatePoint' + - $ref: '#/components/schemas/PublicIndexedTimePoint' + - $ref: '#/components/schemas/PublicPropertyReferencedTime' + PublicWebinarFilter: + title: WEBINAR + required: + - filterType + - operator + type: object + properties: + webinarId: + type: string + filterType: + type: string + default: WEBINAR + enum: + - WEBINAR + operator: + type: string + ListCreateResponse: + required: + - list + type: object + properties: + list: + $ref: '#/components/schemas/PublicObjectList' + MembershipsUpdateResponse: + type: object + properties: + recordIdsRemoved: + type: array + description: The IDs of the records that were `removed` from the list + items: + type: string + recordsIdsAdded: + type: array + items: + type: string + recordIdsMissing: + type: array + description: The IDs of the records that were `missing` (e.g. did not exist + in the portal) and so were not `added` or `removed` + items: + type: string + PublicUnifiedEventsFilterBranch: + title: UNIFIED_EVENTS + required: + - eventTypeId + - filterBranchOperator + - filterBranchType + - filterBranches + - filters + - operator + type: object + properties: + filterBranchType: + type: string + default: UNIFIED_EVENTS + enum: + - UNIFIED_EVENTS + filterBranches: + type: array + items: + $ref: '#/components/schemas/PublicUnifiedEventsFilterBranchFilterBranches' + eventTypeId: + type: string + coalescingRefineBy: + oneOf: + - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAllHistoryRefineBy' + - $ref: '#/components/schemas/PublicTimePointOperation' + - $ref: '#/components/schemas/PublicRangedTimeOperation' + filterBranchOperator: + type: string + filters: + type: array + items: + $ref: '#/components/schemas/PublicUnifiedEventsFilterBranchFilters' + operator: + type: string + enum: + - HAS_COMPLETED + - HAS_NOT_COMPLETED + PublicNumOccurrencesRefineBy: + title: NUM_OCCURRENCES + required: + - type + type: object + properties: + maxOccurrences: + type: integer + format: int32 + type: + type: string + default: NUM_OCCURRENCES + enum: + - NUM_OCCURRENCES + minOccurrences: + type: integer + format: int32 + PublicObjectList: + required: + - listId + - listVersion + - name + - objectTypeId + - processingStatus + - processingType + type: object + properties: + processingType: + type: string + description: The processing type of the list + objectTypeId: + type: string + description: The object type of the list + updatedById: + type: string + description: The ID of the user that last updated the list + filtersUpdatedAt: + type: string + description: The time when the filters for this list were last updated + format: datetime + listId: + type: string + description: The **ILS ID** of the list + createdAt: + type: string + description: The time when the list was created + format: datetime + processingStatus: + type: string + description: The processing status of the list + deletedAt: + type: string + description: The time when the list was deleted + format: datetime + listVersion: + type: integer + description: The version of the list + format: int32 + size: + type: integer + format: int64 + name: + type: string + description: The name of the list + createdById: + type: string + description: The ID of the user that created the list + filterBranch: + oneOf: + - $ref: '#/components/schemas/PublicOrFilterBranch' + - $ref: '#/components/schemas/PublicAndFilterBranch' + - $ref: '#/components/schemas/PublicNotAllFilterBranch' + - $ref: '#/components/schemas/PublicNotAnyFilterBranch' + - $ref: '#/components/schemas/PublicRestrictedFilterBranch' + - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' + - $ref: '#/components/schemas/PublicPropertyAssociationFilterBranch' + - $ref: '#/components/schemas/PublicAssociationFilterBranch' + updatedAt: + type: string + description: The time the list was last updated + format: datetime + RecordListMembership: + required: + - firstAddedTimestamp + - lastAddedTimestamp + - listId + - listVersion + type: object + properties: + listId: + type: string + listVersion: + type: integer + format: int32 + lastAddedTimestamp: + type: string + format: datetime + firstAddedTimestamp: + type: string + format: datetime + PublicCtaAnalyticsFilter: + title: CTA + required: + - ctaName + - filterType + - operator + type: object + properties: + coalescingRefineBy: + oneOf: + - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAllHistoryRefineBy' + - $ref: '#/components/schemas/PublicTimePointOperation' + - $ref: '#/components/schemas/PublicRangedTimeOperation' + pruningRefineBy: + oneOf: + - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAllHistoryRefineBy' + - $ref: '#/components/schemas/PublicTimePointOperation' + - $ref: '#/components/schemas/PublicRangedTimeOperation' + filterType: + type: string + default: CTA + enum: + - CTA + ctaName: + type: string + operator: + type: string + ListFetchResponse: + required: + - list + type: object + properties: + list: + $ref: '#/components/schemas/PublicObjectList' + PublicConstantFilter: + title: CONSTANT + required: + - filterType + - shouldAccept + type: object + properties: + shouldAccept: + type: boolean + source: + type: string + filterType: + type: string + default: CONSTANT + enum: + - CONSTANT + PublicSetOccurrencesRefineBy: + title: SET_OCCURRENCES + required: + - setType + - type + type: object + properties: + type: + type: string + default: SET_OCCURRENCES + enum: + - SET_OCCURRENCES + setType: + type: string + PublicNotAnyFilterBranchFilters: + oneOf: + - $ref: '#/components/schemas/PublicPropertyFilter' + - $ref: '#/components/schemas/PublicAssociationInListFilter' + - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' + - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' + - $ref: '#/components/schemas/PublicEventAnalyticsFilter' + - $ref: '#/components/schemas/PublicFormSubmissionFilter' + - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' + - $ref: '#/components/schemas/PublicIntegrationEventFilter' + - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' + - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' + - $ref: '#/components/schemas/PublicCampaignInfluencedFilter' + - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' + - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' + - $ref: '#/components/schemas/PublicWebinarFilter' + - $ref: '#/components/schemas/PublicEmailEventFilter' + - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' + - $ref: '#/components/schemas/PublicAdsSearchFilter' + - $ref: '#/components/schemas/PublicAdsTimeFilter' + - $ref: '#/components/schemas/PublicInListFilter' + - $ref: '#/components/schemas/PublicNumAssociationsFilter' + - $ref: '#/components/schemas/PublicUnifiedEventsFilter' + - $ref: '#/components/schemas/PublicPropertyAssociationInListFilter' + - $ref: '#/components/schemas/PublicConstantFilter' + PublicListFolder: + required: + - childLists + - childNodes + - id + - parentFolderId + type: object + properties: + createdAt: + type: string + description: The time the folder was created at + format: datetime + parentFolderId: + type: integer + description: "The Id of the folder this folder is in, the root folder is\ + \ represented as 0" + format: int32 + childNodes: + type: array + items: + $ref: '#/components/schemas/PublicListFolder' + name: + type: string + description: The name of the folder + id: + type: integer + description: The Id of the folder + format: int32 + childLists: + type: array + description: An array of list Id's contained in this folder + items: + type: integer + format: int32 + updatedContentsAt: + type: string + description: The time that the contents of the folder was last updated at + format: datetime + userId: + type: integer + description: The user Id of the owner of the folder + format: int32 + updatedAt: + type: string + description: The time the folder was last updated at + format: datetime + ApiCollectionResponseRecordListMembershipNoPaging: + required: + - results + type: object + properties: + total: + type: integer + format: int64 + results: + type: array + items: + $ref: '#/components/schemas/RecordListMembership' + PublicComparativeDatePropertyOperation: + title: COMPARATIVE_DATE + required: + - comparisonPropertyName + - includeObjectsWithNoValueSet + - operationType + - operator + type: object + properties: + includeObjectsWithNoValueSet: + type: boolean + defaultComparisonValue: + type: string + operationType: + type: string + default: COMPARATIVE_DATE + enum: + - COMPARATIVE_DATE + comparisonPropertyName: + type: string + operator: + type: string + PublicRangedNumberPropertyOperation: + title: NUMBER_RANGED + required: + - includeObjectsWithNoValueSet + - lowerBound + - operationType + - operator + - upperBound + type: object + properties: + includeObjectsWithNoValueSet: + type: boolean + upperBound: + type: integer + format: int32 + operationType: + type: string + default: NUMBER_RANGED + enum: + - NUMBER_RANGED + lowerBound: + type: integer + format: int32 + operator: + type: string + PublicPageViewAnalyticsFilter: + title: PAGE_VIEW + required: + - filterType + - operator + - pageUrl + type: object + properties: + coalescingRefineBy: + oneOf: + - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAllHistoryRefineBy' + - $ref: '#/components/schemas/PublicTimePointOperation' + - $ref: '#/components/schemas/PublicRangedTimeOperation' + enableTracking: + type: boolean + pruningRefineBy: + oneOf: + - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAllHistoryRefineBy' + - $ref: '#/components/schemas/PublicTimePointOperation' + - $ref: '#/components/schemas/PublicRangedTimeOperation' + pageUrl: + type: string + filterType: + type: string + default: PAGE_VIEW + enum: + - PAGE_VIEW + operator: + type: string + PublicAndFilterBranchFilters: + oneOf: + - $ref: '#/components/schemas/PublicPropertyFilter' + - $ref: '#/components/schemas/PublicAssociationInListFilter' + - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' + - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' + - $ref: '#/components/schemas/PublicEventAnalyticsFilter' + - $ref: '#/components/schemas/PublicFormSubmissionFilter' + - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' + - $ref: '#/components/schemas/PublicIntegrationEventFilter' + - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' + - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' + - $ref: '#/components/schemas/PublicCampaignInfluencedFilter' + - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' + - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' + - $ref: '#/components/schemas/PublicWebinarFilter' + - $ref: '#/components/schemas/PublicEmailEventFilter' + - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' + - $ref: '#/components/schemas/PublicAdsSearchFilter' + - $ref: '#/components/schemas/PublicAdsTimeFilter' + - $ref: '#/components/schemas/PublicInListFilter' + - $ref: '#/components/schemas/PublicNumAssociationsFilter' + - $ref: '#/components/schemas/PublicUnifiedEventsFilter' + - $ref: '#/components/schemas/PublicPropertyAssociationInListFilter' + - $ref: '#/components/schemas/PublicConstantFilter' + MembershipChangeRequest: + required: + - recordIdsToAdd + - recordIdsToRemove + type: object + properties: + recordIdsToRemove: + type: array + description: "" + example: + - 654 + items: + type: string + recordIdsToAdd: + type: array + description: "" + example: + - 123 + - 456 + - 789 + items: + type: string + PublicComparativePropertyUpdatedOperation: + title: COMPARATIVE_PROPERTY_UPDATED + required: + - comparisonPropertyName + - includeObjectsWithNoValueSet + - operationType + - operator + type: object + properties: + includeObjectsWithNoValueSet: + type: boolean + defaultComparisonValue: + type: string + operationType: + type: string + default: COMPARATIVE_PROPERTY_UPDATED + enum: + - COMPARATIVE_PROPERTY_UPDATED + comparisonPropertyName: + type: string + operator: + type: string + PreviousPage: + required: + - before + type: object + properties: + before: + type: string + description: The offset of the previous page of records + link: + type: string + description: A direct link to the request for the previous page of records + PublicAndFilterBranch: + title: AND + required: + - filterBranchOperator + - filterBranchType + - filterBranches + - filters + type: object + properties: + filterBranchType: + type: string + default: AND + enum: + - AND + filterBranches: + type: array + items: + $ref: '#/components/schemas/PublicAndFilterBranchFilterBranches' + filterBranchOperator: + type: string + filters: + type: array + items: + $ref: '#/components/schemas/PublicAndFilterBranchFilters' + PublicIntegrationEventFilter: + title: INTEGRATION_EVENT + required: + - eventTypeId + - filterLines + - filterType + type: object + properties: + eventTypeId: + type: integer + format: int32 + filterLines: + type: array + items: + $ref: '#/components/schemas/PublicEventFilterMetadata' + filterType: + type: string + default: INTEGRATION_EVENT + enum: + - INTEGRATION_EVENT + PublicPropertyAssociationFilterBranchFilters: + oneOf: + - $ref: '#/components/schemas/PublicPropertyFilter' + - $ref: '#/components/schemas/PublicAssociationInListFilter' + - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' + - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' + - $ref: '#/components/schemas/PublicEventAnalyticsFilter' + - $ref: '#/components/schemas/PublicFormSubmissionFilter' + - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' + - $ref: '#/components/schemas/PublicIntegrationEventFilter' + - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' + - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' + - $ref: '#/components/schemas/PublicCampaignInfluencedFilter' + - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' + - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' + - $ref: '#/components/schemas/PublicWebinarFilter' + - $ref: '#/components/schemas/PublicEmailEventFilter' + - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' + - $ref: '#/components/schemas/PublicAdsSearchFilter' + - $ref: '#/components/schemas/PublicAdsTimeFilter' + - $ref: '#/components/schemas/PublicInListFilter' + - $ref: '#/components/schemas/PublicNumAssociationsFilter' + - $ref: '#/components/schemas/PublicUnifiedEventsFilter' + - $ref: '#/components/schemas/PublicPropertyAssociationInListFilter' + - $ref: '#/components/schemas/PublicConstantFilter' + PublicAbsoluteComparativeTimestampRefineBy: + title: ABSOLUTE_COMPARATIVE + required: + - comparison + - timestamp + - type + type: object + properties: + comparison: + type: string + type: + type: string + default: ABSOLUTE_COMPARATIVE + enum: + - ABSOLUTE_COMPARATIVE + timestamp: + type: integer + format: int64 + PublicSurveyMonkeyFilter: + title: SURVEY_MONKEY + required: + - filterType + - operator + - surveyId + type: object + properties: + surveyId: + type: string + filterType: + type: string + default: SURVEY_MONKEY + enum: + - SURVEY_MONKEY + operator: + type: string + PublicAbsoluteRangedTimestampRefineBy: + title: ABSOLUTE_RANGED + required: + - lowerTimestamp + - rangeType + - type + - upperTimestamp + type: object + properties: + rangeType: + type: string + upperTimestamp: + type: integer + format: int64 + lowerTimestamp: + type: integer + format: int64 + type: + type: string + default: ABSOLUTE_RANGED + enum: + - ABSOLUTE_RANGED + PublicDatePropertyOperation: + title: DATE + required: + - day + - includeObjectsWithNoValueSet + - month + - operationType + - operator + - year + type: object + properties: + includeObjectsWithNoValueSet: + type: boolean + month: + type: string + year: + type: integer + format: int32 + operationType: + type: string + default: DATE + enum: + - DATE + day: + type: integer + format: int32 + operator: + type: string + PublicEventAnalyticsFilter: + title: EVENT + required: + - eventId + - filterType + - operator + type: object + properties: + eventId: + type: string + coalescingRefineBy: + oneOf: + - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAllHistoryRefineBy' + - $ref: '#/components/schemas/PublicTimePointOperation' + - $ref: '#/components/schemas/PublicRangedTimeOperation' + pruningRefineBy: + oneOf: + - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAllHistoryRefineBy' + - $ref: '#/components/schemas/PublicTimePointOperation' + - $ref: '#/components/schemas/PublicRangedTimeOperation' + filterType: + type: string + default: EVENT + enum: + - EVENT + operator: + type: string + PublicUnifiedEventsFilter: + title: UNIFIED_EVENTS + required: + - filterLines + - filterType + type: object + properties: + coalescingRefineBy: + oneOf: + - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAllHistoryRefineBy' + - $ref: '#/components/schemas/PublicTimePointOperation' + - $ref: '#/components/schemas/PublicRangedTimeOperation' + eventTypeId: + type: string + filterLines: + type: array + items: + $ref: '#/components/schemas/PublicEventFilterMetadata' + pruningRefineBy: + oneOf: + - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAllHistoryRefineBy' + - $ref: '#/components/schemas/PublicTimePointOperation' + - $ref: '#/components/schemas/PublicRangedTimeOperation' + filterType: + type: string + default: UNIFIED_EVENTS + enum: + - UNIFIED_EVENTS + PublicFiscalYearReference: + title: FISCAL_YEAR + required: + - day + - month + - referenceType + type: object + properties: + hour: + type: integer + format: int32 + month: + type: integer + format: int32 + millisecond: + type: integer + format: int32 + referenceType: + type: string + default: FISCAL_YEAR + enum: + - FISCAL_YEAR + day: + type: integer + format: int32 + minute: + type: integer + format: int32 + second: + type: integer + format: int32 + PublicCalendarDatePropertyOperation: + title: CALENDAR_DATE + required: + - includeObjectsWithNoValueSet + - operationType + - operator + - timeUnit + type: object + properties: + useFiscalYear: + type: boolean + fiscalYearStart: + type: string + enum: + - JANUARY + - FEBRUARY + - MARCH + - APRIL + - MAY + - JUNE + - JULY + - AUGUST + - SEPTEMBER + - OCTOBER + - NOVEMBER + - DECEMBER + includeObjectsWithNoValueSet: + type: boolean + operationType: + type: string + default: CALENDAR_DATE + enum: + - CALENDAR_DATE + timeUnitCount: + type: integer + format: int32 + operator: + type: string + timeUnit: + type: string + PublicOrFilterBranchFilters: + oneOf: + - $ref: '#/components/schemas/PublicPropertyFilter' + - $ref: '#/components/schemas/PublicAssociationInListFilter' + - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' + - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' + - $ref: '#/components/schemas/PublicEventAnalyticsFilter' + - $ref: '#/components/schemas/PublicFormSubmissionFilter' + - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' + - $ref: '#/components/schemas/PublicIntegrationEventFilter' + - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' + - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' + - $ref: '#/components/schemas/PublicCampaignInfluencedFilter' + - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' + - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' + - $ref: '#/components/schemas/PublicWebinarFilter' + - $ref: '#/components/schemas/PublicEmailEventFilter' + - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' + - $ref: '#/components/schemas/PublicAdsSearchFilter' + - $ref: '#/components/schemas/PublicAdsTimeFilter' + - $ref: '#/components/schemas/PublicInListFilter' + - $ref: '#/components/schemas/PublicNumAssociationsFilter' + - $ref: '#/components/schemas/PublicUnifiedEventsFilter' + - $ref: '#/components/schemas/PublicPropertyAssociationInListFilter' + - $ref: '#/components/schemas/PublicConstantFilter' + PublicPropertyFilter: + title: PROPERTY + required: + - filterType + - operation + - property + type: object + properties: + property: + type: string + filterType: + type: string + default: PROPERTY + enum: + - PROPERTY + operation: + oneOf: + - $ref: '#/components/schemas/PublicBoolPropertyOperation' + - $ref: '#/components/schemas/PublicNumberPropertyOperation' + - $ref: '#/components/schemas/PublicStringPropertyOperation' + - $ref: '#/components/schemas/PublicDateTimePropertyOperation' + - $ref: '#/components/schemas/PublicRangedDatePropertyOperation' + - $ref: '#/components/schemas/PublicComparativePropertyUpdatedOperation' + - $ref: '#/components/schemas/PublicComparativeDatePropertyOperation' + - $ref: '#/components/schemas/PublicRollingDateRangePropertyOperation' + - $ref: '#/components/schemas/PublicRollingPropertyUpdatedOperation' + - $ref: '#/components/schemas/PublicEnumerationPropertyOperation' + - $ref: '#/components/schemas/PublicAllPropertyTypesOperation' + - $ref: '#/components/schemas/PublicRangedNumberPropertyOperation' + - $ref: '#/components/schemas/PublicMultiStringPropertyOperation' + - $ref: '#/components/schemas/PublicDatePropertyOperation' + - $ref: '#/components/schemas/PublicCalendarDatePropertyOperation' + - $ref: '#/components/schemas/PublicTimePointOperation' + - $ref: '#/components/schemas/PublicRangedTimeOperation' + ErrorDetail: + required: + - message + type: object + properties: + subCategory: + type: string + description: A specific category that contains more specific detail about + the error + code: + type: string + description: The status code associated with the error detail + in: + type: string + description: The name of the field or parameter in which the error was found + context: + type: object + additionalProperties: + type: array + items: + type: string + description: Context about the error condition + example: + missingScopes: + - scope1 + - scope2 + message: + type: string + description: A human readable message describing the error along with remediation + steps where appropriate + PublicNumAssociationsFilter: + title: NUM_ASSOCIATIONS + required: + - associationCategory + - associationTypeId + - coalescingRefineBy + - filterType + type: object + properties: + coalescingRefineBy: + oneOf: + - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAllHistoryRefineBy' + - $ref: '#/components/schemas/PublicTimePointOperation' + - $ref: '#/components/schemas/PublicRangedTimeOperation' + associationTypeId: + type: integer + format: int32 + associationCategory: + type: string + filterType: + type: string + default: NUM_ASSOCIATIONS + enum: + - NUM_ASSOCIATIONS + PublicAssociationInListFilter: + title: ASSOCIATION + required: + - associationCategory + - associationTypeId + - coalescingRefineBy + - filterType + - listId + - operator + type: object + properties: + listId: + type: string + coalescingRefineBy: + oneOf: + - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAllHistoryRefineBy' + - $ref: '#/components/schemas/PublicTimePointOperation' + - $ref: '#/components/schemas/PublicRangedTimeOperation' + toObjectType: + type: string + associationTypeId: + type: integer + format: int32 + associationCategory: + type: string + filterType: + type: string + default: ASSOCIATION + enum: + - ASSOCIATION + toObjectTypeId: + type: string + operator: + type: string + PublicRestrictedFilterBranchFilterBranches: + oneOf: + - $ref: '#/components/schemas/PublicOrFilterBranch' + - $ref: '#/components/schemas/PublicAndFilterBranch' + - $ref: '#/components/schemas/PublicNotAllFilterBranch' + - $ref: '#/components/schemas/PublicNotAnyFilterBranch' + - $ref: '#/components/schemas/PublicRestrictedFilterBranch' + - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' + - $ref: '#/components/schemas/PublicPropertyAssociationFilterBranch' + - $ref: '#/components/schemas/PublicAssociationFilterBranch' + PublicEmailEventFilter: + title: EMAIL_EVENT + required: + - appId + - emailId + - filterType + - level + - operator + type: object + properties: + clickUrl: + type: string + level: + type: string + pruningRefineBy: + oneOf: + - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAllHistoryRefineBy' + - $ref: '#/components/schemas/PublicTimePointOperation' + - $ref: '#/components/schemas/PublicRangedTimeOperation' + appId: + type: string + emailId: + type: string + filterType: + type: string + default: EMAIL_EVENT + enum: + - EMAIL_EVENT + operator: + type: string + enum: + - LINK_CLICKED + - MARKED_SPAM + - OPENED + - OPENED_BUT_LINK_NOT_CLICKED + - OPENED_BUT_NOT_REPLIED + - REPLIED + - UNSUBSCRIBED + - BOUNCED + - RECEIVED + - RECEIVED_BUT_NOT_OPENED + - SENT + - SENT_BUT_LINK_NOT_CLICKED + - SENT_BUT_NOT_RECEIVED + PublicOrFilterBranch: + title: OR + required: + - filterBranchOperator + - filterBranchType + - filterBranches + - filters + type: object + properties: + filterBranchType: + type: string + default: OR + enum: + - OR + filterBranches: + type: array + items: + $ref: '#/components/schemas/PublicOrFilterBranchFilterBranches' + filterBranchOperator: + type: string + filters: + type: array + items: + $ref: '#/components/schemas/PublicOrFilterBranchFilters' + PublicAdsTimeFilter: + title: ADS_TIME + required: + - filterType + - pruningRefineBy + type: object + properties: + pruningRefineBy: + oneOf: + - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAllHistoryRefineBy' + - $ref: '#/components/schemas/PublicTimePointOperation' + - $ref: '#/components/schemas/PublicRangedTimeOperation' + filterType: + type: string + default: ADS_TIME + enum: + - ADS_TIME + PublicFormSubmissionOnPageFilter: + title: FORM_SUBMISSION_ON_PAGE + required: + - filterType + - operator + - pageId + type: object + properties: + formId: + type: string + coalescingRefineBy: + oneOf: + - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAllHistoryRefineBy' + - $ref: '#/components/schemas/PublicTimePointOperation' + - $ref: '#/components/schemas/PublicRangedTimeOperation' + pruningRefineBy: + oneOf: + - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAllHistoryRefineBy' + - $ref: '#/components/schemas/PublicTimePointOperation' + - $ref: '#/components/schemas/PublicRangedTimeOperation' + filterType: + type: string + default: FORM_SUBMISSION_ON_PAGE + enum: + - FORM_SUBMISSION_ON_PAGE + pageId: + type: string + operator: + type: string + enum: + - FILLED_OUT + - NOT_FILLED_OUT + PublicPropertyAssociationInListFilter: + title: PROPERTY_ASSOCIATION + required: + - coalescingRefineBy + - filterType + - listId + - operator + - propertyWithObjectId + type: object + properties: + listId: + type: string + coalescingRefineBy: + oneOf: + - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' + - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' + - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' + - $ref: '#/components/schemas/PublicAllHistoryRefineBy' + - $ref: '#/components/schemas/PublicTimePointOperation' + - $ref: '#/components/schemas/PublicRangedTimeOperation' + propertyWithObjectId: + type: string + filterType: + type: string + default: PROPERTY_ASSOCIATION + enum: + - PROPERTY_ASSOCIATION + toObjectTypeId: + type: string + operator: + type: string + PublicStringPropertyOperation: + title: STRING + required: + - includeObjectsWithNoValueSet + - operationType + - operator + - value + type: object + properties: + includeObjectsWithNoValueSet: + type: boolean + operationType: + type: string + default: STRING + enum: + - STRING + value: + type: string + operator: + type: string + PublicPropertyReferencedTime: + title: PROPERTY_REFERENCED + required: + - property + - referenceType + - timeType + - zoneId + type: object + properties: + timezoneSource: + type: string + property: + type: string + timeType: + type: string + default: PROPERTY_REFERENCED + enum: + - PROPERTY_REFERENCED + zoneId: + type: string + referenceType: + type: string + Paging: + type: object + properties: + next: + $ref: '#/components/schemas/NextPage' + prev: + $ref: '#/components/schemas/PreviousPage' + PublicPrivacyAnalyticsFilter: + title: PRIVACY + required: + - filterType + - operator + - privacyName + type: object + properties: + privacyName: + type: string + filterType: + type: string + default: PRIVACY + enum: + - PRIVACY + operator: + type: string + PublicNotAnyFilterBranchFilterBranches: + oneOf: + - $ref: '#/components/schemas/PublicOrFilterBranch' + - $ref: '#/components/schemas/PublicAndFilterBranch' + - $ref: '#/components/schemas/PublicNotAllFilterBranch' + - $ref: '#/components/schemas/PublicNotAnyFilterBranch' + - $ref: '#/components/schemas/PublicRestrictedFilterBranch' + - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' + - $ref: '#/components/schemas/PublicPropertyAssociationFilterBranch' + - $ref: '#/components/schemas/PublicAssociationFilterBranch' + ListFilterUpdateRequest: + required: + - filterBranch + type: object + properties: + filterBranch: + oneOf: + - $ref: '#/components/schemas/PublicOrFilterBranch' + - $ref: '#/components/schemas/PublicAndFilterBranch' + - $ref: '#/components/schemas/PublicNotAllFilterBranch' + - $ref: '#/components/schemas/PublicNotAnyFilterBranch' + - $ref: '#/components/schemas/PublicRestrictedFilterBranch' + - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' + - $ref: '#/components/schemas/PublicPropertyAssociationFilterBranch' + - $ref: '#/components/schemas/PublicAssociationFilterBranch' + PublicMultiStringPropertyOperation: + title: MULTISTRING + required: + - includeObjectsWithNoValueSet + - operationType + - operator + - values + type: object + properties: + includeObjectsWithNoValueSet: + type: boolean + values: + type: array + items: + type: string + operationType: + type: string + default: MULTISTRING + enum: + - MULTISTRING + operator: + type: string + PublicWeekReference: + title: WEEK + required: + - dayOfWeek + - referenceType + type: object + properties: + dayOfWeek: + type: string + enum: + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + - SUNDAY + hour: + type: integer + format: int32 + millisecond: + type: integer + format: int32 + referenceType: + type: string + default: WEEK + enum: + - WEEK + minute: + type: integer + format: int32 + second: + type: integer + format: int32 + PublicAdsSearchFilter: + title: ADS_SEARCH + required: + - adNetwork + - entityType + - filterType + - operator + - searchTermType + - searchTerms + type: object + properties: + searchTerms: + type: array + items: + type: string + entityType: + type: string + adNetwork: + type: string + searchTermType: + type: string + filterType: + type: string + default: ADS_SEARCH + enum: + - ADS_SEARCH + operator: + type: string + PublicTodayReference: + title: TODAY + required: + - referenceType + type: object + properties: + hour: + type: integer + format: int32 + millisecond: + type: integer + format: int32 + referenceType: + type: string + default: TODAY + enum: + - TODAY + minute: + type: integer + format: int32 + second: + type: integer + format: int32 + PublicNowReference: + title: NOW + required: + - referenceType + type: object + properties: + hour: + type: integer + format: int32 + millisecond: + type: integer + format: int32 + referenceType: + type: string + default: NOW + enum: + - NOW + minute: + type: integer + format: int32 + second: + type: integer + format: int32 + ListFolderCreateRequest: + required: + - name + type: object + properties: + parentFolderId: + type: string + description: "The folder this should be created in, if not specified will\ + \ be created in the root folder 0" + name: + type: string + description: The name of the folder to be created + JoinTimeAndRecordId: + required: + - membershipTimestamp + - recordId + type: object + properties: + recordId: + type: string + membershipTimestamp: + type: string + format: datetime + PublicRestrictedFilterBranch: + title: RESTRICTED + required: + - filterBranchOperator + - filterBranchType + - filterBranches + - filters + type: object + properties: + filterBranchType: + type: string + default: RESTRICTED + enum: + - RESTRICTED + filterBranches: + type: array + items: + $ref: '#/components/schemas/PublicRestrictedFilterBranchFilterBranches' + filterBranchOperator: + type: string + filters: + type: array + items: + $ref: '#/components/schemas/PublicRestrictedFilterBranchFilters' + PublicMonthReference: + title: MONTH + required: + - day + - referenceType + type: object + properties: + hour: + type: integer + format: int32 + millisecond: + type: integer + format: int32 + referenceType: + type: string + default: MONTH + enum: + - MONTH + day: + type: integer + format: int32 + minute: + type: integer + format: int32 + second: + type: integer + format: int32 + PublicNotAllFilterBranchFilterBranches: + oneOf: + - $ref: '#/components/schemas/PublicOrFilterBranch' + - $ref: '#/components/schemas/PublicAndFilterBranch' + - $ref: '#/components/schemas/PublicNotAllFilterBranch' + - $ref: '#/components/schemas/PublicNotAnyFilterBranch' + - $ref: '#/components/schemas/PublicRestrictedFilterBranch' + - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' + - $ref: '#/components/schemas/PublicPropertyAssociationFilterBranch' + - $ref: '#/components/schemas/PublicAssociationFilterBranch' + PublicDateTimePropertyOperation: + title: DATETIME + required: + - includeObjectsWithNoValueSet + - operationType + - operator + - requiresTimeZoneConversion + - timestamp + type: object + properties: + includeObjectsWithNoValueSet: + type: boolean + requiresTimeZoneConversion: + type: boolean + operationType: + type: string + default: DATETIME + enum: + - DATETIME + operator: + type: string + timestamp: + type: integer + format: int32 + PublicCampaignInfluencedFilter: + title: CAMPAIGN_INFLUENCED + required: + - campaignId + - filterType + type: object + properties: + campaignId: + type: string + filterType: + type: string + default: CAMPAIGN_INFLUENCED + enum: + - CAMPAIGN_INFLUENCED + ListMoveRequest: + required: + - listId + - newFolderId + type: object + properties: + listId: + type: string + description: The Id of the list to move + newFolderId: + type: string + description: "The Id of folder to move the list to, the root folder is Id\ + \ 0" + PublicFiscalQuarterReference: + title: FISCAL_QUARTER + required: + - day + - month + - referenceType + type: object + properties: + hour: + type: integer + format: int32 + month: + type: integer + format: int32 + millisecond: + type: integer + format: int32 + referenceType: + type: string + default: FISCAL_QUARTER + enum: + - FISCAL_QUARTER + day: + type: integer + format: int32 + minute: + type: integer + format: int32 + second: + type: integer + format: int32 + PublicPropertyAssociationFilterBranchFilterBranches: + oneOf: + - $ref: '#/components/schemas/PublicOrFilterBranch' + - $ref: '#/components/schemas/PublicAndFilterBranch' + - $ref: '#/components/schemas/PublicNotAllFilterBranch' + - $ref: '#/components/schemas/PublicNotAnyFilterBranch' + - $ref: '#/components/schemas/PublicRestrictedFilterBranch' + - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' + - $ref: '#/components/schemas/PublicPropertyAssociationFilterBranch' + - $ref: '#/components/schemas/PublicAssociationFilterBranch' + Error: + required: + - category + - correlationId + - message + type: object + properties: + subCategory: + type: string + description: A specific category that contains more specific detail about + the error + context: + type: object + additionalProperties: + type: array + items: + type: string + description: Context about the error condition + example: + missingScopes: + - scope1 + - scope2 + invalidPropertyName: + - propertyValue + correlationId: + type: string + description: A unique identifier for the request. Include this value with + any error reports or support tickets + format: uuid + example: aeb5f871-7f07-4993-9211-075dc63e7cbf + links: + type: object + additionalProperties: + type: string + description: A map of link names to associated URIs containing documentation + about the error or recommended remediation steps + example: + knowledge-base: https://www.hubspot.com/products/service/knowledge-base + message: + type: string + description: A human readable message describing the error along with remediation + steps where appropriate + example: Invalid input (details will vary based on the error) + category: + type: string + description: The error category + example: VALIDATION_ERROR + errors: + type: array + description: further information about the error + items: + $ref: '#/components/schemas/ErrorDetail' + example: + message: Invalid input (details will vary based on the error) + correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf + category: VALIDATION_ERROR + links: + knowledge-base: https://www.hubspot.com/products/service/knowledge-base + PublicMigrationMapping: + required: + - legacyListId + - listId + type: object + properties: + listId: + type: string + description: The V3 list id for the list + legacyListId: + type: string + description: The legacy list id for the list + PublicAssociationFilterBranchFilterBranches: + oneOf: + - $ref: '#/components/schemas/PublicOrFilterBranch' + - $ref: '#/components/schemas/PublicAndFilterBranch' + - $ref: '#/components/schemas/PublicNotAllFilterBranch' + - $ref: '#/components/schemas/PublicNotAnyFilterBranch' + - $ref: '#/components/schemas/PublicRestrictedFilterBranch' + - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' + - $ref: '#/components/schemas/PublicPropertyAssociationFilterBranch' + - $ref: '#/components/schemas/PublicAssociationFilterBranch' + PublicAndFilterBranchFilterBranches: + oneOf: + - $ref: '#/components/schemas/PublicOrFilterBranch' + - $ref: '#/components/schemas/PublicAndFilterBranch' + - $ref: '#/components/schemas/PublicNotAllFilterBranch' + - $ref: '#/components/schemas/PublicNotAnyFilterBranch' + - $ref: '#/components/schemas/PublicRestrictedFilterBranch' + - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' + - $ref: '#/components/schemas/PublicPropertyAssociationFilterBranch' + - $ref: '#/components/schemas/PublicAssociationFilterBranch' + ListCreateRequest: + required: + - name + - objectTypeId + - processingType + type: object + properties: + objectTypeId: + type: string + description: The object type ID of the type of objects that the list will + store + processingType: + type: string + description: "The processing type of the list. One of: `SNAPSHOT`, `MANUAL`,\ + \ or `DYNAMIC`" + customProperties: + type: object + additionalProperties: + type: string + description: "The list of custom properties to tie to the list. Custom property\ + \ name is the key, the value is the value" + listFolderId: + type: integer + description: "The ID of the folder that the list should be created in. If\ + \ left blank, then the list will be created in the root of the list folder\ + \ structure" + format: int32 + name: + type: string + description: "The name of the list, which must be globally unique across\ + \ all public lists in the portal" + filterBranch: + oneOf: + - $ref: '#/components/schemas/PublicOrFilterBranch' + - $ref: '#/components/schemas/PublicAndFilterBranch' + - $ref: '#/components/schemas/PublicNotAllFilterBranch' + - $ref: '#/components/schemas/PublicNotAnyFilterBranch' + - $ref: '#/components/schemas/PublicRestrictedFilterBranch' + - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' + - $ref: '#/components/schemas/PublicPropertyAssociationFilterBranch' + - $ref: '#/components/schemas/PublicAssociationFilterBranch' + PublicBoolPropertyOperation: + title: BOOL + required: + - includeObjectsWithNoValueSet + - operationType + - operator + - value + type: object + properties: + includeObjectsWithNoValueSet: + type: boolean + operationType: + type: string + default: BOOL + enum: + - BOOL + value: + type: boolean + operator: + type: string + PublicAllPropertyTypesOperation: + title: ALL_PROPERTY + required: + - includeObjectsWithNoValueSet + - operationType + - operator + type: object + properties: + includeObjectsWithNoValueSet: + type: boolean + operationType: + type: string + default: ALL_PROPERTY + enum: + - ALL_PROPERTY + operator: + type: string + PublicEventFilterMetadata: + required: + - operation + - property + type: object + properties: + property: + type: string + operation: + oneOf: + - $ref: '#/components/schemas/PublicBoolPropertyOperation' + - $ref: '#/components/schemas/PublicNumberPropertyOperation' + - $ref: '#/components/schemas/PublicStringPropertyOperation' + - $ref: '#/components/schemas/PublicDateTimePropertyOperation' + - $ref: '#/components/schemas/PublicRangedDatePropertyOperation' + - $ref: '#/components/schemas/PublicComparativePropertyUpdatedOperation' + - $ref: '#/components/schemas/PublicComparativeDatePropertyOperation' + - $ref: '#/components/schemas/PublicRollingDateRangePropertyOperation' + - $ref: '#/components/schemas/PublicRollingPropertyUpdatedOperation' + - $ref: '#/components/schemas/PublicEnumerationPropertyOperation' + - $ref: '#/components/schemas/PublicAllPropertyTypesOperation' + - $ref: '#/components/schemas/PublicRangedNumberPropertyOperation' + - $ref: '#/components/schemas/PublicMultiStringPropertyOperation' + - $ref: '#/components/schemas/PublicDatePropertyOperation' + - $ref: '#/components/schemas/PublicCalendarDatePropertyOperation' + - $ref: '#/components/schemas/PublicTimePointOperation' + - $ref: '#/components/schemas/PublicRangedTimeOperation' + PublicDatePoint: + title: DATE + required: + - day + - month + - timeType + - year + - zoneId + type: object + properties: + month: + type: integer + format: int32 + hour: + type: integer + format: int32 + year: + type: integer + format: int32 + timezoneSource: + type: string + millisecond: + type: integer + format: int32 + timeType: + type: string + default: DATE + enum: + - DATE + zoneId: + type: string + day: + type: integer + format: int32 + minute: + type: integer + format: int32 + second: + type: integer + format: int32 + PublicTimeOffset: + required: + - amount + - offsetDirection + - timeUnit + type: object + properties: + amount: + type: integer + format: int64 + offsetDirection: + type: string + timeUnit: + type: string + NextPage: + required: + - after + type: object + properties: + link: + type: string + description: A direct link to the request for the next page of records + after: + type: string + description: The offset for the next page of records + PublicRollingPropertyUpdatedOperation: + title: ROLLING_PROPERTY_UPDATED + required: + - includeObjectsWithNoValueSet + - numberOfDays + - operationType + - operator + type: object + properties: + includeObjectsWithNoValueSet: + type: boolean + operationType: + type: string + default: ROLLING_PROPERTY_UPDATED + enum: + - ROLLING_PROPERTY_UPDATED + numberOfDays: + type: integer + format: int32 + operator: + type: string + responses: + Error: + description: An error occurred. + content: + '*/*': + schema: + $ref: '#/components/schemas/Error' + securitySchemes: + oauth2: + type: oauth2 + flows: + authorizationCode: + authorizationUrl: https://app.hubspot.com/oauth/authorize + tokenUrl: https://api.hubapi.com/oauth/v1/token + scopes: + crm.lists.read: ' ' + cms.membership.access_groups.write: Write membership access groups. + crm.lists.write: ' ' + private_apps: + type: apiKey + name: private-app + in: header + x-ballerina-name: privateApp +x-hubspot-available-client-libraries: +- PHP +- Node +- Ruby +- Python +x-hubspot-product-tier-requirements: + marketing: STARTER + cms: STARTER +x-hubspot-documentation-banner: NONE From 50f6c94c59e026c7cc847c0a7e8140d969918ef9 Mon Sep 17 00:00:00 2001 From: ballerina-bot Date: Wed, 9 Apr 2025 10:13:50 +0000 Subject: [PATCH 2/7] [AUTOMATED] Client Regeneration --- ballerina/client.bal | 447 ++++++++++++++++++-------------------- ballerina/types.bal | 506 ++++++++++++++++++++++--------------------- ballerina/utils.bal | 25 +-- gradle.properties | 2 +- 4 files changed, 480 insertions(+), 500 deletions(-) diff --git a/ballerina/client.bal b/ballerina/client.bal index 1f67aa7..bca4816 100644 --- a/ballerina/client.bal +++ b/ballerina/client.bal @@ -28,460 +28,437 @@ public isolated client class Client { # + serviceUrl - URL of the target service # + return - An error if connector initialization failed public isolated function init(ConnectionConfig config, string serviceUrl = "https://api.hubapi.com/crm/v3/lists") returns error? { - http:ClientConfiguration httpClientConfig = {httpVersion: config.httpVersion, timeout: config.timeout, forwarded: config.forwarded, poolConfig: config.poolConfig, compression: config.compression, circuitBreaker: config.circuitBreaker, retryConfig: config.retryConfig, validation: config.validation}; - do { - if config.http1Settings is ClientHttp1Settings { - ClientHttp1Settings settings = check config.http1Settings.ensureType(ClientHttp1Settings); - httpClientConfig.http1Settings = {...settings}; - } - if config.http2Settings is http:ClientHttp2Settings { - httpClientConfig.http2Settings = check config.http2Settings.ensureType(http:ClientHttp2Settings); - } - if config.cache is http:CacheConfig { - httpClientConfig.cache = check config.cache.ensureType(http:CacheConfig); - } - if config.responseLimits is http:ResponseLimitConfigs { - httpClientConfig.responseLimits = check config.responseLimits.ensureType(http:ResponseLimitConfigs); - } - if config.secureSocket is http:ClientSecureSocket { - httpClientConfig.secureSocket = check config.secureSocket.ensureType(http:ClientSecureSocket); - } - if config.proxy is http:ProxyConfig { - httpClientConfig.proxy = check config.proxy.ensureType(http:ProxyConfig); - } - } + http:ClientConfiguration httpClientConfig = {httpVersion: config.httpVersion, http1Settings: config.http1Settings, http2Settings: config.http2Settings, timeout: config.timeout, forwarded: config.forwarded, followRedirects: config.followRedirects, poolConfig: config.poolConfig, cache: config.cache, compression: config.compression, circuitBreaker: config.circuitBreaker, retryConfig: config.retryConfig, cookieConfig: config.cookieConfig, responseLimits: config.responseLimits, secureSocket: config.secureSocket, proxy: config.proxy, socketConfig: config.socketConfig, validation: config.validation, laxDataBinding: config.laxDataBinding}; if config.auth is ApiKeysConfig { self.apiKeyConfig = (config.auth).cloneReadOnly(); } else { httpClientConfig.auth = config.auth; self.apiKeyConfig = (); } - http:Client httpEp = check new (serviceUrl, httpClientConfig); - self.clientEp = httpEp; - return; + self.clientEp = check new (serviceUrl, httpClientConfig); } - # Deletes a folder + # Update List Name # - # + folderId - + # + listId - The **ILS ID** of the list to update # + headers - Headers to be sent with the request - # + return - No content - remote isolated function deleteFoldersFolderid_remove(string folderId, map headers = {}) returns http:Response|error { - string resourcePath = string `/folders/${getEncodedUri(folderId)}`; + # + queries - Queries to be sent with the request + # + return - successful operation + remote isolated function putListIdUpdateListNameUpdateName(string listId, map headers = {}, *PutListIdUpdateListNameUpdateNameQueries queries) returns ListUpdateResponse|error { + string resourcePath = string `/${getEncodedUri(listId)}/update-list-name`; map headerValues = {...headers}; if self.apiKeyConfig is ApiKeysConfig { - headerValues["private-app"] = self.apiKeyConfig?.private\-app; + headerValues["private-app"] = self.apiKeyConfig?.privateApp; } - map httpHeaders = getMapForHeaders(headerValues); - return self.clientEp->delete(resourcePath, headers = httpHeaders); + resourcePath = resourcePath + check getPathForQueryParam(queries); + map httpHeaders = http:getHeaderMap(headerValues); + http:Request request = new; + return self.clientEp->put(resourcePath, request, httpHeaders); } - # Delete All Records from a List + # Add and/or Remove Records from a List # - # + listId - The **ILS ID** of the `MANUAL` or `SNAPSHOT` list. + # + listId - The **ILS ID** of the `MANUAL` or `SNAPSHOT` list # + headers - Headers to be sent with the request - # + return - No content - remote isolated function deleteListidMemberships_removeall(string listId, map headers = {}) returns http:Response|error { - string resourcePath = string `/${getEncodedUri(listId)}/memberships`; + # + return - successful operation + remote isolated function putListIdMembershipsAddAndRemoveAddAndRemove(string listId, MembershipChangeRequest payload, map headers = {}) returns MembershipsUpdateResponse|error { + string resourcePath = string `/${getEncodedUri(listId)}/memberships/add-and-remove`; map headerValues = {...headers}; if self.apiKeyConfig is ApiKeysConfig { - headerValues["private-app"] = self.apiKeyConfig?.private\-app; + headerValues["private-app"] = self.apiKeyConfig?.privateApp; } - map httpHeaders = getMapForHeaders(headerValues); - return self.clientEp->delete(resourcePath, headers = httpHeaders); + map httpHeaders = http:getHeaderMap(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->put(resourcePath, request, httpHeaders); } - # Delete a List + # Fetch List by ID # - # + listId - The **ILS ID** of the list to delete. + # + listId - The **ILS ID** of the list to fetch # + headers - Headers to be sent with the request - # + return - No content - remote isolated function deleteListid_remove(string listId, map headers = {}) returns http:Response|error { + # + queries - Queries to be sent with the request + # + return - successful operation + remote isolated function getListIdGetById(string listId, map headers = {}, *GetListIdGetByIdQueries queries) returns ListFetchResponse|error { string resourcePath = string `/${getEncodedUri(listId)}`; map headerValues = {...headers}; if self.apiKeyConfig is ApiKeysConfig { - headerValues["private-app"] = self.apiKeyConfig?.private\-app; + headerValues["private-app"] = self.apiKeyConfig?.privateApp; } - map httpHeaders = getMapForHeaders(headerValues); - return self.clientEp->delete(resourcePath, headers = httpHeaders); + resourcePath = resourcePath + check getPathForQueryParam(queries); + map httpHeaders = http:getHeaderMap(headerValues); + return self.clientEp->get(resourcePath, httpHeaders); } - # Retrieves a folder. + # Delete a List # + # + listId - The **ILS ID** of the list to delete # + headers - Headers to be sent with the request - # + queries - Queries to be sent with the request - # + return - successful operation - remote isolated function getFolders_getall(map headers = {}, *GetFolders_getallQueries queries) returns ListFolderFetchResponse|error { - string resourcePath = string `/folders`; + # + return - No content + remote isolated function deleteListIdRemove(string listId, map headers = {}) returns error? { + string resourcePath = string `/${getEncodedUri(listId)}`; map headerValues = {...headers}; if self.apiKeyConfig is ApiKeysConfig { - headerValues["private-app"] = self.apiKeyConfig?.private\-app; + headerValues["private-app"] = self.apiKeyConfig?.privateApp; } - resourcePath = resourcePath + check getPathForQueryParam(queries); - map httpHeaders = getMapForHeaders(headerValues); - return self.clientEp->get(resourcePath, httpHeaders); + map httpHeaders = http:getHeaderMap(headerValues); + return self.clientEp->delete(resourcePath, headers = httpHeaders); } - # Translate Legacy List Id to Modern List Id + # Update List Filter Definition # + # + listId - The **ILS ID** of the list to update # + headers - Headers to be sent with the request # + queries - Queries to be sent with the request # + return - successful operation - remote isolated function getIdmapping_translatelegacylistidtolistid(map headers = {}, *GetIdmapping_translatelegacylistidtolistidQueries queries) returns PublicMigrationMapping|error { - string resourcePath = string `/idmapping`; + remote isolated function putListIdUpdateListFiltersUpdateListFilters(string listId, ListFilterUpdateRequest payload, map headers = {}, *PutListIdUpdateListFiltersUpdateListFiltersQueries queries) returns ListUpdateResponse|error { + string resourcePath = string `/${getEncodedUri(listId)}/update-list-filters`; map headerValues = {...headers}; if self.apiKeyConfig is ApiKeysConfig { - headerValues["private-app"] = self.apiKeyConfig?.private\-app; + headerValues["private-app"] = self.apiKeyConfig?.privateApp; } resourcePath = resourcePath + check getPathForQueryParam(queries); - map httpHeaders = getMapForHeaders(headerValues); - return self.clientEp->get(resourcePath, httpHeaders); + map httpHeaders = http:getHeaderMap(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->put(resourcePath, request, httpHeaders); } - # Fetch List Memberships Ordered by Added to List Date + # Search Lists # - # + listId - The **ILS ID** of the list. # + headers - Headers to be sent with the request - # + queries - Queries to be sent with the request # + return - successful operation - remote isolated function getListidMembershipsJoinOrder_getpageorderedbyaddedtolistdate(string listId, map headers = {}, *GetListidMembershipsJoinOrder_getpageorderedbyaddedtolistdateQueries queries) returns ApiCollectionResponseJoinTimeAndRecordId|error { - string resourcePath = string `/${getEncodedUri(listId)}/memberships/join-order`; + remote isolated function postSearchDoSearch(ListSearchRequest payload, map headers = {}) returns ListSearchResponse|error { + string resourcePath = string `/search`; map headerValues = {...headers}; if self.apiKeyConfig is ApiKeysConfig { - headerValues["private-app"] = self.apiKeyConfig?.private\-app; + headerValues["private-app"] = self.apiKeyConfig?.privateApp; } - resourcePath = resourcePath + check getPathForQueryParam(queries); - map httpHeaders = getMapForHeaders(headerValues); - return self.clientEp->get(resourcePath, httpHeaders); + map httpHeaders = http:getHeaderMap(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->post(resourcePath, request, httpHeaders); } - # Fetch List Memberships Ordered by ID + # Moves a list to a given folder # - # + listId - The **ILS ID** of the list. # + headers - Headers to be sent with the request - # + queries - Queries to be sent with the request - # + return - successful operation - remote isolated function getListidMemberships_getpage(string listId, map headers = {}, *GetListidMemberships_getpageQueries queries) returns ApiCollectionResponseJoinTimeAndRecordId|error { - string resourcePath = string `/${getEncodedUri(listId)}/memberships`; + # + return - No content + remote isolated function putFoldersMoveListMoveList(ListMoveRequest payload, map headers = {}) returns error? { + string resourcePath = string `/folders/move-list`; map headerValues = {...headers}; if self.apiKeyConfig is ApiKeysConfig { - headerValues["private-app"] = self.apiKeyConfig?.private\-app; + headerValues["private-app"] = self.apiKeyConfig?.privateApp; } - resourcePath = resourcePath + check getPathForQueryParam(queries); - map httpHeaders = getMapForHeaders(headerValues); - return self.clientEp->get(resourcePath, httpHeaders); + map httpHeaders = http:getHeaderMap(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->put(resourcePath, request, httpHeaders); } - # Fetch List by ID + # Add Records to a List # - # + listId - The **ILS ID** of the list to fetch. + # + listId - The **ILS ID** of the `MANUAL` or `SNAPSHOT` list # + headers - Headers to be sent with the request - # + queries - Queries to be sent with the request # + return - successful operation - remote isolated function getListid_getbyid(string listId, map headers = {}, *GetListid_getbyidQueries queries) returns ListFetchResponse|error { - string resourcePath = string `/${getEncodedUri(listId)}`; + remote isolated function putListIdMembershipsAddAdd(string listId, string[] payload, map headers = {}) returns MembershipsUpdateResponse|error { + string resourcePath = string `/${getEncodedUri(listId)}/memberships/add`; map headerValues = {...headers}; if self.apiKeyConfig is ApiKeysConfig { - headerValues["private-app"] = self.apiKeyConfig?.private\-app; + headerValues["private-app"] = self.apiKeyConfig?.privateApp; } - resourcePath = resourcePath + check getPathForQueryParam(queries); - map httpHeaders = getMapForHeaders(headerValues); - return self.clientEp->get(resourcePath, httpHeaders); + map httpHeaders = http:getHeaderMap(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + return self.clientEp->put(resourcePath, request, httpHeaders); } # Fetch List by Name # - # + listName - The name of the list to fetch. This is **not** case sensitive. - # + objectTypeId - The object type ID of the object types stored by the list to fetch. For example, `0-1` for a `CONTACT` list. + # + listName - The name of the list to fetch. This is **not** case sensitive + # + objectTypeId - The object type ID of the object types stored by the list to fetch. For example, `0-1` for a `CONTACT` list # + headers - Headers to be sent with the request # + queries - Queries to be sent with the request # + return - successful operation - remote isolated function getObjectTypeIdObjecttypeidNameListname_getbyname(string listName, string objectTypeId, map headers = {}, *GetObjectTypeIdObjecttypeidNameListname_getbynameQueries queries) returns ListFetchResponse|error { + remote isolated function getObjectTypeIdObjectTypeIdNameListNameGetByName(string listName, string objectTypeId, map headers = {}, *GetObjectTypeIdObjectTypeIdNameListNameGetByNameQueries queries) returns ListFetchResponse|error { string resourcePath = string `/object-type-id/${getEncodedUri(objectTypeId)}/name/${getEncodedUri(listName)}`; map headerValues = {...headers}; if self.apiKeyConfig is ApiKeysConfig { - headerValues["private-app"] = self.apiKeyConfig?.private\-app; + headerValues["private-app"] = self.apiKeyConfig?.privateApp; } resourcePath = resourcePath + check getPathForQueryParam(queries); - map httpHeaders = getMapForHeaders(headerValues); + map httpHeaders = http:getHeaderMap(headerValues); return self.clientEp->get(resourcePath, httpHeaders); } - # Get lists record is member of + # Moves a folder # - # + objectTypeId - Object type id of the record - # + recordId - Id of the record + # + folderId - + # + newParentFolderId - # + headers - Headers to be sent with the request # + return - successful operation - remote isolated function getRecordsObjecttypeidRecordidMemberships_getlists(string objectTypeId, string recordId, map headers = {}) returns ApiCollectionResponseRecordListMembershipNoPaging|error { - string resourcePath = string `/records/${getEncodedUri(objectTypeId)}/${getEncodedUri(recordId)}/memberships`; + remote isolated function putFoldersFolderIdMoveNewParentFolderIdMove(string folderId, string newParentFolderId, map headers = {}) returns ListFolderFetchResponse|error { + string resourcePath = string `/folders/${getEncodedUri(folderId)}/move/${getEncodedUri(newParentFolderId)}`; map headerValues = {...headers}; if self.apiKeyConfig is ApiKeysConfig { - headerValues["private-app"] = self.apiKeyConfig?.private\-app; + headerValues["private-app"] = self.apiKeyConfig?.privateApp; } - map httpHeaders = getMapForHeaders(headerValues); - return self.clientEp->get(resourcePath, httpHeaders); + map httpHeaders = http:getHeaderMap(headerValues); + http:Request request = new; + return self.clientEp->put(resourcePath, request, httpHeaders); } - # Fetch Multiple Lists + # Translate Legacy List Id to Modern List Id # # + headers - Headers to be sent with the request # + queries - Queries to be sent with the request # + return - successful operation - remote isolated function get_getall(map headers = {}, *Get_getallQueries queries) returns ListsByIdResponse|error { - string resourcePath = string `/`; + remote isolated function getIdmappingTranslateLegacyListIdToListId(map headers = {}, *GetIdmappingTranslateLegacyListIdToListIdQueries queries) returns PublicMigrationMapping|error { + string resourcePath = string `/idmapping`; map headerValues = {...headers}; if self.apiKeyConfig is ApiKeysConfig { - headerValues["private-app"] = self.apiKeyConfig?.private\-app; + headerValues["private-app"] = self.apiKeyConfig?.privateApp; } - map queryParamEncoding = {"listIds": {style: FORM, explode: true}}; - resourcePath = resourcePath + check getPathForQueryParam(queries, queryParamEncoding); - map httpHeaders = getMapForHeaders(headerValues); + resourcePath = resourcePath + check getPathForQueryParam(queries); + map httpHeaders = http:getHeaderMap(headerValues); return self.clientEp->get(resourcePath, httpHeaders); } - # Creates a folder + # Translate Legacy List Id to Modern List Id in Batch # # + headers - Headers to be sent with the request # + return - successful operation - remote isolated function postFolders_create(ListFolderCreateRequest payload, map headers = {}) returns ListFolderCreateResponse|error { - string resourcePath = string `/folders`; + remote isolated function postIdmappingTranslateLegacyListIdToListIdBatch(string[] payload, map headers = {}) returns PublicBatchMigrationMapping|error { + string resourcePath = string `/idmapping`; map headerValues = {...headers}; if self.apiKeyConfig is ApiKeysConfig { - headerValues["private-app"] = self.apiKeyConfig?.private\-app; + headerValues["private-app"] = self.apiKeyConfig?.privateApp; } - map httpHeaders = getMapForHeaders(headerValues); + map httpHeaders = http:getHeaderMap(headerValues); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); return self.clientEp->post(resourcePath, request, httpHeaders); } - # Translate Legacy List Id to Modern List Id in Batch + # Restore a List # + # + listId - The **ILS ID** of the list to restore # + headers - Headers to be sent with the request - # + return - successful operation - remote isolated function postIdmapping_translatelegacylistidtolistidbatch(string[] payload, map headers = {}) returns PublicBatchMigrationMapping|error { - string resourcePath = string `/idmapping`; + # + return - No content + remote isolated function putListIdRestoreRestore(string listId, map headers = {}) returns error? { + string resourcePath = string `/${getEncodedUri(listId)}/restore`; map headerValues = {...headers}; if self.apiKeyConfig is ApiKeysConfig { - headerValues["private-app"] = self.apiKeyConfig?.private\-app; + headerValues["private-app"] = self.apiKeyConfig?.privateApp; } - map httpHeaders = getMapForHeaders(headerValues); + map httpHeaders = http:getHeaderMap(headerValues); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->put(resourcePath, request, httpHeaders); } - # Search Lists + # Rename a folder # + # + folderId - # + headers - Headers to be sent with the request + # + queries - Queries to be sent with the request # + return - successful operation - remote isolated function postSearch_dosearch(ListSearchRequest payload, map headers = {}) returns ListSearchResponse|error { - string resourcePath = string `/search`; + remote isolated function putFoldersFolderIdRenameRename(string folderId, map headers = {}, *PutFoldersFolderIdRenameRenameQueries queries) returns ListFolderFetchResponse|error { + string resourcePath = string `/folders/${getEncodedUri(folderId)}/rename`; map headerValues = {...headers}; if self.apiKeyConfig is ApiKeysConfig { - headerValues["private-app"] = self.apiKeyConfig?.private\-app; + headerValues["private-app"] = self.apiKeyConfig?.privateApp; } - map httpHeaders = getMapForHeaders(headerValues); + resourcePath = resourcePath + check getPathForQueryParam(queries); + map httpHeaders = http:getHeaderMap(headerValues); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + return self.clientEp->put(resourcePath, request, httpHeaders); } - # Create List + # Fetch List Memberships Ordered by Added to List Date # + # + listId - The **ILS ID** of the list # + headers - Headers to be sent with the request + # + queries - Queries to be sent with the request # + return - successful operation - remote isolated function post_create(ListCreateRequest payload, map headers = {}) returns ListCreateResponse|error { - string resourcePath = string `/`; + remote isolated function getListIdMembershipsJoinOrderGetPageOrderedByAddedToListDate(string listId, map headers = {}, *GetListIdMembershipsJoinOrderGetPageOrderedByAddedToListDateQueries queries) returns ApiCollectionResponseJoinTimeAndRecordId|error { + string resourcePath = string `/${getEncodedUri(listId)}/memberships/join-order`; map headerValues = {...headers}; if self.apiKeyConfig is ApiKeysConfig { - headerValues["private-app"] = self.apiKeyConfig?.private\-app; + headerValues["private-app"] = self.apiKeyConfig?.privateApp; } - map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - return self.clientEp->post(resourcePath, request, httpHeaders); + resourcePath = resourcePath + check getPathForQueryParam(queries); + map httpHeaders = http:getHeaderMap(headerValues); + return self.clientEp->get(resourcePath, httpHeaders); } - # Moves a folder + # Add All Records from a Source List to a Destination List # - # + folderId - - # + newParentFolderId - + # + listId - The **ILS ID** of the `MANUAL` or `SNAPSHOT` *destination list*, which the *source list* records are added to + # + sourceListId - The **ILS ID** of the *source list* to grab the records from, which are then added to the *destination list* # + headers - Headers to be sent with the request - # + return - successful operation - remote isolated function putFoldersFolderidMoveNewparentfolderid_move(string folderId, string newParentFolderId, map headers = {}) returns ListFolderFetchResponse|error { - string resourcePath = string `/folders/${getEncodedUri(folderId)}/move/${getEncodedUri(newParentFolderId)}`; + # + return - No content + remote isolated function putListIdMembershipsAddFromSourceListIdAddAllFromList(string listId, string sourceListId, map headers = {}) returns error? { + string resourcePath = string `/${getEncodedUri(listId)}/memberships/add-from/${getEncodedUri(sourceListId)}`; map headerValues = {...headers}; if self.apiKeyConfig is ApiKeysConfig { - headerValues["private-app"] = self.apiKeyConfig?.private\-app; + headerValues["private-app"] = self.apiKeyConfig?.privateApp; } - map httpHeaders = getMapForHeaders(headerValues); + map httpHeaders = http:getHeaderMap(headerValues); http:Request request = new; return self.clientEp->put(resourcePath, request, httpHeaders); } - # Rename a folder + # Get lists record is member of # - # + folderId - + # + objectTypeId - Object type id of the record + # + recordId - Id of the record # + headers - Headers to be sent with the request - # + queries - Queries to be sent with the request # + return - successful operation - remote isolated function putFoldersFolderidRename_rename(string folderId, map headers = {}, *PutFoldersFolderidRename_renameQueries queries) returns ListFolderFetchResponse|error { - string resourcePath = string `/folders/${getEncodedUri(folderId)}/rename`; + remote isolated function getRecordsObjectTypeIdRecordIdMembershipsGetLists(string objectTypeId, string recordId, map headers = {}) returns ApiCollectionResponseRecordListMembershipNoPaging|error { + string resourcePath = string `/records/${getEncodedUri(objectTypeId)}/${getEncodedUri(recordId)}/memberships`; map headerValues = {...headers}; if self.apiKeyConfig is ApiKeysConfig { - headerValues["private-app"] = self.apiKeyConfig?.private\-app; + headerValues["private-app"] = self.apiKeyConfig?.privateApp; } - resourcePath = resourcePath + check getPathForQueryParam(queries); - map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - return self.clientEp->put(resourcePath, request, httpHeaders); + map httpHeaders = http:getHeaderMap(headerValues); + return self.clientEp->get(resourcePath, httpHeaders); } - # Moves a list to a given folder + # Fetch Multiple Lists # # + headers - Headers to be sent with the request - # + return - No content - remote isolated function putFoldersMoveList_movelist(ListMoveRequest payload, map headers = {}) returns http:Response|error { - string resourcePath = string `/folders/move-list`; + # + queries - Queries to be sent with the request + # + return - successful operation + remote isolated function getGetAll(map headers = {}, *GetGetAllQueries queries) returns ListsByIdResponse|error { + string resourcePath = string `/`; map headerValues = {...headers}; if self.apiKeyConfig is ApiKeysConfig { - headerValues["private-app"] = self.apiKeyConfig?.private\-app; + headerValues["private-app"] = self.apiKeyConfig?.privateApp; } - map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - return self.clientEp->put(resourcePath, request, httpHeaders); + map queryParamEncoding = {"listIds": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queries, queryParamEncoding); + map httpHeaders = http:getHeaderMap(headerValues); + return self.clientEp->get(resourcePath, httpHeaders); } - # Add and/or Remove Records from a List + # Create List # - # + listId - The **ILS ID** of the `MANUAL` or `SNAPSHOT` list. # + headers - Headers to be sent with the request # + return - successful operation - remote isolated function putListidMembershipsAddAndRemove_addandremove(string listId, MembershipChangeRequest payload, map headers = {}) returns MembershipsUpdateResponse|error { - string resourcePath = string `/${getEncodedUri(listId)}/memberships/add-and-remove`; + remote isolated function postCreate(ListCreateRequest payload, map headers = {}) returns ListCreateResponse|error { + string resourcePath = string `/`; map headerValues = {...headers}; if self.apiKeyConfig is ApiKeysConfig { - headerValues["private-app"] = self.apiKeyConfig?.private\-app; + headerValues["private-app"] = self.apiKeyConfig?.privateApp; } - map httpHeaders = getMapForHeaders(headerValues); + map httpHeaders = http:getHeaderMap(headerValues); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->put(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, httpHeaders); } - # Add All Records from a Source List to a Destination List + # Retrieves a folder. # - # + listId - The **ILS ID** of the `MANUAL` or `SNAPSHOT` *destination list*, which the *source list* records are added to. - # + sourceListId - The **ILS ID** of the *source list* to grab the records from, which are then added to the *destination list*. # + headers - Headers to be sent with the request - # + return - No content - remote isolated function putListidMembershipsAddFromSourcelistid_addallfromlist(string listId, string sourceListId, map headers = {}) returns http:Response|error { - string resourcePath = string `/${getEncodedUri(listId)}/memberships/add-from/${getEncodedUri(sourceListId)}`; + # + queries - Queries to be sent with the request + # + return - successful operation + remote isolated function getFoldersGetAll(map headers = {}, *GetFoldersGetAllQueries queries) returns ListFolderFetchResponse|error { + string resourcePath = string `/folders`; map headerValues = {...headers}; if self.apiKeyConfig is ApiKeysConfig { - headerValues["private-app"] = self.apiKeyConfig?.private\-app; + headerValues["private-app"] = self.apiKeyConfig?.privateApp; } - map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - return self.clientEp->put(resourcePath, request, httpHeaders); + resourcePath = resourcePath + check getPathForQueryParam(queries); + map httpHeaders = http:getHeaderMap(headerValues); + return self.clientEp->get(resourcePath, httpHeaders); } - # Add Records to a List + # Creates a folder # - # + listId - The **ILS ID** of the `MANUAL` or `SNAPSHOT` list. # + headers - Headers to be sent with the request # + return - successful operation - remote isolated function putListidMembershipsAdd_add(string listId, string[] payload, map headers = {}) returns MembershipsUpdateResponse|error { - string resourcePath = string `/${getEncodedUri(listId)}/memberships/add`; + remote isolated function postFoldersCreate(ListFolderCreateRequest payload, map headers = {}) returns ListFolderCreateResponse|error { + string resourcePath = string `/folders`; map headerValues = {...headers}; if self.apiKeyConfig is ApiKeysConfig { - headerValues["private-app"] = self.apiKeyConfig?.private\-app; + headerValues["private-app"] = self.apiKeyConfig?.privateApp; } - map httpHeaders = getMapForHeaders(headerValues); + map httpHeaders = http:getHeaderMap(headerValues); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - return self.clientEp->put(resourcePath, request, httpHeaders); + return self.clientEp->post(resourcePath, request, httpHeaders); } - # Remove Records from a List + # Deletes a folder # - # + listId - The **ILS ID** of the `MANUAL` or `SNAPSHOT` list. + # + folderId - # + headers - Headers to be sent with the request - # + return - successful operation - remote isolated function putListidMembershipsRemove_remove(string listId, string[] payload, map headers = {}) returns MembershipsUpdateResponse|error { - string resourcePath = string `/${getEncodedUri(listId)}/memberships/remove`; + # + return - No content + remote isolated function deleteFoldersFolderIdRemove(string folderId, map headers = {}) returns error? { + string resourcePath = string `/folders/${getEncodedUri(folderId)}`; map headerValues = {...headers}; if self.apiKeyConfig is ApiKeysConfig { - headerValues["private-app"] = self.apiKeyConfig?.private\-app; + headerValues["private-app"] = self.apiKeyConfig?.privateApp; } - map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - return self.clientEp->put(resourcePath, request, httpHeaders); + map httpHeaders = http:getHeaderMap(headerValues); + return self.clientEp->delete(resourcePath, headers = httpHeaders); } - # Restore a List + # Fetch List Memberships Ordered by ID # - # + listId - The **ILS ID** of the list to restore. + # + listId - The **ILS ID** of the list # + headers - Headers to be sent with the request - # + return - No content - remote isolated function putListidRestore_restore(string listId, map headers = {}) returns http:Response|error { - string resourcePath = string `/${getEncodedUri(listId)}/restore`; + # + queries - Queries to be sent with the request + # + return - successful operation + remote isolated function getListIdMembershipsGetPage(string listId, map headers = {}, *GetListIdMembershipsGetPageQueries queries) returns ApiCollectionResponseJoinTimeAndRecordId|error { + string resourcePath = string `/${getEncodedUri(listId)}/memberships`; map headerValues = {...headers}; if self.apiKeyConfig is ApiKeysConfig { - headerValues["private-app"] = self.apiKeyConfig?.private\-app; + headerValues["private-app"] = self.apiKeyConfig?.privateApp; } - map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - return self.clientEp->put(resourcePath, request, httpHeaders); + resourcePath = resourcePath + check getPathForQueryParam(queries); + map httpHeaders = http:getHeaderMap(headerValues); + return self.clientEp->get(resourcePath, httpHeaders); } - # Update List Filter Definition + # Delete All Records from a List # - # + listId - The **ILS ID** of the list to update. + # + listId - The **ILS ID** of the `MANUAL` or `SNAPSHOT` list # + headers - Headers to be sent with the request - # + queries - Queries to be sent with the request - # + return - successful operation - remote isolated function putListidUpdateListFilters_updatelistfilters(string listId, ListFilterUpdateRequest payload, map headers = {}, *PutListidUpdateListFilters_updatelistfiltersQueries queries) returns ListUpdateResponse|error { - string resourcePath = string `/${getEncodedUri(listId)}/update-list-filters`; + # + return - No content + remote isolated function deleteListIdMembershipsRemoveAll(string listId, map headers = {}) returns error? { + string resourcePath = string `/${getEncodedUri(listId)}/memberships`; map headerValues = {...headers}; if self.apiKeyConfig is ApiKeysConfig { - headerValues["private-app"] = self.apiKeyConfig?.private\-app; + headerValues["private-app"] = self.apiKeyConfig?.privateApp; } - resourcePath = resourcePath + check getPathForQueryParam(queries); - map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - return self.clientEp->put(resourcePath, request, httpHeaders); + map httpHeaders = http:getHeaderMap(headerValues); + return self.clientEp->delete(resourcePath, headers = httpHeaders); } - # Update List Name + # Remove Records from a List # - # + listId - The **ILS ID** of the list to update. + # + listId - The **ILS ID** of the `MANUAL` or `SNAPSHOT` list # + headers - Headers to be sent with the request - # + queries - Queries to be sent with the request # + return - successful operation - remote isolated function putListidUpdateListName_updatename(string listId, map headers = {}, *PutListidUpdateListName_updatenameQueries queries) returns ListUpdateResponse|error { - string resourcePath = string `/${getEncodedUri(listId)}/update-list-name`; + remote isolated function putListIdMembershipsRemoveRemove(string listId, string[] payload, map headers = {}) returns MembershipsUpdateResponse|error { + string resourcePath = string `/${getEncodedUri(listId)}/memberships/remove`; map headerValues = {...headers}; if self.apiKeyConfig is ApiKeysConfig { - headerValues["private-app"] = self.apiKeyConfig?.private\-app; + headerValues["private-app"] = self.apiKeyConfig?.privateApp; } - resourcePath = resourcePath + check getPathForQueryParam(queries); - map httpHeaders = getMapForHeaders(headerValues); + map httpHeaders = http:getHeaderMap(headerValues); http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); return self.clientEp->put(resourcePath, request, httpHeaders); } } diff --git a/ballerina/types.bal b/ballerina/types.bal index 8316cc4..844585a 100644 --- a/ballerina/types.bal +++ b/ballerina/types.bal @@ -19,28 +19,32 @@ import ballerina/http; +public type PublicAssociationFilterBranchFilters PublicPropertyFilter|PublicAssociationInListFilter|PublicPageViewAnalyticsFilter|PublicCtaAnalyticsFilter|PublicEventAnalyticsFilter|PublicFormSubmissionFilter|PublicFormSubmissionOnPageFilter|PublicIntegrationEventFilter|PublicEmailSubscriptionFilter|PublicCommunicationSubscriptionFilter|PublicCampaignInfluencedFilter|PublicSurveyMonkeyFilter|PublicSurveyMonkeyValueFilter|PublicWebinarFilter|PublicEmailEventFilter|PublicPrivacyAnalyticsFilter|PublicAdsSearchFilter|PublicAdsTimeFilter|PublicInListFilter|PublicNumAssociationsFilter|PublicUnifiedEventsFilter|PublicPropertyAssociationInListFilter|PublicConstantFilter; + public type PublicPropertyAssociationFilterBranch record { - "PROPERTY_ASSOCIATION" filterBranchType; - (PublicOrFilterBranch|PublicAndFilterBranch|PublicNotAllFilterBranch|PublicNotAnyFilterBranch|PublicRestrictedFilterBranch|PublicUnifiedEventsFilterBranch|PublicPropertyAssociationFilterBranch|PublicAssociationFilterBranch)[] filterBranches; + "PROPERTY_ASSOCIATION" filterBranchType = "PROPERTY_ASSOCIATION"; + PublicPropertyAssociationFilterBranchFilterBranches[] filterBranches; string objectTypeId; string filterBranchOperator; - (PublicPropertyFilter|PublicAssociationInListFilter|PublicPageViewAnalyticsFilter|PublicCtaAnalyticsFilter|PublicEventAnalyticsFilter|PublicFormSubmissionFilter|PublicFormSubmissionOnPageFilter|PublicIntegrationEventFilter|PublicEmailSubscriptionFilter|PublicCommunicationSubscriptionFilter|PublicCampaignInfluencedFilter|PublicSurveyMonkeyFilter|PublicSurveyMonkeyValueFilter|PublicWebinarFilter|PublicEmailEventFilter|PublicPrivacyAnalyticsFilter|PublicAdsSearchFilter|PublicAdsTimeFilter|PublicInListFilter|PublicNumAssociationsFilter|PublicUnifiedEventsFilter|PublicPropertyAssociationInListFilter|PublicConstantFilter)[] filters; + PublicPropertyAssociationFilterBranchFilters[] filters; string propertyWithObjectId; string operator; }; public type PublicNumberPropertyOperation record { boolean includeObjectsWithNoValueSet; - "NUMBER" operationType; + "NUMBER" operationType = "NUMBER"; decimal value; string operator; }; +public type PublicUnifiedEventsFilterBranchFilterBranches PublicOrFilterBranch|PublicAndFilterBranch|PublicNotAllFilterBranch|PublicNotAnyFilterBranch|PublicRestrictedFilterBranch|PublicUnifiedEventsFilterBranch|PublicPropertyAssociationFilterBranch|PublicAssociationFilterBranch; + public type PublicYearReference record { int:Signed32 hour?; int:Signed32 month; int:Signed32 millisecond?; - "YEAR" referenceType; + "YEAR" referenceType = "YEAR"; int:Signed32 day; int:Signed32 minute?; int:Signed32 second?; @@ -55,7 +59,7 @@ public type PublicRangedDatePropertyOperation record { boolean includeObjectsWithNoValueSet; int:Signed32 upperBound; boolean requiresTimeZoneConversion; - "RANGED_DATE" operationType; + "RANGED_DATE" operationType = "RANGED_DATE"; int:Signed32 lowerBound; string operator; }; @@ -67,70 +71,50 @@ public type ListFolderFetchResponse record { public type ListSearchRequest record { # 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`. + # If no value is provided, or if an empty list is provided, then the results will not be filtered by `listId` string[] listIds?; - # Value used to paginate through lists. The `offset` provided in the response can be used in the next request to fetch the next page of results. Defaults to `0` if no offset is provided. + # Value used to paginate through lists. The `offset` provided in the response can be used in the next request to fetch the next page of results. Defaults to `0` if no offset is provided int:Signed32 offset?; - # The `query` that will be used to search for lists by list name. If no `query` is provided, then the results will include all lists. + # The `query` that will be used to search for lists by list name. If no `query` is provided, then the results will include all lists string query?; - # The number of lists to include in the response. Defaults to `20` if no value is provided. The max `count` is `500`. + # The number of lists to include in the response. Defaults to `20` if no value is provided. The max `count` is `500` int:Signed32 count?; # The `processingTypes` that will be used to filter results by `processingType`. If values are provided, then the response will only include results that have a `processingType` in this array. # # If no value is provided, or if an empty list is provided, then results will not be filtered by `processingType`. # - # Valid `processingTypes` are: `MANUAL`, `SNAPSHOT`, or `DYNAMIC`. + # Valid `processingTypes` are: `MANUAL`, `SNAPSHOT`, or `DYNAMIC` string[] processingTypes?; # The property names of any additional list properties to include in the response. Properties that do not exist or that are empty for a particular list are not included in the response. # - # By default, all requests will fetch the following properties for each list: `hs_list_size`, `hs_last_record_added_at`, `hs_last_record_removed_at`, `hs_folder_name`, and `hs_list_reference_count`. + # By default, all requests will fetch the following properties for each list: `hs_list_size`, `hs_last_record_added_at`, `hs_last_record_removed_at`, `hs_folder_name`, and `hs_list_reference_count` string[] additionalProperties?; string sort?; }; -# Represents the Queries record for the operation: putFoldersFolderidRename_rename -public type PutFoldersFolderidRename_renameQueries record { - # - string newFolderName?; -}; - public type PublicInListFilter record { string listId; PublicInListFilterMetadata metadata?; - "IN_LIST" filterType; + "IN_LIST" filterType = "IN_LIST"; string operator; }; public type ListSearchResponse record { - # The total number of lists that match the search criteria. + # The total number of lists that match the search criteria int:Signed32 total; - # Value to be passed in a future request to paginate through list search results. + # Value to be passed in a future request to paginate through list search results int:Signed32 offset; - # The lists that matched the search criteria. + # The lists that matched the search criteria PublicObjectListSearchResult[] lists; - # Whether or not there are more results to page through. + # Whether or not there are more results to page through boolean hasMore; }; -# Represents the Queries record for the operation: getListidMembershipsJoinOrder_getpageorderedbyaddedtolistdate -public type GetListidMembershipsJoinOrder_getpageorderedbyaddedtolistdateQueries record { - # The paging offset token for the page that comes `before` the previously requested records. - # - # If provided, then the records in the response will be the records preceding the offset, sorted in *descending* order. - string before?; - # The number of records to return in the response. The maximum `limit` is 250. - int:Signed32 'limit = 100; - # The paging offset token for the page that comes `after` the previously requested records. - # - # If provided, then the records in the response will be the records following the offset, sorted in *ascending* order. Takes precedence over the `before` offset. - string after?; -}; - public type PublicSurveyMonkeyValueFilter record { PublicBoolPropertyOperation|PublicNumberPropertyOperation|PublicStringPropertyOperation|PublicDateTimePropertyOperation|PublicRangedDatePropertyOperation|PublicComparativePropertyUpdatedOperation|PublicComparativeDatePropertyOperation|PublicRollingDateRangePropertyOperation|PublicRollingPropertyUpdatedOperation|PublicEnumerationPropertyOperation|PublicAllPropertyTypesOperation|PublicRangedNumberPropertyOperation|PublicMultiStringPropertyOperation|PublicDatePropertyOperation|PublicCalendarDatePropertyOperation|PublicTimePointOperation|PublicRangedTimeOperation valueComparison; string surveyId; string surveyQuestion; - "SURVEY_MONKEY_VALUE" filterType; + "SURVEY_MONKEY_VALUE" filterType = "SURVEY_MONKEY_VALUE"; string surveyAnswerRowId?; string surveyAnswerColId?; string operator; @@ -139,7 +123,7 @@ public type PublicSurveyMonkeyValueFilter record { public type PublicRelativeComparativeTimestampRefineBy record { string comparison; PublicTimeOffset timeOffset; - "RELATIVE_COMPARATIVE" 'type; + "RELATIVE_COMPARATIVE" 'type = "RELATIVE_COMPARATIVE"; }; public type PublicCommunicationSubscriptionFilter record { @@ -147,63 +131,63 @@ public type PublicCommunicationSubscriptionFilter record { string[] subscriptionIds; string channel; string[] acceptedOptStates; - "COMMUNICATION_SUBSCRIPTION" filterType; + "COMMUNICATION_SUBSCRIPTION" filterType = "COMMUNICATION_SUBSCRIPTION"; string businessUnitId?; }; public type ListsByIdResponse record { - # The object list definitions. + # The object list definitions PublicObjectList[] lists; }; +public type PublicNotAllFilterBranchFilters PublicPropertyFilter|PublicAssociationInListFilter|PublicPageViewAnalyticsFilter|PublicCtaAnalyticsFilter|PublicEventAnalyticsFilter|PublicFormSubmissionFilter|PublicFormSubmissionOnPageFilter|PublicIntegrationEventFilter|PublicEmailSubscriptionFilter|PublicCommunicationSubscriptionFilter|PublicCampaignInfluencedFilter|PublicSurveyMonkeyFilter|PublicSurveyMonkeyValueFilter|PublicWebinarFilter|PublicEmailEventFilter|PublicPrivacyAnalyticsFilter|PublicAdsSearchFilter|PublicAdsTimeFilter|PublicInListFilter|PublicNumAssociationsFilter|PublicUnifiedEventsFilter|PublicPropertyAssociationInListFilter|PublicConstantFilter; + +# Represents the Queries record for the operation: getIdmappingTranslateLegacyListIdToListId +public type GetIdmappingTranslateLegacyListIdToListIdQueries record { + # The legacy list id from lists v1 API + string legacyListId?; +}; + public type PublicObjectListSearchResult record { - # The processing type of the list. + # The processing type of the list string processingType; - # The object type of the list. + # The object type of the list string objectTypeId; - # The ID of the user that last updated the list. + # The ID of the user that last updated the list string updatedById?; - # The time when the filters for this list were last updated. + # The time when the filters for this list were last updated string filtersUpdatedAt?; - # The **ILS ID** of the list. + # The **ILS ID** of the list string listId; - # The time when the list was created. + # The time when the list was created string createdAt?; - # The processing status of the list. + # The processing status of the list string processingStatus; - # The time when the list was deleted. + # The time when the list was deleted string deletedAt?; - # The version of the list. + # The version of the list int:Signed32 listVersion; - # The name of the list. + # The name of the list string name; - # The name and value of any additional properties that exist for this list and that were included in the search request. + # The name and value of any additional properties that exist for this list and that were included in the search request record {|string...;|} additionalProperties; - # The ID of the user that created the list. + # The ID of the user that created the list string createdById?; - # The time the list was last updated. + # The time the list was last updated string updatedAt?; }; -# Represents the Queries record for the operation: getListidMemberships_getpage -public type GetListidMemberships_getpageQueries record { - # The paging offset token for the page that comes `before` the previously requested records. - # - # If provided, then the records in the response will be the records preceding the offset, sorted in *descending* order. - string before?; - # The number of records to return in the response. The maximum `limit` is 250. - int:Signed32 'limit = 100; - # The paging offset token for the page that comes `after` the previously requested records. - # - # If provided, then the records in the response will be the records following the offset, sorted in *ascending* order. Takes precedence over the `before` offset. - string after?; +# Represents the Queries record for the operation: getObjectTypeIdObjectTypeIdNameListNameGetByName +public type GetObjectTypeIdObjectTypeIdNameListNameGetByNameQueries record { + # A flag indicating whether or not the response object list definition should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response + boolean includeFilters = false; }; public type PublicRelativeRangedTimestampRefineBy record { PublicTimeOffset upperBoundOffset; string rangeType; PublicTimeOffset lowerBoundOffset; - "RELATIVE_RANGED" 'type; + "RELATIVE_RANGED" 'type = "RELATIVE_RANGED"; }; # Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint. @@ -214,31 +198,40 @@ public type ConnectionConfig record {| # The HTTP version understood by the client http:HttpVersion httpVersion = http:HTTP_2_0; # Configurations related to HTTP/1.x protocol - ClientHttp1Settings http1Settings?; + http:ClientHttp1Settings http1Settings = {}; # Configurations related to HTTP/2 protocol - http:ClientHttp2Settings http2Settings?; + http:ClientHttp2Settings http2Settings = {}; # The maximum time to wait (in seconds) for a response before closing the connection - decimal timeout = 60; + decimal timeout = 30; # The choice of setting `forwarded`/`x-forwarded` header string forwarded = "disable"; + # Configurations associated with Redirection + http:FollowRedirects followRedirects?; # Configurations associated with request pooling http:PoolConfiguration poolConfig?; # HTTP caching related configurations - http:CacheConfig cache?; + http:CacheConfig cache = {}; # Specifies the way of handling compression (`accept-encoding`) header http:Compression compression = http:COMPRESSION_AUTO; # Configurations associated with the behaviour of the Circuit Breaker http:CircuitBreakerConfig circuitBreaker?; # Configurations associated with retrying http:RetryConfig retryConfig?; + # Configurations associated with cookies + http:CookieConfig cookieConfig?; # Configurations associated with inbound response size limits - http:ResponseLimitConfigs responseLimits?; + http:ResponseLimitConfigs responseLimits = {}; # SSL/TLS-related options http:ClientSecureSocket secureSocket?; # Proxy server related options http:ProxyConfig proxy?; + # Provides settings related to client socket configuration + http:ClientSocketConfig socketConfig = {}; # Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default boolean validation = true; + # Enables relaxed data binding on the client side. When enabled, `nil` values are treated as optional, + # and absent fields are handled as `nilable` types. Enabled by default. + boolean laxDataBinding = true; |}; public type PublicIndexOffset record { @@ -254,10 +247,16 @@ public type PublicIndexOffset record { }; public type PublicNotAllFilterBranch record { - "NOT_ALL" filterBranchType; - (PublicOrFilterBranch|PublicAndFilterBranch|PublicNotAllFilterBranch|PublicNotAnyFilterBranch|PublicRestrictedFilterBranch|PublicUnifiedEventsFilterBranch|PublicPropertyAssociationFilterBranch|PublicAssociationFilterBranch)[] filterBranches; + "NOT_ALL" filterBranchType = "NOT_ALL"; + PublicNotAllFilterBranchFilterBranches[] filterBranches; string filterBranchOperator; - (PublicPropertyFilter|PublicAssociationInListFilter|PublicPageViewAnalyticsFilter|PublicCtaAnalyticsFilter|PublicEventAnalyticsFilter|PublicFormSubmissionFilter|PublicFormSubmissionOnPageFilter|PublicIntegrationEventFilter|PublicEmailSubscriptionFilter|PublicCommunicationSubscriptionFilter|PublicCampaignInfluencedFilter|PublicSurveyMonkeyFilter|PublicSurveyMonkeyValueFilter|PublicWebinarFilter|PublicEmailEventFilter|PublicPrivacyAnalyticsFilter|PublicAdsSearchFilter|PublicAdsTimeFilter|PublicInListFilter|PublicNumAssociationsFilter|PublicUnifiedEventsFilter|PublicPropertyAssociationInListFilter|PublicConstantFilter)[] filters; + PublicNotAllFilterBranchFilters[] filters; +}; + +# Represents the Queries record for the operation: putListIdUpdateListFiltersUpdateListFilters +public type PutListIdUpdateListFiltersUpdateListFiltersQueries record { + # A flag indicating whether or not the memberships added to the list as a result of the filter change should be enrolled in workflows that are relevant to this list + boolean enrollObjectsInWorkflows = false; }; public type PublicBatchMigrationMapping record { @@ -270,14 +269,14 @@ public type PublicFormSubmissionFilter record { string formId?; PublicNumOccurrencesRefineBy|PublicSetOccurrencesRefineBy|PublicRelativeComparativeTimestampRefineBy|PublicRelativeRangedTimestampRefineBy|PublicAbsoluteComparativeTimestampRefineBy|PublicAbsoluteRangedTimestampRefineBy|PublicAllHistoryRefineBy|PublicTimePointOperation|PublicRangedTimeOperation coalescingRefineBy?; PublicNumOccurrencesRefineBy|PublicSetOccurrencesRefineBy|PublicRelativeComparativeTimestampRefineBy|PublicRelativeRangedTimestampRefineBy|PublicAbsoluteComparativeTimestampRefineBy|PublicAbsoluteRangedTimestampRefineBy|PublicAllHistoryRefineBy|PublicTimePointOperation|PublicRangedTimeOperation pruningRefineBy?; - "FORM_SUBMISSION" filterType; + "FORM_SUBMISSION" filterType = "FORM_SUBMISSION"; "FILLED_OUT"|"NOT_FILLED_OUT" operator; }; public type PublicRollingDateRangePropertyOperation record { boolean includeObjectsWithNoValueSet; boolean requiresTimeZoneConversion; - "ROLLING_DATE_RANGE" operationType; + "ROLLING_DATE_RANGE" operationType = "ROLLING_DATE_RANGE"; int:Signed32 numberOfDays; string operator; }; @@ -289,13 +288,13 @@ public type ApiCollectionResponseJoinTimeAndRecordId record { }; public type PublicAssociationFilterBranch record { - "ASSOCIATION" filterBranchType; - (PublicOrFilterBranch|PublicAndFilterBranch|PublicNotAllFilterBranch|PublicNotAnyFilterBranch|PublicRestrictedFilterBranch|PublicUnifiedEventsFilterBranch|PublicPropertyAssociationFilterBranch|PublicAssociationFilterBranch)[] filterBranches; + "ASSOCIATION" filterBranchType = "ASSOCIATION"; + PublicAssociationFilterBranchFilterBranches[] filterBranches; string objectTypeId; string filterBranchOperator; int:Signed32 associationTypeId; string associationCategory; - (PublicPropertyFilter|PublicAssociationInListFilter|PublicPageViewAnalyticsFilter|PublicCtaAnalyticsFilter|PublicEventAnalyticsFilter|PublicFormSubmissionFilter|PublicFormSubmissionOnPageFilter|PublicIntegrationEventFilter|PublicEmailSubscriptionFilter|PublicCommunicationSubscriptionFilter|PublicCampaignInfluencedFilter|PublicSurveyMonkeyFilter|PublicSurveyMonkeyValueFilter|PublicWebinarFilter|PublicEmailEventFilter|PublicPrivacyAnalyticsFilter|PublicAdsSearchFilter|PublicAdsTimeFilter|PublicInListFilter|PublicNumAssociationsFilter|PublicUnifiedEventsFilter|PublicPropertyAssociationInListFilter|PublicConstantFilter)[] filters; + PublicAssociationFilterBranchFilters[] filters; string operator; }; @@ -303,7 +302,7 @@ public type PublicQuarterReference record { int:Signed32 hour?; int:Signed32 month; int:Signed32 millisecond?; - "QUARTER" referenceType; + "QUARTER" referenceType = "QUARTER"; int:Signed32 day; int:Signed32 minute?; int:Signed32 second?; @@ -312,22 +311,24 @@ public type PublicQuarterReference record { public type PublicEnumerationPropertyOperation record { boolean includeObjectsWithNoValueSet; string[] values; - "ENUMERATION" operationType; + "ENUMERATION" operationType = "ENUMERATION"; string operator; }; public type PublicEmailSubscriptionFilter record { string subscriptionType?; string[] subscriptionIds; - "EMAIL_SUBSCRIPTION" filterType; + "EMAIL_SUBSCRIPTION" filterType = "EMAIL_SUBSCRIPTION"; string[] acceptedStatuses; }; +public type PublicUnifiedEventsFilterBranchFilters PublicPropertyFilter|PublicAssociationInListFilter|PublicPageViewAnalyticsFilter|PublicCtaAnalyticsFilter|PublicEventAnalyticsFilter|PublicFormSubmissionFilter|PublicFormSubmissionOnPageFilter|PublicIntegrationEventFilter|PublicEmailSubscriptionFilter|PublicCommunicationSubscriptionFilter|PublicCampaignInfluencedFilter|PublicSurveyMonkeyFilter|PublicSurveyMonkeyValueFilter|PublicWebinarFilter|PublicEmailEventFilter|PublicPrivacyAnalyticsFilter|PublicAdsSearchFilter|PublicAdsTimeFilter|PublicInListFilter|PublicNumAssociationsFilter|PublicUnifiedEventsFilter|PublicPropertyAssociationInListFilter|PublicConstantFilter; + public type PublicTimePointOperation record { string endpointBehavior?; boolean includeObjectsWithNoValueSet; string propertyParser?; - "TIME_POINT" operationType; + "TIME_POINT" operationType = "TIME_POINT"; PublicDatePoint|PublicIndexedTimePoint|PublicPropertyReferencedTime timePoint; string 'type; string operator; @@ -339,11 +340,11 @@ public type ListFolderCreateResponse record { # Provides API key configurations needed when communicating with a remote HTTP endpoint. public type ApiKeysConfig record {| - string private\-app; + string privateApp; |}; public type PublicAllHistoryRefineBy record { - "ALL_HISTORY" 'type; + "ALL_HISTORY" 'type = "ALL_HISTORY"; }; public type ListUpdateResponse record { @@ -351,27 +352,45 @@ public type ListUpdateResponse record { }; public type PublicNotAnyFilterBranch record { - "NOT_ANY" filterBranchType; - (PublicOrFilterBranch|PublicAndFilterBranch|PublicNotAllFilterBranch|PublicNotAnyFilterBranch|PublicRestrictedFilterBranch|PublicUnifiedEventsFilterBranch|PublicPropertyAssociationFilterBranch|PublicAssociationFilterBranch)[] filterBranches; + "NOT_ANY" filterBranchType = "NOT_ANY"; + PublicNotAnyFilterBranchFilterBranches[] filterBranches; string filterBranchOperator; - (PublicPropertyFilter|PublicAssociationInListFilter|PublicPageViewAnalyticsFilter|PublicCtaAnalyticsFilter|PublicEventAnalyticsFilter|PublicFormSubmissionFilter|PublicFormSubmissionOnPageFilter|PublicIntegrationEventFilter|PublicEmailSubscriptionFilter|PublicCommunicationSubscriptionFilter|PublicCampaignInfluencedFilter|PublicSurveyMonkeyFilter|PublicSurveyMonkeyValueFilter|PublicWebinarFilter|PublicEmailEventFilter|PublicPrivacyAnalyticsFilter|PublicAdsSearchFilter|PublicAdsTimeFilter|PublicInListFilter|PublicNumAssociationsFilter|PublicUnifiedEventsFilter|PublicPropertyAssociationInListFilter|PublicConstantFilter)[] filters; + PublicNotAnyFilterBranchFilters[] filters; }; public type PublicIndexedTimePoint record { PublicIndexOffset offset?; string timezoneSource?; PublicNowReference|PublicTodayReference|PublicWeekReference|PublicFiscalQuarterReference|PublicFiscalYearReference|PublicYearReference|PublicQuarterReference|PublicMonthReference indexReference; - "INDEXED" timeType; + "INDEXED" timeType = "INDEXED"; string zoneId; }; +public type PublicOrFilterBranchFilterBranches PublicOrFilterBranch|PublicAndFilterBranch|PublicNotAllFilterBranch|PublicNotAnyFilterBranch|PublicRestrictedFilterBranch|PublicUnifiedEventsFilterBranch|PublicPropertyAssociationFilterBranch|PublicAssociationFilterBranch; + +public type PublicRestrictedFilterBranchFilters PublicPropertyFilter|PublicAssociationInListFilter|PublicPageViewAnalyticsFilter|PublicCtaAnalyticsFilter|PublicEventAnalyticsFilter|PublicFormSubmissionFilter|PublicFormSubmissionOnPageFilter|PublicIntegrationEventFilter|PublicEmailSubscriptionFilter|PublicCommunicationSubscriptionFilter|PublicCampaignInfluencedFilter|PublicSurveyMonkeyFilter|PublicSurveyMonkeyValueFilter|PublicWebinarFilter|PublicEmailEventFilter|PublicPrivacyAnalyticsFilter|PublicAdsSearchFilter|PublicAdsTimeFilter|PublicInListFilter|PublicNumAssociationsFilter|PublicUnifiedEventsFilter|PublicPropertyAssociationInListFilter|PublicConstantFilter; + +# Represents the Queries record for the operation: getListIdMembershipsJoinOrderGetPageOrderedByAddedToListDate +public type GetListIdMembershipsJoinOrderGetPageOrderedByAddedToListDateQueries record { + # The paging offset token for the page that comes `before` the previously requested records. + # + # If provided, then the records in the response will be the records preceding the offset, sorted in *descending* order + string before?; + # The number of records to return in the response. The maximum `limit` is 250 + int:Signed32 'limit = 100; + # The paging offset token for the page that comes `after` the previously requested records. + # + # If provided, then the records in the response will be the records following the offset, sorted in *ascending* order. Takes precedence over the `before` offset + string after?; +}; + public type PublicRangedTimeOperation record { string upperBoundEndpointBehavior?; boolean includeObjectsWithNoValueSet; PublicDatePoint|PublicIndexedTimePoint|PublicPropertyReferencedTime upperBoundTimePoint; string propertyParser?; string operationType; - "TIME_RANGED" 'type; + "TIME_RANGED" 'type = "TIME_RANGED"; string lowerBoundEndpointBehavior?; string operator; PublicDatePoint|PublicIndexedTimePoint|PublicPropertyReferencedTime lowerBoundTimePoint; @@ -379,15 +398,15 @@ public type PublicRangedTimeOperation record { public type PublicWebinarFilter record { string webinarId?; - "WEBINAR" filterType; + "WEBINAR" filterType = "WEBINAR"; string operator; }; public type MembershipsUpdateResponse record { - # The IDs of the records that were `removed` from the list. + # The IDs of the records that were `removed` from the list string[] recordIdsRemoved?; string[] recordsIdsAdded?; - # The IDs of the records that were `missing` (e.g. did not exist in the portal) and so were not `added` or `removed`. + # The IDs of the records that were `missing` (e.g. did not exist in the portal) and so were not `added` or `removed` string[] recordIdsMissing?; }; @@ -396,47 +415,47 @@ public type ListCreateResponse record { }; public type PublicUnifiedEventsFilterBranch record { - "UNIFIED_EVENTS" filterBranchType; - (PublicOrFilterBranch|PublicAndFilterBranch|PublicNotAllFilterBranch|PublicNotAnyFilterBranch|PublicRestrictedFilterBranch|PublicUnifiedEventsFilterBranch|PublicPropertyAssociationFilterBranch|PublicAssociationFilterBranch)[] filterBranches; + "UNIFIED_EVENTS" filterBranchType = "UNIFIED_EVENTS"; + PublicUnifiedEventsFilterBranchFilterBranches[] filterBranches; string eventTypeId; PublicNumOccurrencesRefineBy|PublicSetOccurrencesRefineBy|PublicRelativeComparativeTimestampRefineBy|PublicRelativeRangedTimestampRefineBy|PublicAbsoluteComparativeTimestampRefineBy|PublicAbsoluteRangedTimestampRefineBy|PublicAllHistoryRefineBy|PublicTimePointOperation|PublicRangedTimeOperation coalescingRefineBy?; string filterBranchOperator; - (PublicPropertyFilter|PublicAssociationInListFilter|PublicPageViewAnalyticsFilter|PublicCtaAnalyticsFilter|PublicEventAnalyticsFilter|PublicFormSubmissionFilter|PublicFormSubmissionOnPageFilter|PublicIntegrationEventFilter|PublicEmailSubscriptionFilter|PublicCommunicationSubscriptionFilter|PublicCampaignInfluencedFilter|PublicSurveyMonkeyFilter|PublicSurveyMonkeyValueFilter|PublicWebinarFilter|PublicEmailEventFilter|PublicPrivacyAnalyticsFilter|PublicAdsSearchFilter|PublicAdsTimeFilter|PublicInListFilter|PublicNumAssociationsFilter|PublicUnifiedEventsFilter|PublicPropertyAssociationInListFilter|PublicConstantFilter)[] filters; + PublicUnifiedEventsFilterBranchFilters[] filters; "HAS_COMPLETED"|"HAS_NOT_COMPLETED" operator; }; public type PublicNumOccurrencesRefineBy record { int:Signed32 maxOccurrences?; - "NUM_OCCURRENCES" 'type; + "NUM_OCCURRENCES" 'type = "NUM_OCCURRENCES"; int:Signed32 minOccurrences?; }; public type PublicObjectList record { - # The processing type of the list. + # The processing type of the list string processingType; - # The object type of the list. + # The object type of the list string objectTypeId; - # The ID of the user that last updated the list. + # The ID of the user that last updated the list string updatedById?; - # The time when the filters for this list were last updated. + # The time when the filters for this list were last updated string filtersUpdatedAt?; - # The **ILS ID** of the list. + # The **ILS ID** of the list string listId; - # The time when the list was created. + # The time when the list was created string createdAt?; - # The processing status of the list. + # The processing status of the list string processingStatus; - # The time when the list was deleted. + # The time when the list was deleted string deletedAt?; - # The version of the list. + # The version of the list int:Signed32 listVersion; int size?; - # The name of the list. + # The name of the list string name; - # The ID of the user that created the list. + # The ID of the user that created the list string createdById?; PublicOrFilterBranch|PublicAndFilterBranch|PublicNotAllFilterBranch|PublicNotAnyFilterBranch|PublicRestrictedFilterBranch|PublicUnifiedEventsFilterBranch|PublicPropertyAssociationFilterBranch|PublicAssociationFilterBranch filterBranch?; - # The time the list was last updated. + # The time the list was last updated string updatedAt?; }; @@ -450,50 +469,66 @@ public type RecordListMembership record { public type PublicCtaAnalyticsFilter record { PublicNumOccurrencesRefineBy|PublicSetOccurrencesRefineBy|PublicRelativeComparativeTimestampRefineBy|PublicRelativeRangedTimestampRefineBy|PublicAbsoluteComparativeTimestampRefineBy|PublicAbsoluteRangedTimestampRefineBy|PublicAllHistoryRefineBy|PublicTimePointOperation|PublicRangedTimeOperation coalescingRefineBy?; PublicNumOccurrencesRefineBy|PublicSetOccurrencesRefineBy|PublicRelativeComparativeTimestampRefineBy|PublicRelativeRangedTimestampRefineBy|PublicAbsoluteComparativeTimestampRefineBy|PublicAbsoluteRangedTimestampRefineBy|PublicAllHistoryRefineBy|PublicTimePointOperation|PublicRangedTimeOperation pruningRefineBy?; - "CTA" filterType; + "CTA" filterType = "CTA"; string ctaName; string operator; }; +# Represents the Queries record for the operation: getListIdMembershipsGetPage +public type GetListIdMembershipsGetPageQueries record { + # The paging offset token for the page that comes `before` the previously requested records. + # + # If provided, then the records in the response will be the records preceding the offset, sorted in *descending* order + string before?; + # The number of records to return in the response. The maximum `limit` is 250 + int:Signed32 'limit = 100; + # The paging offset token for the page that comes `after` the previously requested records. + # + # If provided, then the records in the response will be the records following the offset, sorted in *ascending* order. Takes precedence over the `before` offset + string after?; +}; + public type ListFetchResponse record { PublicObjectList list; }; public type PublicSetOccurrencesRefineBy record { - "SET_OCCURRENCES" 'type; + "SET_OCCURRENCES" 'type = "SET_OCCURRENCES"; string setType; }; public type PublicConstantFilter record { boolean shouldAccept; string 'source?; - "CONSTANT" filterType; + "CONSTANT" filterType = "CONSTANT"; }; +public type PublicNotAnyFilterBranchFilters PublicPropertyFilter|PublicAssociationInListFilter|PublicPageViewAnalyticsFilter|PublicCtaAnalyticsFilter|PublicEventAnalyticsFilter|PublicFormSubmissionFilter|PublicFormSubmissionOnPageFilter|PublicIntegrationEventFilter|PublicEmailSubscriptionFilter|PublicCommunicationSubscriptionFilter|PublicCampaignInfluencedFilter|PublicSurveyMonkeyFilter|PublicSurveyMonkeyValueFilter|PublicWebinarFilter|PublicEmailEventFilter|PublicPrivacyAnalyticsFilter|PublicAdsSearchFilter|PublicAdsTimeFilter|PublicInListFilter|PublicNumAssociationsFilter|PublicUnifiedEventsFilter|PublicPropertyAssociationInListFilter|PublicConstantFilter; + public type PublicListFolder record { - # The time the folder was created at. + # The time the folder was created at string createdAt?; - # The Id of the folder this folder is in, the root folder is represented as 0. + # The Id of the folder this folder is in, the root folder is represented as 0 int:Signed32 parentFolderId; PublicListFolder[] childNodes; - # The name of the folder. + # The name of the folder string name?; - # The Id of the folder. + # The Id of the folder int:Signed32 id; - # An array of list Id's contained in this folder. + # An array of list Id's contained in this folder int:Signed32[] childLists; - # The time that the contents of the folder was last updated at. + # The time that the contents of the folder was last updated at string updatedContentsAt?; - # The user Id of the owner of the folder. + # The user Id of the owner of the folder int:Signed32 userId?; - # The time the folder was last updated at. + # The time the folder was last updated at string updatedAt?; }; public type PublicComparativeDatePropertyOperation record { boolean includeObjectsWithNoValueSet; string defaultComparisonValue?; - "COMPARATIVE_DATE" operationType; + "COMPARATIVE_DATE" operationType = "COMPARATIVE_DATE"; string comparisonPropertyName; string operator; }; @@ -506,7 +541,7 @@ public type ApiCollectionResponseRecordListMembershipNoPaging record { public type PublicRangedNumberPropertyOperation record { boolean includeObjectsWithNoValueSet; int:Signed32 upperBound; - "NUMBER_RANGED" operationType; + "NUMBER_RANGED" operationType = "NUMBER_RANGED"; int:Signed32 lowerBound; string operator; }; @@ -516,14 +551,16 @@ public type PublicPageViewAnalyticsFilter record { boolean enableTracking?; PublicNumOccurrencesRefineBy|PublicSetOccurrencesRefineBy|PublicRelativeComparativeTimestampRefineBy|PublicRelativeRangedTimestampRefineBy|PublicAbsoluteComparativeTimestampRefineBy|PublicAbsoluteRangedTimestampRefineBy|PublicAllHistoryRefineBy|PublicTimePointOperation|PublicRangedTimeOperation pruningRefineBy?; string pageUrl; - "PAGE_VIEW" filterType; + "PAGE_VIEW" filterType = "PAGE_VIEW"; string operator; }; +public type PublicAndFilterBranchFilters PublicPropertyFilter|PublicAssociationInListFilter|PublicPageViewAnalyticsFilter|PublicCtaAnalyticsFilter|PublicEventAnalyticsFilter|PublicFormSubmissionFilter|PublicFormSubmissionOnPageFilter|PublicIntegrationEventFilter|PublicEmailSubscriptionFilter|PublicCommunicationSubscriptionFilter|PublicCampaignInfluencedFilter|PublicSurveyMonkeyFilter|PublicSurveyMonkeyValueFilter|PublicWebinarFilter|PublicEmailEventFilter|PublicPrivacyAnalyticsFilter|PublicAdsSearchFilter|PublicAdsTimeFilter|PublicInListFilter|PublicNumAssociationsFilter|PublicUnifiedEventsFilter|PublicPropertyAssociationInListFilter|PublicConstantFilter; + public type PublicComparativePropertyUpdatedOperation record { boolean includeObjectsWithNoValueSet; string defaultComparisonValue?; - "COMPARATIVE_PROPERTY_UPDATED" operationType; + "COMPARATIVE_PROPERTY_UPDATED" operationType = "COMPARATIVE_PROPERTY_UPDATED"; string comparisonPropertyName; string operator; }; @@ -535,57 +572,37 @@ public type MembershipChangeRequest record { string[] recordIdsToAdd; }; -# Provides settings related to HTTP/1.x protocol. -public type ClientHttp1Settings record {| - # Specifies whether to reuse a connection for multiple requests - http:KeepAlive keepAlive = http:KEEPALIVE_AUTO; - # The chunking behaviour of the request - http:Chunking chunking = http:CHUNKING_AUTO; - # Proxy server related options - ProxyConfig proxy?; -|}; - public type PublicIntegrationEventFilter record { int:Signed32 eventTypeId; PublicEventFilterMetadata[] filterLines; - "INTEGRATION_EVENT" filterType; + "INTEGRATION_EVENT" filterType = "INTEGRATION_EVENT"; }; public type PublicAndFilterBranch record { - "AND" filterBranchType; - (PublicOrFilterBranch|PublicAndFilterBranch|PublicNotAllFilterBranch|PublicNotAnyFilterBranch|PublicRestrictedFilterBranch|PublicUnifiedEventsFilterBranch|PublicPropertyAssociationFilterBranch|PublicAssociationFilterBranch)[] filterBranches; + "AND" filterBranchType = "AND"; + PublicAndFilterBranchFilterBranches[] filterBranches; string filterBranchOperator; - (PublicPropertyFilter|PublicAssociationInListFilter|PublicPageViewAnalyticsFilter|PublicCtaAnalyticsFilter|PublicEventAnalyticsFilter|PublicFormSubmissionFilter|PublicFormSubmissionOnPageFilter|PublicIntegrationEventFilter|PublicEmailSubscriptionFilter|PublicCommunicationSubscriptionFilter|PublicCampaignInfluencedFilter|PublicSurveyMonkeyFilter|PublicSurveyMonkeyValueFilter|PublicWebinarFilter|PublicEmailEventFilter|PublicPrivacyAnalyticsFilter|PublicAdsSearchFilter|PublicAdsTimeFilter|PublicInListFilter|PublicNumAssociationsFilter|PublicUnifiedEventsFilter|PublicPropertyAssociationInListFilter|PublicConstantFilter)[] filters; + PublicAndFilterBranchFilters[] filters; }; public type PreviousPage record { - # The offset of the previous page of records. + # The offset of the previous page of records string before; - # A direct link to the request for the previous page of records. + # A direct link to the request for the previous page of records string link?; }; -# Represents the Queries record for the operation: getFolders_getall -public type GetFolders_getallQueries record { - # The Id of the folder to retrieve. - string folderId = "0"; -}; - -# Represents the Queries record for the operation: getListid_getbyid -public type GetListid_getbyidQueries record { - # A flag indicating whether or not the response object list definition should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response. - boolean includeFilters = false; -}; +public type PublicPropertyAssociationFilterBranchFilters PublicPropertyFilter|PublicAssociationInListFilter|PublicPageViewAnalyticsFilter|PublicCtaAnalyticsFilter|PublicEventAnalyticsFilter|PublicFormSubmissionFilter|PublicFormSubmissionOnPageFilter|PublicIntegrationEventFilter|PublicEmailSubscriptionFilter|PublicCommunicationSubscriptionFilter|PublicCampaignInfluencedFilter|PublicSurveyMonkeyFilter|PublicSurveyMonkeyValueFilter|PublicWebinarFilter|PublicEmailEventFilter|PublicPrivacyAnalyticsFilter|PublicAdsSearchFilter|PublicAdsTimeFilter|PublicInListFilter|PublicNumAssociationsFilter|PublicUnifiedEventsFilter|PublicPropertyAssociationInListFilter|PublicConstantFilter; public type PublicAbsoluteComparativeTimestampRefineBy record { string comparison; - "ABSOLUTE_COMPARATIVE" 'type; + "ABSOLUTE_COMPARATIVE" 'type = "ABSOLUTE_COMPARATIVE"; int timestamp; }; public type PublicSurveyMonkeyFilter record { string surveyId; - "SURVEY_MONKEY" filterType; + "SURVEY_MONKEY" filterType = "SURVEY_MONKEY"; string operator; }; @@ -593,22 +610,14 @@ public type PublicAbsoluteRangedTimestampRefineBy record { string rangeType; int upperTimestamp; int lowerTimestamp; - "ABSOLUTE_RANGED" 'type; -}; - -# Represents the Queries record for the operation: putListidUpdateListName_updatename -public type PutListidUpdateListName_updatenameQueries record { - # The name to update the list to. - string listName?; - # A flag indicating whether or not the response object list definition should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response. - boolean includeFilters = false; + "ABSOLUTE_RANGED" 'type = "ABSOLUTE_RANGED"; }; public type PublicDatePropertyOperation record { boolean includeObjectsWithNoValueSet; string month; int:Signed32 year; - "DATE" operationType; + "DATE" operationType = "DATE"; int:Signed32 day; string operator; }; @@ -617,7 +626,7 @@ public type PublicEventAnalyticsFilter record { string eventId; PublicNumOccurrencesRefineBy|PublicSetOccurrencesRefineBy|PublicRelativeComparativeTimestampRefineBy|PublicRelativeRangedTimestampRefineBy|PublicAbsoluteComparativeTimestampRefineBy|PublicAbsoluteRangedTimestampRefineBy|PublicAllHistoryRefineBy|PublicTimePointOperation|PublicRangedTimeOperation coalescingRefineBy?; PublicNumOccurrencesRefineBy|PublicSetOccurrencesRefineBy|PublicRelativeComparativeTimestampRefineBy|PublicRelativeRangedTimestampRefineBy|PublicAbsoluteComparativeTimestampRefineBy|PublicAbsoluteRangedTimestampRefineBy|PublicAllHistoryRefineBy|PublicTimePointOperation|PublicRangedTimeOperation pruningRefineBy?; - "EVENT" filterType; + "EVENT" filterType = "EVENT"; string operator; }; @@ -626,14 +635,14 @@ public type PublicUnifiedEventsFilter record { string eventTypeId?; PublicEventFilterMetadata[] filterLines; PublicNumOccurrencesRefineBy|PublicSetOccurrencesRefineBy|PublicRelativeComparativeTimestampRefineBy|PublicRelativeRangedTimestampRefineBy|PublicAbsoluteComparativeTimestampRefineBy|PublicAbsoluteRangedTimestampRefineBy|PublicAllHistoryRefineBy|PublicTimePointOperation|PublicRangedTimeOperation pruningRefineBy?; - "UNIFIED_EVENTS" filterType; + "UNIFIED_EVENTS" filterType = "UNIFIED_EVENTS"; }; public type PublicFiscalYearReference record { int:Signed32 hour?; int:Signed32 month; int:Signed32 millisecond?; - "FISCAL_YEAR" referenceType; + "FISCAL_YEAR" referenceType = "FISCAL_YEAR"; int:Signed32 day; int:Signed32 minute?; int:Signed32 second?; @@ -643,21 +652,17 @@ public type PublicCalendarDatePropertyOperation record { boolean useFiscalYear?; "JANUARY"|"FEBRUARY"|"MARCH"|"APRIL"|"MAY"|"JUNE"|"JULY"|"AUGUST"|"SEPTEMBER"|"OCTOBER"|"NOVEMBER"|"DECEMBER" fiscalYearStart?; boolean includeObjectsWithNoValueSet; - "CALENDAR_DATE" operationType; + "CALENDAR_DATE" operationType = "CALENDAR_DATE"; int:Signed32 timeUnitCount?; string operator; string timeUnit; }; -# Represents the Queries record for the operation: getObjectTypeIdObjecttypeidNameListname_getbyname -public type GetObjectTypeIdObjecttypeidNameListname_getbynameQueries record { - # A flag indicating whether or not the response object list definition should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response. - boolean includeFilters = false; -}; +public type PublicOrFilterBranchFilters PublicPropertyFilter|PublicAssociationInListFilter|PublicPageViewAnalyticsFilter|PublicCtaAnalyticsFilter|PublicEventAnalyticsFilter|PublicFormSubmissionFilter|PublicFormSubmissionOnPageFilter|PublicIntegrationEventFilter|PublicEmailSubscriptionFilter|PublicCommunicationSubscriptionFilter|PublicCampaignInfluencedFilter|PublicSurveyMonkeyFilter|PublicSurveyMonkeyValueFilter|PublicWebinarFilter|PublicEmailEventFilter|PublicPrivacyAnalyticsFilter|PublicAdsSearchFilter|PublicAdsTimeFilter|PublicInListFilter|PublicNumAssociationsFilter|PublicUnifiedEventsFilter|PublicPropertyAssociationInListFilter|PublicConstantFilter; public type PublicPropertyFilter record { string property; - "PROPERTY" filterType; + "PROPERTY" filterType = "PROPERTY"; PublicBoolPropertyOperation|PublicNumberPropertyOperation|PublicStringPropertyOperation|PublicDateTimePropertyOperation|PublicRangedDatePropertyOperation|PublicComparativePropertyUpdatedOperation|PublicComparativeDatePropertyOperation|PublicRollingDateRangePropertyOperation|PublicRollingPropertyUpdatedOperation|PublicEnumerationPropertyOperation|PublicAllPropertyTypesOperation|PublicRangedNumberPropertyOperation|PublicMultiStringPropertyOperation|PublicDatePropertyOperation|PublicCalendarDatePropertyOperation|PublicTimePointOperation|PublicRangedTimeOperation operation; }; @@ -665,7 +670,7 @@ public type PublicNumAssociationsFilter record { PublicNumOccurrencesRefineBy|PublicSetOccurrencesRefineBy|PublicRelativeComparativeTimestampRefineBy|PublicRelativeRangedTimestampRefineBy|PublicAbsoluteComparativeTimestampRefineBy|PublicAbsoluteRangedTimestampRefineBy|PublicAllHistoryRefineBy|PublicTimePointOperation|PublicRangedTimeOperation coalescingRefineBy; int:Signed32 associationTypeId; string associationCategory; - "NUM_ASSOCIATIONS" filterType; + "NUM_ASSOCIATIONS" filterType = "NUM_ASSOCIATIONS"; }; public type PublicAssociationInListFilter record { @@ -674,45 +679,67 @@ public type PublicAssociationInListFilter record { string toObjectType?; int:Signed32 associationTypeId; string associationCategory; - "ASSOCIATION" filterType; + "ASSOCIATION" filterType = "ASSOCIATION"; string toObjectTypeId?; string operator; }; +public type PublicRestrictedFilterBranchFilterBranches PublicOrFilterBranch|PublicAndFilterBranch|PublicNotAllFilterBranch|PublicNotAnyFilterBranch|PublicRestrictedFilterBranch|PublicUnifiedEventsFilterBranch|PublicPropertyAssociationFilterBranch|PublicAssociationFilterBranch; + +# Represents the Queries record for the operation: putListIdUpdateListNameUpdateName +public type PutListIdUpdateListNameUpdateNameQueries record { + # The name to update the list to + string listName?; + # A flag indicating whether or not the response object list definition should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response + boolean includeFilters = false; +}; + public type PublicEmailEventFilter record { string clickUrl?; string level; PublicNumOccurrencesRefineBy|PublicSetOccurrencesRefineBy|PublicRelativeComparativeTimestampRefineBy|PublicRelativeRangedTimestampRefineBy|PublicAbsoluteComparativeTimestampRefineBy|PublicAbsoluteRangedTimestampRefineBy|PublicAllHistoryRefineBy|PublicTimePointOperation|PublicRangedTimeOperation pruningRefineBy?; string appId; string emailId; - "EMAIL_EVENT" filterType; + "EMAIL_EVENT" filterType = "EMAIL_EVENT"; "LINK_CLICKED"|"MARKED_SPAM"|"OPENED"|"OPENED_BUT_LINK_NOT_CLICKED"|"OPENED_BUT_NOT_REPLIED"|"REPLIED"|"UNSUBSCRIBED"|"BOUNCED"|"RECEIVED"|"RECEIVED_BUT_NOT_OPENED"|"SENT"|"SENT_BUT_LINK_NOT_CLICKED"|"SENT_BUT_NOT_RECEIVED" operator; }; public type PublicOrFilterBranch record { - "OR" filterBranchType; - (PublicOrFilterBranch|PublicAndFilterBranch|PublicNotAllFilterBranch|PublicNotAnyFilterBranch|PublicRestrictedFilterBranch|PublicUnifiedEventsFilterBranch|PublicPropertyAssociationFilterBranch|PublicAssociationFilterBranch)[] filterBranches; + "OR" filterBranchType = "OR"; + PublicOrFilterBranchFilterBranches[] filterBranches; string filterBranchOperator; - (PublicPropertyFilter|PublicAssociationInListFilter|PublicPageViewAnalyticsFilter|PublicCtaAnalyticsFilter|PublicEventAnalyticsFilter|PublicFormSubmissionFilter|PublicFormSubmissionOnPageFilter|PublicIntegrationEventFilter|PublicEmailSubscriptionFilter|PublicCommunicationSubscriptionFilter|PublicCampaignInfluencedFilter|PublicSurveyMonkeyFilter|PublicSurveyMonkeyValueFilter|PublicWebinarFilter|PublicEmailEventFilter|PublicPrivacyAnalyticsFilter|PublicAdsSearchFilter|PublicAdsTimeFilter|PublicInListFilter|PublicNumAssociationsFilter|PublicUnifiedEventsFilter|PublicPropertyAssociationInListFilter|PublicConstantFilter)[] filters; + PublicOrFilterBranchFilters[] filters; }; public type PublicFormSubmissionOnPageFilter record { string formId?; PublicNumOccurrencesRefineBy|PublicSetOccurrencesRefineBy|PublicRelativeComparativeTimestampRefineBy|PublicRelativeRangedTimestampRefineBy|PublicAbsoluteComparativeTimestampRefineBy|PublicAbsoluteRangedTimestampRefineBy|PublicAllHistoryRefineBy|PublicTimePointOperation|PublicRangedTimeOperation coalescingRefineBy?; PublicNumOccurrencesRefineBy|PublicSetOccurrencesRefineBy|PublicRelativeComparativeTimestampRefineBy|PublicRelativeRangedTimestampRefineBy|PublicAbsoluteComparativeTimestampRefineBy|PublicAbsoluteRangedTimestampRefineBy|PublicAllHistoryRefineBy|PublicTimePointOperation|PublicRangedTimeOperation pruningRefineBy?; - "FORM_SUBMISSION_ON_PAGE" filterType; + "FORM_SUBMISSION_ON_PAGE" filterType = "FORM_SUBMISSION_ON_PAGE"; string pageId; "FILLED_OUT"|"NOT_FILLED_OUT" operator; }; public type PublicAdsTimeFilter record { PublicNumOccurrencesRefineBy|PublicSetOccurrencesRefineBy|PublicRelativeComparativeTimestampRefineBy|PublicRelativeRangedTimestampRefineBy|PublicAbsoluteComparativeTimestampRefineBy|PublicAbsoluteRangedTimestampRefineBy|PublicAllHistoryRefineBy|PublicTimePointOperation|PublicRangedTimeOperation pruningRefineBy; - "ADS_TIME" filterType; + "ADS_TIME" filterType = "ADS_TIME"; +}; + +# Represents the Queries record for the operation: getFoldersGetAll +public type GetFoldersGetAllQueries record { + # The Id of the folder to retrieve + string folderId = "0"; +}; + +# Represents the Queries record for the operation: getListIdGetById +public type GetListIdGetByIdQueries record { + # A flag indicating whether or not the response object list definition should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response + boolean includeFilters = false; }; public type PublicStringPropertyOperation record { boolean includeObjectsWithNoValueSet; - "STRING" operationType; + "STRING" operationType = "STRING"; string value; string operator; }; @@ -721,7 +748,7 @@ public type PublicPropertyAssociationInListFilter record { string listId; PublicNumOccurrencesRefineBy|PublicSetOccurrencesRefineBy|PublicRelativeComparativeTimestampRefineBy|PublicRelativeRangedTimestampRefineBy|PublicAbsoluteComparativeTimestampRefineBy|PublicAbsoluteRangedTimestampRefineBy|PublicAllHistoryRefineBy|PublicTimePointOperation|PublicRangedTimeOperation coalescingRefineBy; string propertyWithObjectId; - "PROPERTY_ASSOCIATION" filterType; + "PROPERTY_ASSOCIATION" filterType = "PROPERTY_ASSOCIATION"; string toObjectTypeId?; string operator; }; @@ -729,7 +756,7 @@ public type PublicPropertyAssociationInListFilter record { public type PublicPropertyReferencedTime record { string timezoneSource?; string property; - "PROPERTY_REFERENCED" timeType; + "PROPERTY_REFERENCED" timeType = "PROPERTY_REFERENCED"; string zoneId; string referenceType; }; @@ -741,10 +768,12 @@ public type Paging record { public type PublicPrivacyAnalyticsFilter record { string privacyName; - "PRIVACY" filterType; + "PRIVACY" filterType = "PRIVACY"; string operator; }; +public type PublicNotAnyFilterBranchFilterBranches PublicOrFilterBranch|PublicAndFilterBranch|PublicNotAllFilterBranch|PublicNotAnyFilterBranch|PublicRestrictedFilterBranch|PublicUnifiedEventsFilterBranch|PublicPropertyAssociationFilterBranch|PublicAssociationFilterBranch; + public type ListFilterUpdateRequest record { PublicOrFilterBranch|PublicAndFilterBranch|PublicNotAllFilterBranch|PublicNotAnyFilterBranch|PublicRestrictedFilterBranch|PublicUnifiedEventsFilterBranch|PublicPropertyAssociationFilterBranch|PublicAssociationFilterBranch filterBranch; }; @@ -752,7 +781,7 @@ public type ListFilterUpdateRequest record { public type PublicMultiStringPropertyOperation record { boolean includeObjectsWithNoValueSet; string[] values; - "MULTISTRING" operationType; + "MULTISTRING" operationType = "MULTISTRING"; string operator; }; @@ -760,7 +789,7 @@ public type PublicWeekReference record { "MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY"|"SUNDAY" dayOfWeek; int:Signed32 hour?; int:Signed32 millisecond?; - "WEEK" referenceType; + "WEEK" referenceType = "WEEK"; int:Signed32 minute?; int:Signed32 second?; }; @@ -768,7 +797,7 @@ public type PublicWeekReference record { public type PublicTodayReference record { int:Signed32 hour?; int:Signed32 millisecond?; - "TODAY" referenceType; + "TODAY" referenceType = "TODAY"; int:Signed32 minute?; int:Signed32 second?; }; @@ -778,22 +807,36 @@ public type PublicAdsSearchFilter record { string entityType; string adNetwork; string searchTermType; - "ADS_SEARCH" filterType; + "ADS_SEARCH" filterType = "ADS_SEARCH"; string operator; }; +# Represents the Queries record for the operation: putFoldersFolderIdRenameRename +public type PutFoldersFolderIdRenameRenameQueries record { + # + string newFolderName?; +}; + +# Represents the Queries record for the operation: getGetAll +public type GetGetAllQueries record { + # The **ILS IDs** of the lists to fetch + string[] listIds?; + # A flag indicating whether or not the response object list definitions should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response + boolean includeFilters = false; +}; + public type PublicNowReference record { int:Signed32 hour?; int:Signed32 millisecond?; - "NOW" referenceType; + "NOW" referenceType = "NOW"; int:Signed32 minute?; int:Signed32 second?; }; public type ListFolderCreateRequest record { - # The folder this should be created in, if not specified will be created in the root folder 0. + # The folder this should be created in, if not specified will be created in the root folder 0 string parentFolderId?; - # The name of the folder to be created. + # The name of the folder to be created string name; }; @@ -802,35 +845,23 @@ public type JoinTimeAndRecordId record { string membershipTimestamp; }; -# Represents the Queries record for the operation: getIdmapping_translatelegacylistidtolistid -public type GetIdmapping_translatelegacylistidtolistidQueries record { - # The legacy list id from lists v1 API. - string legacyListId?; -}; - public type PublicRestrictedFilterBranch record { - "RESTRICTED" filterBranchType; - (PublicOrFilterBranch|PublicAndFilterBranch|PublicNotAllFilterBranch|PublicNotAnyFilterBranch|PublicRestrictedFilterBranch|PublicUnifiedEventsFilterBranch|PublicPropertyAssociationFilterBranch|PublicAssociationFilterBranch)[] filterBranches; + "RESTRICTED" filterBranchType = "RESTRICTED"; + PublicRestrictedFilterBranchFilterBranches[] filterBranches; string filterBranchOperator; - (PublicPropertyFilter|PublicAssociationInListFilter|PublicPageViewAnalyticsFilter|PublicCtaAnalyticsFilter|PublicEventAnalyticsFilter|PublicFormSubmissionFilter|PublicFormSubmissionOnPageFilter|PublicIntegrationEventFilter|PublicEmailSubscriptionFilter|PublicCommunicationSubscriptionFilter|PublicCampaignInfluencedFilter|PublicSurveyMonkeyFilter|PublicSurveyMonkeyValueFilter|PublicWebinarFilter|PublicEmailEventFilter|PublicPrivacyAnalyticsFilter|PublicAdsSearchFilter|PublicAdsTimeFilter|PublicInListFilter|PublicNumAssociationsFilter|PublicUnifiedEventsFilter|PublicPropertyAssociationInListFilter|PublicConstantFilter)[] filters; + PublicRestrictedFilterBranchFilters[] filters; }; public type PublicMonthReference record { int:Signed32 hour?; int:Signed32 millisecond?; - "MONTH" referenceType; + "MONTH" referenceType = "MONTH"; int:Signed32 day; int:Signed32 minute?; int:Signed32 second?; }; -# Represents the Queries record for the operation: get_getall -public type Get_getallQueries record { - # The **ILS IDs** of the lists to fetch. - string[] listIds?; - # A flag indicating whether or not the response object list definitions should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response. - boolean includeFilters = false; -}; +public type PublicNotAllFilterBranchFilterBranches PublicOrFilterBranch|PublicAndFilterBranch|PublicNotAllFilterBranch|PublicNotAnyFilterBranch|PublicRestrictedFilterBranch|PublicUnifiedEventsFilterBranch|PublicPropertyAssociationFilterBranch|PublicAssociationFilterBranch; # OAuth2 Refresh Token Grant Configs public type OAuth2RefreshTokenGrantConfig record {| @@ -842,26 +873,20 @@ public type OAuth2RefreshTokenGrantConfig record {| public type PublicDateTimePropertyOperation record { boolean includeObjectsWithNoValueSet; boolean requiresTimeZoneConversion; - "DATETIME" operationType; + "DATETIME" operationType = "DATETIME"; string operator; int:Signed32 timestamp; }; public type PublicCampaignInfluencedFilter record { string campaignId; - "CAMPAIGN_INFLUENCED" filterType; -}; - -# Represents the Queries record for the operation: putListidUpdateListFilters_updatelistfilters -public type PutListidUpdateListFilters_updatelistfiltersQueries record { - # A flag indicating whether or not the memberships added to the list as a result of the filter change should be enrolled in workflows that are relevant to this list. - boolean enrollObjectsInWorkflows = false; + "CAMPAIGN_INFLUENCED" filterType = "CAMPAIGN_INFLUENCED"; }; public type ListMoveRequest record { - # The Id of the list to move. + # The Id of the list to move string listId; - # The Id of folder to move the list to, the root folder is Id 0. + # The Id of folder to move the list to, the root folder is Id 0 string newFolderId; }; @@ -869,12 +894,16 @@ public type PublicFiscalQuarterReference record { int:Signed32 hour?; int:Signed32 month; int:Signed32 millisecond?; - "FISCAL_QUARTER" referenceType; + "FISCAL_QUARTER" referenceType = "FISCAL_QUARTER"; int:Signed32 day; int:Signed32 minute?; int:Signed32 second?; }; +public type PublicPropertyAssociationFilterBranchFilterBranches PublicOrFilterBranch|PublicAndFilterBranch|PublicNotAllFilterBranch|PublicNotAnyFilterBranch|PublicRestrictedFilterBranch|PublicUnifiedEventsFilterBranch|PublicPropertyAssociationFilterBranch|PublicAssociationFilterBranch; + +public type PublicAssociationFilterBranchFilterBranches PublicOrFilterBranch|PublicAndFilterBranch|PublicNotAllFilterBranch|PublicNotAnyFilterBranch|PublicRestrictedFilterBranch|PublicUnifiedEventsFilterBranch|PublicPropertyAssociationFilterBranch|PublicAssociationFilterBranch; + public type PublicMigrationMapping record { # The V3 list id for the list string listId; @@ -882,43 +911,32 @@ public type PublicMigrationMapping record { string legacyListId; }; -# Proxy server configurations to be used with the HTTP client endpoint. -public type ProxyConfig record {| - # Host name of the proxy server - string host = ""; - # Proxy server port - int port = 0; - # Proxy server username - string userName = ""; - # Proxy server password - @display {label: "", kind: "password"} - string password = ""; -|}; +public type PublicAndFilterBranchFilterBranches PublicOrFilterBranch|PublicAndFilterBranch|PublicNotAllFilterBranch|PublicNotAnyFilterBranch|PublicRestrictedFilterBranch|PublicUnifiedEventsFilterBranch|PublicPropertyAssociationFilterBranch|PublicAssociationFilterBranch; public type ListCreateRequest record { - # The object type ID of the type of objects that the list will store. + # The object type ID of the type of objects that the list will store string objectTypeId; - # The processing type of the list. One of: `SNAPSHOT`, `MANUAL`, or `DYNAMIC`. + # The processing type of the list. One of: `SNAPSHOT`, `MANUAL`, or `DYNAMIC` string processingType; - # The list of custom properties to tie to the list. Custom property name is the key, the value is the value. + # The list of custom properties to tie to the list. Custom property name is the key, the value is the value record {|string...;|} customProperties?; - # The ID of the folder that the list should be created in. If left blank, then the list will be created in the root of the list folder structure. + # The ID of the folder that the list should be created in. If left blank, then the list will be created in the root of the list folder structure int:Signed32 listFolderId?; - # The name of the list, which must be globally unique across all public lists in the portal. + # The name of the list, which must be globally unique across all public lists in the portal string name; PublicOrFilterBranch|PublicAndFilterBranch|PublicNotAllFilterBranch|PublicNotAnyFilterBranch|PublicRestrictedFilterBranch|PublicUnifiedEventsFilterBranch|PublicPropertyAssociationFilterBranch|PublicAssociationFilterBranch filterBranch?; }; public type PublicBoolPropertyOperation record { boolean includeObjectsWithNoValueSet; - "BOOL" operationType; + "BOOL" operationType = "BOOL"; boolean value; string operator; }; public type PublicAllPropertyTypesOperation record { boolean includeObjectsWithNoValueSet; - "ALL_PROPERTY" operationType; + "ALL_PROPERTY" operationType = "ALL_PROPERTY"; string operator; }; @@ -933,7 +951,7 @@ public type PublicDatePoint record { int:Signed32 year; string timezoneSource?; int:Signed32 millisecond?; - "DATE" timeType; + "DATE" timeType = "DATE"; string zoneId; int:Signed32 day; int:Signed32 minute?; @@ -947,15 +965,15 @@ public type PublicTimeOffset record { }; public type NextPage record { - # A direct link to the request for the next page of records. + # A direct link to the request for the next page of records string link?; - # The offset for the next page of records. + # The offset for the next page of records string after; }; public type PublicRollingPropertyUpdatedOperation record { boolean includeObjectsWithNoValueSet; - "ROLLING_PROPERTY_UPDATED" operationType; + "ROLLING_PROPERTY_UPDATED" operationType = "ROLLING_PROPERTY_UPDATED"; int:Signed32 numberOfDays; string operator; }; diff --git a/ballerina/utils.bal b/ballerina/utils.bal index 5d8e591..8269f00 100644 --- a/ballerina/utils.bal +++ b/ballerina/utils.bal @@ -17,6 +17,7 @@ // specific language governing permissions and limitations // under the License. +import ballerina/http; import ballerina/url; type SimpleBasicType string|boolean|int|float|decimal; @@ -186,12 +187,13 @@ isolated function getEncodedUri(anydata value) returns string { # + encodingMap - Details on serialization mechanism # + return - Returns generated Path or error at failure of client initialization isolated function getPathForQueryParam(map queryParam, map encodingMap = {}) returns string|error { + map queriesMap = http:getQueryMap(queryParam); string[] param = []; - if queryParam.length() > 0 { + if queriesMap.length() > 0 { param.push("?"); - foreach var [key, value] in queryParam.entries() { + foreach var [key, value] in queriesMap.entries() { if value is () { - _ = queryParam.remove(key); + _ = queriesMap.remove(key); continue; } Encoding encodingData = encodingMap.hasKey(key) ? encodingMap.get(key) : defaultEncoding; @@ -215,20 +217,3 @@ isolated function getPathForQueryParam(map queryParam, map en string restOfPath = string:'join("", ...param); return restOfPath; } - -# Generate header map for given header values. -# -# + headerParam - Headers map -# + return - Returns generated map or error at failure of client initialization -isolated function getMapForHeaders(map headerParam) returns map { - map headerMap = {}; - foreach var [key, value] in headerParam.entries() { - if value is SimpleBasicType[] { - headerMap[key] = from SimpleBasicType data in value - select data.toString(); - } else { - headerMap[key] = value.toString(); - } - } - return headerMap; -} diff --git a/gradle.properties b/gradle.properties index aa1aa84..f7dd3ee 100644 --- a/gradle.properties +++ b/gradle.properties @@ -4,4 +4,4 @@ version=0.1.1-SNAPSHOT releasePluginVersion=2.8.0 ballerinaGradlePluginVersion=2.2.4 -ballerinaLangVersion=2201.10.0 +ballerinaLangVersion=2201.12.2 From e5087402b74fe479c9955ead1a3a04fec58b7e84 Mon Sep 17 00:00:00 2001 From: Danesh Kuruppu Date: Wed, 9 Apr 2025 15:40:02 +0530 Subject: [PATCH 3/7] [Automated] Update the toml files --- ballerina/Ballerina.toml | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/ballerina/Ballerina.toml b/ballerina/Ballerina.toml index 361fea1..7bda99e 100644 --- a/ballerina/Ballerina.toml +++ b/ballerina/Ballerina.toml @@ -1,8 +1,8 @@ [package] -distribution = "2201.10.0" +distribution = "2201.12.0" org = "ballerinax" name = "hubspot.crm.lists" -version = "0.1.0" +version = "1.0.0" license = ["Apache-2.0"] authors = ["Ballerina"] keywords = ["hubspot", "crm", "lists"] @@ -10,6 +10,3 @@ repository = "https://github.com/ballerina-platform/module-ballerinax-hubspot.cr [build-options] observabilityIncluded = true - -[platform.java17] -graalvmCompatible = true From 94648e4628559312339faecc00e9a3c8ee778b0d Mon Sep 17 00:00:00 2001 From: Danesh Kuruppu Date: Wed, 9 Apr 2025 15:45:40 +0530 Subject: [PATCH 4/7] [Automated] Update the toml files --- ballerina/Ballerina.toml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/ballerina/Ballerina.toml b/ballerina/Ballerina.toml index 7bda99e..cdddf69 100644 --- a/ballerina/Ballerina.toml +++ b/ballerina/Ballerina.toml @@ -1,8 +1,8 @@ [package] -distribution = "2201.12.0" +distribution = "2201.10.0" org = "ballerinax" name = "hubspot.crm.lists" -version = "1.0.0" +version = "0.1.1" license = ["Apache-2.0"] authors = ["Ballerina"] keywords = ["hubspot", "crm", "lists"] @@ -10,3 +10,6 @@ repository = "https://github.com/ballerina-platform/module-ballerinax-hubspot.cr [build-options] observabilityIncluded = true + +[platform.java17] +graalvmCompatible = true From ddb26599165b86e2d069e55753ea53a858b6dda9 Mon Sep 17 00:00:00 2001 From: Danesh Kuruppu Date: Wed, 9 Apr 2025 15:58:09 +0530 Subject: [PATCH 5/7] [Automated] Update the toml files --- ballerina/Ballerina.toml | 5 +--- ballerina/Dependencies.toml | 46 ++++++++++++++++++++++--------------- 2 files changed, 29 insertions(+), 22 deletions(-) diff --git a/ballerina/Ballerina.toml b/ballerina/Ballerina.toml index cdddf69..55f5661 100644 --- a/ballerina/Ballerina.toml +++ b/ballerina/Ballerina.toml @@ -1,5 +1,5 @@ [package] -distribution = "2201.10.0" +distribution = "2201.12.0" org = "ballerinax" name = "hubspot.crm.lists" version = "0.1.1" @@ -10,6 +10,3 @@ repository = "https://github.com/ballerina-platform/module-ballerinax-hubspot.cr [build-options] observabilityIncluded = true - -[platform.java17] -graalvmCompatible = true diff --git a/ballerina/Dependencies.toml b/ballerina/Dependencies.toml index d642fea..9dfeb87 100644 --- a/ballerina/Dependencies.toml +++ b/ballerina/Dependencies.toml @@ -5,12 +5,12 @@ [ballerina] dependencies-toml-version = "2" -distribution-version = "2201.10.0" +distribution-version = "2201.12.2" [[package]] org = "ballerina" name = "auth" -version = "2.12.0" +version = "2.14.0" dependencies = [ {org = "ballerina", name = "crypto"}, {org = "ballerina", name = "jballerina.java"}, @@ -22,7 +22,7 @@ dependencies = [ [[package]] org = "ballerina" name = "cache" -version = "3.8.0" +version = "3.10.0" dependencies = [ {org = "ballerina", name = "constraint"}, {org = "ballerina", name = "jballerina.java"}, @@ -33,7 +33,7 @@ dependencies = [ [[package]] org = "ballerina" name = "constraint" -version = "1.5.0" +version = "1.7.0" dependencies = [ {org = "ballerina", name = "jballerina.java"} ] @@ -41,16 +41,25 @@ dependencies = [ [[package]] org = "ballerina" name = "crypto" -version = "2.7.2" +version = "2.9.0" dependencies = [ {org = "ballerina", name = "jballerina.java"}, {org = "ballerina", name = "time"} ] +[[package]] +org = "ballerina" +name = "data.jsondata" +version = "1.1.0" +dependencies = [ + {org = "ballerina", name = "jballerina.java"}, + {org = "ballerina", name = "lang.object"} +] + [[package]] org = "ballerina" name = "file" -version = "1.10.0" +version = "1.12.0" dependencies = [ {org = "ballerina", name = "io"}, {org = "ballerina", name = "jballerina.java"}, @@ -61,12 +70,13 @@ dependencies = [ [[package]] org = "ballerina" name = "http" -version = "2.12.4" +version = "2.14.0" dependencies = [ {org = "ballerina", name = "auth"}, {org = "ballerina", name = "cache"}, {org = "ballerina", name = "constraint"}, {org = "ballerina", name = "crypto"}, + {org = "ballerina", name = "data.jsondata"}, {org = "ballerina", name = "file"}, {org = "ballerina", name = "io"}, {org = "ballerina", name = "jballerina.java"}, @@ -93,7 +103,7 @@ modules = [ [[package]] org = "ballerina" name = "io" -version = "1.6.3" +version = "1.8.0" dependencies = [ {org = "ballerina", name = "jballerina.java"}, {org = "ballerina", name = "lang.value"} @@ -110,7 +120,7 @@ version = "0.0.0" [[package]] org = "ballerina" name = "jwt" -version = "2.13.0" +version = "2.15.0" dependencies = [ {org = "ballerina", name = "cache"}, {org = "ballerina", name = "crypto"}, @@ -208,7 +218,7 @@ dependencies = [ [[package]] org = "ballerina" name = "log" -version = "2.10.0" +version = "2.12.0" dependencies = [ {org = "ballerina", name = "io"}, {org = "ballerina", name = "jballerina.java"}, @@ -219,7 +229,7 @@ dependencies = [ [[package]] org = "ballerina" name = "mime" -version = "2.10.1" +version = "2.12.0" dependencies = [ {org = "ballerina", name = "io"}, {org = "ballerina", name = "jballerina.java"}, @@ -230,7 +240,7 @@ dependencies = [ [[package]] org = "ballerina" name = "oauth2" -version = "2.12.0" +version = "2.14.0" dependencies = [ {org = "ballerina", name = "cache"}, {org = "ballerina", name = "crypto"}, @@ -246,7 +256,7 @@ modules = [ [[package]] org = "ballerina" name = "observe" -version = "1.3.0" +version = "1.5.0" dependencies = [ {org = "ballerina", name = "jballerina.java"} ] @@ -254,7 +264,7 @@ dependencies = [ [[package]] org = "ballerina" name = "os" -version = "1.8.0" +version = "1.10.0" dependencies = [ {org = "ballerina", name = "io"}, {org = "ballerina", name = "jballerina.java"} @@ -263,7 +273,7 @@ dependencies = [ [[package]] org = "ballerina" name = "task" -version = "2.5.0" +version = "2.7.0" dependencies = [ {org = "ballerina", name = "jballerina.java"}, {org = "ballerina", name = "time"} @@ -286,7 +296,7 @@ modules = [ [[package]] org = "ballerina" name = "time" -version = "2.4.0" +version = "2.7.0" dependencies = [ {org = "ballerina", name = "jballerina.java"} ] @@ -294,7 +304,7 @@ dependencies = [ [[package]] org = "ballerina" name = "url" -version = "2.4.0" +version = "2.6.0" dependencies = [ {org = "ballerina", name = "jballerina.java"} ] @@ -317,7 +327,7 @@ modules = [ [[package]] org = "ballerinax" name = "hubspot.crm.lists" -version = "0.1.0" +version = "0.1.1" dependencies = [ {org = "ballerina", name = "http"}, {org = "ballerina", name = "io"}, From 4b0fbd9d268ce6cce9af079b86a380a134db6723 Mon Sep 17 00:00:00 2001 From: Danesh Kuruppu Date: Wed, 9 Apr 2025 16:05:25 +0530 Subject: [PATCH 6/7] [Automated] Update the toml files --- ballerina/Ballerina.toml | 2 +- ballerina/Dependencies.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/ballerina/Ballerina.toml b/ballerina/Ballerina.toml index 55f5661..7bda99e 100644 --- a/ballerina/Ballerina.toml +++ b/ballerina/Ballerina.toml @@ -2,7 +2,7 @@ distribution = "2201.12.0" org = "ballerinax" name = "hubspot.crm.lists" -version = "0.1.1" +version = "1.0.0" license = ["Apache-2.0"] authors = ["Ballerina"] keywords = ["hubspot", "crm", "lists"] diff --git a/ballerina/Dependencies.toml b/ballerina/Dependencies.toml index 9dfeb87..2964a7c 100644 --- a/ballerina/Dependencies.toml +++ b/ballerina/Dependencies.toml @@ -327,7 +327,7 @@ modules = [ [[package]] org = "ballerinax" name = "hubspot.crm.lists" -version = "0.1.1" +version = "1.0.0" dependencies = [ {org = "ballerina", name = "http"}, {org = "ballerina", name = "io"}, From 63f89cdcb6dfffe3e40daa95b97a91656769ad9d Mon Sep 17 00:00:00 2001 From: Danesh Kuruppu Date: Wed, 9 Apr 2025 16:20:09 +0530 Subject: [PATCH 7/7] fix the build failure --- ballerina/tests/tests.bal | 76 ++--- build-config/resources/Ballerina.toml | 5 +- .../Ballerina.toml | 1 - .../Dependencies.toml | 314 ------------------ .../customer_support_tickets_manager/main.bal | 26 +- examples/leads_tracker/Ballerina.toml | 1 - examples/leads_tracker/Dependencies.toml | 314 ------------------ examples/leads_tracker/main.bal | 10 +- gradle.properties | 4 +- 9 files changed, 57 insertions(+), 694 deletions(-) delete mode 100644 examples/customer_support_tickets_manager/Dependencies.toml delete mode 100644 examples/leads_tracker/Dependencies.toml diff --git a/ballerina/tests/tests.bal b/ballerina/tests/tests.bal index 0d99f5b..123df7f 100644 --- a/ballerina/tests/tests.bal +++ b/ballerina/tests/tests.bal @@ -14,7 +14,6 @@ // specific language governing permissions and limitations // under the License. -import ballerina/http; import ballerina/oauth2; import ballerina/test; @@ -59,7 +58,7 @@ function testCreateAManualList() returns error? { processingType: "MANUAL", name: testListName }; - ListCreateResponse response = check hubspotClient->post_create(payload); + ListCreateResponse response = check hubspotClient->postCreate(payload); testListId = response.list.listId; testListName = response.list.name; test:assertEquals(response.list.name, testListName); @@ -99,7 +98,7 @@ function testCreateADynamicList() returns error? { name: "my-test-list-dynamic", filterBranch: filterBranch }; - ListCreateResponse response = check hubspotClient->post_create(payload); + ListCreateResponse response = check hubspotClient->postCreate(payload); testDynamicListId = response.list.listId; test:assertEquals(response.list.name, "my-test-list-dynamic"); } @@ -109,7 +108,7 @@ function testCreateADynamicList() returns error? { groups: ["live_tests", "mock_tests"] } function testGetAllLists() returns error? { - ListsByIdResponse response = check hubspotClient->get_getall(); + ListsByIdResponse response = check hubspotClient->getGetAll(); test:assertTrue(response.lists.length() >= 0); } @@ -119,7 +118,7 @@ function testGetAllLists() returns error? { groups: ["live_tests", "mock_tests"] } function testGetListByName() returns error? { - ListFetchResponse response = check hubspotClient->getObjectTypeIdObjecttypeidNameListname_getbyname(listName = testListName, objectTypeId = "0-1"); + ListFetchResponse response = check hubspotClient->getObjectTypeIdObjectTypeIdNameListNameGetByName(listName = testListName, objectTypeId = "0-1"); test:assertEquals(response.list.name, testListName); } @@ -129,7 +128,7 @@ function testGetListByName() returns error? { groups: ["live_tests", "mock_tests"] } function testGetListById() returns error? { - ListFetchResponse response = check hubspotClient->getListid_getbyid(listId = testListId); + ListFetchResponse response = check hubspotClient->getListIdGetById(listId = testListId); test:assertTrue(response.list.name != ""); } @@ -141,7 +140,7 @@ function testSearchLists() returns error? { ListSearchRequest payload = { query: "test" }; - ListSearchResponse response = check hubspotClient->postSearch_dosearch(payload); + ListSearchResponse response = check hubspotClient->postSearchDoSearch(payload); test:assertTrue(response.lists.length() > 0); test:assertTrue(response.lists[0].name.includes("test")); } @@ -152,8 +151,7 @@ function testSearchLists() returns error? { groups: ["live_tests", "mock_tests"] } function testDeleteListById() returns error? { - http:Response response = check hubspotClient->deleteListid_remove(listId = testListId); - test:assertEquals(response.statusCode, 204); + _ = check hubspotClient->deleteListIdRemove(listId = testListId); } // Restore a List @@ -162,8 +160,7 @@ function testDeleteListById() returns error? { groups: ["live_tests", "mock_tests"] } function testRestoreListById() returns error? { - http:Response response = check hubspotClient->putListidRestore_restore(listId = testListId); - test:assertEquals(response.statusCode, 204); + _ = check hubspotClient->putListIdRestoreRestore(listId = testListId); } // Update List Name @@ -172,10 +169,10 @@ function testRestoreListById() returns error? { groups: ["live_tests", "mock_tests"] } function testUpdateListName() returns error? { - PutListidUpdateListName_updatenameQueries queries = { + PutListIdUpdateListNameUpdateNameQueries queries = { listName: "my-test-list-updated" }; - ListUpdateResponse response = check hubspotClient->putListidUpdateListName_updatename(listId = testListId, queries = queries); + ListUpdateResponse response = check hubspotClient->putListIdUpdateListNameUpdateName(listId = testListId, queries = queries); test:assertEquals(response.updatedList?.name, "my-test-list-updated"); } @@ -224,7 +221,7 @@ function testUpdateListFilter() returns error? { filterBranch }; - ListUpdateResponse response = check hubspotClient->putListidUpdateListFilters_updatelistfilters(listId = testDynamicListId, payload = payload); + ListUpdateResponse response = check hubspotClient->putListIdUpdateListFiltersUpdateListFilters(listId = testDynamicListId, payload = payload); test:assertEquals(response.updatedList?.filterBranch, filterBranch); } @@ -235,7 +232,7 @@ function testUpdateListFilter() returns error? { enable: isLiveServer } function testFetchListMembershipsOrderedByAddedToListDate() returns error? { - ApiCollectionResponseJoinTimeAndRecordId response = check hubspotClient->getListidMembershipsJoinOrder_getpageorderedbyaddedtolistdate(listId = testListId); + ApiCollectionResponseJoinTimeAndRecordId response = check hubspotClient->getListIdMembershipsJoinOrderGetPageOrderedByAddedToListDate(listId = testListId); test:assertTrue(response.results.length() >= 0); } @@ -246,7 +243,7 @@ function testFetchListMembershipsOrderedByAddedToListDate() returns error? { enable: isLiveServer } function testFetchListMembershipsOrderedById() returns error? { - ApiCollectionResponseJoinTimeAndRecordId response = check hubspotClient->getListidMemberships_getpage(listId = testListId); + ApiCollectionResponseJoinTimeAndRecordId response = check hubspotClient->getListIdMembershipsGetPage(listId = testListId); test:assertTrue(response.results.length() >= 0); }; @@ -256,7 +253,7 @@ function testFetchListMembershipsOrderedById() returns error? { enable: isLiveServer } function testGetListsRecordIsMemberOf() returns error? { - ApiCollectionResponseRecordListMembershipNoPaging response = check hubspotClient->getRecordsObjecttypeidRecordidMemberships_getlists(objectTypeId = "0-1", recordId = "123456"); + ApiCollectionResponseRecordListMembershipNoPaging response = check hubspotClient->getRecordsObjectTypeIdRecordIdMembershipsGetLists(objectTypeId = "0-1", recordId = "123456"); int total = response.total ?: 0; test:assertEquals(response.results.length(), total); } @@ -268,8 +265,8 @@ function testGetListsRecordIsMemberOf() returns error? { enable: isLiveServer } function testAddAllRecordsFromSourceListToDestinationList() returns error? { - http:Response response = check hubspotClient->putListidMembershipsAddFromSourcelistid_addallfromlist(listId = testListId, sourceListId = testDynamicListId); - test:assertEquals(response.statusCode, 204); + _ = check hubspotClient->putListIdMembershipsAddFromSourceListIdAddAllFromList(listId = testListId, sourceListId = testDynamicListId); + test:assertTrue(true); } // Add and/or Remove Records from a List @@ -283,7 +280,7 @@ function testAddRemoveRecordsFromAList() returns error? { recordIdsToAdd: ["123123", "123456"], recordIdsToRemove: ["456456"] }; - MembershipsUpdateResponse response = check hubspotClient->putListidMembershipsAddAndRemove_addandremove(listId = testListId, payload = payload); + MembershipsUpdateResponse response = check hubspotClient->putListIdMembershipsAddAndRemoveAddAndRemove(listId = testListId, payload = payload); test:assertTrue(response.recordIdsMissing !is () || response.recordsIdsAdded !is ()); } @@ -295,7 +292,7 @@ function testAddRemoveRecordsFromAList() returns error? { } function testAddRecordsToAList() returns error? { string[] payload = ["123123", "123456"]; - MembershipsUpdateResponse response = check hubspotClient->putListidMembershipsAdd_add(listId = testListId, payload = payload); + MembershipsUpdateResponse response = check hubspotClient->putListIdMembershipsAddAdd(listId = testListId, payload = payload); test:assertTrue(response.recordIdsMissing !is () || response.recordsIdsAdded !is ()); } @@ -307,7 +304,7 @@ function testAddRecordsToAList() returns error? { } function testRemoveRecordsFromList() returns error? { string[] payload = ["123123"]; - MembershipsUpdateResponse response = check hubspotClient->putListidMembershipsRemove_remove(listId = testListId, payload = payload); + MembershipsUpdateResponse response = check hubspotClient->putListIdMembershipsRemoveRemove(listId = testListId, payload = payload); test:assertTrue(response.recordIdsMissing !is () || response.recordIdsRemoved !is ()); } @@ -318,8 +315,8 @@ function testRemoveRecordsFromList() returns error? { enable: isLiveServer } function testDeleteAllRecordsFromList() returns error? { - http:Response response = check hubspotClient->deleteListidMemberships_removeall(listId = testListId); - test:assertEquals(response.statusCode, 204); + _ = check hubspotClient->deleteListIdMembershipsRemoveAll(listId = testListId); + test:assertTrue(true); } // Creates a folder @@ -331,7 +328,7 @@ function testCreateFolders() returns error? { ListFolderCreateRequest payload = { name: "test-folder" }; - ListFolderCreateResponse response = check hubspotClient->postFolders_create(payload); + ListFolderCreateResponse response = check hubspotClient->postFoldersCreate(payload); test:assertEquals(response.folder.name, "test-folder"); testParentFolderId = response.folder.id; @@ -339,7 +336,7 @@ function testCreateFolders() returns error? { name: "test-child-folder", parentFolderId: testParentFolderId.toString() }; - ListFolderCreateResponse childResponse = check hubspotClient->postFolders_create(childPayload); + ListFolderCreateResponse childResponse = check hubspotClient->postFoldersCreate(childPayload); test:assertEquals(childResponse.folder.name, "test-child-folder"); testChildFolderId = childResponse.folder.id; } @@ -351,7 +348,7 @@ function testCreateFolders() returns error? { enable: isLiveServer } function testMoveAFolder() returns error? { - ListFolderFetchResponse response = check hubspotClient->putFoldersFolderidMoveNewparentfolderid_move(folderId = testChildFolderId.toString(), newParentFolderId = "0"); + ListFolderFetchResponse response = check hubspotClient->putFoldersFolderIdMoveNewParentFolderIdMove(folderId = testChildFolderId.toString(), newParentFolderId = "0"); test:assertEquals(response.folder.parentFolderId, 0); } @@ -366,8 +363,8 @@ function testMoveAListToAGivenFolder() returns error? { listId: testListId, newFolderId: testChildFolderId.toString() }; - http:Response response = check hubspotClient->putFoldersMoveList_movelist(payload); - test:assertEquals(response.statusCode, 204); + _ = check hubspotClient->putFoldersMoveListMoveList(payload); + test:assertTrue(true); } // Rename a folder @@ -377,10 +374,10 @@ function testMoveAListToAGivenFolder() returns error? { enable: isLiveServer } function testRenameAFolder() returns error? { - PutFoldersFolderidRename_renameQueries queries = { + PutFoldersFolderIdRenameRenameQueries queries = { newFolderName: "test-child-folder-updated" }; - ListFolderFetchResponse response = check hubspotClient->putFoldersFolderidRename_rename(folderId = testChildFolderId.toString(), queries = queries); + ListFolderFetchResponse response = check hubspotClient->putFoldersFolderIdRenameRename(folderId = testChildFolderId.toString(), queries = queries); test:assertEquals(response.folder.name, "test-child-folder-updated"); } @@ -391,10 +388,10 @@ function testRenameAFolder() returns error? { enable: isLiveServer } function testRetrieveAFolder() returns error? { - GetFolders_getallQueries queries = { + GetFoldersGetAllQueries queries = { folderId: testChildFolderId.toString() }; - ListFolderFetchResponse response = check hubspotClient->getFolders_getall(queries = queries); + ListFolderFetchResponse response = check hubspotClient->getFoldersGetAll(queries = queries); test:assertEquals(response.folder.name, "test-child-folder-updated"); } @@ -405,17 +402,16 @@ function testRetrieveAFolder() returns error? { enable: isLiveServer } function testDeleteFolders() returns error? { - http:Response response = check hubspotClient->deleteFoldersFolderid_remove(folderId = testChildFolderId.toString()); - test:assertEquals(response.statusCode, 204); - http:Response responseParent = check hubspotClient->deleteFoldersFolderid_remove(folderId = testParentFolderId.toString()); - test:assertEquals(responseParent.statusCode, 204); + _ = check hubspotClient->deleteFoldersFolderIdRemove(folderId = testChildFolderId.toString()); + _ = check hubspotClient->deleteFoldersFolderIdRemove(folderId = testParentFolderId.toString()); + test:assertTrue(true); }; // Delete all lists created for tests @test:AfterSuite function deleteTestListAfterRestore() returns error? { - http:Response response = check hubspotClient->deleteListid_remove(listId = testListId); - http:Response responseDynamic = check hubspotClient->deleteListid_remove(listId = testDynamicListId); - test:assertTrue(response.statusCode == 204 && responseDynamic.statusCode == 204); + _ = check hubspotClient->deleteListIdRemove(listId = testListId); + _ = check hubspotClient->deleteListIdRemove(listId = testDynamicListId); + test:assertTrue(true); } diff --git a/build-config/resources/Ballerina.toml b/build-config/resources/Ballerina.toml index 4485af5..bb66249 100644 --- a/build-config/resources/Ballerina.toml +++ b/build-config/resources/Ballerina.toml @@ -1,5 +1,5 @@ [package] -distribution = "2201.10.0" +distribution = "2201.12.0" org = "ballerinax" name = "hubspot.crm.lists" version = "@toml.version@" @@ -10,6 +10,3 @@ repository = "https://github.com/ballerina-platform/module-ballerinax-hubspot.cr [build-options] observabilityIncluded = true - -[platform.java17] -graalvmCompatible = true diff --git a/examples/customer_support_tickets_manager/Ballerina.toml b/examples/customer_support_tickets_manager/Ballerina.toml index 70f4bd9..d06773e 100644 --- a/examples/customer_support_tickets_manager/Ballerina.toml +++ b/examples/customer_support_tickets_manager/Ballerina.toml @@ -6,4 +6,3 @@ distribution = "2201.10.3" [build-options] observabilityIncluded = true - diff --git a/examples/customer_support_tickets_manager/Dependencies.toml b/examples/customer_support_tickets_manager/Dependencies.toml deleted file mode 100644 index de0f868..0000000 --- a/examples/customer_support_tickets_manager/Dependencies.toml +++ /dev/null @@ -1,314 +0,0 @@ -# AUTO-GENERATED FILE. DO NOT MODIFY. - -# This file is auto-generated by Ballerina for managing dependency versions. -# It should not be modified by hand. - -[ballerina] -dependencies-toml-version = "2" -distribution-version = "2201.10.3" - -[[package]] -org = "ballerina" -name = "auth" -version = "2.12.0" -dependencies = [ - {org = "ballerina", name = "crypto"}, - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "lang.array"}, - {org = "ballerina", name = "lang.string"}, - {org = "ballerina", name = "log"} -] - -[[package]] -org = "ballerina" -name = "cache" -version = "3.8.0" -dependencies = [ - {org = "ballerina", name = "constraint"}, - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "task"}, - {org = "ballerina", name = "time"} -] - -[[package]] -org = "ballerina" -name = "constraint" -version = "1.5.0" -dependencies = [ - {org = "ballerina", name = "jballerina.java"} -] - -[[package]] -org = "ballerina" -name = "crypto" -version = "2.7.2" -dependencies = [ - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "time"} -] - -[[package]] -org = "ballerina" -name = "file" -version = "1.10.0" -dependencies = [ - {org = "ballerina", name = "io"}, - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "os"}, - {org = "ballerina", name = "time"} -] - -[[package]] -org = "ballerina" -name = "http" -version = "2.12.4" -dependencies = [ - {org = "ballerina", name = "auth"}, - {org = "ballerina", name = "cache"}, - {org = "ballerina", name = "constraint"}, - {org = "ballerina", name = "crypto"}, - {org = "ballerina", name = "file"}, - {org = "ballerina", name = "io"}, - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "jwt"}, - {org = "ballerina", name = "lang.array"}, - {org = "ballerina", name = "lang.decimal"}, - {org = "ballerina", name = "lang.int"}, - {org = "ballerina", name = "lang.regexp"}, - {org = "ballerina", name = "lang.runtime"}, - {org = "ballerina", name = "lang.string"}, - {org = "ballerina", name = "lang.value"}, - {org = "ballerina", name = "log"}, - {org = "ballerina", name = "mime"}, - {org = "ballerina", name = "oauth2"}, - {org = "ballerina", name = "observe"}, - {org = "ballerina", name = "time"}, - {org = "ballerina", name = "url"} -] - -[[package]] -org = "ballerina" -name = "io" -version = "1.6.3" -dependencies = [ - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "lang.value"} -] -modules = [ - {org = "ballerina", packageName = "io", moduleName = "io"} -] - -[[package]] -org = "ballerina" -name = "jballerina.java" -version = "0.0.0" - -[[package]] -org = "ballerina" -name = "jwt" -version = "2.13.0" -dependencies = [ - {org = "ballerina", name = "cache"}, - {org = "ballerina", name = "crypto"}, - {org = "ballerina", name = "io"}, - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "lang.int"}, - {org = "ballerina", name = "lang.string"}, - {org = "ballerina", name = "log"}, - {org = "ballerina", name = "time"} -] - -[[package]] -org = "ballerina" -name = "lang.__internal" -version = "0.0.0" -dependencies = [ - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "lang.object"} -] - -[[package]] -org = "ballerina" -name = "lang.array" -version = "0.0.0" -dependencies = [ - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "lang.__internal"} -] - -[[package]] -org = "ballerina" -name = "lang.decimal" -version = "0.0.0" -dependencies = [ - {org = "ballerina", name = "jballerina.java"} -] - -[[package]] -org = "ballerina" -name = "lang.int" -version = "0.0.0" -dependencies = [ - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "lang.__internal"}, - {org = "ballerina", name = "lang.object"} -] - -[[package]] -org = "ballerina" -name = "lang.object" -version = "0.0.0" - -[[package]] -org = "ballerina" -name = "lang.regexp" -version = "0.0.0" -dependencies = [ - {org = "ballerina", name = "jballerina.java"} -] - -[[package]] -org = "ballerina" -name = "lang.runtime" -version = "0.0.0" -dependencies = [ - {org = "ballerina", name = "jballerina.java"} -] - -[[package]] -org = "ballerina" -name = "lang.string" -version = "0.0.0" -dependencies = [ - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "lang.regexp"} -] - -[[package]] -org = "ballerina" -name = "lang.value" -version = "0.0.0" -dependencies = [ - {org = "ballerina", name = "jballerina.java"} -] - -[[package]] -org = "ballerina" -name = "log" -version = "2.10.0" -dependencies = [ - {org = "ballerina", name = "io"}, - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "lang.value"}, - {org = "ballerina", name = "observe"} -] - -[[package]] -org = "ballerina" -name = "mime" -version = "2.10.1" -dependencies = [ - {org = "ballerina", name = "io"}, - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "lang.int"}, - {org = "ballerina", name = "log"} -] - -[[package]] -org = "ballerina" -name = "oauth2" -version = "2.12.0" -dependencies = [ - {org = "ballerina", name = "cache"}, - {org = "ballerina", name = "crypto"}, - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "log"}, - {org = "ballerina", name = "time"}, - {org = "ballerina", name = "url"} -] -modules = [ - {org = "ballerina", packageName = "oauth2", moduleName = "oauth2"} -] - -[[package]] -org = "ballerina" -name = "observe" -version = "1.3.0" -dependencies = [ - {org = "ballerina", name = "jballerina.java"} -] - -[[package]] -org = "ballerina" -name = "os" -version = "1.8.0" -dependencies = [ - {org = "ballerina", name = "io"}, - {org = "ballerina", name = "jballerina.java"} -] - -[[package]] -org = "ballerina" -name = "task" -version = "2.5.0" -dependencies = [ - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "time"} -] - -[[package]] -org = "ballerina" -name = "time" -version = "2.4.0" -dependencies = [ - {org = "ballerina", name = "jballerina.java"} -] - -[[package]] -org = "ballerina" -name = "url" -version = "2.4.0" -dependencies = [ - {org = "ballerina", name = "jballerina.java"} -] - -[[package]] -org = "ballerinai" -name = "observe" -version = "0.0.0" -dependencies = [ - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "observe"} -] -modules = [ - {org = "ballerinai", packageName = "observe", moduleName = "observe"} -] - -[[package]] -org = "ballerinax" -name = "hubspot.crm.lists" -version = "0.1.0" -dependencies = [ - {org = "ballerina", name = "http"}, - {org = "ballerina", name = "oauth2"}, - {org = "ballerina", name = "url"}, - {org = "ballerinai", name = "observe"} -] -modules = [ - {org = "ballerinax", packageName = "hubspot.crm.lists", moduleName = "hubspot.crm.lists"} -] - -[[package]] -org = "wso2" -name = "customer_support_tickets_manager" -version = "0.1.0" -dependencies = [ - {org = "ballerina", name = "io"}, - {org = "ballerina", name = "oauth2"}, - {org = "ballerinai", name = "observe"}, - {org = "ballerinax", name = "hubspot.crm.lists"} -] -modules = [ - {org = "wso2", packageName = "customer_support_tickets_manager", moduleName = "customer_support_tickets_manager"} -] - diff --git a/examples/customer_support_tickets_manager/main.bal b/examples/customer_support_tickets_manager/main.bal index 94435e1..c4c6a07 100644 --- a/examples/customer_support_tickets_manager/main.bal +++ b/examples/customer_support_tickets_manager/main.bal @@ -39,7 +39,7 @@ public function main() returns error? { hslists:ListFolderCreateRequest folderCreateReqPayload = { name: "Customer Support Tickets" }; - hslists:ListFolderCreateResponse postFolderCreateResponse = check hubspotClient->postFolders_create(folderCreateReqPayload); + hslists:ListFolderCreateResponse postFolderCreateResponse = check hubspotClient->postFoldersCreate(folderCreateReqPayload); hslists:PublicListFolder folder = postFolderCreateResponse.folder; io:println("[+] Folder created successfully: ", folder.name); @@ -74,14 +74,14 @@ public function main() returns error? { name: "High priority tickets", filterBranch: filterBranch }; - hslists:ListFetchResponse|error highPriorityListCheckResponse = hubspotClient->getObjectTypeIdObjecttypeidNameListname_getbyname("0-5", "High priority tickets"); + hslists:ListFetchResponse|error highPriorityListCheckResponse = hubspotClient->getObjectTypeIdObjectTypeIdNameListNameGetByName("0-5", "High priority tickets"); hslists:PublicObjectList highPriorityList; hslists:PublicObjectList mediumPriorityList; hslists:PublicObjectList lowPriorityList; if highPriorityListCheckResponse is error { - hslists:ListCreateResponse highPriorityListResponse = check hubspotClient->post_create(payloadForLists); + hslists:ListCreateResponse highPriorityListResponse = check hubspotClient->postCreate(payloadForLists); highPriorityList = highPriorityListResponse.list; io:println("[+] High priority list created successfully: ", highPriorityList.name); } else { @@ -92,9 +92,9 @@ public function main() returns error? { filterOperation.values = ["MEDIUM"]; filterName.operation = {...filterOperation}; payloadForLists.name = "Medium priority tickets"; - hslists:ListFetchResponse|error midPriorityListCheckResponse = hubspotClient->getObjectTypeIdObjecttypeidNameListname_getbyname("0-5", "High priority tickets"); + hslists:ListFetchResponse|error midPriorityListCheckResponse = hubspotClient->getObjectTypeIdObjectTypeIdNameListNameGetByName("0-5", "High priority tickets"); if midPriorityListCheckResponse is error { - hslists:ListCreateResponse mediumPriorityListResponse = check hubspotClient->post_create(payloadForLists); + hslists:ListCreateResponse mediumPriorityListResponse = check hubspotClient->postCreate(payloadForLists); mediumPriorityList = mediumPriorityListResponse.list; io:println("[+] Medium priority list created successfully: ", mediumPriorityList.name); } else { @@ -105,9 +105,9 @@ public function main() returns error? { filterOperation.values = ["LOW"]; filterName.operation = {...filterOperation}; payloadForLists.name = "Low priority tickets"; - hslists:ListFetchResponse|error lowPriorityListCheckResponse = hubspotClient->getObjectTypeIdObjecttypeidNameListname_getbyname("0-5", "High priority tickets"); + hslists:ListFetchResponse|error lowPriorityListCheckResponse = hubspotClient->getObjectTypeIdObjectTypeIdNameListNameGetByName("0-5", "Low priority tickets"); if lowPriorityListCheckResponse is error { - hslists:ListCreateResponse lowPriorityListResponse = check hubspotClient->post_create(payloadForLists); + hslists:ListCreateResponse lowPriorityListResponse = check hubspotClient->postCreate(payloadForLists); lowPriorityList = lowPriorityListResponse.list; io:println("[+] Low priority list created successfully: ", lowPriorityList.name); } else { @@ -116,26 +116,26 @@ public function main() returns error? { } // Move the created lists to the folder - _ = check hubspotClient->putFoldersMoveList_movelist({listId: highPriorityList.listId, newFolderId: folder.id.toString()}); - _ = check hubspotClient->putFoldersMoveList_movelist({listId: mediumPriorityList.listId, newFolderId: folder.id.toString()}); - _ = check hubspotClient->putFoldersMoveList_movelist({listId: lowPriorityList.listId, newFolderId: folder.id.toString()}); + _ = check hubspotClient->putFoldersMoveListMoveList({listId: highPriorityList.listId, newFolderId: folder.id.toString()}); + _ = check hubspotClient->putFoldersMoveListMoveList({listId: mediumPriorityList.listId, newFolderId: folder.id.toString()}); + _ = check hubspotClient->putFoldersMoveListMoveList({listId: lowPriorityList.listId, newFolderId: folder.id.toString()}); // Retrieve each list and print the details - hslists:ApiCollectionResponseJoinTimeAndRecordId highPriorityListMembersResponse = check hubspotClient->getListidMembershipsJoinOrder_getpageorderedbyaddedtolistdate(highPriorityList.listId); + hslists:ApiCollectionResponseJoinTimeAndRecordId highPriorityListMembersResponse = check hubspotClient->getListIdMembershipsJoinOrderGetPageOrderedByAddedToListDate(highPriorityList.listId); hslists:JoinTimeAndRecordId[] highPriorityListMembers = highPriorityListMembersResponse.results; io:println("[+] High priority list members: "); foreach var member in highPriorityListMembers { io:println(" - ", member.recordId); } - hslists:ApiCollectionResponseJoinTimeAndRecordId mediumPriorityListMembersResponse = check hubspotClient->getListidMembershipsJoinOrder_getpageorderedbyaddedtolistdate(mediumPriorityList.listId); + hslists:ApiCollectionResponseJoinTimeAndRecordId mediumPriorityListMembersResponse = check hubspotClient->getListIdMembershipsJoinOrderGetPageOrderedByAddedToListDate(mediumPriorityList.listId); hslists:JoinTimeAndRecordId[] mediumPriorityListMembers = mediumPriorityListMembersResponse.results; io:println("[+] Medium priority list members: "); foreach var member in mediumPriorityListMembers { io:println(" - ", member.recordId); } - hslists:ApiCollectionResponseJoinTimeAndRecordId lowPriorityListMembersResponse = check hubspotClient->getListidMembershipsJoinOrder_getpageorderedbyaddedtolistdate(lowPriorityList.listId); + hslists:ApiCollectionResponseJoinTimeAndRecordId lowPriorityListMembersResponse = check hubspotClient->getListIdMembershipsJoinOrderGetPageOrderedByAddedToListDate(lowPriorityList.listId); hslists:JoinTimeAndRecordId[] lowPriorityListMembers = lowPriorityListMembersResponse.results; io:println("[+] Low priority list members: "); foreach var member in lowPriorityListMembers { diff --git a/examples/leads_tracker/Ballerina.toml b/examples/leads_tracker/Ballerina.toml index 88af063..4322c8a 100644 --- a/examples/leads_tracker/Ballerina.toml +++ b/examples/leads_tracker/Ballerina.toml @@ -6,4 +6,3 @@ distribution = "2201.10.3" [build-options] observabilityIncluded = true - diff --git a/examples/leads_tracker/Dependencies.toml b/examples/leads_tracker/Dependencies.toml deleted file mode 100644 index fa09954..0000000 --- a/examples/leads_tracker/Dependencies.toml +++ /dev/null @@ -1,314 +0,0 @@ -# AUTO-GENERATED FILE. DO NOT MODIFY. - -# This file is auto-generated by Ballerina for managing dependency versions. -# It should not be modified by hand. - -[ballerina] -dependencies-toml-version = "2" -distribution-version = "2201.10.3" - -[[package]] -org = "ballerina" -name = "auth" -version = "2.12.0" -dependencies = [ - {org = "ballerina", name = "crypto"}, - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "lang.array"}, - {org = "ballerina", name = "lang.string"}, - {org = "ballerina", name = "log"} -] - -[[package]] -org = "ballerina" -name = "cache" -version = "3.8.0" -dependencies = [ - {org = "ballerina", name = "constraint"}, - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "task"}, - {org = "ballerina", name = "time"} -] - -[[package]] -org = "ballerina" -name = "constraint" -version = "1.5.0" -dependencies = [ - {org = "ballerina", name = "jballerina.java"} -] - -[[package]] -org = "ballerina" -name = "crypto" -version = "2.7.2" -dependencies = [ - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "time"} -] - -[[package]] -org = "ballerina" -name = "file" -version = "1.10.0" -dependencies = [ - {org = "ballerina", name = "io"}, - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "os"}, - {org = "ballerina", name = "time"} -] - -[[package]] -org = "ballerina" -name = "http" -version = "2.12.4" -dependencies = [ - {org = "ballerina", name = "auth"}, - {org = "ballerina", name = "cache"}, - {org = "ballerina", name = "constraint"}, - {org = "ballerina", name = "crypto"}, - {org = "ballerina", name = "file"}, - {org = "ballerina", name = "io"}, - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "jwt"}, - {org = "ballerina", name = "lang.array"}, - {org = "ballerina", name = "lang.decimal"}, - {org = "ballerina", name = "lang.int"}, - {org = "ballerina", name = "lang.regexp"}, - {org = "ballerina", name = "lang.runtime"}, - {org = "ballerina", name = "lang.string"}, - {org = "ballerina", name = "lang.value"}, - {org = "ballerina", name = "log"}, - {org = "ballerina", name = "mime"}, - {org = "ballerina", name = "oauth2"}, - {org = "ballerina", name = "observe"}, - {org = "ballerina", name = "time"}, - {org = "ballerina", name = "url"} -] - -[[package]] -org = "ballerina" -name = "io" -version = "1.6.3" -dependencies = [ - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "lang.value"} -] -modules = [ - {org = "ballerina", packageName = "io", moduleName = "io"} -] - -[[package]] -org = "ballerina" -name = "jballerina.java" -version = "0.0.0" - -[[package]] -org = "ballerina" -name = "jwt" -version = "2.13.0" -dependencies = [ - {org = "ballerina", name = "cache"}, - {org = "ballerina", name = "crypto"}, - {org = "ballerina", name = "io"}, - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "lang.int"}, - {org = "ballerina", name = "lang.string"}, - {org = "ballerina", name = "log"}, - {org = "ballerina", name = "time"} -] - -[[package]] -org = "ballerina" -name = "lang.__internal" -version = "0.0.0" -dependencies = [ - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "lang.object"} -] - -[[package]] -org = "ballerina" -name = "lang.array" -version = "0.0.0" -dependencies = [ - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "lang.__internal"} -] - -[[package]] -org = "ballerina" -name = "lang.decimal" -version = "0.0.0" -dependencies = [ - {org = "ballerina", name = "jballerina.java"} -] - -[[package]] -org = "ballerina" -name = "lang.int" -version = "0.0.0" -dependencies = [ - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "lang.__internal"}, - {org = "ballerina", name = "lang.object"} -] - -[[package]] -org = "ballerina" -name = "lang.object" -version = "0.0.0" - -[[package]] -org = "ballerina" -name = "lang.regexp" -version = "0.0.0" -dependencies = [ - {org = "ballerina", name = "jballerina.java"} -] - -[[package]] -org = "ballerina" -name = "lang.runtime" -version = "0.0.0" -dependencies = [ - {org = "ballerina", name = "jballerina.java"} -] - -[[package]] -org = "ballerina" -name = "lang.string" -version = "0.0.0" -dependencies = [ - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "lang.regexp"} -] - -[[package]] -org = "ballerina" -name = "lang.value" -version = "0.0.0" -dependencies = [ - {org = "ballerina", name = "jballerina.java"} -] - -[[package]] -org = "ballerina" -name = "log" -version = "2.10.0" -dependencies = [ - {org = "ballerina", name = "io"}, - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "lang.value"}, - {org = "ballerina", name = "observe"} -] - -[[package]] -org = "ballerina" -name = "mime" -version = "2.10.1" -dependencies = [ - {org = "ballerina", name = "io"}, - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "lang.int"}, - {org = "ballerina", name = "log"} -] - -[[package]] -org = "ballerina" -name = "oauth2" -version = "2.12.0" -dependencies = [ - {org = "ballerina", name = "cache"}, - {org = "ballerina", name = "crypto"}, - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "log"}, - {org = "ballerina", name = "time"}, - {org = "ballerina", name = "url"} -] -modules = [ - {org = "ballerina", packageName = "oauth2", moduleName = "oauth2"} -] - -[[package]] -org = "ballerina" -name = "observe" -version = "1.3.0" -dependencies = [ - {org = "ballerina", name = "jballerina.java"} -] - -[[package]] -org = "ballerina" -name = "os" -version = "1.8.0" -dependencies = [ - {org = "ballerina", name = "io"}, - {org = "ballerina", name = "jballerina.java"} -] - -[[package]] -org = "ballerina" -name = "task" -version = "2.5.0" -dependencies = [ - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "time"} -] - -[[package]] -org = "ballerina" -name = "time" -version = "2.5.0" -dependencies = [ - {org = "ballerina", name = "jballerina.java"} -] - -[[package]] -org = "ballerina" -name = "url" -version = "2.4.0" -dependencies = [ - {org = "ballerina", name = "jballerina.java"} -] - -[[package]] -org = "ballerinai" -name = "observe" -version = "0.0.0" -dependencies = [ - {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "observe"} -] -modules = [ - {org = "ballerinai", packageName = "observe", moduleName = "observe"} -] - -[[package]] -org = "ballerinax" -name = "hubspot.crm.lists" -version = "0.1.0" -dependencies = [ - {org = "ballerina", name = "http"}, - {org = "ballerina", name = "oauth2"}, - {org = "ballerina", name = "url"}, - {org = "ballerinai", name = "observe"} -] -modules = [ - {org = "ballerinax", packageName = "hubspot.crm.lists", moduleName = "hubspot.crm.lists"} -] - -[[package]] -org = "sajithaj" -name = "leads_tracker" -version = "0.1.0" -dependencies = [ - {org = "ballerina", name = "io"}, - {org = "ballerina", name = "oauth2"}, - {org = "ballerinai", name = "observe"}, - {org = "ballerinax", name = "hubspot.crm.lists"} -] -modules = [ - {org = "sajithaj", packageName = "leads_tracker", moduleName = "leads_tracker"} -] - diff --git a/examples/leads_tracker/main.bal b/examples/leads_tracker/main.bal index bd19808..1c2e489 100644 --- a/examples/leads_tracker/main.bal +++ b/examples/leads_tracker/main.bal @@ -44,7 +44,7 @@ function getLeadsIDs() returns string[] { function addRecordsToList(string listId, string typeOfLeads) returns error? { string[] payload = getLeadsIDs(); - hslists:MembershipsUpdateResponse response = check hubspotClient->putListidMembershipsAdd_add(listId, payload); + hslists:MembershipsUpdateResponse response = check hubspotClient->putListIdMembershipsAddAdd(listId, payload); if response.recordsIdsAdded !is () { io:println("[+] Leads added to the " + typeOfLeads + " Leads List: ", response.recordsIdsAdded); } @@ -64,22 +64,22 @@ public function main() returns error? { }; // Create lists for leads with status 'New' - hslists:ListCreateResponse newLeadsListCreateResponse = check hubspotClient->post_create(payload = payloadForList); + hslists:ListCreateResponse newLeadsListCreateResponse = check hubspotClient->postCreate(payload = payloadForList); io:println("[+] New Leads List created successfully: ", newLeadsListCreateResponse.list.name); // Create a list for leads with status 'Open' payloadForList.name = "Open Leads"; - hslists:ListCreateResponse openLeadsListCreateResponse = check hubspotClient->post_create(payload = payloadForList); + hslists:ListCreateResponse openLeadsListCreateResponse = check hubspotClient->postCreate(payload = payloadForList); io:println("[+] Open Leads List created successfully: ", openLeadsListCreateResponse.list.name); // Create a list for leads with status 'In progress' payloadForList.name = "In Progress Leads"; - hslists:ListCreateResponse inProgressLeadsListCreateResponse = check hubspotClient->post_create(payload = payloadForList); + hslists:ListCreateResponse inProgressLeadsListCreateResponse = check hubspotClient->postCreate(payload = payloadForList); io:println("[+] In Progress Leads List created successfully: ", inProgressLeadsListCreateResponse.list.name); // Create a list for leads with status 'Contacted' payloadForList.name = "Contacted Leads"; - hslists:ListCreateResponse contactedLeadsListCreateResponse = check hubspotClient->post_create(payload = payloadForList); + hslists:ListCreateResponse contactedLeadsListCreateResponse = check hubspotClient->postCreate(payload = payloadForList); io:println("[+] Contacted Leads List created successfully: ", contactedLeadsListCreateResponse.list.name); // adding leads to the list diff --git a/gradle.properties b/gradle.properties index f7dd3ee..550f16d 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,7 +1,7 @@ org.gradle.caching=true group=io.ballerina.lib -version=0.1.1-SNAPSHOT +version=1.0.0-SNAPSHOT releasePluginVersion=2.8.0 -ballerinaGradlePluginVersion=2.2.4 +ballerinaGradlePluginVersion=2.3.0 ballerinaLangVersion=2201.12.2