esi-sdk 2.0.0 → 2.1.0

data/lib/esi/client/mail.rb

@@ -29,10 +29,38 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Mail/delete_characters_character_id_mail_mail_id
       def delete_character_mail(character_id:, mail_id:, headers: {}, params: {})
-        delete("/characters/#{character_id}/mail/#{mail_id}/", headers: headers, params: params).json
+        delete_character_mail_raw(character_id: character_id, mail_id: mail_id, headers: headers, params: params).json
       end
       alias delete_characters_character_id_mail_mail_id delete_character_mail
 
+      # Delete a mail.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-mail.organize_mail.v1
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param character_id [Integer] An EVE character ID
+      # @param mail_id [Integer] An EVE mail ID
+      # @param params [Hash] Additional query string parameters
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @raise [ESI::Errors::UnauthorizedError] Unauthorized
+      # @raise [ESI::Errors::ForbiddenError] Forbidden
+      # @raise [ESI::Errors::ErrorLimitedError] Error limited
+      # @raise [ESI::Errors::InternalServerError] Internal server error
+      # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
+      # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
+      #
+      # @see https://esi.evetech.net/ui/#/Mail/delete_characters_character_id_mail_mail_id
+      def delete_character_mail_raw(character_id:, mail_id:, headers: {}, params: {})
+        delete("/characters/#{character_id}/mail/#{mail_id}/", headers: headers, params: params)
+      end
+
       # Delete a mail label.
       #
       # This endpoint requires authorization (see {ESI::Client#authorize}).
@@ -59,10 +87,39 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Mail/delete_characters_character_id_mail_labels_label_id
       def delete_character_mail_label(character_id:, label_id:, headers: {}, params: {})
-        delete("/characters/#{character_id}/mail/labels/#{label_id}/", headers: headers, params: params).json
+        delete_character_mail_label_raw(character_id: character_id, label_id: label_id, headers: headers, params: params).json
       end
       alias delete_characters_character_id_mail_labels_label_id delete_character_mail_label
 
+      # Delete a mail label.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-mail.organize_mail.v1
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param character_id [Integer] An EVE character ID
+      # @param label_id [Integer] An EVE label id
+      # @param params [Hash] Additional query string parameters
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @raise [ESI::Errors::UnauthorizedError] Unauthorized
+      # @raise [ESI::Errors::ForbiddenError] Forbidden
+      # @raise [ESI::Errors::ErrorLimitedError] Error limited
+      # @raise [ESI::Errors::UnprocessableEntityError] Default labels cannot be deleted
+      # @raise [ESI::Errors::InternalServerError] Internal server error
+      # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
+      # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
+      #
+      # @see https://esi.evetech.net/ui/#/Mail/delete_characters_character_id_mail_labels_label_id
+      def delete_character_mail_label_raw(character_id:, label_id:, headers: {}, params: {})
+        delete("/characters/#{character_id}/mail/labels/#{label_id}/", headers: headers, params: params)
+      end
+
       # Return the contents of an EVE mail.
       #
       # This endpoint is cached for up to 30 seconds.
@@ -91,10 +148,41 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Mail/get_characters_character_id_mail_mail_id
       def get_character_mail(character_id:, mail_id:, headers: {}, params: {})
-        get("/characters/#{character_id}/mail/#{mail_id}/", headers: headers, params: params).json
+        get_character_mail_raw(character_id: character_id, mail_id: mail_id, headers: headers, params: params).json
       end
       alias get_characters_character_id_mail_mail_id get_character_mail
 
