@outseta/api-client 0.3.36 → 0.3.38

package/dist/index.js

@@ -1235,6 +1235,17 @@ var caseGetCase = async (caseUid, options) => {
     method: "GET"
   });
 };
+var getCaseUpdateCaseUrl = (caseUid) => {
+  return `/api/v1/support/cases/${caseUid}`;
+};
+var caseUpdateCase = async (caseUid, caseUpdateCaseBody, options) => {
+  return customFetch(getCaseUpdateCaseUrl(caseUid), {
+    ...options,
+    method: "PUT",
+    headers: { "Content-Type": "application/json", ...options?.headers },
+    body: JSON.stringify(caseUpdateCaseBody)
+  });
+};
 var getCaseAddReplyUrl = (caseUid) => {
   return `/api/v1/support/cases/${caseUid}/replies`;
 };
@@ -1922,6 +1933,12 @@ var TaskStatus = {
   InProgress: 2,
   Done: 3
 };
+// src/generated/models/taskWebhookEventDataStatus.ts
+var TaskWebhookEventDataStatus = {
+  Pending: 1,
+  InProgress: 2,
+  Done: 3
+};
 // src/generated/models/teamRole.ts
 var TeamRole = {
   Admin: 1,
@@ -1996,6 +2013,7 @@ export {
   SupportCaseStatus,
   TagColor,
   TaskStatus,
+  TaskWebhookEventDataStatus,
   TeamRole,
   accountAddAccount,
   accountAddPersonToAccount,
@@ -2027,6 +2045,7 @@ export {
   caseAddReply,
   caseGetAllCases,
   caseGetCase,
+  caseUpdateCase,
   categoryGetAllCategories,
   createClient,
   customFetch,
@@ -2090,6 +2109,7 @@ export {
   getCaseAddReplyUrl,
   getCaseGetAllCasesUrl,
   getCaseGetCaseUrl,
+  getCaseUpdateCaseUrl,
   getCategoryGetAllCategoriesUrl,
   getDealAddDealUrl,
   getDealDeleteDealUrl,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@outseta/api-client",
-  "version": "0.3.36",
+  "version": "0.3.38",
   "description": "Generated API client for the Outseta REST API",
   "license": "MIT",
   "repository": {

package/src/generated/attribute/attribute.ts

@@ -2,11 +2,315 @@
 import type {
   Definition,
   DefinitionGetAllDefinitions200,
-  DefinitionGetAllDefinitionsParams
+  DefinitionGetAllDefinitionsParams,
+  Tag,
+  TagAddTagBody,
+  TagGetAllTags200,
+  TagGetAllTagsParams,
+  TagUpdateTagBody
 } from '.././models';
 
 import { customFetch } from '../../client';
 
+// https://stackoverflow.com/questions/49579094/typescript-conditional-types-filter-out-readonly-properties-pick-only-requir/49579497#49579497
+type IfEquals<X, Y, A = X, B = never> = (<T>() => T extends X ? 1 : 2) extends <
+T,
+>() => T extends Y ? 1 : 2
+? A
+: B;
+
+type WritableKeys<T> = {
+[P in keyof T]-?: IfEquals<
+  { [Q in P]: T[P] },
+  { -readonly [Q in P]: T[P] },
+  P
+>;
+}[keyof T];
+
+type UnionToIntersection<U> =
+  (U extends any ? (k: U)=>void : never) extends ((k: infer I)=>void) ? I : never;
+type DistributeReadOnlyOverUnions<T> = T extends any ? NonReadonly<T> : never;
+
+type Writable<T> = Pick<T, WritableKeys<T>>;
+type NonReadonly<T> = [T] extends [UnionToIntersection<T>] ? {
+  [P in keyof Writable<T>]: T[P] extends object
+    ? NonReadonly<NonNullable<T[P]>>
+    : T[P];
+} : DistributeReadOnlyOverUnions<T>;
+
+
+/**
+ * Each tag applies to a single entity type. Pass entityType=Case to retrieve the tags
+that can be put on support tickets.
+            
+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.
+            
+Name is unique within an entity type. SystemName and SystemDescription identify a
+built-in tag (for example Priority.Urgent) and are set by Outseta.
+ * @summary Retrieve all tags.
+ */
+export type tagGetAllTagsResponse200 = {
+  data: TagGetAllTags200
+  status: 200
+}
+
+export type tagGetAllTagsResponse401 = {
+  data: void
+  status: 401
+}
+    
+export type tagGetAllTagsResponseSuccess = (tagGetAllTagsResponse200) & {
+  headers: Headers;
+};
+export type tagGetAllTagsResponseError = (tagGetAllTagsResponse401) & {
+  headers: Headers;
+};
+
+export type tagGetAllTagsResponse = (tagGetAllTagsResponseSuccess | tagGetAllTagsResponseError)
+
+export const getTagGetAllTagsUrl = (params?: TagGetAllTagsParams,) => {
+  const normalizedParams = new URLSearchParams();
+
+  Object.entries(params || {}).forEach(([key, value]) => {
+    
+    if (value !== undefined) {
+      normalizedParams.append(key, value === null ? 'null' : value.toString())
+    }
+  });
+
+  const stringifiedParams = normalizedParams.toString();
+
+  return stringifiedParams.length > 0 ? `/api/v1/attribute/tags?${stringifiedParams}` : `/api/v1/attribute/tags`
+}
+
+export const tagGetAllTags = async (params?: TagGetAllTagsParams, options?: RequestInit): Promise<tagGetAllTagsResponse> => {
+  
+  return customFetch<tagGetAllTagsResponse>(getTagGetAllTagsUrl(params),
+  {      
+    ...options,
+    method: 'GET'
+    
+    
+  }
+);}
+
+
+/**
+ * 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 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
+updated when a different TagColor is supplied. SystemName and SystemDescription are
+set by Outseta and are ignored here.
+ * @summary Create a tag.
+ */
+export type tagAddTagResponse200 = {
+  data: Tag
+  status: 200
+}
+
+export type tagAddTagResponse401 = {
+  data: void
+  status: 401
+}
+    
+export type tagAddTagResponseSuccess = (tagAddTagResponse200) & {
+  headers: Headers;
+};
+export type tagAddTagResponseError = (tagAddTagResponse401) & {
+  headers: Headers;
+};
+
+export type tagAddTagResponse = (tagAddTagResponseSuccess | tagAddTagResponseError)
+
+export const getTagAddTagUrl = () => {
+
+
+  
+
+  return `/api/v1/attribute/tags`
+}
+
+export const tagAddTag = async (tagAddTagBody: NonReadonly<TagAddTagBody>, options?: RequestInit): Promise<tagAddTagResponse> => {
+  
+  return customFetch<tagAddTagResponse>(getTagAddTagUrl(),
+  {      
+    ...options,
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json', ...options?.headers },
+    body: JSON.stringify(
+      tagAddTagBody,)
+  }
+);}
+
+
+/**
+ * @summary Retrieve a tag.
+ */
+export type tagGetTagResponse200 = {
+  data: Tag
+  status: 200
+}
+
+export type tagGetTagResponse400 = {
+  data: void
+  status: 400
+}
+
+export type tagGetTagResponse401 = {
+  data: void
+  status: 401
+}
+
+export type tagGetTagResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type tagGetTagResponseSuccess = (tagGetTagResponse200) & {
+  headers: Headers;
+};
+export type tagGetTagResponseError = (tagGetTagResponse400 | tagGetTagResponse401 | tagGetTagResponse404) & {
+  headers: Headers;
+};
+
+export type tagGetTagResponse = (tagGetTagResponseSuccess | tagGetTagResponseError)
+
+export const getTagGetTagUrl = (tagUid: string | null,) => {
+
+
+  
+
+  return `/api/v1/attribute/tags/${tagUid}`
+}
+
+export const tagGetTag = async (tagUid: string | null, options?: RequestInit): Promise<tagGetTagResponse> => {
+  
+  return customFetch<tagGetTagResponse>(getTagGetTagUrl(tagUid),
+  {      
+    ...options,
+    method: 'GET'
+    
+    
+  }
+);}
+
+
+/**
+ * Use this to rename a tag or to change its color. EntityType cannot be changed after
+the tag is created. Name must stay unique within the entity type. SystemName and
+SystemDescription are set by Outseta and cannot be changed.
+ * @summary Update a tag.
+ */
+export type tagUpdateTagResponse200 = {
+  data: Tag
+  status: 200
+}
+
+export type tagUpdateTagResponse400 = {
+  data: void
+  status: 400
+}
+
+export type tagUpdateTagResponse401 = {
+  data: void
+  status: 401
+}
+
+export type tagUpdateTagResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type tagUpdateTagResponseSuccess = (tagUpdateTagResponse200) & {
+  headers: Headers;
+};
+export type tagUpdateTagResponseError = (tagUpdateTagResponse400 | tagUpdateTagResponse401 | tagUpdateTagResponse404) & {
+  headers: Headers;
+};
+
+export type tagUpdateTagResponse = (tagUpdateTagResponseSuccess | tagUpdateTagResponseError)
+
+export const getTagUpdateTagUrl = (tagUid: string | null,) => {
+
+
+  
+
+  return `/api/v1/attribute/tags/${tagUid}`
+}
+
+export const tagUpdateTag = async (tagUid: string | null,
+    tagUpdateTagBody: NonReadonly<TagUpdateTagBody>, options?: RequestInit): Promise<tagUpdateTagResponse> => {
+  
+  return customFetch<tagUpdateTagResponse>(getTagUpdateTagUrl(tagUid),
+  {      
+    ...options,
+    method: 'PUT',
+    headers: { 'Content-Type': 'application/json', ...options?.headers },
+    body: JSON.stringify(
+      tagUpdateTagBody,)
+  }
+);}
+
+
+/**
+ * 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.
+ * @summary Delete a tag.
+ */
+export type tagDeleteTagResponse200 = {
+  data: Blob
+  status: 200
+}
+
+export type tagDeleteTagResponse400 = {
+  data: void
+  status: 400
+}
+
+export type tagDeleteTagResponse401 = {
+  data: void
+  status: 401
+}
+
+export type tagDeleteTagResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type tagDeleteTagResponseSuccess = (tagDeleteTagResponse200) & {
+  headers: Headers;
+};
+export type tagDeleteTagResponseError = (tagDeleteTagResponse400 | tagDeleteTagResponse401 | tagDeleteTagResponse404) & {
+  headers: Headers;
+};
+
+export type tagDeleteTagResponse = (tagDeleteTagResponseSuccess | tagDeleteTagResponseError)
+
+export const getTagDeleteTagUrl = (tagUid: string | null,) => {
+
+
+  
+
+  return `/api/v1/attribute/tags/${tagUid}`
+}
+
+export const tagDeleteTag = async (tagUid: string | null, options?: RequestInit): Promise<tagDeleteTagResponse> => {
+  
+  return customFetch<tagDeleteTagResponse>(getTagDeleteTagUrl(tagUid),
+  {      
+    ...options,
+    method: 'DELETE'
+    
+    
+  }
+);}
+
+
 /**
  * entityType is the name of an EntityType enum value, for example: Account, Person,
 Deal. Definitions describe the labels, system names, and control types of

package/src/generated/models/caseTagAllOf.ts

@@ -1,10 +1,7 @@
 // @ts-nocheck
-import type { CaseTagAllOfCase } from './caseTagAllOfCase';
 import type { CaseTagAllOfTag } from './caseTagAllOfTag';
 
 export type CaseTagAllOf = {
-  /** @nullable */
-  Case?: CaseTagAllOfCase;
   /** @nullable */
   Tag?: CaseTagAllOfTag;
 };

package/src/generated/models/{caseTagAllOfCase.ts → caseUpdateCaseBody.ts}

@@ -4,4 +4,4 @@ import type { Case } from './case';
 /**
  * @nullable
  */
-export type CaseTagAllOfCase = Case | null;
+export type CaseUpdateCaseBody = Case | null;

package/src/generated/models/index.ts

@@ -270,8 +270,8 @@ export * from './caseHistory';
 export * from './caseHistoryAllOf';
 export * from './caseTag';
 export * from './caseTagAllOf';
-export * from './caseTagAllOfCase';
 export * from './caseTagAllOfTag';
+export * from './caseUpdateCaseBody';
 export * from './category';
 export * from './categoryAllOf';
 export * from './categoryGetAllCategories200';
@@ -707,9 +707,13 @@ export * from './supportCaseStatus';
 export * from './supportSettings';
 export * from './supportSettingsAllOf';
 export * from './tag';
+export * from './tagAddTagBody';
 export * from './tagAllOf';
 export * from './tagColor';
+export * from './tagGetAllTags200';
+export * from './tagGetAllTagsParams';
 export * from './tagUidList';
+export * from './tagUpdateTagBody';
 export * from './task';
 export * from './taskAllOf';
 export * from './taskAllOfAccount';
@@ -717,9 +721,17 @@ export * from './taskAllOfAssignee';
 export * from './taskAllOfDeal';
 export * from './taskAllOfPerson';
 export * from './taskAllOfType';
+export * from './taskCreatedWebhookPayload';
+export * from './taskCreatedWebhookPayloadAllOf';
+export * from './taskCreatedWebhookPayloadAllOfTwo';
 export * from './taskStatus';
 export * from './taskType';
 export * from './taskTypeAllOf';
+export * from './taskUpdatedWebhookPayload';
+export * from './taskUpdatedWebhookPayloadAllOf';
+export * from './taskUpdatedWebhookPayloadAllOfTwo';
+export * from './taskWebhookEventData';
+export * from './taskWebhookEventDataStatus';
 export * from './taxRate';
 export * from './taxRateAllOf';
 export * from './teamRole';

package/src/generated/models/tagAddTagBody.ts

@@ -0,0 +1,7 @@
+// @ts-nocheck
+import type { Tag } from './tag';
+
+/**
+ * @nullable
+ */
+export type TagAddTagBody = Tag | null;

package/src/generated/models/tagGetAllTags200.ts

@@ -0,0 +1,8 @@
+// @ts-nocheck
+import type { CollectionMetadata } from './collectionMetadata';
+import type { Tag } from './tag';
+
+export type TagGetAllTags200 = {
+  metadata?: CollectionMetadata;
+  items?: Tag[];
+};

package/src/generated/models/tagGetAllTagsParams.ts

@@ -0,0 +1,19 @@
+// @ts-nocheck
+import type { LimitParameter } from './limitParameter';
+import type { OffsetParameter } from './offsetParameter';
+
+export type TagGetAllTagsParams = {
+/**
+ * The entity type whose tags to retrieve, as the name or the numeric value (for example Case or 4)
+ * @nullable
+ */
+entityType?: string | null;
+/**
+ * Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
+ */
+limit?: LimitParameter;
+/**
+ * Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
+ */
+offset?: OffsetParameter;
+};

package/src/generated/models/tagUpdateTagBody.ts

@@ -0,0 +1,7 @@
+// @ts-nocheck
+import type { Tag } from './tag';
+
+/**
+ * @nullable
+ */
+export type TagUpdateTagBody = Tag | null;

package/src/generated/models/taskCreatedWebhookPayload.ts

@@ -0,0 +1,5 @@
+// @ts-nocheck
+import type { TaskCreatedWebhookPayloadAllOf } from './taskCreatedWebhookPayloadAllOf';
+import type { TaskCreatedWebhookPayloadAllOfTwo } from './taskCreatedWebhookPayloadAllOfTwo';
+
+export type TaskCreatedWebhookPayload = TaskCreatedWebhookPayloadAllOf & TaskCreatedWebhookPayloadAllOfTwo;

package/src/generated/models/taskCreatedWebhookPayloadAllOf.ts

@@ -0,0 +1,6 @@
+// @ts-nocheck
+import type { DealWebhookEntity } from './dealWebhookEntity';
+import type { PersonWebhookEntity } from './personWebhookEntity';
+import type { AccountWebhookEntity } from './accountWebhookEntity';
+
+export type TaskCreatedWebhookPayloadAllOf = DealWebhookEntity | PersonWebhookEntity | AccountWebhookEntity;

package/src/generated/models/taskCreatedWebhookPayloadAllOfTwo.ts

@@ -0,0 +1,6 @@
+// @ts-nocheck
+import type { TaskWebhookEventData } from './taskWebhookEventData';
+
+export type TaskCreatedWebhookPayloadAllOfTwo = {
+  ActivityEventData?: TaskWebhookEventData;
+};

package/src/generated/models/taskUpdatedWebhookPayload.ts

@@ -0,0 +1,5 @@
+// @ts-nocheck
+import type { TaskUpdatedWebhookPayloadAllOf } from './taskUpdatedWebhookPayloadAllOf';
+import type { TaskUpdatedWebhookPayloadAllOfTwo } from './taskUpdatedWebhookPayloadAllOfTwo';
+
+export type TaskUpdatedWebhookPayload = TaskUpdatedWebhookPayloadAllOf & TaskUpdatedWebhookPayloadAllOfTwo;

package/src/generated/models/taskUpdatedWebhookPayloadAllOf.ts

@@ -0,0 +1,6 @@
+// @ts-nocheck
+import type { DealWebhookEntity } from './dealWebhookEntity';
+import type { PersonWebhookEntity } from './personWebhookEntity';
+import type { AccountWebhookEntity } from './accountWebhookEntity';
+
+export type TaskUpdatedWebhookPayloadAllOf = DealWebhookEntity | PersonWebhookEntity | AccountWebhookEntity;

package/src/generated/models/taskUpdatedWebhookPayloadAllOfTwo.ts

@@ -0,0 +1,6 @@
+// @ts-nocheck
+import type { TaskWebhookEventData } from './taskWebhookEventData';
+
+export type TaskUpdatedWebhookPayloadAllOfTwo = {
+  ActivityEventData?: TaskWebhookEventData;
+};

package/src/generated/models/taskWebhookEventData.ts

@@ -0,0 +1,33 @@
+// @ts-nocheck
+import type { TaskWebhookEventDataStatus } from './taskWebhookEventDataStatus';
+
+export interface TaskWebhookEventData {
+  /**
+   * @maxLength 10
+   * @nullable
+   */
+  Uid?: string | null;
+  /** @nullable */
+  _objectType?: string | null;
+  /** @minLength 1 */
+  Created: string;
+  /** @minLength 1 */
+  Updated: string;
+  /**
+   * @maxLength 250
+   * @nullable
+   */
+  Title?: string | null;
+  /** @nullable */
+  DueDate?: string | null;
+  /**
+   * @maxLength 5000
+   * @nullable
+   */
+  Notes?: string | null;
+  /** `1` - Pending, `2` - InProgress, `3` - Done */
+  Status?: TaskWebhookEventDataStatus;
+  CreatedDateTime?: string;
+  /** @nullable */
+  CompletedDateTime?: string | null;
+}

package/src/generated/models/taskWebhookEventDataStatus.ts

@@ -0,0 +1,14 @@
+// @ts-nocheck
+
+/**
+ * `1` - Pending, `2` - InProgress, `3` - Done
+ */
+export type TaskWebhookEventDataStatus = typeof TaskWebhookEventDataStatus[keyof typeof TaskWebhookEventDataStatus];
+
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const TaskWebhookEventDataStatus = {
+  Pending: 1,
+  InProgress: 2,
+  Done: 3,
+} as const;

package/src/generated/support/support.ts

@@ -10,6 +10,7 @@ import type {
   CaseGetAllCases200,
   CaseGetAllCasesParams,
   CaseHistory,
+  CaseUpdateCaseBody,
   CategoryGetAllCategories200,
   CategoryGetAllCategoriesParams
 } from '.././models';
@@ -203,6 +204,78 @@ export const caseGetCase = async (caseUid: string | null, options?: RequestInit)
 );}
 
 
+/**
+ * The Uid in the URL identifies the ticket, and a Uid in the request body is ignored.
+Any property that the body does not contain keeps its current value, so a request
+can send only the properties that change.
+            
+Tags are managed through the CaseTags collection. Send the full set of tags that
+the ticket must end with:
+            
+- To keep a tag, include its entry with the CaseTag Uid that GET returned.
+- To add a tag, include an entry that has no Uid and a Tag that holds the tag's Uid.
+- To remove a tag, leave its entry out.
+- To remove all tags, send an empty array.
+            
+If the body does not contain CaseTags, the current tags stay as they are. To read
+the current tags, request them with the fields parameter, for example
+fields=Uid,CaseTags.Uid,CaseTags.Tag.Uid,CaseTags.Tag.Name. To get the tags that are
+available for tickets, use GET /attribute/tags?entityType=Case.
+            
+Case history is kept. Add replies and notes with their own endpoints.
+ * @summary Update a support ticket.
+ */
+export type caseUpdateCaseResponse200 = {
+  data: Case
+  status: 200
+}
+
+export type caseUpdateCaseResponse400 = {
+  data: void
+  status: 400
+}
+
+export type caseUpdateCaseResponse401 = {
+  data: void
+  status: 401
+}
+
+export type caseUpdateCaseResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type caseUpdateCaseResponseSuccess = (caseUpdateCaseResponse200) & {
+  headers: Headers;
+};
+export type caseUpdateCaseResponseError = (caseUpdateCaseResponse400 | caseUpdateCaseResponse401 | caseUpdateCaseResponse404) & {
+  headers: Headers;
+};
+
+export type caseUpdateCaseResponse = (caseUpdateCaseResponseSuccess | caseUpdateCaseResponseError)
+
+export const getCaseUpdateCaseUrl = (caseUid: string | null,) => {
+
+
+  
+
+  return `/api/v1/support/cases/${caseUid}`
+}
+
+export const caseUpdateCase = async (caseUid: string | null,
+    caseUpdateCaseBody: NonReadonly<CaseUpdateCaseBody>, options?: RequestInit): Promise<caseUpdateCaseResponse> => {
+  
+  return customFetch<caseUpdateCaseResponse>(getCaseUpdateCaseUrl(caseUid),
+  {      
+    ...options,
+    method: 'PUT',
+    headers: { 'Content-Type': 'application/json', ...options?.headers },
+    body: JSON.stringify(
+      caseUpdateCaseBody,)
+  }
+);}
+
+
 /**
  * @summary Adds a reply from an agent to a support case.
  */