box-node-sdk/src/managers/emailAliases.ts

Official SDK for Box Platform APIs

import { serializeEmailAliases } from '../schemas/emailAliases';
import { deserializeEmailAliases } from '../schemas/emailAliases';
import { serializeClientError } from '../schemas/clientError';
import { deserializeClientError } from '../schemas/clientError';
import { serializeEmailAlias } from '../schemas/emailAlias';
import { deserializeEmailAlias } from '../schemas/emailAlias';
import { ResponseFormat } from '../networking/fetchOptions';
import { EmailAliases } from '../schemas/emailAliases';
import { ClientError } from '../schemas/clientError';
import { EmailAlias } from '../schemas/emailAlias';
import { BoxSdkError } from '../box/errors';
import { Authentication } from '../networking/auth';
import { NetworkSession } from '../networking/network';
import { FetchOptions } from '../networking/fetchOptions';
import { FetchResponse } from '../networking/fetchResponse';
import { prepareParams } from '../internal/utils';
import { toString } from '../internal/utils';
import { ByteStream } from '../internal/utils';
import { CancellationToken } from '../internal/utils';
import { sdToJson } from '../serialization/json';
import { SerializedData } from '../serialization/json';
import { sdIsEmpty } from '../serialization/json';
import { sdIsBoolean } from '../serialization/json';
import { sdIsNumber } from '../serialization/json';
import { sdIsString } from '../serialization/json';
import { sdIsList } from '../serialization/json';
import { sdIsMap } from '../serialization/json';
export class GetUserEmailAliasesOptionals {
  readonly headers: GetUserEmailAliasesHeaders = new GetUserEmailAliasesHeaders(
    {},
  );
  readonly cancellationToken?: CancellationToken = void 0;
  constructor(
    fields: Omit<
      GetUserEmailAliasesOptionals,
      'headers' | 'cancellationToken'
    > &
      Partial<
        Pick<GetUserEmailAliasesOptionals, 'headers' | 'cancellationToken'>
      >,
  ) {
    if (fields.headers !== undefined) {
      this.headers = fields.headers;
    }
    if (fields.cancellationToken !== undefined) {
      this.cancellationToken = fields.cancellationToken;
    }
  }
}
export interface GetUserEmailAliasesOptionalsInput {
  readonly headers?: GetUserEmailAliasesHeaders;
  readonly cancellationToken?: CancellationToken;
}
export class CreateUserEmailAliasOptionals {
  readonly headers: CreateUserEmailAliasHeaders =
    new CreateUserEmailAliasHeaders({});
  readonly cancellationToken?: CancellationToken = void 0;
  constructor(
    fields: Omit<
      CreateUserEmailAliasOptionals,
      'headers' | 'cancellationToken'
    > &
      Partial<
        Pick<CreateUserEmailAliasOptionals, 'headers' | 'cancellationToken'>
      >,
  ) {
    if (fields.headers !== undefined) {
      this.headers = fields.headers;
    }
    if (fields.cancellationToken !== undefined) {
      this.cancellationToken = fields.cancellationToken;
    }
  }
}
export interface CreateUserEmailAliasOptionalsInput {
  readonly headers?: CreateUserEmailAliasHeaders;
  readonly cancellationToken?: CancellationToken;
}
export class DeleteUserEmailAliasByIdOptionals {
  readonly headers: DeleteUserEmailAliasByIdHeaders =
    new DeleteUserEmailAliasByIdHeaders({});
  readonly cancellationToken?: CancellationToken = void 0;
  constructor(
    fields: Omit<
      DeleteUserEmailAliasByIdOptionals,
      'headers' | 'cancellationToken'
    > &
      Partial<
        Pick<DeleteUserEmailAliasByIdOptionals, 'headers' | 'cancellationToken'>
      >,
  ) {
    if (fields.headers !== undefined) {
      this.headers = fields.headers;
    }
    if (fields.cancellationToken !== undefined) {
      this.cancellationToken = fields.cancellationToken;
    }
  }
}
export interface DeleteUserEmailAliasByIdOptionalsInput {
  readonly headers?: DeleteUserEmailAliasByIdHeaders;
  readonly cancellationToken?: CancellationToken;
}
export class GetUserEmailAliasesHeaders {
  /**
   * Extra headers that will be included in the HTTP request. */
  readonly extraHeaders?: {
    readonly [key: string]: undefined | string;
  } = {};
  constructor(
    fields: Omit<GetUserEmailAliasesHeaders, 'extraHeaders'> &
      Partial<Pick<GetUserEmailAliasesHeaders, 'extraHeaders'>>,
  ) {
    if (fields.extraHeaders !== undefined) {
      this.extraHeaders = fields.extraHeaders;
    }
  }
}
export interface GetUserEmailAliasesHeadersInput {
  /**
   * Extra headers that will be included in the HTTP request. */
  readonly extraHeaders?: {
    readonly [key: string]: undefined | string;
  };
}
export interface CreateUserEmailAliasRequestBody {
  /**
   * The email address to add to the account as an alias.
   *
   * Note: The domain of the email alias needs to be registered
   *  to your enterprise.
   * See the [domain verification guide](
   *   https://support.box.com/hc/en-us/articles/4408619650579-Domain-Verification
   *   ) for steps to add a new domain. */
  readonly email: string;
  readonly rawData?: SerializedData;
}
export class CreateUserEmailAliasHeaders {
  /**
   * Extra headers that will be included in the HTTP request. */
  readonly extraHeaders?: {
    readonly [key: string]: undefined | string;
  } = {};
  constructor(
    fields: Omit<CreateUserEmailAliasHeaders, 'extraHeaders'> &
      Partial<Pick<CreateUserEmailAliasHeaders, 'extraHeaders'>>,
  ) {
    if (fields.extraHeaders !== undefined) {
      this.extraHeaders = fields.extraHeaders;
    }
  }
}
export interface CreateUserEmailAliasHeadersInput {
  /**
   * Extra headers that will be included in the HTTP request. */
  readonly extraHeaders?: {
    readonly [key: string]: undefined | string;
  };
}
export class DeleteUserEmailAliasByIdHeaders {
  /**
   * Extra headers that will be included in the HTTP request. */
  readonly extraHeaders?: {
    readonly [key: string]: undefined | string;
  } = {};
  constructor(
    fields: Omit<DeleteUserEmailAliasByIdHeaders, 'extraHeaders'> &
      Partial<Pick<DeleteUserEmailAliasByIdHeaders, 'extraHeaders'>>,
  ) {
    if (fields.extraHeaders !== undefined) {
      this.extraHeaders = fields.extraHeaders;
    }
  }
}
export interface DeleteUserEmailAliasByIdHeadersInput {
  /**
   * Extra headers that will be included in the HTTP request. */
  readonly extraHeaders?: {
    readonly [key: string]: undefined | string;
  };
}
export class EmailAliasesManager {
  readonly auth?: Authentication;
  readonly networkSession: NetworkSession = new NetworkSession({});
  constructor(
    fields: Omit<
      EmailAliasesManager,
      | 'networkSession'
      | 'getUserEmailAliases'
      | 'createUserEmailAlias'
      | 'deleteUserEmailAliasById'
    > &
      Partial<Pick<EmailAliasesManager, 'networkSession'>>,
  ) {
    if (fields.auth !== undefined) {
      this.auth = fields.auth;
    }
    if (fields.networkSession !== undefined) {
      this.networkSession = fields.networkSession;
    }
  }
  /**
     * Retrieves all email aliases for a user. The collection
     * does not include the primary login for the user.
     * @param {string} userId The ID of the user.
    Example: "12345"
     * @param {GetUserEmailAliasesOptionalsInput} optionalsInput
     * @returns {Promise<EmailAliases>}
     */
  async getUserEmailAliases(
    userId: string,
    optionalsInput: GetUserEmailAliasesOptionalsInput = {},
  ): Promise<EmailAliases> {
    const optionals: GetUserEmailAliasesOptionals =
      new GetUserEmailAliasesOptionals({
        headers: optionalsInput.headers,
        cancellationToken: optionalsInput.cancellationToken,
      });
    const headers: any = optionals.headers;
    const cancellationToken: any = optionals.cancellationToken;
    const headersMap: {
      readonly [key: string]: string;
    } = prepareParams({ ...{}, ...headers.extraHeaders });
    const response: FetchResponse =
      await this.networkSession.networkClient.fetch(
        new FetchOptions({
          url: ''.concat(
            this.networkSession.baseUrls.baseUrl,
            '/2.0/users/',
            (toString(userId) as string)!,
            '/email_aliases',
          ) as string,
          method: 'GET',
          headers: headersMap,
          responseFormat: 'json' as ResponseFormat,
          auth: this.auth,
          networkSession: this.networkSession,
          cancellationToken: cancellationToken,
        }),
      );
    return {
      ...deserializeEmailAliases(response.data!),
      rawData: response.data!,
    };
  }
  /**
     * Adds a new email alias to a user account..
     * @param {string} userId The ID of the user.
    Example: "12345"
     * @param {CreateUserEmailAliasRequestBody} requestBody Request body of createUserEmailAlias method
     * @param {CreateUserEmailAliasOptionalsInput} optionalsInput
     * @returns {Promise<EmailAlias>}
     */
  async createUserEmailAlias(
    userId: string,
    requestBody: CreateUserEmailAliasRequestBody,
    optionalsInput: CreateUserEmailAliasOptionalsInput = {},
  ): Promise<EmailAlias> {
    const optionals: CreateUserEmailAliasOptionals =
      new CreateUserEmailAliasOptionals({
        headers: optionalsInput.headers,
        cancellationToken: optionalsInput.cancellationToken,
      });
    const headers: any = optionals.headers;
    const cancellationToken: any = optionals.cancellationToken;
    const headersMap: {
      readonly [key: string]: string;
    } = prepareParams({ ...{}, ...headers.extraHeaders });
    const response: FetchResponse =
      await this.networkSession.networkClient.fetch(
        new FetchOptions({
          url: ''.concat(
            this.networkSession.baseUrls.baseUrl,
            '/2.0/users/',
            (toString(userId) as string)!,
            '/email_aliases',
          ) as string,
          method: 'POST',
          headers: headersMap,
          data: serializeCreateUserEmailAliasRequestBody(requestBody),
          contentType: 'application/json',
          responseFormat: 'json' as ResponseFormat,
          auth: this.auth,
          networkSession: this.networkSession,
          cancellationToken: cancellationToken,
        }),
      );
    return {
      ...deserializeEmailAlias(response.data!),
      rawData: response.data!,
    };
  }
  /**
     * Removes an email alias from a user.
     * @param {string} userId The ID of the user.
    Example: "12345"
     * @param {string} emailAliasId The ID of the email alias.
    Example: "23432"
     * @param {DeleteUserEmailAliasByIdOptionalsInput} optionalsInput
     * @returns {Promise<undefined>}
     */
  async deleteUserEmailAliasById(
    userId: string,
    emailAliasId: string,
    optionalsInput: DeleteUserEmailAliasByIdOptionalsInput = {},
  ): Promise<undefined> {
    const optionals: DeleteUserEmailAliasByIdOptionals =
      new DeleteUserEmailAliasByIdOptionals({
        headers: optionalsInput.headers,
        cancellationToken: optionalsInput.cancellationToken,
      });
    const headers: any = optionals.headers;
    const cancellationToken: any = optionals.cancellationToken;
    const headersMap: {
      readonly [key: string]: string;
    } = prepareParams({ ...{}, ...headers.extraHeaders });
    const response: FetchResponse =
      await this.networkSession.networkClient.fetch(
        new FetchOptions({
          url: ''.concat(
            this.networkSession.baseUrls.baseUrl,
            '/2.0/users/',
            (toString(userId) as string)!,
            '/email_aliases/',
            (toString(emailAliasId) as string)!,
          ) as string,
          method: 'DELETE',
          headers: headersMap,
          responseFormat: 'no_content' as ResponseFormat,
          auth: this.auth,
          networkSession: this.networkSession,
          cancellationToken: cancellationToken,
        }),
      );
    return void 0;
  }
}
export interface EmailAliasesManagerInput {
  readonly auth?: Authentication;
  readonly networkSession?: NetworkSession;
}
export function serializeCreateUserEmailAliasRequestBody(
  val: CreateUserEmailAliasRequestBody,
): SerializedData {
  return { ['email']: val.email };
}
export function deserializeCreateUserEmailAliasRequestBody(
  val: SerializedData,
): CreateUserEmailAliasRequestBody {
  if (!sdIsMap(val)) {
    throw new BoxSdkError({
      message: 'Expecting a map for "CreateUserEmailAliasRequestBody"',
    });
  }
  if (val.email == void 0) {
    throw new BoxSdkError({
      message:
        'Expecting "email" of type "CreateUserEmailAliasRequestBody" to be defined',
    });
  }
  if (!sdIsString(val.email)) {
    throw new BoxSdkError({
      message:
        'Expecting string for "email" of type "CreateUserEmailAliasRequestBody"',
    });
  }
  const email: string = val.email;
  return { email: email } satisfies CreateUserEmailAliasRequestBody;
}