+      # Return the contents of an EVE mail.
+      #
+      # This endpoint is cached for up to 30 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-mail.read_mail.v1
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param character_id [Integer] An EVE character ID
+      # @param mail_id [Integer] An EVE mail ID
+      # @param params [Hash] Additional query string parameters
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @raise [ESI::Errors::UnauthorizedError] Unauthorized
+      # @raise [ESI::Errors::ForbiddenError] Forbidden
+      # @raise [ESI::Errors::NotFoundError] Mail not found
+      # @raise [ESI::Errors::ErrorLimitedError] Error limited
+      # @raise [ESI::Errors::InternalServerError] Internal server error
+      # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
+      # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
+      #
+      # @see https://esi.evetech.net/ui/#/Mail/get_characters_character_id_mail_mail_id
+      def get_character_mail_raw(character_id:, mail_id:, headers: {}, params: {})
+        get("/characters/#{character_id}/mail/#{mail_id}/", headers: headers, params: params)
+      end
+
       # Return a list of the users mail labels, unread counts for each label and a total unread count.
       #
       # This endpoint is cached for up to 30 seconds.
@@ -120,10 +208,38 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Mail/get_characters_character_id_mail_labels
       def get_character_mail_labels(character_id:, headers: {}, params: {})
-        get("/characters/#{character_id}/mail/labels/", headers: headers, params: params).json
+        get_character_mail_labels_raw(character_id: character_id, headers: headers, params: params).json
       end
       alias get_characters_character_id_mail_labels get_character_mail_labels
 
+      # Return a list of the users mail labels, unread counts for each label and a total unread count.
+      #
+      # This endpoint is cached for up to 30 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-mail.read_mail.v1
+      #
+      # @esi_version dev
+      # @esi_version v3
+      #
+      # @param character_id [Integer] An EVE character ID
+      # @param params [Hash] Additional query string parameters
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @raise [ESI::Errors::UnauthorizedError] Unauthorized
+      # @raise [ESI::Errors::ForbiddenError] Forbidden
+      # @raise [ESI::Errors::ErrorLimitedError] Error limited
+      # @raise [ESI::Errors::InternalServerError] Internal server error
+      # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
+      # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
+      #
+      # @see https://esi.evetech.net/ui/#/Mail/get_characters_character_id_mail_labels
+      def get_character_mail_labels_raw(character_id:, headers: {}, params: {})
+        get("/characters/#{character_id}/mail/labels/", headers: headers, params: params)
+      end
+
       # Return all mailing lists that the character is subscribed to.
       #
       # This endpoint is cached for up to 120 seconds.
@@ -150,10 +266,39 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Mail/get_characters_character_id_mail_lists
       def get_character_mail_lists(character_id:, headers: {}, params: {})
-        get("/characters/#{character_id}/mail/lists/", headers: headers, params: params).json
+        get_character_mail_lists_raw(character_id: character_id, headers: headers, params: params).json
       end
       alias get_characters_character_id_mail_lists get_character_mail_lists
 
+      # Return all mailing lists that the character is subscribed to.
+      #
+      # This endpoint is cached for up to 120 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-mail.read_mail.v1
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param character_id [Integer] An EVE character ID
+      # @param params [Hash] Additional query string parameters
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @raise [ESI::Errors::UnauthorizedError] Unauthorized
+      # @raise [ESI::Errors::ForbiddenError] Forbidden
+      # @raise [ESI::Errors::ErrorLimitedError] Error limited
+      # @raise [ESI::Errors::InternalServerError] Internal server error
+      # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
+      # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
+      #
+      # @see https://esi.evetech.net/ui/#/Mail/get_characters_character_id_mail_lists
+      def get_character_mail_lists_raw(character_id:, headers: {}, params: {})
+        get("/characters/#{character_id}/mail/lists/", headers: headers, params: params)
+      end
+
       # Create and send a new mail.
       #
       # This endpoint requires authorization (see {ESI::Client#authorize}).
@@ -180,10 +325,39 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Mail/post_characters_character_id_mail
       def post_character_mail(character_id:, mail:, headers: {}, params: {})
-        post("/characters/#{character_id}/mail/", headers: headers, params: params, payload: mail).json
+        post_character_mail_raw(character_id: character_id, mail: mail, headers: headers, params: params).json
       end
       alias post_characters_character_id_mail post_character_mail
 
