Class: Contentful::Management::ApiKey

Inherits:

Object

• Object
• Contentful::Management::ApiKey

Includes:

Resource, Resource::Refresher, Resource::SystemProperties

Defined in:

lib/contentful/management/api_key.rb

Overview

Resource class for ApiKey.

See Also:

• https://www.contentful.com/developers/docs/references/content-management-api/#/reference/api-keys

Instance Attribute Summary

Attributes included from Resource::SystemProperties

#sys

Attributes included from Resource

#client, #default_locale, #properties, #raw_object, #request

Class Method Summary

• .create(client, space_id, attributes = {}) ⇒ Contentful::Management::ApiKey

  Creates an API Key.

• .find(client, space_id, api_key_id) ⇒ Contentful::Management::ApiKey

  Finds an API Key by ID.

Methods included from Resource::Refresher

#reload

Methods included from Resource

#array?, #destroy, #environment_id, #fields, #nested_locale_fields?, #resource?, #sys, #update

Class Method Details

.create(client, space_id, attributes = {}) ⇒ Contentful::Management::ApiKey

Creates an API Key.

Parameters:

• client (Contentful::Management::Client)
• space_id (String)
• attributes (Hash) (defaults to: {})

Returns:

• (Contentful::Management::ApiKey)

See Also:

• README for full attribute list for each resource.

# File 'lib/contentful/management/api_key.rb', line 33

def self.create(client, space_id, attributes = {})
  super(client, space_id, nil, attributes)
end

.find(client, space_id, api_key_id) ⇒ Contentful::Management::ApiKey

Finds an API Key by ID.

Parameters:

• client (Contentful::Management::Client)
• space_id (String)
• api_key_id (String)

Returns:

• (Contentful::Management::ApiKey)

# File 'lib/contentful/management/api_key.rb', line 44

def self.find(client, space_id, api_key_id)
  super(client, space_id, nil, api_key_id)
end