lib/cryptomate_api/management/key.rb in cryptomate_api-0.2.0 vs lib/cryptomate_api/management/key.rb in cryptomate_api-0.3.0
- old
+ new
@@ -4,69 +4,71 @@
module Management
# Manage the api-keys of your clients.
# You can create, modify and delete them.
# This api-keys are used to authenticate the clients in the platform.
class Key < CryptomateApi::Base
- # Get all keys
- # https://cryptomate.me/docs/management#get-all-keys
- # Response:
- # [
- # {
- # "api_key": "string",
- # "name": "string"
- # }
- # ]
- def get_all_keys
- self.class.get('/management/keys/list')
- end
+ class << self
+ # Get all keys
+ # https://cryptomate.me/docs/management#get-all-keys
+ # Response:
+ # [
+ # {
+ # "api_key": "string",
+ # "name": "string"
+ # }
+ # ]
+ def get_all_keys
+ get('/management/keys/list')
+ end
- # Get a specific key
- # https://cryptomate.me/docs/management#get-a-key
- # Response:
- # [
- # {
- # "api_key": "string",
- # "name": "string"
- # }
- # ]
- def get_key(key_id)
- self.class.get("/management/keys/#{key_id}")
- end
+ # Get a specific key
+ # https://cryptomate.me/docs/management#get-a-key
+ # Response:
+ # [
+ # {
+ # "api_key": "string",
+ # "name": "string"
+ # }
+ # ]
+ def get_key(key_id)
+ get("/management/keys/#{key_id}")
+ end
- # Create a key
- # https://cryptomate.me/docs/management#create-a-key
- # @param [String] name (Alias name of the API-Key to create.)
- # Response:
- # [
- # {
- # "api_key": "string",
- # "name": "string"
- # }
- # ]
- def create_key(name)
- self.class.post('/management/keys/create', body: { name: }.to_json)
- end
+ # Create a key
+ # https://cryptomate.me/docs/management#create-a-key
+ # @param [String] name (Alias name of the API-Key to create.)
+ # Response:
+ # [
+ # {
+ # "api_key": "string",
+ # "name": "string"
+ # }
+ # ]
+ def create_key(name)
+ post('/management/keys/create', body: { name: }.to_json)
+ end
- # Modify a key
- # https://cryptomate.me/docs/management#modify-a-key
- # @param [String] key_name (Name of the key to modify.)
- # @param [String] new_api_key_value (New api-key value.)
- # Response:
- # [
- # {
- # "api_key": "string",
- # "name": "string"
- # }
- # ]
- def modify_key(key_name, new_api_key_value)
- self.class.put("/management/keys/#{key_name}", body: { api_key: new_api_key_value }.to_json)
- end
+ # Modify a key
+ # https://cryptomate.me/docs/management#modify-a-key
+ # @param [String] key_name (Name of the key to modify.)
+ # @param [String] new_api_key_value (New api-key value.)
+ # Response:
+ # [
+ # {
+ # "api_key": "string",
+ # "name": "string"
+ # }
+ # ]
+ def modify_key(key_name, new_api_key_value)
+ put("/management/keys/#{key_name}", body: { api_key: new_api_key_value }.to_json)
+ end
- # Delete a key
- # https://cryptomate.me/docs/management#delete-a-key
- # @param [String] api_key (Id of the API-Key. Ex: master-ac8ff424-426f-46a7-94c3-13932c6e8adf)
- def delete_key(api_key)
- self.class.delete("/management/keys/#{api_key}")
+ # Delete a key
+ # https://cryptomate.me/docs/management#delete-a-key
+ # @param [String] api_key (Id of the API-Key. Ex: master-ac8ff424-426f-46a7-94c3-13932c6e8adf)
+ def delete_key(api_key)
+ delete("/management/keys/#{api_key}")
+ end
end
end
end
end