@rc-ex/core 1.4.1 → 1.5.0

package/src/definitions/IdentityModel.ts

@@ -1,248 +0,0 @@
-import type IdentityExtraValues from './IdentityExtraValues';
-
-interface IdentityModel {
-  /**
-   * Identity identifier.
-   * Required
-   * Example: 506d9e817aa58d1259000f12
-   */
-  id?: string;
-
-  /**
-   * Identity's avatar URI
-   * Format: uri
-   * Example: https://example.com/assets/avatar/default-79fd530c58c2a6b83a11fcc0e842ed7023ceb69292cfeb857bc2af2c624b90fd.png
-   */
-  avatarUri?: string;
-
-  /**
-   * Company.
-   * Example: Test Company
-   */
-  company?: string;
-
-  /**
-   * Creation time of the resource.
-   * Required
-   * Format: date-time
-   * Example: 2023-02-04T12:43:07Z
-   */
-  creationTime?: string;
-
-  /**
-   * Display name of identity
-   * Example: John Doe
-   */
-  displayName?: string;
-
-  /**
-   * Email address.
-   * Format: email
-   * Example: user@example.com
-   */
-  emailAddress?: string;
-
-  /**
-   */
-  extraValues?: IdentityExtraValues;
-
-  /**
-   * FirstName.
-   * Example: John
-   */
-  firstName?: string;
-
-  /**
-   * Gender.
-   * Example: Woman
-   */
-  gender?: 'Man' | 'Woman';
-
-  /**
-   * Phone number.
-   * Example: +33634231224
-   */
-  homePhone?: string;
-
-  /**
-   * Identity group identifier which references the identity group that contains
-   *  all information (phone, notes, etc). Multiple identities may belong to
-   *  a single group. If the parameter value is null, it means that identity
-   *  does not belong to a group or have extra information
-   * Example: 54085e5b7aa58d8b5d00006c
-   */
-  identityGroupId?: string;
-
-  /**
-   * Either Agent or Customer
-   */
-  identityType?: 'Agent' | 'Customer';
-
-  /**
-   * LastName.
-   * Example: Doe
-   */
-  lastName?: string;
-
-  /**
-   * Phone number.
-   * Example: +33634231224
-   */
-  mobilePhone?: string;
-
-  /**
-   * Screen name of identity
-   * Example: John D.
-   */
-  screenName?: string;
-
-  /**
-   * Type of identity
-   * Required
-   */
-  type?:
-    | 'AppleMessagesForBusiness'
-    | 'Email'
-    | 'EngageMessaging'
-    | 'Facebook'
-    | 'GoogleMyBusiness'
-    | 'Instagram'
-    | 'Linkedin'
-    | 'Twitter'
-    | 'Viber'
-    | 'WhatsApp'
-    | 'Youtube';
-
-  /**
-   * The time when the last modification was completed.
-   * Required
-   * Format: date-time
-   * Example: 2023-02-04T12:43:07Z
-   */
-  lastModifiedTime?: string;
-
-  /**
-   * List of the associated user identifiers who can use the identity
-   */
-  userIds?: string[];
-
-  /**
-   * UUID of identity
-   * Example: 9680ab94-3b78-495c-bb2c-a969954d8260
-   */
-  uuid?: string;
-
-  /**
-   * Device info of the identity. Applicable to RingCX Digital Messaging channels only
-   * Example: iPhone (iPhone); iOS 15.0.2
-   */
-  mobileDeviceInfo?: string;
-
-  /**
-   * Facebook biography of the identity. Applicable to Facebook and Messenger channels only
-   * Example: Painter living in Paris
-   */
-  fbBio?: string;
-
-  /**
-   * Facebook category of the identity. Applicable to Facebook and Messenger channels only
-   * Example: Computers/Internet
-   */
-  fbCategory?: string;
-
-  /**
-   * Facebook locale of the identity. Applicable to Facebook and Messenger channels only
-   * Example: fr_FR
-   */
-  fbLocale?: string;
-
-  /**
-   * Instagram followers count of the identity. Applicable to Instagram and InstagramMessaging channels only
-   * Format: int32
-   * Example: 10
-   */
-  igFollowersCount?: number;
-
-  /**
-   * Twitter description of the identity. Applicable to Twitter channels only
-   * Example: Software Engineer
-   */
-  twDescription?: string;
-
-  /**
-   * Twitter followers count of the identity. Applicable to Twitter channels only
-   * Format: int32
-   * Example: 10
-   */
-  twFollowersCount?: number;
-
-  /**
-   * Count of Twitter accounts followed by the identity. Applicable to Twitter channels only
-   * Format: int32
-   * Example: 500
-   */
-  twFollowingCount?: number;
-
-  /**
-   * Count of tweets of the identity. Applicable to Twitter channels only
-   * Format: int32
-   * Example: 42
-   */
-  twStatusesCount?: number;
-
-  /**
-   * Twitter location of the identity. Applicable to Twitter channels only
-   * Example: Paris
-   */
-  twLocation?: string;
-
-  /**
-   * Viber API version of the identity. Applicable to Viber channels only
-   * Example: 10
-   */
-  apiVersion?: string;
-
-  /**
-   * Viber country of the identity. Applicable to Viber channels only
-   * Example: FR
-   */
-  country?: string;
-
-  /**
-   * Viber device type of the identity. Applicable to Viber channels only
-   * Example: SM-G970U1
-   */
-  deviceType?: string;
-
-  /**
-   * Viber language of the identity. Applicable to Viber channels only
-   * Example: fr-FR
-   */
-  language?: string;
-
-  /**
-   * Viber mobile country code of the identity. Applicable to Viber channels only
-   * Example: 1
-   */
-  mcc?: string;
-
-  /**
-   * Viber mobile network code of the identity. Applicable to Viber channels only
-   * Example: 220
-   */
-  mnc?: string;
-
-  /**
-   * Viber primary device OS of the identity. Applicable to Viber channels only
-   * Example: Android 11
-   */
-  primaryDeviceOs?: string;
-
-  /**
-   * Viber application version of the identity. Applicable to Viber channels only
-   * Example: 19.5.0
-   */
-  viberVersion?: string;
-}
-
-export default IdentityModel;

