Contents

# frozen_string_literal: true

require_relative 'resource'
require 'contentful/management/organization_user_methods_factory'

module Contentful
  module Management
    # Resource class for Organization.
    # @see _ https://www.contentful.com/developers/docs/references/content-management-api/#/reference/organizations
    class Organization
      include Contentful::Management::Resource
      include Contentful::Management::Resource::Refresher
      include Contentful::Management::Resource::SystemProperties

      property :name

      # @private
      def self.build_endpoint(_endpoint_options)
        'organizations'
      end

      # Allows listing all usage periods for organization grouped by organization or space.
      # @see _ README for details.
      #
      # @return [Contentful::Management::ClientOrganizationPeriodicUsageMethodsFactory]
      def periodic_usages
        ClientOrganizationPeriodicUsageMethodsFactory.new(client, id)
      end

      # Allows listing all usage periods for organization grouped by organization or space.
      # @see _ README for details.
      #
      # @return [Contentful::Management::ClientSpacePeriodicUsageMethodsFactory]
      def space_periodic_usages
        ClientSpacePeriodicUsageMethodsFactory.new(client, id)
      end

      # Allows viewing of users in context of an organization
      # Allows listing all users for an organization, and finding one by ID.
      # @see _ README for details.
      #
      # @return [Contentful::Management::OrganizationUserMethodsFactory]
      def users
        OrganizationUserMethodsFactory.new(client, id)
      end
    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
contentful-management-3.10.0	lib/contentful/management/organization.rb
contentful-management-3.9.0	lib/contentful/management/organization.rb