Invitations.ts

import { ClassDoAPIClient, Result } from '.'
import { InvitationKeys, buildSendInvitationMutation, InvitationOption, InvitationResult } from '../models/Invitations';
import { RoomKeys } from '../models/Rooms';
import { OrganizationKeys } from '../models/Organizations';
import { RoomMemberKeys } from '../models/RoomMembers';
import { UserKeys } from '../models/Users';
import { UserProfileKeys } from '../models/UserProfiles';
import { MutationSendInvitationArgs } from '../generated/graphql';
import { EmailKeys } from '../models/Emails';

/** Client to call mutation for invitations */
export class InvitatationsClient {
  /** @ignore */
  constructor(private client: ClassDoAPIClient) {}

  /**
   * Send an invitatoin.
   * 
   * ```typescript
   * client.invitatoins.send(['id'], {
   *   data: {
   *     contactFullName: 'joe',
   *     contactType: ContactType.Email,
   *     contactInfo: 'example@gmail.com',
   *     organizationMemberRoleId: 'xxxxxxxxxxxxxxxxxx',
   *     roomId: 'xxxxxxxxxxxxxxxxxx',
   *     locale: Enum.Locale.En
   *   }
   * }).then(v => {
   *   console.log(v)
   * })
   * ```
   * 
   * If you don't want to send a notificatoin message from classdo, you can use `withoutNotificattion` flag.
   * 
   * ```typescript
   *  client.invitatoins.send(['id'], {
   *   data: {
   *     contactFullName: 'joe',
   *     contactType: ContactType.Email,
   *     contactInfo: 'example@gmail.com',
   *     organizationMemberRoleId: 'xxxxxxxxxxxxxxxxxx',
   *     roomId: 'xxxxxxxxxxxxxxxxxx',
   *     locale: Enum.Locale.En,
   *     withoutNotification: true
   *   }
   * }).then(v => {
   *   console.log(v)
   * })
   * ```
   * 
   * @param fields Array of [[Invitation]] key names. Returns specified fields as result.
   * @param args
   * @param option
   */
  async send<
    I extends InvitationKeys,
    R extends RoomKeys | null,
    R_O extends OrganizationKeys | null,
    R_RM extends RoomMemberKeys | null,
    R_RM_U extends UserKeys | null,
    R_RM_U_UP extends UserProfileKeys | null,
    R_RM_U_UP_E extends EmailKeys | null,
    O extends OrganizationKeys | null
  >(
    fields: I[],
    args: MutationSendInvitationArgs,
    option?: InvitationOption<R, R_O, R_RM, R_RM_U, R_RM_U_UP, R_RM_U_UP_E, O>
  ): Promise<Result<InvitationResult<I, R, R_O, R_RM, R_RM_U, R_RM_U_UP, R_RM_U_UP_E, O>>> {
    const result = await this.client.mutate(
      buildSendInvitationMutation(fields, args, option)
    )
    return { errors: result.errors, data: result.data?.sendInvitation || null }
  }
}