package/src/definitions/ListSocialMessagingContentsParameters.ts

@@ -1,85 +0,0 @@
-/**
- * Query parameters for operation listSocialMessagingContents
- */
-interface ListSocialMessagingContentsParameters {
-  /**
-   * Filter based on the specified intervention identifiers
-   * Example: 7f946431b6eebffafae642cc,re946431b6eebffafae642cc
-   */
-  interventionIds?: string[];
-
-  /**
-   * Filter based on the specified identity identifiers
-   * Example: 7f946431b6eebffafae642cc,re946431b6eebffafae642cc
-   */
-  authorIdentityIds?: string[];
-
-  /**
-   * Filter based on the specified identity group identifiers
-   * Example: 7f946431b6eebffafae642cc,re946431b6eebffafae642cc
-   */
-  authorIdentityGroupIds?: string[];
-
-  /**
-   * Filter based on the specified channel identifiers
-   * Example: 7f946431b6eebffafae642cc
-   */
-  channelIds?: string[];
-
-  /**
-   * Direction of the content.
-   *
-   *  * Incoming contents are received from a channel.
-   *  * Outgoing contents are exported to a channel.
-   * Example: Incoming
-   */
-  contentDirection?: 'Incoming' | 'Outgoing';
-
-  /**
-   * Filter based on the specified thread identifiers
-   * Example: 7f946431b6eebffafae642cc
-   */
-  threadIds?: string[];
-
-  /**
-   * Filter based on the specified text(s). Provided multiple times, the values are ANDed
-   */
-  text?: string[];
-
-  /**
-   * Filter for specified status
-   */
-  status?: ('New' | 'Assigned' | 'Replied' | 'UserReply' | 'UserInitiated' | 'Ignored')[];
-
-  /**
-   * Ordering by creationTime and lastModifiedTime is descending by default.
-   * Example: +creationTime
-   * Default: -creationTime
-   */
-  orderBy?:
-    | '-creationTime'
-    | '+creationTime'
-    | 'creationTime'
-    | '-lastModifiedTime'
-    | '+lastModifiedTime'
-    | 'lastModifiedTime';
-
-  /**
-   * The token indicating the particular page of the result set to be retrieved.
-   *  If omitted the first page will be returned.
-   */
-  pageToken?: string;
-
-  /**
-   * The number of items per page. If provided value in the request
-   *  is greater than a maximum, the maximum value is applied
-   * Maximum: 1000
-   * Minimum: 1
-   * Format: int32
-   * Example: 100
-   * Default: 100
-   */
-  perPage?: number;
-}
-
-export default ListSocialMessagingContentsParameters;