+      # Create and send a new mail.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-mail.send_mail.v1
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param character_id [Integer] An EVE character ID
+      # @param mail [Hash] The mail to send
+      # @param params [Hash] Additional query string parameters
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @raise [ESI::Errors::UnauthorizedError] Unauthorized
+      # @raise [ESI::Errors::ForbiddenError] Forbidden
+      # @raise [ESI::Errors::ErrorLimitedError] Error limited
+      # @raise [ESI::Errors::InternalServerError] Internal server error
+      # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
+      # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
+      # @raise [ESI::Errors::EveServerError] Internal error thrown from the EVE server. Most of the time this means you have hit an EVE server rate limit
+      #
+      # @see https://esi.evetech.net/ui/#/Mail/post_characters_character_id_mail
+      def post_character_mail_raw(character_id:, mail:, headers: {}, params: {})
+        post("/characters/#{character_id}/mail/", headers: headers, params: params, payload: mail)
+      end
+
       # Create a mail label.
       #
       # This endpoint requires authorization (see {ESI::Client#authorize}).
@@ -209,10 +383,38 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Mail/post_characters_character_id_mail_labels
       def post_character_mail_labels(character_id:, label:, headers: {}, params: {})
-        post("/characters/#{character_id}/mail/labels/", headers: headers, params: params, payload: label).json
+        post_character_mail_labels_raw(character_id: character_id, label: label, headers: headers, params: params).json
       end
       alias post_characters_character_id_mail_labels post_character_mail_labels
 
+      # Create a mail label.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-mail.organize_mail.v1
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v2
+      #
+      # @param character_id [Integer] An EVE character ID
+      # @param label [Hash] Label to create
+      # @param params [Hash] Additional query string parameters
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @raise [ESI::Errors::UnauthorizedError] Unauthorized
+      # @raise [ESI::Errors::ForbiddenError] Forbidden
+      # @raise [ESI::Errors::ErrorLimitedError] Error limited
+      # @raise [ESI::Errors::InternalServerError] Internal server error
+      # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
+      # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
+      #
+      # @see https://esi.evetech.net/ui/#/Mail/post_characters_character_id_mail_labels
+      def post_character_mail_labels_raw(character_id:, label:, headers: {}, params: {})
+        post("/characters/#{character_id}/mail/labels/", headers: headers, params: params, payload: label)
+      end
+
       # Update metadata about a mail.
       #
       # This endpoint requires authorization (see {ESI::Client#authorize}).
@@ -239,9 +441,38 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Mail/put_characters_character_id_mail_mail_id
       def put_character_mail(character_id:, mail_id:, contents:, headers: {}, params: {})
-        put("/characters/#{character_id}/mail/#{mail_id}/", headers: headers, params: params, payload: contents).json
+        put_character_mail_raw(character_id: character_id, mail_id: mail_id, contents: contents, headers: headers, params: params).json
       end
       alias put_characters_character_id_mail_mail_id put_character_mail
+
+      # Update metadata about a mail.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-mail.organize_mail.v1
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param character_id [Integer] An EVE character ID
+      # @param mail_id [Integer] An EVE mail ID
+      # @param contents [Hash] Data used to update the mail
+      # @param params [Hash] Additional query string parameters
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @raise [ESI::Errors::UnauthorizedError] Unauthorized
+      # @raise [ESI::Errors::ForbiddenError] Forbidden
+      # @raise [ESI::Errors::ErrorLimitedError] Error limited
+      # @raise [ESI::Errors::InternalServerError] Internal server error
+      # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
+      # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
+      #
+      # @see https://esi.evetech.net/ui/#/Mail/put_characters_character_id_mail_mail_id
+      def put_character_mail_raw(character_id:, mail_id:, contents:, headers: {}, params: {})
+        put("/characters/#{character_id}/mail/#{mail_id}/", headers: headers, params: params, payload: contents)
+      end
     end
   end
 end