@devrev/typescript-sdk 1.0.2 → 1.1.3

package/src/auto-generated/beta/beta-devrev-sdk.ts

@@ -1,1826 +0,0 @@
-/* eslint-disable */
-/* tslint:disable */
-/*
- * ---------------------------------------------------------------
- * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
- * ##                                                           ##
- * ## AUTHOR: acacode                                           ##
- * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
- * ---------------------------------------------------------------
- */
-
-/** artifact-summary */
-export type ArtifactSummary = AtomBaseSummary;
-
-/** atom-base */
-export interface AtomBase {
-  created_by?: UserSummary;
-  /**
-   * Timestamp when the object was created.
-   * @format date-time
-   */
-  created_date?: string;
-  /** Human-readable object ID unique to the Dev organization. */
-  display_id?: string;
-  /** Globally unique object ID. */
-  id: string;
-  modified_by?: UserSummary;
-  /**
-   * Timestamp when the object was last modified.
-   * @format date-time
-   */
-  modified_date?: string;
-}
-
-/** atom-base-summary */
-export interface AtomBaseSummary {
-  /** Human-readable object ID unique to the Dev organization. */
-  display_id?: string;
-  /** Globally unique object ID. */
-  id: string;
-}
-
-/** capability-summary */
-export type CapabilitySummary = PartBaseSummary;
-
-/** conversation */
-export type Conversation = AtomBase & {
-  /** Description of the conversation object. */
-  description?: string;
-  group?: GroupSummary;
-  /** The latest messages on the conversation. */
-  messages?: TimelineEntry[];
-  /** Owner IDs for the conversation. */
-  owned_by?: UserSummary[];
-  /** Describes the current stage of a work item. */
-  stage?: Stage;
-  /** Title of the conversation object. */
-  title?: string;
-};
-
-/** conversation-summary */
-export type ConversationSummary = AtomBaseSummary & {
-  /** Title of the conversation object. */
-  title?: string;
-};
-
-/**
- * conversations-create-request
- * The request to create a new conversation.
- */
-export interface ConversationsCreateRequest {
-  /** Description for the conversation. */
-  description?: string;
-  /** The group that the conversation is associated with. */
-  group?: string;
-  /**
-   * The users in the conversation.
-   * @example ["don:<partition>:identity:devo/<dev-org-id>:devu/<dev-user-id>"]
-   */
-  members?: string[];
-  /** Initial messages on the conversation. */
-  messages?: ConversationsCreateRequestMessage[];
-  /** Sets an object's initial stage. */
-  stage?: StageInit;
-  /** Tags associated with the conversation. */
-  tags?: SetTagWithValue[];
-  /** The title for the conversation. */
-  title?: string;
-  type: ConversationsCreateRequestTypeValue;
-}
-
-/** conversations-create-request-message */
-export interface ConversationsCreateRequestMessage {
-  /**
-   * The IDs of the artifacts to the message.
-   * @example ["don:<partition>:core:devo/<dev-org-id>:artifact/<artifact-id>"]
-   */
-  artifacts?: string[];
-  /** The message's body. */
-  body?: string;
-}
-
-export enum ConversationsCreateRequestTypeValue {
-  Support = 'support',
-}
-
-/**
- * conversations-create-response
- * The response to creating a new conversation.
- */
-export interface ConversationsCreateResponse {
-  conversation: Conversation;
-}
-
-/**
- * conversations-delete-request
- * The request to delete a conversation.
- */
-export interface ConversationsDeleteRequest {
-  /** The ID of the conversation to delete. */
-  id: string;
-}
-
-/**
- * conversations-delete-response
- * The response for deleting a conversation.
- */
-export type ConversationsDeleteResponse = object;
-
-/** conversations-export-response */
-export interface ConversationsExportResponse {
-  /** The resulting collection of conversation items. */
-  conversations: Conversation[];
-}
-
-/**
- * conversations-get-response
- * The response to getting a conversation's information.
- */
-export interface ConversationsGetResponse {
-  conversation: Conversation;
-}
-
-/**
- * conversations-list-response
- * The response to listing the conversations.
- */
-export interface ConversationsListResponse {
-  /** The list of conversations. */
-  conversations: Conversation[];
-  /**
-   * The cursor used to iterate subsequent results in accordance to the
-   * sort order. If not set, then no later elements exist.
-   */
-  next_cursor?: string;
-  /**
-   * The cursor used to iterate preceding results in accordance to the
-   * sort order. If not set, then no prior elements exist.
-   */
-  prev_cursor?: string;
-}
-
-/**
- * conversations-update-request
- * The request to update a conversation.
- */
-export interface ConversationsUpdateRequest {
-  applies_to_parts?: ConversationsUpdateRequestAppliesToParts;
-  /** The updated description for the conversation. */
-  description?: string;
-  /** The group that the conversation is associated with. */
-  group?: string;
-  /** The ID of the conversation to update. */
-  id: string;
-  /** Updates an object's stage. */
-  stage?: StageUpdate;
-  /** The updated status of the conversation. */
-  status?: string;
-  /** The updated title of the conversation. */
-  title?: string;
-}
-
-/** conversations-update-request-applies-to-parts */
-export interface ConversationsUpdateRequestAppliesToParts {
-  /**
-   * Updates the parts that the conversation applies to.
-   * @example ["don:<partition>:core:devo/<dev-org-id>:<part-type>/<part-id>"]
-   */
-  set?: string[];
-}
-
-/**
- * conversations-update-response
- * The response for updating a conversation.
- */
-export interface ConversationsUpdateResponse {
-  conversation: Conversation;
-}
-
-/** dev-user-summary */
-export type DevUserSummary = UserBaseSummary;
-
-/** enhancement-summary */
-export type EnhancementSummary = PartBaseSummary;
-
-/** error-bad-request */
-export type ErrorBadRequest = ErrorBase &
-  (
-    | ErrorBadRequestBadRequest
-    | ErrorBadRequestInvalidEnumValue
-    | ErrorBadRequestMissingRequiredField
-    | ErrorBadRequestParseError
-    | ErrorBadRequestValueNotPermitted
-  ) & {
-    type: ErrorBadRequestType;
-  };
-
-/** error-bad-request-bad-request */
-export type ErrorBadRequestBadRequest = object;
-
-/** error-bad-request-invalid-enum-value */
-export interface ErrorBadRequestInvalidEnumValue {
-  /** The allowed values for the field. */
-  allowed_values: string[];
-  /** The field whose enum value is invalid. */
-  field_name: string;
-  /** The value that was received. */
-  value: string;
-}
-
-/** error-bad-request-missing-required-field */
-export interface ErrorBadRequestMissingRequiredField {
-  /** The missing field's name. */
-  field_name: string;
-}
-
-/** error-bad-request-parse-error */
-export type ErrorBadRequestParseError = object;
-
-export enum ErrorBadRequestType {
-  BadRequest = 'bad_request',
-  InvalidEnumValue = 'invalid_enum_value',
-  MissingRequiredField = 'missing_required_field',
-  ParseError = 'parse_error',
-  ValueNotPermitted = 'value_not_permitted',
-}
-
-/** error-bad-request-value-not-permitted */
-export interface ErrorBadRequestValueNotPermitted {
-  /** The field whose value is not permitted. */
-  field_name: string;
-  /** The reason the value isn't permitted. */
-  reason?: string;
-}
-
-/** error-base */
-export interface ErrorBase {
-  /** The message associated with the error. */
-  message?: string;
-}
-
-/** error-forbidden */
-export type ErrorForbidden = ErrorBase &
-  ErrorForbiddenForbidden & {
-    type: ErrorForbiddenType;
-  };
-
-/** error-forbidden-forbidden */
-export type ErrorForbiddenForbidden = object;
-
-export enum ErrorForbiddenType {
-  Forbidden = 'forbidden',
-}
-
-/** error-internal-server-error */
-export type ErrorInternalServerError = ErrorBase &
-  ErrorInternalServerErrorInternalError & {
-    /**
-     * A unique ID that's generated for the error that can be used for
-     * inquiry.
-     */
-    reference_id?: string;
-    type: ErrorInternalServerErrorType;
-  };
-
-/** error-internal-server-error-internal-error */
-export type ErrorInternalServerErrorInternalError = object;
-
-export enum ErrorInternalServerErrorType {
-  InternalError = 'internal_error',
-}
-
-/** error-not-found */
-export type ErrorNotFound = ErrorBase &
-  ErrorNotFoundNotFound & {
-    type: ErrorNotFoundType;
-  };
-
-/** error-not-found-not-found */
-export type ErrorNotFoundNotFound = object;
-
-export enum ErrorNotFoundType {
-  NotFound = 'not_found',
-}
-
-/** error-service-unavailable */
-export type ErrorServiceUnavailable = ErrorBase &
-  ErrorServiceUnavailableServiceUnavailable & {
-    type: ErrorServiceUnavailableType;
-  };
-
-/** error-service-unavailable-service-unavailable */
-export type ErrorServiceUnavailableServiceUnavailable = object;
-
-export enum ErrorServiceUnavailableType {
-  ServiceUnavailable = 'service_unavailable',
-}
-
-/** error-too-many-requests */
-export type ErrorTooManyRequests = ErrorBase &
-  ErrorTooManyRequestsTooManyRequests & {
-    /**
-     * The number of seconds after which the client should retry.
-     * @format int64
-     */
-    retry_after?: number;
-    type: ErrorTooManyRequestsType;
-  };
-
-/** error-too-many-requests-too-many-requests */
-export type ErrorTooManyRequestsTooManyRequests = object;
-
-export enum ErrorTooManyRequestsType {
-  TooManyRequests = 'too_many_requests',
-}
-
-/** error-unauthorized */
-export type ErrorUnauthorized = ErrorBase &
-  ErrorUnauthorizedUnauthenticated & {
-    type: ErrorUnauthorizedType;
-  };
-
-export enum ErrorUnauthorizedType {
-  Unauthenticated = 'unauthenticated',
-}
-
-/** error-unauthorized-unauthenticated */
-export type ErrorUnauthorizedUnauthenticated = object;
-
-/** feature-summary */
-export type FeatureSummary = PartBaseSummary;
-
-/** group-summary */
-export type GroupSummary = AtomBaseSummary;
-
-/** Priority of the work based upon impact and criticality. */
-export enum IssuePriority {
-  P0 = 'p0',
-  P1 = 'p1',
-  P2 = 'p2',
-  P3 = 'p3',
-}
-
-/** issue-summary */
-export type IssueSummary = WorkBaseSummary & {
-  /** Priority of the work based upon impact and criticality. */
-  priority?: IssuePriority;
-};
-
-/** link */
-export type Link = AtomBase & {
-  /** Type of link used to define the relationship. */
-  link_type: LinkType;
-  source: LinkEndpointSummary;
-  target: LinkEndpointSummary;
-};
-
-/** link-endpoint-summary */
-export type LinkEndpointSummary = (
-  | CapabilitySummary
-  | ConversationSummary
-  | EnhancementSummary
-  | FeatureSummary
-  | IssueSummary
-  | ProductSummary
-  | TicketSummary
-) & {
-  type: LinkEndpointType;
-};
-
-export enum LinkEndpointType {
-  Capability = 'capability',
-  Conversation = 'conversation',
-  Enhancement = 'enhancement',
-  Feature = 'feature',
-  Issue = 'issue',
-  Product = 'product',
-  Ticket = 'ticket',
-}
-
-/**
- * link-rev-user-to-rev-org-request
- * A request to link a rev user to a rev org.
- */
-export interface LinkRevUserToRevOrgRequest {
-  /**
-   * The don of the rev org to link the rev user to.
-   * @example "don:<partition>:identity:devo/<dev-org-id>:revo/<rev-org-id>"
-   */
-  rev_org_don: string;
-  /** The don of the rev user to link. */
-  user_don: string;
-}
-
-/**
- * link-rev-user-to-rev-org-response
- * The response to link a rev user to a rev org.
- */
-export interface LinkRevUserToRevOrgResponse {
-  rev_user: RevUser;
-}
-
-/** Type of link used to define the relationship. */
-export enum LinkType {
-  DevelopedWith = 'developed_with',
-  Imports = 'imports',
-  IsDependentOn = 'is_dependent_on',
-  IsDuplicateOf = 'is_duplicate_of',
-  IsParentOf = 'is_parent_of',
-  IsPartOf = 'is_part_of',
-  IsRelatedTo = 'is_related_to',
-  Serves = 'serves',
-}
-
-/**
- * links-create-request
- * The request to create a new link.
- */
-export interface LinksCreateRequest {
-  /** Type of link used to define the relationship. */
-  link_type: LinkType;
-  /** The ID of the source object. */
-  source: string;
-  /** The ID of the target object. */
-  target: string;
-}
-
-/**
- * links-create-response
- * The response to creating a new link.
- */
-export interface LinksCreateResponse {
-  link: Link;
-}
-
-/**
- * links-delete-request
- * The request to delete a link.
- */
-export interface LinksDeleteRequest {
-  /** The ID of the link to delete. */
-  id: string;
-}
-
-/**
- * links-delete-response
- * The response for deleting a link.
- */
-export type LinksDeleteResponse = object;
-
-/**
- * The direction of link, which can either be outbound such that the
- * object is the source of the link, otherwise inbound where the object is
- * the target of the link.
- */
-export enum LinksDirection {
-  IsSource = 'is_source',
-  IsTarget = 'is_target',
-}
-
-/**
- * links-get-response
- * The response to getting a link's information.
- */
-export interface LinksGetResponse {
-  link: Link;
-}
-
-/**
- * links-list-response
- * The response to listing the links.
- */
-export interface LinksListResponse {
-  /** The list of links. */
-  links: Link[];
-  /**
-   * The cursor used to iterate subsequent results in accordance to the
-   * sort order. If not set, then no later elements exist.
-   */
-  next_cursor?: string;
-  /**
-   * The cursor used to iterate preceding results in accordance to the
-   * sort order. If not set, then no prior elements exist.
-   */
-  prev_cursor?: string;
-}
-
-/**
- * The iteration mode to use. If "after", then entries after the provided
- * cursor will be returned, or if no cursor is provided, then from the
- * beginning. If "before", then entries before the provided cursor will be
- * returned, or if no cursor is provided, then from the end. Entries will
- * always be returned in the specified sort-by order.
- */
-export enum ListMode {
-  After = 'after',
-  Before = 'before',
-}
-
-/** org-base-summary */
-export type OrgBaseSummary = AtomBaseSummary & {
-  /** Name of the Organization. */
-  display_name?: string;
-};
-
-/** org-summary */
-export type OrgSummary = RevOrgSummary & {
-  type: OrgType;
-};
-
-export enum OrgType {
-  RevOrg = 'rev_org',
-}
-
-/** part-base-summary */
-export type PartBaseSummary = AtomBaseSummary & {
-  /** Name of the part. */
-  name: string;
-};
-
-/** product-summary */
-export type ProductSummary = PartBaseSummary;
-
-/** rev-org-summary */
-export type RevOrgSummary = OrgBaseSummary;
-
-/** 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 & {
-  /**
-   * 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-users-create-request
- * Request object to create a new Rev user for a Rev organization.
- */
-export interface RevUsersCreateRequest {
-  /** Description of the Rev user. */
-  description?: string;
-  /** The user's display name. The name is non-unique and mutable. */
-  display_name?: string;
-  /** Email address of the Rev user. */
-  email?: string;
-  /**
-   * External ref is a mutable unique identifier for a user within the
-   * Dev 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;
-  /** Phone numbers of the Rev user. */
-  phone_numbers?: string[];
-  /**
-   * The ID of Rev organization for which a Rev user is to be created.
-   * @example "don:<partition>:identity:devo/<dev-org-id>:revo/<rev-org-id>"
-   */
-  rev_org: string;
-}
-
-/**
- * rev-users-create-response
- * Response object for creating a new Rev user for Rev organization.
- */
-export interface RevUsersCreateResponse {
-  rev_user: RevUser;
-}
-
-/**
- * rev-users-delete-request
- * Request object to delete a Rev user.
- */
-export interface RevUsersDeleteRequest {
-  /** The ID of Rev user to delete. */
-  id: string;
-}
-
-/**
- * rev-users-delete-response
- * The response to deleting a Rev user of a Rev organization.
- */
-export type RevUsersDeleteResponse = object;
-
-/**
- * rev-users-get-response
- * The returned Rev user.
- */
-export interface RevUsersGetResponse {
-  rev_user: RevUser;
-}
-
-/**
- * rev-users-list-response
- * The response to listing all Rev users matching the filter criteria.
- */
-export interface RevUsersListResponse {
-  /**
-   * The cursor used to iterate subsequent results in accordance to the
-   * sort order. If not set, then no later elements exist.
-   */
-  next_cursor?: string;
-  /**
-   * The cursor used to iterate preceding results in accordance to the
-   * sort order. If not set, then no prior elements exist.
-   */
-  prev_cursor?: string;
-  /** List containing all the Rev users. */
-  rev_users: RevUser[];
-}
-
-/**
- * rev-users-update-request
- * Request to update details of a Rev user.
- */
-export interface RevUsersUpdateRequest {
-  /** Updated description of the Rev user. */
-  description?: string;
-  /** Updated display name of the Rev user. */
-  display_name?: string;
-  /** Updated email address of the Rev user. */
-  email?: string;
-  /** Updated external ref value of the Rev user. */
-  external_ref?: string;
-  /** The ID of Rev user to update. */
-  id: string;
-}
-
-/**
- * rev-users-update-response
- * Updated Rev user object.
- */
-export interface RevUsersUpdateResponse {
-  rev_user: RevUser;
-}
-
-/** set-tag-with-value */
-export interface SetTagWithValue {
-  /**
-   * The ID of the tag.
-   * @example "don:<partition>:core:devo/<dev-org-id>:tag/<tag-id>"
-   */
-  id: string;
-  /**
-   * The value for the object's association with the tag. If specified,
-   * the value must be one that's specified in the tag's allowed values.
-   */
-  value?: string;
-}
-
-/**
- * stage
- * Describes the current stage of a work item.
- */
-export interface Stage {
-  /** Current stage name of the work item. */
-  name: string;
-}
-
-/**
- * stage-init
- * Sets an object's initial stage.
- */
-export interface StageInit {
-  /** The name of the stage. */
-  name?: string;
-}
-
-/**
- * stage-update
- * Updates an object's stage.
- */
-export interface StageUpdate {
-  /** The updated name of the stage, otherwise unchanged if not set. */
-  name?: string;
-}
-
-/** sys-user */
-export type SysUser = UserBase;
-
-/** sys-user-summary */
-export type SysUserSummary = UserBaseSummary;
-
-/**
- * sys-users-list-response
- * The response to listing the system users.
- */
-export interface SysUsersListResponse {
-  /**
-   * The cursor used to iterate subsequent results in accordance to the
-   * sort order. If not set, then no later elements exist.
-   */
-  next_cursor?: string;
-  /**
-   * The cursor used to iterate preceding results in accordance to the
-   * sort order. If not set, then no prior elements exist.
-   */
-  prev_cursor?: string;
-  /** The list of system users. */
-  sys_users: SysUser[];
-}
-
-/**
- * sys-users-update-request
- * Request to update information of the system user.
- */
-export interface SysUsersUpdateRequest {
-  /** Updated display name for the system user. */
-  display_name?: string;
-  /**
-   * Artifact ID of the system user's new display picture.
-   * @example "don:<partition>:core:devo/<dev-org-id>:artifact/<artifact-id>"
-   */
-  display_picture?: string | null;
-  /** Updated full name for the system user. */
-  full_name?: string;
-  /** The ID of system user to update. */
-  id: string;
-}
-
-/**
- * sys-users-update-response
- * Updated Sys user object.
- */
-export interface SysUsersUpdateResponse {
-  sys_user: SysUser;
-}
-
-/** Severity of the ticket. */
-export enum TicketSeverity {
-  Blocker = 'blocker',
-  High = 'high',
-  Low = 'low',
-  Medium = 'medium',
-}
-
-/** ticket-summary */
-export type TicketSummary = WorkBaseSummary & {
-  rev_org?: OrgSummary;
-  /** Severity of the ticket. */
-  severity?: TicketSeverity;
-};
-
-/** timeline-comment */
-export type TimelineComment = TimelineEntryBase & {
-  /** The artifacts for the comment. */
-  artifacts?: ArtifactSummary[];
-  /**
-   * The comment's body. If the comment has been deleted, then no body
-   * will appear in the response.
-   */
-  body?: string;
-  /** The type of the body to use for the comment. */
-  body_type?: TimelineCommentBodyType;
-  /** The SnapKit Body of the comment. */
-  snap_kit_body?: object;
-};
-
-/** The type of the body to use for the comment. */
-export enum TimelineCommentBodyType {
-  SnapKit = 'snap_kit',
-  Text = 'text',
-}
-
-/** timeline-entry */
-export type TimelineEntry = TimelineComment & {
-  type: TimelineEntryType;
-};
-
-/** timeline-entry-base */
-export type TimelineEntryBase = AtomBase;
-
-export enum TimelineEntryType {
-  TimelineComment = 'timeline_comment',
-}
-
-/**
- * unlink-rev-user-from-rev-org-request
- * A request to unlink a rev user from a rev org.
- */
-export interface UnlinkRevUserFromRevOrgRequest {
-  /**
-   * The don of the rev org to unlink the rev user from.
-   * @example "don:<partition>:identity:devo/<dev-org-id>:revo/<rev-org-id>"
-   */
-  rev_org_don: string;
-  /** The don of the rev user to unlink. */
-  user_don: string;
-}
-
-/**
- * unlink-rev-user-from-rev-org-response
- * The response to unlink a rev user from a rev org.
- */
-export interface UnlinkRevUserFromRevOrgResponse {
-  rev_user: RevUser;
-}
-
-/** user-base */
-export type UserBase = AtomBase & {
-  /** The user's display name. The name is non-unique and mutable. */
-  display_name?: string;
-  display_picture?: ArtifactSummary;
-  /** Email address of the user. */
-  email?: string;
-  /** Full name of the user. */
-  full_name?: string;
-  /** Phone numbers of the user. */
-  phone_numbers?: string[];
-  /** State of the user. */
-  state?: UserState;
-};
-
-/** user-base-summary */
-export type UserBaseSummary = AtomBaseSummary & {
-  /** The user's display name. The name is non-unique and mutable. */
-  display_name?: string;
-  display_picture?: ArtifactSummary;
-  /** Email address of the user. */
-  email?: string;
-  /** Full name of the user. */
-  full_name?: string;
-  /** State of the user. */
-  state?: UserState;
-};
-
-/** State of the user. */
-export enum UserState {
-  Active = 'active',
-  Deactivated = 'deactivated',
-  Locked = 'locked',
-  Shadow = 'shadow',
-  Unassigned = 'unassigned',
-}
-
-/** user-summary */
-export type UserSummary = (DevUserSummary | RevUserSummary | SysUserSummary) & {
-  type: UserType;
-};
-
-export enum UserType {
-  DevUser = 'dev_user',
-  RevUser = 'rev_user',
-  SysUser = 'sys_user',
-}
-
-/** work-base-summary */
-export type WorkBaseSummary = AtomBaseSummary & {
-  /** Title of the work object. */
-  title: string;
-};
-
-import axios, {
-  AxiosInstance,
-  AxiosRequestConfig,
-  AxiosResponse,
-  HeadersDefaults,
-  ResponseType,
-} from 'axios';
-
-export type QueryParamsType = Record<string | number, any>;
-
-export interface FullRequestParams
-  extends Omit<AxiosRequestConfig, 'data' | 'params' | 'url' | 'responseType'> {
-  /** set parameter to `true` for call `securityWorker` for this request */
-  secure?: boolean;
-  /** request path */
-  path: string;
-  /** content type of request body */
-  type?: ContentType;
-  /** query params */
-  query?: QueryParamsType;
-  /** format of response (i.e. response.json() -> format: "json") */
-  format?: ResponseType;
-  /** request body */
-  body?: unknown;
-}
-
-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;
-}
-
-export enum ContentType {
-  Json = 'application/json',
-  FormData = 'multipart/form-data',
-  UrlEncoded = 'application/x-www-form-urlencoded',
-  Text = 'text/plain',
-}
-
-export class HttpClient<SecurityDataType = unknown> {
-  public instance: AxiosInstance;
-  private securityData: SecurityDataType | null = null;
-  private securityWorker?: ApiConfig<SecurityDataType>['securityWorker'];
-  private secure?: boolean;
-  private format?: ResponseType;
-
-  constructor({
-    securityWorker,
-    secure,
-    format,
-    ...axiosConfig
-  }: ApiConfig<SecurityDataType> = {}) {
-    this.instance = axios.create({
-      ...axiosConfig,
-      baseURL: axiosConfig.baseURL || '{protocol}://{hostname}',
-    });
-    this.secure = secure;
-    this.format = format;
-    this.securityWorker = securityWorker;
-  }
-
-  public setSecurityData = (data: SecurityDataType | null) => {
-    this.securityData = data;
-  };
-
-  protected mergeRequestParams(
-    params1: AxiosRequestConfig,
-    params2?: AxiosRequestConfig
-  ): AxiosRequestConfig {
-    const method = params1.method || (params2 && params2.method);
-
-    return {
-      ...this.instance.defaults,
-      ...params1,
-      ...(params2 || {}),
-      headers: {
-        ...((method &&
-          this.instance.defaults.headers[
-            method.toLowerCase() as keyof HeadersDefaults
-          ]) ||
-          {}),
-        ...(params1.headers || {}),
-        ...((params2 && params2.headers) || {}),
-      },
-    };
-  }
-
-  protected stringifyFormItem(formItem: unknown) {
-    if (typeof formItem === 'object' && formItem !== null) {
-      return JSON.stringify(formItem);
-    } else {
-      return `${formItem}`;
-    }
-  }
-
-  protected createFormData(input: Record<string, unknown>): FormData {
-    return Object.keys(input || {}).reduce((formData, key) => {
-      const property = input[key];
-      const propertyContent: any[] =
-        property instanceof Array ? property : [property];
-
-      for (const formItem of propertyContent) {
-        const isFileType = formItem instanceof Blob || formItem instanceof File;
-        formData.append(
-          key,
-          isFileType ? formItem : this.stringifyFormItem(formItem)
-        );
-      }
-
-      return formData;
-    }, new FormData());
-  }
-
-  public request = async <T = any, _E = any>({
-    secure,
-    path,
-    type,
-    query,
-    format,
-    body,
-    ...params
-  }: FullRequestParams): Promise<AxiosResponse<T>> => {
-    const secureParams =
-      ((typeof secure === 'boolean' ? secure : this.secure) &&
-        this.securityWorker &&
-        (await this.securityWorker(this.securityData))) ||
-      {};
-    const requestParams = this.mergeRequestParams(params, secureParams);
-    const responseFormat = format || this.format || undefined;
-
-    if (
-      type === ContentType.FormData &&
-      body &&
-      body !== null &&
-      typeof body === 'object'
-    ) {
-      body = this.createFormData(body as Record<string, unknown>);
-    }
-
-    if (
-      type === ContentType.Text &&
-      body &&
-      body !== null &&
-      typeof body !== 'string'
-    ) {
-      body = JSON.stringify(body);
-    }
-
-    return this.instance.request({
-      ...requestParams,
-      headers: {
-        ...(requestParams.headers || {}),
-        ...(type && type !== ContentType.FormData
-          ? { 'Content-Type': type }
-          : {}),
-      },
-      params: query,
-      responseType: responseFormat,
-      data: body,
-      url: path,
-    });
-  };
-}
-
-/**
- * @title DevRev Beta REST API
- * @version BETA
- * @baseUrl {protocol}://{hostname}
- *
- * DevRev's BETA REST API Specification.
- */
-export class Api<
-  SecurityDataType extends unknown
-> extends HttpClient<SecurityDataType> {
-  /**
-   * @description Creates a conversation.
-   *
-   * @tags conversations
-   * @name ConversationsCreate
-   * @request POST:/conversations.create
-   * @secure
-   */
-  conversationsCreate = (
-    data: ConversationsCreateRequest,
-    params: RequestParams = {}
-  ) =>
-    this.request<
-      ConversationsCreateResponse,
-      | ErrorBadRequest
-      | ErrorUnauthorized
-      | ErrorForbidden
-      | ErrorTooManyRequests
-      | ErrorInternalServerError
-      | ErrorServiceUnavailable
-    >({
-      path: `/conversations.create`,
-      method: 'POST',
-      body: data,
-      secure: true,
-      type: ContentType.Json,
-      format: 'json',
-      ...params,
-    });
-
-  /**
-   * @description Deletes the requested conversation.
-   *
-   * @tags conversations
-   * @name ConversationsDelete
-   * @request POST:/conversations.delete
-   * @secure
-   */
-  conversationsDelete = (
-    data: ConversationsDeleteRequest,
-    params: RequestParams = {}
-  ) =>
-    this.request<
-      ConversationsDeleteResponse,
-      | ErrorBadRequest
-      | ErrorUnauthorized
-      | ErrorForbidden
-      | ErrorNotFound
-      | ErrorTooManyRequests
-      | ErrorInternalServerError
-      | ErrorServiceUnavailable
-    >({
-      path: `/conversations.delete`,
-      method: 'POST',
-      body: data,
-      secure: true,
-      type: ContentType.Json,
-      format: 'json',
-      ...params,
-    });
-
-  /**
-   * @description Exports a collection of conversation items.
-   *
-   * @tags conversations
-   * @name ConversationsExport
-   * @request GET:/conversations.export
-   * @secure
-   */
-  conversationsExport = (
-    query?: {
-      /**
-       * Filters for conversations belonging to any of the provided parts.
-       * @example ["don:<partition>:core:devo/<dev-org-id>:<part-type>/<part-id>"]
-       */
-      applies_to_parts?: string[];
-      /**
-       * The number of conversation items to return. The default is '50', the
-       * maximum is '5000'.
-       * @format int32
-       */
-      first?: number;
-      /**
-       * Filters for conversations where these users are participants.
-       * @example ["don:<partition>:identity:devo/<dev-org-id>:devu/<dev-user-id>"]
-       */
-      members?: string[];
-      /**
-       * Filters for conversations owned by any of these users.
-       * @example ["don:<partition>:identity:devo/<dev-org-id>:devu/<dev-user-id>"]
-       */
-      owned_by?: string[];
-      /**
-       * Filters for conversations that are associated with any of the
-       * provided Rev organizations.
-       * @example ["don:<partition>:identity:devo/<dev-org-id>:revo/<rev-org-id>"]
-       */
-      rev_org?: string[];
-      /** Filters for conversations with any of the provided source channels. */
-      source_channels?: string[];
-      /** Filters for records in the provided stage(s). */
-      'stage.name'?: string[];
-      /**
-       * Filters for conversations with any of the provided tags.
-       * @example ["don:<partition>:core:devo/<dev-org-id>:tag/<tag-id>"]
-       */
-      tags?: string[];
-    },
-    params: RequestParams = {}
-  ) =>
-    this.request<
-      ConversationsExportResponse,
-      | ErrorBadRequest
-      | ErrorUnauthorized
-      | ErrorForbidden
-      | ErrorTooManyRequests
-      | ErrorInternalServerError
-      | ErrorServiceUnavailable
-    >({
-      path: `/conversations.export`,
-      method: 'GET',
-      query: query,
-      secure: true,
-      format: 'json',
-      ...params,
-    });
-
-  /**
-   * @description Gets the requested conversation's information.
-   *
-   * @tags conversations
-   * @name ConversationsGet
-   * @request GET:/conversations.get
-   * @secure
-   */
-  conversationsGet = (
-    query: {
-      /** The requested conversation's ID. */
-      id: string;
-    },
-    params: RequestParams = {}
-  ) =>
-    this.request<
-      ConversationsGetResponse,
-      | ErrorBadRequest
-      | ErrorUnauthorized
-      | ErrorForbidden
-      | ErrorNotFound
-      | ErrorTooManyRequests
-      | ErrorInternalServerError
-      | ErrorServiceUnavailable
-    >({
-      path: `/conversations.get`,
-      method: 'GET',
-      query: query,
-      secure: true,
-      format: 'json',
-      ...params,
-    });
-
-  /**
-   * @description Lists the available conversations.
-   *
-   * @tags conversations
-   * @name ConversationsList
-   * @request GET:/conversations.list
-   * @secure
-   */
-  conversationsList = (
-    query?: {
-      /**
-       * Filters for conversations belonging to any of the provided parts.
-       * @example ["don:<partition>:core:devo/<dev-org-id>:<part-type>/<part-id>"]
-       */
-      applies_to_parts?: string[];
-      /**
-       * The cursor to resume iteration from. If not provided, then iteration
-       * starts from the beginning.
-       */
-      cursor?: string;
-      /**
-       * The maximum number of conversations to return. The default is '50'.
-       * @format int32
-       */
-      limit?: number;
-      /**
-       * Filters for conversations where these users are participants.
-       * @example ["don:<partition>:identity:devo/<dev-org-id>:devu/<dev-user-id>"]
-       */
-      members?: string[];
-      /**
-       * The iteration mode to use, otherwise if not set, then "after" is
-       * used.
-       */
-      mode?: ListMode;
-      /**
-       * Filters for conversations owned by any of these users.
-       * @example ["don:<partition>:identity:devo/<dev-org-id>:devu/<dev-user-id>"]
-       */
-      owned_by?: string[];
-      /**
-       * Filters for conversations that are associated with any of the
-       * provided Rev organizations.
-       * @example ["don:<partition>:identity:devo/<dev-org-id>:revo/<rev-org-id>"]
-       */
-      rev_org?: string[];
-      /** Filters for conversations with any of the provided source channels. */
-      source_channels?: string[];
-      /** Filters for records in the provided stage(s). */
-      'stage.name'?: string[];
-      /**
-       * Filters for conversations with any of the provided tags.
-       * @example ["don:<partition>:core:devo/<dev-org-id>:tag/<tag-id>"]
-       */
-      tags?: string[];
-    },
-    params: RequestParams = {}
-  ) =>
-    this.request<
-      ConversationsListResponse,
-      | ErrorBadRequest
-      | ErrorUnauthorized
-      | ErrorForbidden
-      | ErrorTooManyRequests
-      | ErrorInternalServerError
-      | ErrorServiceUnavailable
-    >({
-      path: `/conversations.list`,
-      method: 'GET',
-      query: query,
-      secure: true,
-      format: 'json',
-      ...params,
-    });
-
-  /**
-   * @description Updates the requested conversation.
-   *
-   * @tags conversations
-   * @name ConversationsUpdate
-   * @request POST:/conversations.update
-   * @secure
-   */
-  conversationsUpdate = (
-    data: ConversationsUpdateRequest,
-    params: RequestParams = {}
-  ) =>
-    this.request<
-      ConversationsUpdateResponse,
-      | ErrorBadRequest
-      | ErrorUnauthorized
-      | ErrorForbidden
-      | ErrorNotFound
-      | ErrorTooManyRequests
-      | ErrorInternalServerError
-      | ErrorServiceUnavailable
-    >({
-      path: `/conversations.update`,
-      method: 'POST',
-      body: data,
-      secure: true,
-      type: ContentType.Json,
-      format: 'json',
-      ...params,
-    });
-
-  /**
-   * @description Creates a link between two objects to indicate a relationship.
-   *
-   * @tags links
-   * @name LinksCreate
-   * @request POST:/links.create
-   * @secure
-   */
-  linksCreate = (data: LinksCreateRequest, params: RequestParams = {}) =>
-    this.request<
-      LinksCreateResponse,
-      | ErrorBadRequest
-      | ErrorUnauthorized
-      | ErrorForbidden
-      | ErrorTooManyRequests
-      | ErrorInternalServerError
-      | ErrorServiceUnavailable
-    >({
-      path: `/links.create`,
-      method: 'POST',
-      body: data,
-      secure: true,
-      type: ContentType.Json,
-      format: 'json',
-      ...params,
-    });
-
-  /**
-   * @description Deletes a link.
-   *
-   * @tags links
-   * @name LinksDelete
-   * @request POST:/links.delete
-   * @secure
-   */
-  linksDelete = (data: LinksDeleteRequest, params: RequestParams = {}) =>
-    this.request<
-      LinksDeleteResponse,
-      | ErrorBadRequest
-      | ErrorUnauthorized
-      | ErrorForbidden
-      | ErrorNotFound
-      | ErrorTooManyRequests
-      | ErrorInternalServerError
-      | ErrorServiceUnavailable
-    >({
-      path: `/links.delete`,
-      method: 'POST',
-      body: data,
-      secure: true,
-      type: ContentType.Json,
-      format: 'json',
-      ...params,
-    });
-
-  /**
-   * @description Gets the requested link's information.
-   *
-   * @tags links
-   * @name LinksGet
-   * @request GET:/links.get
-   * @secure
-   */
-  linksGet = (
-    query: {
-      /** The requested link's ID. */
-      id: string;
-    },
-    params: RequestParams = {}
-  ) =>
-    this.request<
-      LinksGetResponse,
-      | ErrorBadRequest
-      | ErrorUnauthorized
-      | ErrorForbidden
-      | ErrorNotFound
-      | ErrorTooManyRequests
-      | ErrorInternalServerError
-      | ErrorServiceUnavailable
-    >({
-      path: `/links.get`,
-      method: 'GET',
-      query: query,
-      secure: true,
-      format: 'json',
-      ...params,
-    });
-
-  /**
-   * @description Lists the available links.
-   *
-   * @tags links
-   * @name LinksList
-   * @request GET:/links.list
-   * @secure
-   */
-  linksList = (
-    query: {
-      /** The ID of the object to list the links for. */
-      object: string;
-      /**
-       * The cursor to resume iteration from. If not provided, then iteration
-       * starts from the beginning.
-       */
-      cursor?: string;
-      /**
-       * The direction of the links to list, otherwise if not present, then
-       * links in both directions (source and target) are included.
-       */
-      direction?: LinksDirection;
-      /**
-       * The maximum number of links to return. If not set, then the default
-       * is '50'.
-       * @format int32
-       */
-      limit?: number;
-      /**
-       * The link type(s) to filter for, otherwise if not present, all link
-       * types are included.
-       */
-      link_type?: LinkType[];
-      /**
-       * The iteration mode to use, otherwise if not set, then "after" is
-       * used.
-       */
-      mode?: ListMode;
-      /**
-       * The link types to filter for, otherwise if not present, all link
-       * types are included.
-       * @deprecated
-       */
-      types?: LinkType[];
-    },
-    params: RequestParams = {}
-  ) =>
-    this.request<
-      LinksListResponse,
-      | ErrorBadRequest
-      | ErrorUnauthorized
-      | ErrorForbidden
-      | ErrorTooManyRequests
-      | ErrorInternalServerError
-      | ErrorServiceUnavailable
-    >({
-      path: `/links.list`,
-      method: 'GET',
-      query: query,
-      secure: true,
-      format: 'json',
-      ...params,
-    });
-
-  /**
-   * @description Creates a Rev user for a Rev organization. Rev user can be a customer or a lead of an organization.
-   *
-   * @tags rev-users
-   * @name RevUsersCreate
-   * @request POST:/rev-users.create
-   * @secure
-   */
-  revUsersCreate = (data: RevUsersCreateRequest, params: RequestParams = {}) =>
-    this.request<
-      RevUsersCreateResponse,
-      | ErrorBadRequest
-      | ErrorUnauthorized
-      | ErrorForbidden
-      | ErrorTooManyRequests
-      | ErrorInternalServerError
-      | ErrorServiceUnavailable
-    >({
-      path: `/rev-users.create`,
-      method: 'POST',
-      body: data,
-      secure: true,
-      type: ContentType.Json,
-      format: 'json',
-      ...params,
-    });
-
-  /**
-   * @description Deletes a Rev user.
-   *
-   * @tags rev-users
-   * @name RevUsersDelete
-   * @request POST:/rev-users.delete
-   * @secure
-   */
-  revUsersDelete = (data: RevUsersDeleteRequest, params: RequestParams = {}) =>
-    this.request<
-      RevUsersDeleteResponse,
-      | ErrorBadRequest
-      | ErrorUnauthorized
-      | ErrorForbidden
-      | ErrorNotFound
-      | ErrorTooManyRequests
-      | ErrorInternalServerError
-      | ErrorServiceUnavailable
-    >({
-      path: `/rev-users.delete`,
-      method: 'POST',
-      body: data,
-      secure: true,
-      type: ContentType.Json,
-      format: 'json',
-      ...params,
-    });
-
-  /**
-   * @description Returns the Rev user of a Rev organization by its ID.
-   *
-   * @tags rev-users
-   * @name RevUsersGet
-   * @request GET:/rev-users.get
-   * @secure
-   */
-  revUsersGet = (
-    query: {
-      /** The ID of Rev user to be retrieved. */
-      id: string;
-    },
-    params: RequestParams = {}
-  ) =>
-    this.request<
-      RevUsersGetResponse,
-      | ErrorBadRequest
-      | ErrorUnauthorized
-      | ErrorForbidden
-      | ErrorNotFound
-      | ErrorTooManyRequests
-      | ErrorInternalServerError
-      | ErrorServiceUnavailable
-    >({
-      path: `/rev-users.get`,
-      method: 'GET',
-      query: query,
-      secure: true,
-      format: 'json',
-      ...params,
-    });
-
-  /**
-   * @description Links a rev user to a rev org.
-   *
-   * @tags rev-users
-   * @name LinkRevUserToRevOrg
-   * @request POST:/rev-users.link
-   * @secure
-   */
-  linkRevUserToRevOrg = (
-    data: LinkRevUserToRevOrgRequest,
-    params: RequestParams = {}
-  ) =>
-    this.request<
-      LinkRevUserToRevOrgResponse,
-      | ErrorBadRequest
-      | ErrorUnauthorized
-      | ErrorForbidden
-      | ErrorNotFound
-      | ErrorTooManyRequests
-      | ErrorInternalServerError
-      | ErrorServiceUnavailable
-    >({
-      path: `/rev-users.link`,
-      method: 'POST',
-      body: data,
-      secure: true,
-      type: ContentType.Json,
-      format: 'json',
-      ...params,
-    });
-
-  /**
-   * @description Returns a list of all Rev Users belonging to the authenticated user's Dev Organization.
-   *
-   * @tags rev-users
-   * @name RevUsersList
-   * @request GET:/rev-users.list
-   * @secure
-   */
-  revUsersList = (
-    query?: {
-      /** Filters for Rev users that were created by the specified user(s). */
-      created_by?: string[];
-      /**
-       * Filters for objects created after the provided timestamp (inclusive).
-       * @format date-time
-       */
-      'created_date.after'?: string;
-      /**
-       * Filters for objects created before the provided timestamp
-       * (inclusive).
-       * @format date-time
-       */
-      'created_date.before'?: string;
-      /**
-       * The cursor to resume iteration from. If not provided, then iteration
-       * starts from the beginning.
-       */
-      cursor?: string;
-      /** List of emails of Rev users to be filtered. */
-      email?: string[];
-      /**
-       * The maximum number of Rev users to return. The default is '50'.
-       * @format int32
-       */
-      limit?: number;
-      /**
-       * The iteration mode to use, otherwise if not set, then "after" is
-       * used.
-       */
-      mode?: ListMode;
-      /**
-       * Filters for objects created after the provided timestamp (inclusive).
-       * @format date-time
-       */
-      'modified_date.after'?: string;
-      /**
-       * Filters for objects created before the provided timestamp
-       * (inclusive).
-       * @format date-time
-       */
-      'modified_date.before'?: string;
-      /**
-       * List of IDs of Rev organizations to be filtered.
-       * @example ["don:<partition>:identity:devo/<dev-org-id>:revo/<rev-org-id>"]
-       */
-      rev_org?: string[];
-      /** Fields to sort the Rev users by and the direction to sort them. */
-      sort_by?: string[];
-    },
-    params: RequestParams = {}
-  ) =>
-    this.request<
-      RevUsersListResponse,
-      | ErrorBadRequest
-      | ErrorUnauthorized
-      | ErrorForbidden
-      | ErrorNotFound
-      | ErrorTooManyRequests
-      | ErrorInternalServerError
-      | ErrorServiceUnavailable
-    >({
-      path: `/rev-users.list`,
-      method: 'GET',
-      query: query,
-      secure: true,
-      format: 'json',
-      ...params,
-    });
-
-  /**
-   * @description Unlinks a rev user from a rev org.
-   *
-   * @tags rev-users
-   * @name UnlinkRevUserFromRevOrg
-   * @request POST:/rev-users.unlink
-   * @secure
-   */
-  unlinkRevUserFromRevOrg = (
-    data: UnlinkRevUserFromRevOrgRequest,
-    params: RequestParams = {}
-  ) =>
-    this.request<
-      UnlinkRevUserFromRevOrgResponse,
-      | ErrorBadRequest
-      | ErrorUnauthorized
-      | ErrorForbidden
-      | ErrorNotFound
-      | ErrorTooManyRequests
-      | ErrorInternalServerError
-      | ErrorServiceUnavailable
-    >({
-      path: `/rev-users.unlink`,
-      method: 'POST',
-      body: data,
-      secure: true,
-      type: ContentType.Json,
-      format: 'json',
-      ...params,
-    });
-
-  /**
-   * @description Updates a Rev user.
-   *
-   * @tags rev-users
-   * @name RevUsersUpdate
-   * @request POST:/rev-users.update
-   * @secure
-   */
-  revUsersUpdate = (data: RevUsersUpdateRequest, params: RequestParams = {}) =>
-    this.request<
-      RevUsersUpdateResponse,
-      | ErrorBadRequest
-      | ErrorUnauthorized
-      | ErrorForbidden
-      | ErrorNotFound
-      | ErrorTooManyRequests
-      | ErrorInternalServerError
-      | ErrorServiceUnavailable
-    >({
-      path: `/rev-users.update`,
-      method: 'POST',
-      body: data,
-      secure: true,
-      type: ContentType.Json,
-      format: 'json',
-      ...params,
-    });
-
-  /**
-   * @description Lists system users within your organization.
-   *
-   * @tags sys-users
-   * @name SysUsersList
-   * @request GET:/sys-users.list
-   * @secure
-   */
-  sysUsersList = (
-    query?: {
-      /**
-       * The cursor to resume iteration from. If not provided, then iteration
-       * starts from the beginning.
-       */
-      cursor?: string;
-      /**
-       * The maximum number of system users to return. Value can range from
-       * '1' to '100', with a default of '50'.
-       * @format int32
-       */
-      limit?: number;
-      /**
-       * The iteration mode to use, otherwise if not set, then "after" is
-       * used.
-       */
-      mode?: ListMode;
-      /** Fields to sort the system users by and the direction to sort them. */
-      sort_by?: string[];
-    },
-    params: RequestParams = {}
-  ) =>
-    this.request<
-      SysUsersListResponse,
-      | ErrorBadRequest
-      | ErrorUnauthorized
-      | ErrorForbidden
-      | ErrorTooManyRequests
-      | ErrorInternalServerError
-      | ErrorServiceUnavailable
-    >({
-      path: `/sys-users.list`,
-      method: 'GET',
-      query: query,
-      secure: true,
-      format: 'json',
-      ...params,
-    });
-
-  /**
-   * @description Updates the system user.
-   *
-   * @tags sys-users
-   * @name SysUsersUpdate
-   * @request POST:/sys-users.update
-   * @secure
-   */
-  sysUsersUpdate = (data: SysUsersUpdateRequest, params: RequestParams = {}) =>
-    this.request<
-      SysUsersUpdateResponse,
-      | ErrorBadRequest
-      | ErrorUnauthorized
-      | ErrorForbidden
-      | ErrorNotFound
-      | ErrorTooManyRequests
-      | ErrorInternalServerError
-      | ErrorServiceUnavailable
-    >({
-      path: `/sys-users.update`,
-      method: 'POST',
-      body: data,
-      secure: true,
-      type: ContentType.Json,
-      format: 'json',
-      ...params,
-    });
-}