package/src/definitions/ListSocialMessagingIdentitiesParameters.ts

@@ -1,61 +0,0 @@
-/**
- * Query parameters for operation listSocialMessagingIdentities
- */
-interface ListSocialMessagingIdentitiesParameters {
-  /**
-   * Filter based on the specified channelId.
-   */
-  channelId?: string;
-
-  /**
-   * Filter based on the specified `identityGroupIds` (separated by commas)
-   */
-  identityGroupIds?: string[];
-
-  /**
-   * Either Agent or Customer
-   */
-  identityType?: 'Agent' | 'Customer';
-
-  /**
-   * Filter based on the specified `userId`
-   */
-  userId?: string;
-
-  /**
-   * Filter based on the specified `uuid`
-   */
-  uuid?: string;
-
-  /**
-   * Ordering by creationTime and lastModifiedTime is descending by default.
-   * Example: +creationTime
-   * Default: -creationTime
-   */
-  orderBy?:
-    | '-creationTime'
-    | '+creationTime'
-    | 'creationTime'
-    | '-lastModifiedTime'
-    | '+lastModifiedTime'
-    | 'lastModifiedTime';
-
-  /**
-   * The token indicating the particular page of the result set to be retrieved.
-   *  If omitted the first page will be returned.
-   */
-  pageToken?: string;
-
-  /**
-   * The number of items per page. If provided value in the request
-   *  is greater than a maximum, the maximum value is applied
-   * Maximum: 1000
-   * Minimum: 1
-   * Format: int32
-   * Example: 100
-   * Default: 100
-   */
-  perPage?: number;
-}
-
-export default ListSocialMessagingIdentitiesParameters;

package/src/definitions/SocMsgContentAttachment.ts

@@ -1,86 +0,0 @@
-interface SocMsgContentAttachment {
-  /**
-   * Type of attachment, which is generally a MIME attachment type like `image/jpeg`, etc.
-   *  Security level in RingCX determines what type of attachment is allowed.
-   *  Based on the security level the following attachment types are supported.
-   *
-   *  *'Strict'* level allows safe extensions below:
-   *  Content name and supported types:
-   *
-   *  - audio (AAC, MP3, OGG, M4A)
-   *  - image (BMP, GIF, JPG, JPEG, PNG, SVG, WEBP)
-   *  - pdf (PDF)
-   *  - text (CSV, TXT, LOG)
-   *  - video (AVI, FLV, M4V, MKV, MOV, MP4, MPG, QT, WMV)
-   *  - other (AMR, DMS, VCARD, TIF, TIFF, MPEG)
-   *
-   *  *'Relaxed'* level allows documents:
-   *  Content name and supported types:
-   *
-   *  - excel (XLS, XLSM, XLSX, XLC, XLT, XLTM, XLTX)
-   *  - presentation (KEY, ODP, OTP)
-   *  - powerpoint (PPS, PPT, PPTX, POT)
-   *  - spreadsheet (Numbers - ODS, OTS)
-   *  - word (DOC, DOCM, DOCX, DOTM, DOTX)
-   *  - word_processing (Pages - ODT, OTT, RTF)
-   *
-   *  *'Permissive'* level allows all documents.
-   *
-   *  However, there are no security level restrictions for content posted through the channel
-   * Example: image/jpeg
-   */
-  contentType?: string;
-
-  /**
-   * Creation time of the resource.
-   * Format: date-time
-   * Example: 2023-02-04T12:43:07Z
-   */
-  creationTime?: string;
-
-  /**
-   * Specifies if attachment is embedded in content
-   */
-  embedded?: boolean;
-
-  /**
-   * Filename of attachment
-   * Example: 0.jpeg
-   */
-  filename?: string;
-
-  /**
-   * Identifier of the attachment.
-   * Example: 54085e5b7aa58d8b5d00006c
-   */
-  id?: string;
-
-  /**
-   * Attachment privacy setting
-   * Default: true
-   */
-  public?: boolean;
-
-  /**
-   * Size of attachment
-   * Format: int32
-   * Example: 217571
-   */
-  size?: number;
-
-  /**
-   * The time when the last modification was completed.
-   * Format: date-time
-   * Example: 2023-02-04T12:43:07Z
-   */
-  lastModifiedTime?: string;
-
-  /**
-   * Attachment URI
-   * Format: uri
-   * Example: https://example.digital.ringcentral.com/files/attachments/54085e5b7aa58d8b5d00006c
-   */
-  uri?: string;
-}
-
-export default SocMsgContentAttachment;

