esi-sdk 1.1.2 → 2.1.0

data/lib/esi/client/contracts.rb

@@ -16,8 +16,8 @@ module ESI
       # @esi_version legacy
       # @esi_version v1
       #
-      # @param character_id [Integer,String] An EVE character ID
-      # @param contract_id [Integer,String] ID of a contract
+      # @param character_id [Integer] An EVE character ID
+      # @param contract_id [Integer] ID of a contract
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
       #
@@ -31,11 +31,42 @@ module ESI
       # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
       #
       # @see https://esi.evetech.net/ui/#/Contracts/get_characters_character_id_contracts_contract_id_bids
-      def get_character_contract_bids(character_id:, contract_id:, params: {}, headers: {})
-        get("/characters/#{character_id}/contracts/#{contract_id}/bids/", headers: headers, params: params)
+      def get_character_contract_bids(character_id:, contract_id:, headers: {}, params: {})
+        get_character_contract_bids_raw(character_id: character_id, contract_id: contract_id, headers: headers, params: params).json
       end
       alias get_characters_character_id_contracts_contract_id_bids get_character_contract_bids
 
+      # Lists bids on a particular auction contract.
+      #
+      # This endpoint is cached for up to 300 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-contracts.read_character_contracts.v1
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param character_id [Integer] An EVE character ID
+      # @param contract_id [Integer] ID of a contract
+      # @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] 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/#/Contracts/get_characters_character_id_contracts_contract_id_bids
+      def get_character_contract_bids_raw(character_id:, contract_id:, headers: {}, params: {})
+        get("/characters/#{character_id}/contracts/#{contract_id}/bids/", headers: headers, params: params)
+      end
+
       # Lists items of a particular contract.
       #
       # This endpoint is cached for up to 3600 seconds.
@@ -48,8 +79,8 @@ module ESI
       # @esi_version legacy
       # @esi_version v1
       #
-      # @param character_id [Integer,String] An EVE character ID
-      # @param contract_id [Integer,String] ID of a contract
+      # @param character_id [Integer] An EVE character ID
+      # @param contract_id [Integer] ID of a contract
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
       #
@@ -63,11 +94,42 @@ module ESI
       # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
       #
       # @see https://esi.evetech.net/ui/#/Contracts/get_characters_character_id_contracts_contract_id_items
-      def get_character_contract_items(character_id:, contract_id:, params: {}, headers: {})
-        get("/characters/#{character_id}/contracts/#{contract_id}/items/", headers: headers, params: params)
+      def get_character_contract_items(character_id:, contract_id:, headers: {}, params: {})
+        get_character_contract_items_raw(character_id: character_id, contract_id: contract_id, headers: headers, params: params).json
       end
       alias get_characters_character_id_contracts_contract_id_items get_character_contract_items
 
+      # Lists items of a particular contract.
+      #
+      # This endpoint is cached for up to 3600 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-contracts.read_character_contracts.v1
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param character_id [Integer] An EVE character ID
+      # @param contract_id [Integer] ID of a contract
+      # @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] 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/#/Contracts/get_characters_character_id_contracts_contract_id_items
+      def get_character_contract_items_raw(character_id:, contract_id:, headers: {}, params: {})
+        get("/characters/#{character_id}/contracts/#{contract_id}/items/", headers: headers, params: params)
+      end
+
       # Returns contracts available to a character, only if the character is issuer, acceptor or assignee. Only returns contracts no older than 30 days, or if the status is "in_progress".
       #
       # This endpoint is cached for up to 300 seconds.
@@ -80,7 +142,7 @@ module ESI
       # @esi_version legacy
       # @esi_version v1
       #
-      # @param character_id [Integer,String] An EVE character ID
+      # @param character_id [Integer] An EVE character ID
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
       #
@@ -93,11 +155,41 @@ module ESI
       # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
       #
       # @see https://esi.evetech.net/ui/#/Contracts/get_characters_character_id_contracts
-      def get_character_contracts(character_id:, params: {}, headers: {})
-        get("/characters/#{character_id}/contracts/", headers: headers, params: params)
+      def get_character_contracts(character_id:, headers: {}, params: {})
+        responses = get_character_contracts_raw(character_id: character_id, headers: headers, params: params)
+        responses.map(&:json).reduce([], :concat)
       end
       alias get_characters_character_id_contracts get_character_contracts
 
+      # Returns contracts available to a character, only if the character is issuer, acceptor or assignee. Only returns contracts no older than 30 days, or if the status is "in_progress".
+      #
+      # This endpoint is cached for up to 300 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-contracts.read_character_contracts.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/#/Contracts/get_characters_character_id_contracts
+      def get_character_contracts_raw(character_id:, headers: {}, params: {})
+        get("/characters/#{character_id}/contracts/", headers: headers, params: params)
+      end
+
       # Lists bids on a public auction contract.
       #
       # This endpoint is cached for up to 300 seconds.
