@devrev/typescript-sdk 1.1.4 → 1.1.6

package/dist/auto-generated/public-devrev-sdk.d.ts

@@ -391,12 +391,16 @@ export interface AuthTokensUpdateResponse {
  * Carries Rev user info.
  */
 export interface AuthTokensUserTraits {
+    /** Application-defined custom fields. */
+    custom_fields?: object;
     /** The display name of the Rev user. */
     display_name?: string;
     /** The email address of the Rev user. */
     email?: string;
     /** The full name of the Rev user. */
     full_name?: string;
+    /** Phone numbers of the Rev user. */
+    phone_numbers?: string[];
 }
 /** capability */
 export type Capability = PartBase;
@@ -539,6 +543,13 @@ export type DevUser = UserBase & {
 };
 /** dev-user-summary */
 export type DevUserSummary = UserBaseSummary;
+/**
+ * dev-users-get-response
+ * The response to getting the information for the Dev user.
+ */
+export interface DevUsersGetResponse {
+    dev_user: DevUser;
+}
 /**
  * dev-users-list-response
  * The response to listing the Dev users.
@@ -721,6 +732,19 @@ export interface EventRevOrgDeleted {
 export interface EventRevOrgUpdated {
     rev_org: RevOrg;
 }
+/** event-rev-user-created */
+export interface EventRevUserCreated {
+    rev_user: RevUser;
+}
+/** event-rev-user-deleted */
+export interface EventRevUserDeleted {
+    /** The ID of the Rev user that was deleted. */
+    id: string;
+}
+/** event-rev-user-updated */
+export interface EventRevUserUpdated {
+    rev_user: RevUser;
+}
 /** event-tag-created */
 export interface EventTagCreated {
     tag: Tag;
@@ -1120,6 +1144,20 @@ export interface RevOrgsUpdateRequest {
 export interface RevOrgsUpdateResponse {
     rev_org: RevOrg;
 }
+/** rev-user */
+export type RevUser = UserBase & {
+    /** Description of the Rev user. */
+    description?: string;
+    /**
+     * External ref is a mutable unique identifier for a user within the
+     * Rev organization from your primary customer record. If none is
+     * available, a good alternative is the email address/phone number
+     * which could uniquely identify the user. If none is specified, a
+     * system-generated identifier will be assigned to the user.
+     */
+    external_ref?: string;
+    rev_org?: OrgSummary;
+};
 /** rev-user-summary */
 export type RevUserSummary = UserBaseSummary & {
     /**
@@ -1395,6 +1433,22 @@ export declare enum TimelineEntriesCreateRequestType {
 export interface TimelineEntriesCreateResponse {
     timeline_entry: TimelineEntry;
 }
+/**
+ * timeline-entries-delete-request
+ * The request to delete a timeline entry from an object.
+ */
+export interface TimelineEntriesDeleteRequest {
+    /**
+     * The ID of the timeline entry to delete.
+     * @example "don:core:<partition>:devo/<dev-org-id>:ticket/123:timeline_event/<timeline-event-id>"
+     */
+    id: string;
+}
+/**
+ * timeline-entries-delete-response
+ * The response to deleting a timeline entry from an object.
+ */
+export type TimelineEntriesDeleteResponse = object;
 /**
  * timeline-entries-get-response
  * The request to getting a timeline entry.
@@ -1478,7 +1532,33 @@ export type TimelineEntry = TimelineComment & {
     type: TimelineEntryType;
 };
 /** timeline-entry-base */
-export type TimelineEntryBase = AtomBase;
+export type TimelineEntryBase = AtomBase & {
+    /** The object that the Timeline entry belongs to. */
+    object: string;
+    /** The type of object that the Timeline entry belongs to. */
+    object_type?: TimelineEntryObjectType;
+    /**
+     * The visibility of the entry. If 'private', then the entry is only
+     * visible to the creator, 'internal' is visible with the Dev
+     * organization, 'external' is visible to the Dev organzation and Rev
+     * users, and 'public' is visible to all. If not set, then the default
+     * visibility is 'external'.
+     */
+    visibility?: TimelineEntryVisibility;
+};
+/** The type of object that the Timeline entry belongs to. */
+export declare enum TimelineEntryObjectType {
+    Capability = "capability",
+    Conversation = "conversation",
+    Enhancement = "enhancement",
+    Feature = "feature",
+    Issue = "issue",
+    Product = "product",
+    RevOrg = "rev_org",
+    RevUser = "rev_user",
+    Ticket = "ticket",
+    TimelineComment = "timeline_comment"
+}
 export declare enum TimelineEntryType {
     TimelineComment = "timeline_comment"
 }
@@ -1579,6 +1659,9 @@ export interface WebhookEventRequest {
     rev_org_created?: EventRevOrgCreated;
     rev_org_deleted?: EventRevOrgDeleted;
     rev_org_updated?: EventRevOrgUpdated;
+    rev_user_created?: EventRevUserCreated;
+    rev_user_deleted?: EventRevUserDeleted;
+    rev_user_updated?: EventRevUserUpdated;
     tag_created?: EventTagCreated;
     tag_deleted?: EventTagDeleted;
     tag_updated?: EventTagUpdated;
@@ -1625,6 +1708,9 @@ export declare enum WebhookEventType {
     RevOrgCreated = "rev_org_created",
     RevOrgDeleted = "rev_org_deleted",
     RevOrgUpdated = "rev_org_updated",
+    RevUserCreated = "rev_user_created",
+    RevUserDeleted = "rev_user_deleted",
+    RevUserUpdated = "rev_user_updated",
     TagCreated = "tag_created",
     TagDeleted = "tag_deleted",
     TagUpdated = "tag_updated",
@@ -1818,11 +1904,6 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestTi
     artifacts?: string[];
     /** Body of the work object. */
     body?: string;
-    /**
-     * The custom schema fragments to use.
-     * @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
-     */
-    custom_schema_fragments?: string[];
     /**
      * The users that own the work.
      * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
@@ -1917,11 +1998,6 @@ export type WorksUpdateRequest = (WorksUpdateRequestIssue | WorksUpdateRequestTi
     artifacts?: WorksUpdateRequestArtifactIds;
     /** Updated body of the work object, or unchanged if not provided. */
     body?: string;
-    /**
-     * The custom schema fragments to use.
-     * @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
-     */
-    custom_schema_fragments?: string[];
     /**
      * The work's ID.
      * @example "don:core:<partition>:devo/<dev-org-id>:<work-type>/<work-id>"
@@ -1996,9 +2072,9 @@ export interface WorksUpdateRequestTicket {
 export interface WorksUpdateResponse {
     work: Work;
 }
-import { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
+import { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from 'axios';
 export type QueryParamsType = Record<string | number, any>;
-export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
+export interface FullRequestParams extends Omit<AxiosRequestConfig, 'data' | 'params' | 'url' | 'responseType'> {
     /** set parameter to `true` for call `securityWorker` for this request */
     secure?: boolean;
     /** request path */
@@ -2012,8 +2088,8 @@ export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "pa
     /** request body */
     body?: unknown;
 }
-export type RequestParams = Omit<FullRequestParams, "body" | "method" | "query" | "path">;
-export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, "data" | "cancelToken"> {
+export type RequestParams = Omit<FullRequestParams, 'body' | 'method' | 'query' | 'path'>;
+export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, 'data' | 'cancelToken'> {
     securityWorker?: (securityData: SecurityDataType | null) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
     secure?: boolean;
     format?: ResponseType;
@@ -2200,6 +2276,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
      * @secure
      */
     devOrgAuthConnectionsUpdate: (data: DevOrgAuthConnectionsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsUpdateResponse, any>>;
+    /**
+     * @description Gets the requested user's information.
+     *
+     * @tags dev-users
+     * @name DevUsersGet
+     * @request GET:/dev-users.get
+     * @secure
+     */
+    devUsersGet: (query: {
+        /** User ID of the requested Dev user. */
+        id: string;
+    }, params?: RequestParams) => Promise<AxiosResponse<DevUsersGetResponse, any>>;
     /**
      * @description Lists users within your organization.
      *
@@ -2369,13 +2457,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * Filters for objects created after the provided timestamp (inclusive).
          * @format date-time
          */
-        "created_date.after"?: string;
+        'created_date.after'?: string;
         /**
          * Filters for objects created before the provided timestamp
          * (inclusive).
          * @format date-time
          */
-        "created_date.before"?: string;
+        'created_date.before'?: string;
         /**
          * The cursor to resume iteration from. If not provided, then iteration
          * starts from the beginning.
@@ -2397,13 +2485,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * Filters for objects created after the provided timestamp (inclusive).
          * @format date-time
          */
-        "modified_date.after"?: string;
+        'modified_date.after'?: string;
         /**
          * Filters for objects created before the provided timestamp
          * (inclusive).
          * @format date-time
          */
-        "modified_date.before"?: string;
+        'modified_date.before'?: string;
         /**
          * Fields to sort the Rev organizations by and the direction to sort
          * them.
@@ -2495,6 +2583,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
      * @secure
      */
     timelineEntriesCreate: (data: TimelineEntriesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesCreateResponse, any>>;
+    /**
+     * @description Deletes an entry from an object's timeline.
+     *
+     * @tags timeline-entries
+     * @name TimelineEntriesDelete
+     * @request POST:/timeline-entries.delete
+     * @secure
+     */
+    timelineEntriesDelete: (data: TimelineEntriesDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
     /**
      * @description Gets an entry on an object's timeline.
      *
@@ -2651,35 +2748,35 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         first?: number;
         /** Filters for issues with any of the provided priorities. */
-        "issue.priority"?: IssuePriority[];
+        'issue.priority'?: IssuePriority[];
         /**
          * Filters for issues with any of the provided Rev organizations.
          * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
          */
-        "issue.rev_orgs"?: string[];
+        'issue.rev_orgs'?: string[];
         /**
          * Filters for work owned by any of these users.
          * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
          */
         owned_by?: string[];
         /** Filters for records in the provided stage(s). */
-        "stage.name"?: string[];
+        'stage.name'?: string[];
         /** Filters for tickets belonging to specific groups. */
-        "ticket.group"?: string[];
+        'ticket.group'?: string[];
         /** Filters for tickets that are spam. */
-        "ticket.is_spam"?: boolean;
+        'ticket.is_spam'?: boolean;
         /** Filters for tickets that need response. */
-        "ticket.needs_response"?: boolean;
+        'ticket.needs_response'?: boolean;
         /**
          * Filters for tickets that are associated with any of the provided Rev
          * organizations.
          * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
          */
-        "ticket.rev_org"?: string[];
+        'ticket.rev_org'?: string[];
         /** Filters for tickets with any of the provided severities. */
-        "ticket.severity"?: TicketSeverity[];
+        'ticket.severity'?: TicketSeverity[];
         /** Filters for tickets with any of the provided source channels. */
-        "ticket.source_channel"?: string[];
+        'ticket.source_channel'?: string[];
         /** Filters for work of the provided types. */
         type?: WorkType[];
     }, params?: RequestParams) => Promise<AxiosResponse<WorksExportResponse, any>>;
@@ -2723,12 +2820,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         cursor?: string;
         /** Filters for issues with any of the provided priorities. */
-        "issue.priority"?: IssuePriority[];
+        'issue.priority'?: IssuePriority[];
         /**
          * Filters for issues with any of the provided Rev organizations.
          * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
          */
-        "issue.rev_orgs"?: string[];
+        'issue.rev_orgs'?: string[];
         /**
          * The maximum number of works to return. The default is '50'.
          * @format int32
@@ -2745,23 +2842,23 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         owned_by?: string[];
         /** Filters for records in the provided stage(s). */
-        "stage.name"?: string[];
+        'stage.name'?: string[];
         /** Filters for tickets belonging to specific groups. */
-        "ticket.group"?: string[];
+        'ticket.group'?: string[];
         /** Filters for tickets that are spam. */
-        "ticket.is_spam"?: boolean;
+        'ticket.is_spam'?: boolean;
         /** Filters for tickets that need response. */
-        "ticket.needs_response"?: boolean;
+        'ticket.needs_response'?: boolean;
         /**
          * Filters for tickets that are associated with any of the provided Rev
          * organizations.
          * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
          */
-        "ticket.rev_org"?: string[];
+        'ticket.rev_org'?: string[];
         /** Filters for tickets with any of the provided severities. */
-        "ticket.severity"?: TicketSeverity[];
+        'ticket.severity'?: TicketSeverity[];
         /** Filters for tickets with any of the provided source channels. */
-        "ticket.source_channel"?: string[];
+        'ticket.source_channel'?: string[];
         /** Filters for work of the provided types. */
         type?: WorkType[];
     }, params?: RequestParams) => Promise<AxiosResponse<WorksListResponse, any>>;