package/src/paths/Cx/SocialMessaging/V1/Contents/index.ts

@@ -1,101 +0,0 @@
-import type CreateSocialMessagingContentRequest from '../../../../../definitions/CreateSocialMessagingContentRequest';
-import type ListSocialMessagingContentsParameters from '../../../../../definitions/ListSocialMessagingContentsParameters';
-import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../types';
-
-class Index {
-  public rc: RingCentralInterface;
-  public _parent: ParentInterface;
-  public contentId: string | null;
-
-  public constructor(_parent: ParentInterface, contentId: string | null = null) {
-    this._parent = _parent;
-    this.rc = _parent.rc;
-    this.contentId = contentId;
-  }
-  public path(withParameter = true): string {
-    if (withParameter && this.contentId !== null) {
-      return `${this._parent.path()}/contents/${this.contentId}`;
-    }
-    return `${this._parent.path()}/contents`;
-  }
-  /**
-   * Returns a list of social messaging contents ordered by creation date. The default order is descending.
-   *
-   * The account context of this request is determined by the RC Account ID associated with
-   * the access token provided in the Authorization header.
-   *
-   * The query parameters provided in request will be considered an AND operation to filter the list.
-   *
-   * A query parameter which is not specified or provided with the null value will be ignored.
-   *
-   * HTTP Method: get
-   * Endpoint: /cx/social-messaging/v1/contents
-   * Rate Limit Group: Light
-   * App Permission: SocialMessaging
-   */
-  public async list(
-    queryParams?: ListSocialMessagingContentsParameters,
-    restRequestConfig?: RestRequestConfig,
-  ): Promise<string> {
-    const r = await this.rc.get<string>(this.path(false), queryParams, restRequestConfig);
-    return r.data;
-  }
-
-  /**
-   * Creates the new social messaging content for use in discussions.
-   *
-   * This request is used to reply to an already posted content or to initiate a discussion. If authorized, the
-   * authenticated user will be used as the content author.
-   *
-   * Content will be created and pushed asynchronously to the channel. When the content is successfully pushed to
-   * the channel, the `Content.Exported` event will be reported.
-   *
-   * The account context of this request is determined by the RC Account ID associated with the access token provided
-   * in the Authorization header.
-   *
-   * Replying to customer content is usually possible unless the channel or conversation is read only. Composing
-   * content, on the contrary, depends on the channel itself.
-   *
-   * - The channel may not support it and be purely reactive like Instagram, Messenger, etc.
-   *
-   * - Some channels (usually public accounts, like Twitter or Facebook pages) allow content publishing
-   * without targeting specific individuals.
-   *
-   * - Some channels (usually non-public media) require specific targeting (phone number for SMS, email address
-   * for email, customer_id, etc.) to be able to create content. This is channel-specific and detailed under the
-   * generic parameters.
-   *
-   * HTTP Method: post
-   * Endpoint: /cx/social-messaging/v1/contents
-   * Rate Limit Group: Light
-   * App Permission: SocialMessaging
-   */
-  public async post(
-    createSocialMessagingContentRequest: CreateSocialMessagingContentRequest,
-    restRequestConfig?: RestRequestConfig,
-  ): Promise<string> {
-    const r = await this.rc.post<string>(
-      this.path(false),
-      createSocialMessagingContentRequest,
-      undefined,
-      restRequestConfig,
-    );
-    return r.data;
-  }
-
-  /**
-   * Returns the social messaging content by ID specified in path.
-   * HTTP Method: get
-   * Endpoint: /cx/social-messaging/v1/contents/{contentId}
-   * Rate Limit Group: Light
-   * App Permission: SocialMessaging
-   */
-  public async get(restRequestConfig?: RestRequestConfig): Promise<string> {
-    if (this.contentId === null) {
-      throw new Error('contentId must be specified.');
-    }
-    const r = await this.rc.get<string>(this.path(), undefined, restRequestConfig);
-    return r.data;
-  }
-}
-export default Index;