@@ -106,7 +198,7 @@ module ESI
       # @esi_version legacy
       # @esi_version v1
       #
-      # @param contract_id [Integer,String] ID of a contract
+      # @param contract_id [Integer] ID of a contract
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
       #
@@ -119,11 +211,37 @@ module ESI
       # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
       #
       # @see https://esi.evetech.net/ui/#/Contracts/get_contracts_public_bids_contract_id
-      def get_contracts_public_bids_contract(contract_id:, params: {}, headers: {})
-        get("/contracts/public/bids/#{contract_id}/", headers: headers, params: params)
+      def get_contracts_public_bids_contract(contract_id:, headers: {}, params: {})
+        responses = get_contracts_public_bids_contract_raw(contract_id: contract_id, headers: headers, params: params)
+        responses.map(&:json).reduce([], :concat)
       end
       alias get_contracts_public_bids_contract_id get_contracts_public_bids_contract
 
+      # Lists bids on a public auction contract.
+      #
+      # This endpoint is cached for up to 300 seconds.
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param contract_id [Integer] ID of a contract
+      # @param params [Hash] Additional query string parameters
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @raise [ESI::Errors::ForbiddenError] Not Authorized to see contract
+      # @raise [ESI::Errors::NotFoundError] 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/#/Contracts/get_contracts_public_bids_contract_id
+      def get_contracts_public_bids_contract_raw(contract_id:, headers: {}, params: {})
+        get("/contracts/public/bids/#{contract_id}/", headers: headers, params: params)
+      end
+
       # Lists items of a public contract.
       #
       # This endpoint is cached for up to 3600 seconds.
@@ -132,7 +250,7 @@ module ESI
       # @esi_version legacy
       # @esi_version v1
       #
-      # @param contract_id [Integer,String] ID of a contract
+      # @param contract_id [Integer] ID of a contract
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
       #
@@ -145,11 +263,37 @@ module ESI
       # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
       #
       # @see https://esi.evetech.net/ui/#/Contracts/get_contracts_public_items_contract_id
-      def get_contracts_public_items_contract(contract_id:, params: {}, headers: {})
-        get("/contracts/public/items/#{contract_id}/", headers: headers, params: params)
+      def get_contracts_public_items_contract(contract_id:, headers: {}, params: {})
+        responses = get_contracts_public_items_contract_raw(contract_id: contract_id, headers: headers, params: params)
+        responses.map(&:json).reduce([], :concat)
       end
       alias get_contracts_public_items_contract_id get_contracts_public_items_contract
 
+      # Lists items of a public contract.
+      #
+      # This endpoint is cached for up to 3600 seconds.
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param contract_id [Integer] ID of a contract
+      # @param params [Hash] Additional query string parameters
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @raise [ESI::Errors::ForbiddenError] Not Authorized to see contract
+      # @raise [ESI::Errors::NotFoundError] 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/#/Contracts/get_contracts_public_items_contract_id
+      def get_contracts_public_items_contract_raw(contract_id:, headers: {}, params: {})
+        get("/contracts/public/items/#{contract_id}/", headers: headers, params: params)
+      end
+
       # Returns a paginated list of all public contracts in the given region.
       #
       # This endpoint is cached for up to 1800 seconds.
@@ -158,7 +302,7 @@ module ESI
       # @esi_version legacy
       # @esi_version v1
       #
-      # @param region_id [Integer,String] An EVE region id
+      # @param region_id [Integer] An EVE region id
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
       #
@@ -170,11 +314,36 @@ module ESI
       # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
       #
       # @see https://esi.evetech.net/ui/#/Contracts/get_contracts_public_region_id
-      def get_contracts_public_region(region_id:, params: {}, headers: {})
-        get("/contracts/public/#{region_id}/", headers: headers, params: params)
+      def get_contracts_public_region(region_id:, headers: {}, params: {})
+        responses = get_contracts_public_region_raw(region_id: region_id, headers: headers, params: params)
+        responses.map(&:json).reduce([], :concat)
       end
       alias get_contracts_public_region_id get_contracts_public_region
 
+      # Returns a paginated list of all public contracts in the given region.
+      #
+      # This endpoint is cached for up to 1800 seconds.
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param region_id [Integer] An EVE region id
+      # @param params [Hash] Additional query string parameters
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @raise [ESI::Errors::NotFoundError] Region 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/#/Contracts/get_contracts_public_region_id
+      def get_contracts_public_region_raw(region_id:, headers: {}, params: {})
+        get("/contracts/public/#{region_id}/", headers: headers, params: params)
+      end
+
       # Lists bids on a particular auction contract.
       #
       # This endpoint is cached for up to 3600 seconds.
@@ -187,8 +356,8 @@ module ESI
       # @esi_version legacy
       # @esi_version v1
       #
-      # @param contract_id [Integer,String] ID of a contract
-      # @param corporation_id [Integer,String] An EVE corporation ID
+      # @param contract_id [Integer] ID of a contract
+      # @param corporation_id [Integer] An EVE corporation ID
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
       #
