@lgriffin/esi.ts - EVE Online ESI API Client - v12.3.0
    Preparing search index...

    Variable mailEndpointsConst

    mailEndpoints: {
        getCharacterMailHeaders: {
            path: "characters/{characterId}/mail/";
            method: "GET";
            requiresAuth: true;
            pathParams: readonly ["characterId"];
            responseSchema: ZodArray<
                ZodObject<
                    {
                        mail_id: ZodOptional<ZodNumber>;
                        subject: ZodOptional<ZodString>;
                        from: ZodOptional<ZodNumber>;
                        timestamp: ZodOptional<ZodString>;
                        labels: ZodOptional<ZodArray<ZodNumber>>;
                        is_read: ZodOptional<ZodBoolean>;
                        recipients: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    {
                                        recipient_id: ZodNumber;
                                        recipient_type: ZodType<
                                            (...)
                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...),
                                            unknown,
                                            $ZodTypeInternals<(...), (...)>,
                                        >;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                    },
                    $loose,
                >,
            >;
        };
        sendMail: {
            path: "characters/{characterId}/mail/";
            method: "POST";
            responseSchema: ZodNumber;
            requiresAuth: true;
            pathParams: readonly ["characterId"];
            hasBody: true;
            requestSchema: ZodObject<
                {
                    recipients: ZodArray<
                        ZodObject<
                            {
                                recipient_id: ZodNumber;
                                recipient_type: ZodEnum<
                                    {
                                        character: "character";
                                        corporation: "corporation";
                                        alliance: "alliance";
                                        mailing_list: "mailing_list";
                                    },
                                >;
                            },
                            $loose,
                        >,
                    >;
                    subject: ZodString;
                    body: ZodString;
                },
                $loose,
            >;
        };
        getMail: {
            path: "characters/{characterId}/mail/{mailId}/";
            method: "GET";
            requiresAuth: true;
            pathParams: readonly ["characterId", "mailId"];
            responseSchema: ZodObject<
                {
                    subject: ZodOptional<ZodString>;
                    from: ZodOptional<ZodNumber>;
                    timestamp: ZodOptional<ZodString>;
                    labels: ZodOptional<ZodArray<ZodNumber>>;
                    read: ZodOptional<ZodBoolean>;
                    body: ZodOptional<ZodString>;
                    recipients: ZodOptional<
                        ZodArray<
                            ZodObject<
                                {
                                    recipient_id: ZodNumber;
                                    recipient_type: ZodType<
                                        | (...) & (...)
                                        | "character"
                                        | "corporation"
                                        | "alliance"
                                        | "mailing_list",
                                        unknown,
                                        $ZodTypeInternals<(...) | (...) | (...) | (...) | (...), unknown>,
                                    >;
                                },
                                $loose,
                            >,
                        >,
                    >;
                },
                $loose,
            >;
        };
        deleteMail: {
            path: "characters/{characterId}/mail/{mailId}/";
            method: "DELETE";
            requiresAuth: true;
            pathParams: readonly ["characterId", "mailId"];
        };
        updateMailMetadata: {
            path: "characters/{characterId}/mail/{mailId}/";
            method: "PUT";
            requiresAuth: true;
            pathParams: readonly ["characterId", "mailId"];
            hasBody: true;
        };
        getMailLabels: {
            path: "characters/{characterId}/mail/labels/";
            method: "GET";
            requiresAuth: true;
            pathParams: readonly ["characterId"];
            responseSchema: ZodObject<
                {
                    labels: ZodOptional<
                        ZodArray<
                            ZodObject<
                                {
                                    label_id: ZodOptional<ZodNumber>;
                                    name: ZodOptional<ZodString>;
                                    color: ZodOptional<ZodString>;
                                    unread_count: ZodOptional<ZodNumber>;
                                },
                                $loose,
                            >,
                        >,
                    >;
                    total_unread_count: ZodOptional<ZodNumber>;
                },
                $loose,
            >;
        };
        createMailLabel: {
            path: "characters/{characterId}/mail/labels/";
            method: "POST";
            responseSchema: ZodNumber;
            requiresAuth: true;
            pathParams: readonly ["characterId"];
            hasBody: true;
        };
        deleteMailLabel: {
            path: "characters/{characterId}/mail/labels/{labelId}/";
            method: "DELETE";
            requiresAuth: true;
            pathParams: readonly ["characterId", "labelId"];
        };
        getMailingLists: {
            path: "characters/{characterId}/mail/lists/";
            method: "GET";
            requiresAuth: true;
            pathParams: readonly ["characterId"];
            responseSchema: ZodArray<
                ZodObject<{ mailing_list_id: ZodNumber; name: ZodString }, $loose>,
            >;
        };
    } = ...

    Type Declaration

    • ReadonlygetCharacterMailHeaders: {
          path: "characters/{characterId}/mail/";
          method: "GET";
          requiresAuth: true;
          pathParams: readonly ["characterId"];
          responseSchema: ZodArray<
              ZodObject<
                  {
                      mail_id: ZodOptional<ZodNumber>;
                      subject: ZodOptional<ZodString>;
                      from: ZodOptional<ZodNumber>;
                      timestamp: ZodOptional<ZodString>;
                      labels: ZodOptional<ZodArray<ZodNumber>>;
                      is_read: ZodOptional<ZodBoolean>;
                      recipients: ZodOptional<
                          ZodArray<
                              ZodObject<
                                  {
                                      recipient_id: ZodNumber;
                                      recipient_type: ZodType<
                                          (...)
                                          | (...)
                                          | (...)
                                          | (...)
                                          | (...),
                                          unknown,
                                          $ZodTypeInternals<(...), (...)>,
                                      >;
                                  },
                                  $loose,
                              >,
                          >,
                      >;
                  },
                  $loose,
              >,
          >;
      }
    • ReadonlysendMail: {
          path: "characters/{characterId}/mail/";
          method: "POST";
          responseSchema: ZodNumber;
          requiresAuth: true;
          pathParams: readonly ["characterId"];
          hasBody: true;
          requestSchema: ZodObject<
              {
                  recipients: ZodArray<
                      ZodObject<
                          {
                              recipient_id: ZodNumber;
                              recipient_type: ZodEnum<
                                  {
                                      character: "character";
                                      corporation: "corporation";
                                      alliance: "alliance";
                                      mailing_list: "mailing_list";
                                  },
                              >;
                          },
                          $loose,
                      >,
                  >;
                  subject: ZodString;
                  body: ZodString;
              },
              $loose,
          >;
      }
    • ReadonlygetMail: {
          path: "characters/{characterId}/mail/{mailId}/";
          method: "GET";
          requiresAuth: true;
          pathParams: readonly ["characterId", "mailId"];
          responseSchema: ZodObject<
              {
                  subject: ZodOptional<ZodString>;
                  from: ZodOptional<ZodNumber>;
                  timestamp: ZodOptional<ZodString>;
                  labels: ZodOptional<ZodArray<ZodNumber>>;
                  read: ZodOptional<ZodBoolean>;
                  body: ZodOptional<ZodString>;
                  recipients: ZodOptional<
                      ZodArray<
                          ZodObject<
                              {
                                  recipient_id: ZodNumber;
                                  recipient_type: ZodType<
                                      | (...) & (...)
                                      | "character"
                                      | "corporation"
                                      | "alliance"
                                      | "mailing_list",
                                      unknown,
                                      $ZodTypeInternals<(...) | (...) | (...) | (...) | (...), unknown>,
                                  >;
                              },
                              $loose,
                          >,
                      >,
                  >;
              },
              $loose,
          >;
      }
    • ReadonlydeleteMail: {
          path: "characters/{characterId}/mail/{mailId}/";
          method: "DELETE";
          requiresAuth: true;
          pathParams: readonly ["characterId", "mailId"];
      }
    • ReadonlyupdateMailMetadata: {
          path: "characters/{characterId}/mail/{mailId}/";
          method: "PUT";
          requiresAuth: true;
          pathParams: readonly ["characterId", "mailId"];
          hasBody: true;
      }
    • ReadonlygetMailLabels: {
          path: "characters/{characterId}/mail/labels/";
          method: "GET";
          requiresAuth: true;
          pathParams: readonly ["characterId"];
          responseSchema: ZodObject<
              {
                  labels: ZodOptional<
                      ZodArray<
                          ZodObject<
                              {
                                  label_id: ZodOptional<ZodNumber>;
                                  name: ZodOptional<ZodString>;
                                  color: ZodOptional<ZodString>;
                                  unread_count: ZodOptional<ZodNumber>;
                              },
                              $loose,
                          >,
                      >,
                  >;
                  total_unread_count: ZodOptional<ZodNumber>;
              },
              $loose,
          >;
      }
    • ReadonlycreateMailLabel: {
          path: "characters/{characterId}/mail/labels/";
          method: "POST";
          responseSchema: ZodNumber;
          requiresAuth: true;
          pathParams: readonly ["characterId"];
          hasBody: true;
      }
    • ReadonlydeleteMailLabel: {
          path: "characters/{characterId}/mail/labels/{labelId}/";
          method: "DELETE";
          requiresAuth: true;
          pathParams: readonly ["characterId", "labelId"];
      }
    • ReadonlygetMailingLists: {
          path: "characters/{characterId}/mail/lists/";
          method: "GET";
          requiresAuth: true;
          pathParams: readonly ["characterId"];
          responseSchema: ZodArray<
              ZodObject<{ mailing_list_id: ZodNumber; name: ZodString }, $loose>,
          >;
      }