package/src/paths/Cx/SocialMessaging/V1/Identities/index.ts

@@ -1,58 +0,0 @@
-import type ListSocialMessagingIdentitiesParameters from '../../../../../definitions/ListSocialMessagingIdentitiesParameters';
-import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../types';
-
-class Index {
-  public rc: RingCentralInterface;
-  public _parent: ParentInterface;
-  public identityId: string | null;
-
-  public constructor(_parent: ParentInterface, identityId: string | null = null) {
-    this._parent = _parent;
-    this.rc = _parent.rc;
-    this.identityId = identityId;
-  }
-  public path(withParameter = true): string {
-    if (withParameter && this.identityId !== null) {
-      return `${this._parent.path()}/identities/${this.identityId}`;
-    }
-    return `${this._parent.path()}/identities`;
-  }
-  /**
-   * Returns a list of identities ordered by creation date. The default order is descending.
-   *
-   * The account context of this request is determined by the RC Account ID associated with
-   * the access token provided in the Authorization header.
-   *
-   * The query parameters provided will be considered an AND operation to filter the list.
-   *
-   * A query parameter which is not specified or provided with the null value will be ignored.
-   *
-   * HTTP Method: get
-   * Endpoint: /cx/social-messaging/v1/identities
-   * Rate Limit Group: Light
-   * App Permission: SocialMessaging
-   */
-  public async list(
-    queryParams?: ListSocialMessagingIdentitiesParameters,
-    restRequestConfig?: RestRequestConfig,
-  ): Promise<string> {
-    const r = await this.rc.get<string>(this.path(false), queryParams, restRequestConfig);
-    return r.data;
-  }
-
-  /**
-   * Returns an identity by ID specified in path.
-   * HTTP Method: get
-   * Endpoint: /cx/social-messaging/v1/identities/{identityId}
-   * Rate Limit Group: Light
-   * App Permission: SocialMessaging
-   */
-  public async get(restRequestConfig?: RestRequestConfig): Promise<string> {
-    if (this.identityId === null) {
-      throw new Error('identityId must be specified.');
-    }
-    const r = await this.rc.get<string>(this.path(), undefined, restRequestConfig);
-    return r.data;
-  }
-}
-export default Index;

package/src/paths/Cx/index.ts

@@ -1,18 +0,0 @@
-import SocialMessaging from './SocialMessaging';
-import type { RingCentralInterface } from '../../types';
-
-class Index {
-  public rc: RingCentralInterface;
-
-  public constructor(rc: RingCentralInterface) {
-    this.rc = rc;
-  }
-  public path(): string {
-    return '/cx';
-  }
-
-  public socialMessaging(): SocialMessaging {
-    return new SocialMessaging(this);
-  }
-}
-export default Index;