@@ -202,11 +371,43 @@ module ESI
       # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
       #
       # @see https://esi.evetech.net/ui/#/Contracts/get_corporations_corporation_id_contracts_contract_id_bids
-      def get_corporation_contract_bids(contract_id:, corporation_id:, params: {}, headers: {})
-        get("/corporations/#{corporation_id}/contracts/#{contract_id}/bids/", headers: headers, params: params)
+      def get_corporation_contract_bids(contract_id:, corporation_id:, headers: {}, params: {})
+        responses = get_corporation_contract_bids_raw(contract_id: contract_id, corporation_id: corporation_id, headers: headers, params: params)
+        responses.map(&:json).reduce([], :concat)
       end
       alias get_corporations_corporation_id_contracts_contract_id_bids get_corporation_contract_bids
 
+      # Lists bids on a particular auction contract.
+      #
+      # This endpoint is cached for up to 3600 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-contracts.read_corporation_contracts.v1
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param contract_id [Integer] ID of a contract
+      # @param corporation_id [Integer] An EVE corporation 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] 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/#/Contracts/get_corporations_corporation_id_contracts_contract_id_bids
+      def get_corporation_contract_bids_raw(contract_id:, corporation_id:, headers: {}, params: {})
+        get("/corporations/#{corporation_id}/contracts/#{contract_id}/bids/", headers: headers, params: params)
+      end
+
       # Lists items of a particular contract.
       #
       # This endpoint is cached for up to 3600 seconds.
@@ -219,8 +420,8 @@ module ESI
       # @esi_version legacy
       # @esi_version v1
       #
-      # @param contract_id [Integer,String] ID of a contract
-      # @param corporation_id [Integer,String] An EVE corporation ID
+      # @param contract_id [Integer] ID of a contract
+      # @param corporation_id [Integer] An EVE corporation ID
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
       #
@@ -235,11 +436,43 @@ module ESI
       # @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/#/Contracts/get_corporations_corporation_id_contracts_contract_id_items
-      def get_corporation_contract_items(contract_id:, corporation_id:, params: {}, headers: {})
-        get("/corporations/#{corporation_id}/contracts/#{contract_id}/items/", headers: headers, params: params)
+      def get_corporation_contract_items(contract_id:, corporation_id:, headers: {}, params: {})
+        get_corporation_contract_items_raw(contract_id: contract_id, corporation_id: corporation_id, headers: headers, params: params).json
       end
       alias get_corporations_corporation_id_contracts_contract_id_items get_corporation_contract_items
 
+      # Lists items of a particular contract.
+      #
+      # This endpoint is cached for up to 3600 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-contracts.read_corporation_contracts.v1
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param contract_id [Integer] ID of a contract
+      # @param corporation_id [Integer] An EVE corporation 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] 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
+      # @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/#/Contracts/get_corporations_corporation_id_contracts_contract_id_items
+      def get_corporation_contract_items_raw(contract_id:, corporation_id:, headers: {}, params: {})
+        get("/corporations/#{corporation_id}/contracts/#{contract_id}/items/", headers: headers, params: params)
+      end
+
       # Returns contracts available to a corporation, only if the corporation is issuer, acceptor or assignee. Only returns contracts no older than 30 days, or if the status is "in_progress".
       #
       # This endpoint is cached for up to 300 seconds.
@@ -252,7 +485,7 @@ module ESI
       # @esi_version legacy
       # @esi_version v1
       #
-      # @param corporation_id [Integer,String] An EVE corporation ID
+      # @param corporation_id [Integer] An EVE corporation ID
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
       #
@@ -265,10 +498,40 @@ module ESI
       # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
       #
       # @see https://esi.evetech.net/ui/#/Contracts/get_corporations_corporation_id_contracts
-      def get_corporation_contracts(corporation_id:, params: {}, headers: {})
-        get("/corporations/#{corporation_id}/contracts/", headers: headers, params: params)
+      def get_corporation_contracts(corporation_id:, headers: {}, params: {})
+        responses = get_corporation_contracts_raw(corporation_id: corporation_id, headers: headers, params: params)
+        responses.map(&:json).reduce([], :concat)
       end
       alias get_corporations_corporation_id_contracts get_corporation_contracts
+
+      # Returns contracts available to a corporation, only if the corporation is issuer, acceptor or assignee. Only returns contracts no older than 30 days, or if the status is "in_progress".
+      #
+      # This endpoint is cached for up to 300 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-contracts.read_corporation_contracts.v1
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param corporation_id [Integer] An EVE corporation 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/#/Contracts/get_corporations_corporation_id_contracts
+      def get_corporation_contracts_raw(corporation_id:, headers: {}, params: {})
+        get("/corporations/#{corporation_id}/contracts/", headers: headers, params: params)
+      end
     end
   end
 end