@outseta/react 0.4.33 → 0.4.34

package/dist/index.js

@@ -1909,6 +1909,97 @@ var useRegistrationRegisterAccount = (options) => {
   const mutationOptions = getRegistrationRegisterAccountMutationOptions(options);
   return useMutation(mutationOptions);
 };
+var segmentAddTagToEntity = (entityUid, segmentAddTagToEntityBody, options, signal) => {
+  return customFetch2({
+    url: `/api/v1/crm/segments/${entityUid}/tags`,
+    method: "POST",
+    headers: { "Content-Type": "application/json" },
+    data: segmentAddTagToEntityBody,
+    responseType: "blob",
+    signal
+  }, options);
+};
+var getSegmentAddTagToEntityMutationOptions = (options) => {
+  const mutationKey = ["segmentAddTagToEntity"];
+  const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey ? options : { ...options, mutation: { ...options.mutation, mutationKey } } : { mutation: { mutationKey }, request: undefined };
+  const mutationFn = (props) => {
+    const { entityUid, data } = props ?? {};
+    return segmentAddTagToEntity(entityUid, data, requestOptions);
+  };
+  return { mutationFn, ...mutationOptions };
+};
+var useSegmentAddTagToEntity = (options) => {
+  const mutationOptions = getSegmentAddTagToEntityMutationOptions(options);
+  return useMutation(mutationOptions);
+};
+var segmentGetTagsForEntity = (entityUid, params, options, signal) => {
+  return customFetch2({
+    url: `/api/v1/crm/segments/${entityUid}/tags`,
+    method: "GET",
+    params,
+    signal
+  }, options);
+};
+var getSegmentGetTagsForEntityQueryKey = (entityUid, params) => {
+  return [
+    `/api/v1/crm/segments/${entityUid}/tags`,
+    ...params ? [params] : []
+  ];
+};
+var getSegmentGetTagsForEntityQueryOptions = (entityUid, params, options) => {
+  const { query: queryOptions, request: requestOptions } = options ?? {};
+  const queryKey = queryOptions?.queryKey ?? getSegmentGetTagsForEntityQueryKey(entityUid, params);
+  const queryFn = ({ signal }) => segmentGetTagsForEntity(entityUid, params, requestOptions, signal);
+  return { queryKey, queryFn, enabled: !!entityUid, ...queryOptions };
+};
+function useSegmentGetTagsForEntity(entityUid, params, options) {
+  const queryOptions = getSegmentGetTagsForEntityQueryOptions(entityUid, params, options);
+  const query = useQuery(queryOptions);
+  query.queryKey = queryOptions.queryKey;
+  return query;
+}
+var segmentSetTagsForEntity = (entityUid, segmentSetTagsForEntityBody, options) => {
+  return customFetch2({
+    url: `/api/v1/crm/segments/${entityUid}/tags`,
+    method: "PUT",
+    headers: { "Content-Type": "application/json" },
+    data: segmentSetTagsForEntityBody,
+    responseType: "blob"
+  }, options);
+};
+var getSegmentSetTagsForEntityMutationOptions = (options) => {
+  const mutationKey = ["segmentSetTagsForEntity"];
+  const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey ? options : { ...options, mutation: { ...options.mutation, mutationKey } } : { mutation: { mutationKey }, request: undefined };
+  const mutationFn = (props) => {
+    const { entityUid, data } = props ?? {};
+    return segmentSetTagsForEntity(entityUid, data, requestOptions);
+  };
+  return { mutationFn, ...mutationOptions };
+};
+var useSegmentSetTagsForEntity = (options) => {
+  const mutationOptions = getSegmentSetTagsForEntityMutationOptions(options);
+  return useMutation(mutationOptions);
+};
+var segmentRemoveTagFromEntity = (entityUid, tagUid, options) => {
+  return customFetch2({
+    url: `/api/v1/crm/segments/${entityUid}/tags/${tagUid}`,
+    method: "DELETE",
+    responseType: "blob"
+  }, options);
+};
+var getSegmentRemoveTagFromEntityMutationOptions = (options) => {
+  const mutationKey = ["segmentRemoveTagFromEntity"];
+  const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey ? options : { ...options, mutation: { ...options.mutation, mutationKey } } : { mutation: { mutationKey }, request: undefined };
+  const mutationFn = (props) => {
+    const { entityUid, tagUid } = props ?? {};
+    return segmentRemoveTagFromEntity(entityUid, tagUid, requestOptions);
+  };
+  return { mutationFn, ...mutationOptions };
+};
+var useSegmentRemoveTagFromEntity = (options) => {
+  const mutationOptions = getSegmentRemoveTagFromEntityMutationOptions(options);
+  return useMutation(mutationOptions);
+};
 var accountGetAllAccounts = (params, options, signal) => {
   return customFetch2({
     url: `/api/v1/crm/accounts`,
@@ -2774,6 +2865,97 @@ var useCampaignSendTestCampaignEmail = (options) => {
   const mutationOptions = getCampaignSendTestCampaignEmailMutationOptions(options);
   return useMutation(mutationOptions);
 };
+var campaignAddTagToEntity = (entityUid, campaignAddTagToEntityBody, options, signal) => {
+  return customFetch2({
+    url: `/api/v1/email/campaigns/broadcasts/${entityUid}/tags`,
+    method: "POST",
+    headers: { "Content-Type": "application/json" },
+    data: campaignAddTagToEntityBody,
+    responseType: "blob",
+    signal
+  }, options);
+};
+var getCampaignAddTagToEntityMutationOptions = (options) => {
+  const mutationKey = ["campaignAddTagToEntity"];
+  const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey ? options : { ...options, mutation: { ...options.mutation, mutationKey } } : { mutation: { mutationKey }, request: undefined };
+  const mutationFn = (props) => {
+    const { entityUid, data } = props ?? {};
+    return campaignAddTagToEntity(entityUid, data, requestOptions);
+  };
+  return { mutationFn, ...mutationOptions };
+};
+var useCampaignAddTagToEntity = (options) => {
+  const mutationOptions = getCampaignAddTagToEntityMutationOptions(options);
+  return useMutation(mutationOptions);
+};
+var campaignGetTagsForEntity = (entityUid, params, options, signal) => {
+  return customFetch2({
+    url: `/api/v1/email/campaigns/broadcasts/${entityUid}/tags`,
+    method: "GET",
+    params,
+    signal
+  }, options);
+};
+var getCampaignGetTagsForEntityQueryKey = (entityUid, params) => {
+  return [
+    `/api/v1/email/campaigns/broadcasts/${entityUid}/tags`,
+    ...params ? [params] : []
+  ];
+};
+var getCampaignGetTagsForEntityQueryOptions = (entityUid, params, options) => {
+  const { query: queryOptions, request: requestOptions } = options ?? {};
+  const queryKey = queryOptions?.queryKey ?? getCampaignGetTagsForEntityQueryKey(entityUid, params);
+  const queryFn = ({ signal }) => campaignGetTagsForEntity(entityUid, params, requestOptions, signal);
+  return { queryKey, queryFn, enabled: !!entityUid, ...queryOptions };
+};
+function useCampaignGetTagsForEntity(entityUid, params, options) {
+  const queryOptions = getCampaignGetTagsForEntityQueryOptions(entityUid, params, options);
+  const query = useQuery(queryOptions);
+  query.queryKey = queryOptions.queryKey;
+  return query;
+}
+var campaignSetTagsForEntity = (entityUid, campaignSetTagsForEntityBody, options) => {
+  return customFetch2({
+    url: `/api/v1/email/campaigns/broadcasts/${entityUid}/tags`,
+    method: "PUT",
+    headers: { "Content-Type": "application/json" },
+    data: campaignSetTagsForEntityBody,
+    responseType: "blob"
+  }, options);
+};
+var getCampaignSetTagsForEntityMutationOptions = (options) => {
+  const mutationKey = ["campaignSetTagsForEntity"];
+  const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey ? options : { ...options, mutation: { ...options.mutation, mutationKey } } : { mutation: { mutationKey }, request: undefined };
+  const mutationFn = (props) => {
+    const { entityUid, data } = props ?? {};
+    return campaignSetTagsForEntity(entityUid, data, requestOptions);
+  };
+  return { mutationFn, ...mutationOptions };
+};
+var useCampaignSetTagsForEntity = (options) => {
+  const mutationOptions = getCampaignSetTagsForEntityMutationOptions(options);
+  return useMutation(mutationOptions);
+};
+var campaignRemoveTagFromEntity = (entityUid, tagUid, options) => {
+  return customFetch2({
+    url: `/api/v1/email/campaigns/broadcasts/${entityUid}/tags/${tagUid}`,
+    method: "DELETE",
+    responseType: "blob"
+  }, options);
+};
+var getCampaignRemoveTagFromEntityMutationOptions = (options) => {
+  const mutationKey = ["campaignRemoveTagFromEntity"];
+  const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey ? options : { ...options, mutation: { ...options.mutation, mutationKey } } : { mutation: { mutationKey }, request: undefined };
+  const mutationFn = (props) => {
+    const { entityUid, tagUid } = props ?? {};
+    return campaignRemoveTagFromEntity(entityUid, tagUid, requestOptions);
+  };
+  return { mutationFn, ...mutationOptions };
+};
+var useCampaignRemoveTagFromEntity = (options) => {
+  const mutationOptions = getCampaignRemoveTagFromEntityMutationOptions(options);
+  return useMutation(mutationOptions);
+};
 var emailListGetAllEmailLists = (params, options, signal) => {
   return customFetch2({
     url: `/api/v1/email/lists`,
@@ -3163,6 +3345,97 @@ function useArticleGetArticle(articleUid, options) {
   query.queryKey = queryOptions.queryKey;
   return query;
 }
+var articleAddTagToEntity = (entityUid, articleAddTagToEntityBody, options, signal) => {
+  return customFetch2({
+    url: `/api/v1/support/articles/${entityUid}/tags`,
+    method: "POST",
+    headers: { "Content-Type": "application/json" },
+    data: articleAddTagToEntityBody,
+    responseType: "blob",
+    signal
+  }, options);
+};
+var getArticleAddTagToEntityMutationOptions = (options) => {
+  const mutationKey = ["articleAddTagToEntity"];
+  const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey ? options : { ...options, mutation: { ...options.mutation, mutationKey } } : { mutation: { mutationKey }, request: undefined };
+  const mutationFn = (props) => {
+    const { entityUid, data } = props ?? {};
+    return articleAddTagToEntity(entityUid, data, requestOptions);
+  };
+  return { mutationFn, ...mutationOptions };
+};
+var useArticleAddTagToEntity = (options) => {
+  const mutationOptions = getArticleAddTagToEntityMutationOptions(options);
+  return useMutation(mutationOptions);
+};
+var articleGetTagsForEntity = (entityUid, params, options, signal) => {
+  return customFetch2({
+    url: `/api/v1/support/articles/${entityUid}/tags`,
+    method: "GET",
+    params,
+    signal
+  }, options);
+};
+var getArticleGetTagsForEntityQueryKey = (entityUid, params) => {
+  return [
+    `/api/v1/support/articles/${entityUid}/tags`,
+    ...params ? [params] : []
+  ];
+};
+var getArticleGetTagsForEntityQueryOptions = (entityUid, params, options) => {
+  const { query: queryOptions, request: requestOptions } = options ?? {};
+  const queryKey = queryOptions?.queryKey ?? getArticleGetTagsForEntityQueryKey(entityUid, params);
+  const queryFn = ({ signal }) => articleGetTagsForEntity(entityUid, params, requestOptions, signal);
+  return { queryKey, queryFn, enabled: !!entityUid, ...queryOptions };
+};
+function useArticleGetTagsForEntity(entityUid, params, options) {
+  const queryOptions = getArticleGetTagsForEntityQueryOptions(entityUid, params, options);
+  const query = useQuery(queryOptions);
+  query.queryKey = queryOptions.queryKey;
+  return query;
+}
+var articleSetTagsForEntity = (entityUid, articleSetTagsForEntityBody, options) => {
+  return customFetch2({
+    url: `/api/v1/support/articles/${entityUid}/tags`,
+    method: "PUT",
+    headers: { "Content-Type": "application/json" },
+    data: articleSetTagsForEntityBody,
+    responseType: "blob"
+  }, options);
+};
+var getArticleSetTagsForEntityMutationOptions = (options) => {
+  const mutationKey = ["articleSetTagsForEntity"];
+  const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey ? options : { ...options, mutation: { ...options.mutation, mutationKey } } : { mutation: { mutationKey }, request: undefined };
+  const mutationFn = (props) => {
+    const { entityUid, data } = props ?? {};
+    return articleSetTagsForEntity(entityUid, data, requestOptions);
+  };
+  return { mutationFn, ...mutationOptions };
+};
+var useArticleSetTagsForEntity = (options) => {
+  const mutationOptions = getArticleSetTagsForEntityMutationOptions(options);
+  return useMutation(mutationOptions);
+};
+var articleRemoveTagFromEntity = (entityUid, tagUid, options) => {
+  return customFetch2({
+    url: `/api/v1/support/articles/${entityUid}/tags/${tagUid}`,
+    method: "DELETE",
+    responseType: "blob"
+  }, options);
+};
+var getArticleRemoveTagFromEntityMutationOptions = (options) => {
+  const mutationKey = ["articleRemoveTagFromEntity"];
+  const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey ? options : { ...options, mutation: { ...options.mutation, mutationKey } } : { mutation: { mutationKey }, request: undefined };
+  const mutationFn = (props) => {
+    const { entityUid, tagUid } = props ?? {};
+    return articleRemoveTagFromEntity(entityUid, tagUid, requestOptions);
+  };
+  return { mutationFn, ...mutationOptions };
+};
+var useArticleRemoveTagFromEntity = (options) => {
+  const mutationOptions = getArticleRemoveTagFromEntityMutationOptions(options);
+  return useMutation(mutationOptions);
+};
 var categoryGetAllCategories = (params, options, signal) => {
   return customFetch2({
     url: `/api/v1/support/categories`,
@@ -3220,7 +3493,8 @@ var EntityType = {
   AddOn: 9,
   Task: 10,
   Segment: 11,
-  Broadcast: 12
+  Broadcast: 12,
+  Article: 13
 };
 var AccountStage = {
   Trialing: 2,
@@ -3854,14 +4128,22 @@ export {
   activityAddCustomActivity,
   activityGetAll,
   articleAddArticle,
+  articleAddTagToEntity,
   articleGetAllArticles,
   articleGetArticle,
+  articleGetTagsForEntity,
+  articleRemoveTagFromEntity,
+  articleSetTagsForEntity,
   campaignAddBroadcastEmail,
+  campaignAddTagToEntity,
   campaignArchiveBroadcastCampaign,
   campaignDeleteBroadcastCampaign,
   campaignGetAllBroadcastEmails,
   campaignGetBroadcastEmail,
+  campaignGetTagsForEntity,
+  campaignRemoveTagFromEntity,
   campaignSendTestCampaignEmail,
+  campaignSetTagsForEntity,
   campaignUnscheduleBroadcastEmail,
   campaignUpdateBroadcastEmail,
   caseAddCase,
@@ -3920,18 +4202,28 @@ export {
   getActivityGetAllQueryKey,
   getActivityGetAllQueryOptions,
   getArticleAddArticleMutationOptions,
+  getArticleAddTagToEntityMutationOptions,
   getArticleGetAllArticlesQueryKey,
   getArticleGetAllArticlesQueryOptions,
   getArticleGetArticleQueryKey,
   getArticleGetArticleQueryOptions,
+  getArticleGetTagsForEntityQueryKey,
+  getArticleGetTagsForEntityQueryOptions,
+  getArticleRemoveTagFromEntityMutationOptions,
+  getArticleSetTagsForEntityMutationOptions,
   getCampaignAddBroadcastEmailMutationOptions,
+  getCampaignAddTagToEntityMutationOptions,
   getCampaignArchiveBroadcastCampaignMutationOptions,
   getCampaignDeleteBroadcastCampaignMutationOptions,
   getCampaignGetAllBroadcastEmailsQueryKey,
   getCampaignGetAllBroadcastEmailsQueryOptions,
   getCampaignGetBroadcastEmailQueryKey,
   getCampaignGetBroadcastEmailQueryOptions,
+  getCampaignGetTagsForEntityQueryKey,
+  getCampaignGetTagsForEntityQueryOptions,
+  getCampaignRemoveTagFromEntityMutationOptions,
   getCampaignSendTestCampaignEmailMutationOptions,
+  getCampaignSetTagsForEntityMutationOptions,
   getCampaignUnscheduleBroadcastEmailMutationOptions,
   getCampaignUpdateBroadcastEmailMutationOptions,
   getCaseAddCaseMutationOptions,
@@ -4024,6 +4316,11 @@ export {
   getPlanGetPlanQueryOptions,
   getPlanUpdatePlanMutationOptions,
   getRegistrationRegisterAccountMutationOptions,
+  getSegmentAddTagToEntityMutationOptions,
+  getSegmentGetTagsForEntityQueryKey,
+  getSegmentGetTagsForEntityQueryOptions,
+  getSegmentRemoveTagFromEntityMutationOptions,
+  getSegmentSetTagsForEntityMutationOptions,
   getSubscriptionAddDiscountToSubscriptionMutationOptions,
   getSubscriptionAddOnAddSubscriptionAddOnMutationOptions,
   getSubscriptionAddOnAddSubscriptionAddOnPreviewMutationOptions,
@@ -4078,6 +4375,10 @@ export {
   planGetPlan,
   planUpdatePlan,
   registrationRegisterAccount,
+  segmentAddTagToEntity,
+  segmentGetTagsForEntity,
+  segmentRemoveTagFromEntity,
+  segmentSetTagsForEntity,
   subscriptionAddDiscountToSubscription,
   subscriptionAddOnAddSubscriptionAddOn,
   subscriptionAddOnAddSubscriptionAddOnPreview,
@@ -4113,14 +4414,22 @@ export {
   useActivityAddCustomActivity,
   useActivityGetAll,
   useArticleAddArticle,
+  useArticleAddTagToEntity,
   useArticleGetAllArticles,
   useArticleGetArticle,
+  useArticleGetTagsForEntity,
+  useArticleRemoveTagFromEntity,
+  useArticleSetTagsForEntity,
   useCampaignAddBroadcastEmail,
+  useCampaignAddTagToEntity,
   useCampaignArchiveBroadcastCampaign,
   useCampaignDeleteBroadcastCampaign,
   useCampaignGetAllBroadcastEmails,
   useCampaignGetBroadcastEmail,
+  useCampaignGetTagsForEntity,
+  useCampaignRemoveTagFromEntity,
   useCampaignSendTestCampaignEmail,
+  useCampaignSetTagsForEntity,
   useCampaignUnscheduleBroadcastEmail,
   useCampaignUpdateBroadcastEmail,
   useCaseAddCase,
@@ -4190,6 +4499,10 @@ export {
   usePlanGetPlan,
   usePlanUpdatePlan,
   useRegistrationRegisterAccount,
+  useSegmentAddTagToEntity,
+  useSegmentGetTagsForEntity,
+  useSegmentRemoveTagFromEntity,
+  useSegmentSetTagsForEntity,
   useSubscriptionAddDiscountToSubscription,
   useSubscriptionAddOnAddSubscriptionAddOn,
   useSubscriptionAddOnAddSubscriptionAddOnPreview,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@outseta/react",
-  "version": "0.4.33",
+  "version": "0.4.34",
   "description": "React hooks and components for the Outseta API",
   "license": "MIT",
   "repository": {
@@ -18,7 +18,7 @@
     }
   },
   "dependencies": {
-    "@outseta/api-client": "0.3.39"
+    "@outseta/api-client": "0.3.40"
   },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0"

package/src/generated/attribute/attribute.ts

@@ -59,13 +59,18 @@ type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
 
 
 /**
- * Each tag applies to a single entity type. Pass entityType=Case to retrieve the tags
-that can be put on support tickets.
+ * Each tag applies to a single entity type. Pass entityType to retrieve the tags for one
+of them, for example entityType=Article for knowledge base article tags.
             
-How a tag goes onto a record depends on the entity type. A support ticket holds its
-tags in its own CaseTags collection, so you add and remove ticket tags with
-PUT /support/cases/{caseUid}. Other entity types store their tags differently. This
-documentation covers ticket tags only.
+How a tag goes onto a record depends on the entity type. Articles, broadcasts and
+segments each take tags on a tags sub-resource of the record:
+            
+- POST /support/articles/{entityUid}/tags and PUT, GET, DELETE on the same path
+- POST /email/campaigns/broadcasts/{entityUid}/tags and the same for the rest
+- POST /crm/segments/{entityUid}/tags and the same for the rest
+            
+A support ticket is the exception. It holds its tags in its own CaseTags collection, so
+you add and remove ticket tags with PUT /support/cases/{caseUid}.
             
 Name is unique within an entity type. SystemName and SystemDescription identify a
 built-in tag (for example Priority.Urgent) and are set by Outseta.
@@ -138,8 +143,9 @@ export function useTagGetAllTags<TData = Awaited<ReturnType<typeof tagGetAllTags
 
 
 /**
- * Name and EntityType are required. Use EntityType 4 (Case) for a tag that goes on
-support tickets. TagColor sets the color the tag shows in.
+ * Name and EntityType are required. EntityType fixes what the tag can go on: 4 (Case) for
+support tickets, 13 (Article) for knowledge base articles, 12 (Broadcast) for broadcast
+emails, 11 (Segment) for segments. TagColor sets the color the tag shows in.
             
 Name must be unique within an entity type. If the name already exists for that
 entity type, the existing tag is returned instead of a duplicate, and its color is
@@ -346,6 +352,9 @@ export const useTagUpdateTag = <TError = void,
     /**
  * The tag is also taken off every record that carries it. For a Case tag, it is
 removed from all support tickets that have it.
+            
+An Article tag that the knowledge base version filter names cannot be deleted. Take it
+out of the version filter first, then delete it.
  * @summary Delete a tag.
  */
 export const tagDeleteTag = (