Class: GroupDocs::Subscription

Inherits:
Api::Entity show all
Defined in:
lib/groupdocs/subscription.rb

Defined Under Namespace

Classes: Limit

Constant Summary collapse

LIMITS = 
{
  annotations_limit:      'AnnotationsLimit',
  apicalls:               'APICalls',
  apiemails:              'APIEmails',
  assembly_limit:         'AssemblyLimit',
  branded:                'Branded',
  comparison_limit:       'ComparisonLimit',
  conversion_limit:       'ConversionLimit',
  documents_limit:        'DocumentsLimit',
  document_history_limit: 'DocumentHistoryLimit',
  document_size_limit:    'DocumentSizeLimit',
  document_tokens_limit:  'DocumentTokensLimit',
  sharing_limit:          'SharingLimit',
  signature_limit:        'SignatureLimit',
  storage_space_limit:    'StorageSpaceLimit',
  users_limit:            'UsersLimit',
}

Instance Attribute Summary collapse

Class Method Summary collapse

Methods inherited from Api::Entity

#initialize, #inspect, #to_hash

Constructor Details

This class inherits a constructor from GroupDocs::Api::Entity

Instance Attribute Details

#CurrencyCode ⇒ Object Also known as: currency_code 



75
76
77
 
# File 'lib/groupdocs/subscription.rb', line 75

def CurrencyCode
  @CurrencyCode
end

#Id ⇒ Object Also known as: id 



67
68
69
 
# File 'lib/groupdocs/subscription.rb', line 67

def Id
  @Id
end

#Name ⇒ Object Also known as: name 



69
70
71
 
# File 'lib/groupdocs/subscription.rb', line 69

def Name
  @Name
end

#Price ⇒ Object Also known as: price 



73
74
75
 
# File 'lib/groupdocs/subscription.rb', line 73

def Price
  @Price
end

#PricingPlanId ⇒ Object Also known as: pricing_plan_id 



71
72
73
 
# File 'lib/groupdocs/subscription.rb', line 71

def PricingPlanId
  @PricingPlanId
end

Class Method Details

.current!(access = {}) ⇒ GroupDocs::Subscription

Returns current subscription plan.

Examples:

GroupDocs::Subscription.current!.name
#=> 'Free'

Parameters:

  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String)

Returns:



36
37
38
39
40
41
42
43
44
 
# File 'lib/groupdocs/subscription.rb', line 36

def self.current!(access = {})
  json = Api::Request.new do |request|
    request[:access] = access
    request[:method] = :GET
    request[:path] = '/system/{{client_id}}/plan'
  end.execute!

  new(json)
end

.list!(access = {}) ⇒ Array<GroupDocs::Subscription>

Returns all subscription plans for family.

Parameters:

  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String)

Returns:



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/groupdocs/subscription.rb', line 54

def self.list!(access = {})
  json = Api::Request.new do |request|
    request[:access] = access
    request[:method] = :GET
    request[:path] = '/system/{{client_id}}/plans/groupdocs'
  end.execute!

  json[:metrics].map do |plan|
    new(plan)
  end
end