Class: ChargeBee::Estimate
  
  
  
  
  
    - Inherits:
 
    - 
      Model
      
        
          - Object
 
          
            - Model
 
          
            - ChargeBee::Estimate
 
          
        
        show all
      
     
  
  
  
  
  
  
  
  
  
  
    - Defined in:
 
    - lib/chargebee/models/estimate.rb
 
  
  
 
  Instance Attribute Summary collapse
  
  
    
      Class Method Summary
      collapse
    
    
      
        - 
  
    
      .advance_invoice_estimate(id, params = {}, env = nil, headers = {})  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
  
 
      
        - 
  
    
      .cancel_subscription(id, params = {}, env = nil, headers = {})  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
  
 
      
        - 
  
    
      .cancel_subscription_for_items(id, params = {}, env = nil, headers = {})  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
  
 
      
        - 
  
    
      .change_term_end(id, params, env = nil, headers = {})  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
  
 
      
        - 
  
    
      .create_invoice(params = {}, env = nil, headers = {})  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
  
 
      
        - 
  
    
      .create_invoice_for_items(params, env = nil, headers = {})  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
  
 
      
        - 
  
    
      .create_sub_for_customer_estimate(id, params, env = nil, headers = {})  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
  
 
      
        - 
  
    
      .create_sub_item_estimate(params, env = nil, headers = {})  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
  
 
      
        - 
  
    
      .create_sub_item_for_customer_estimate(id, params, env = nil, headers = {})  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
  
 
      
        - 
  
    
      .create_subscription(params, env = nil, headers = {})  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
  
 
      
        - 
  
    
      .gift_subscription(params, env = nil, headers = {})  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
  
 
      
        - 
  
    
      .gift_subscription_for_items(params, env = nil, headers = {})  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
  
 
      
        - 
  
    
      .pause_subscription(id, params = {}, env = nil, headers = {})  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
  
 
      
        - 
  
    
      .regenerate_invoice_estimate(id, params = {}, env = nil, headers = {})  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
  
 
      
        - 
  
    
      .renewal_estimate(id, params = {}, env = nil, headers = {})  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
  
 
      
        - 
  
    
      .resume_subscription(id, params = {}, env = nil, headers = {})  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
  
 
      
        - 
  
    
      .upcoming_invoices_estimate(id, env = nil, headers = {})  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
  
 
      
        - 
  
    
      .update_subscription(params, env = nil, headers = {})  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
  
 
      
        - 
  
    
      .update_subscription_for_items(params, env = nil, headers = {})  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
  
 
      
    
  
  
  
  
  
  
  
  
  
  Methods inherited from Model
  construct, #init_dependant, #init_dependant_list, #initialize, #inspect, #load, #method_missing, #replace_white_space_with_underscore, #to_s, uri_path
  Dynamic Method Handling
  
    This class handles dynamic methods through the method_missing method
    
      in the class ChargeBee::Model
    
  
  
 
  
    Instance Attribute Details
    
      
      
      
  
  
    #created_at  ⇒ Object 
  
  
  
  
    
Returns the value of attribute created_at.
   
 
  
  
    
      
4
5
6 
     | 
    
      # File 'lib/chargebee/models/estimate.rb', line 4
def created_at
  @created_at
end 
     | 
  
 
    
      
      
      
  
  
    #credit_note_estimates  ⇒ Object 
  
  
  
  
    
Returns the value of attribute credit_note_estimates.
   
 
  
  
    
      
4
5
6 
     | 
    
      # File 'lib/chargebee/models/estimate.rb', line 4
def credit_note_estimates
  @credit_note_estimates
end 
     | 
  
 
    
      
      
      
  
  
    #invoice_estimate  ⇒ Object 
  
  
  
  
    
Returns the value of attribute invoice_estimate.
   
 
  
  
    
      
4
5
6 
     | 
    
      # File 'lib/chargebee/models/estimate.rb', line 4
def invoice_estimate
  @invoice_estimate
end 
     | 
  
 
    
      
      
      
  
  
    #invoice_estimates  ⇒ Object 
  
  
  
  
    
Returns the value of attribute invoice_estimates.
   
 
  
  
    
      
4
5
6 
     | 
    
      # File 'lib/chargebee/models/estimate.rb', line 4
def invoice_estimates
  @invoice_estimates
end 
     | 
  
 
    
      
      
      
  
  
    #next_invoice_estimate  ⇒ Object 
  
  
  
  
    
Returns the value of attribute next_invoice_estimate.
   
 
  
  
    
      
4
5
6 
     | 
    
      # File 'lib/chargebee/models/estimate.rb', line 4
def next_invoice_estimate
  @next_invoice_estimate
end 
     | 
  
 
    
      
      
      
  
  
    #subscription_estimate  ⇒ Object 
  
  
  
  
    
Returns the value of attribute subscription_estimate.
   
 
  
  
    
      
4
5
6 
     | 
    
      # File 'lib/chargebee/models/estimate.rb', line 4
def subscription_estimate
  @subscription_estimate
end 
     | 
  
 
    
      
      
      
  
  
    #subscription_estimates  ⇒ Object 
  
  
  
  
    
Returns the value of attribute subscription_estimates.
   
 
  
  
    
      
4
5
6 
     | 
    
      # File 'lib/chargebee/models/estimate.rb', line 4
def subscription_estimates
  @subscription_estimates
end 
     | 
  
 
    
      
      
      
  
  
    #unbilled_charge_estimates  ⇒ Object 
  
  
  
  
    
Returns the value of attribute unbilled_charge_estimates.
   
 
  
  
    
      
4
5
6 
     | 
    
      # File 'lib/chargebee/models/estimate.rb', line 4
def unbilled_charge_estimates
  @unbilled_charge_estimates
end 
     | 
  
 
    
   
  
    Class Method Details
    
      
  
  
    .advance_invoice_estimate(id, params = {}, env = nil, headers = {})  ⇒ Object 
  
  
  
  
    
      
38
39
40 
     | 
    
      # File 'lib/chargebee/models/estimate.rb', line 38
def self.advance_invoice_estimate(id, params={}, env=nil, ={})
  Request.send('post', uri_path("subscriptions",id.to_s,"advance_invoice_estimate"), params, env, )
end
     | 
  
 
    
      
  
  
    .cancel_subscription(id, params = {}, env = nil, headers = {})  ⇒ Object 
  
  
  
  
    
      
54
55
56 
     | 
    
      # File 'lib/chargebee/models/estimate.rb', line 54
def self.cancel_subscription(id, params={}, env=nil, ={})
  Request.send('post', uri_path("subscriptions",id.to_s,"cancel_subscription_estimate"), params, env, )
end
     | 
  
 
    
      
  
  
    .cancel_subscription_for_items(id, params = {}, env = nil, headers = {})  ⇒ Object 
  
  
  
  
    
      
58
59
60 
     | 
    
      # File 'lib/chargebee/models/estimate.rb', line 58
def self.cancel_subscription_for_items(id, params={}, env=nil, ={})
  Request.send('post', uri_path("subscriptions",id.to_s,"cancel_subscription_for_items_estimate"), params, env, )
end
     | 
  
 
    
      
  
  
    .change_term_end(id, params, env = nil, headers = {})  ⇒ Object 
  
  
  
  
    
      
50
51
52 
     | 
    
      # File 'lib/chargebee/models/estimate.rb', line 50
def self.change_term_end(id, params, env=nil, ={})
  Request.send('post', uri_path("subscriptions",id.to_s,"change_term_end_estimate"), params, env, )
end
     | 
  
 
    
      
  
  
    .create_invoice(params = {}, env = nil, headers = {})  ⇒ Object 
  
  
  
  
    
      
78
79
80 
     | 
    
      # File 'lib/chargebee/models/estimate.rb', line 78
def self.create_invoice(params={}, env=nil, ={})
  Request.send('post', uri_path("estimates","create_invoice"), params, env, )
end
     | 
  
 
    
      
  
  
    .create_invoice_for_items(params, env = nil, headers = {})  ⇒ Object 
  
  
  
  
    
      
82
83
84 
     | 
    
      # File 'lib/chargebee/models/estimate.rb', line 82
def self.create_invoice_for_items(params, env=nil, ={})
  Request.send('post', uri_path("estimates","create_invoice_for_items"), params, env, )
end
     | 
  
 
    
      
  
  
    .create_sub_for_customer_estimate(id, params, env = nil, headers = {})  ⇒ Object 
  
  
  
  
    
      
18
19
20 
     | 
    
      # File 'lib/chargebee/models/estimate.rb', line 18
def self.create_sub_for_customer_estimate(id, params, env=nil, ={})
  Request.send('get', uri_path("customers",id.to_s,"create_subscription_estimate"), params, env, )
end
     | 
  
 
    
      
  
  
    .create_sub_item_estimate(params, env = nil, headers = {})  ⇒ Object 
  
  
  
  
    
      
14
15
16 
     | 
    
      # File 'lib/chargebee/models/estimate.rb', line 14
def self.create_sub_item_estimate(params, env=nil, ={})
  Request.send('post', uri_path("estimates","create_subscription_for_items"), params, env, )
end
     | 
  
 
    
      
  
  
    .create_sub_item_for_customer_estimate(id, params, env = nil, headers = {})  ⇒ Object 
  
  
  
  
    
      
22
23
24 
     | 
    
      # File 'lib/chargebee/models/estimate.rb', line 22
def self.create_sub_item_for_customer_estimate(id, params, env=nil, ={})
  Request.send('post', uri_path("customers",id.to_s,"create_subscription_for_items_estimate"), params, env, )
end
     | 
  
 
    
      
  
  
    .create_subscription(params, env = nil, headers = {})  ⇒ Object 
  
  
  
  
  
    
      
10
11
12 
     | 
    
      # File 'lib/chargebee/models/estimate.rb', line 10
def self.create_subscription(params, env=nil, ={})
  Request.send('post', uri_path("estimates","create_subscription"), params, env, )
end
     | 
  
 
    
      
  
  
    .gift_subscription(params, env = nil, headers = {})  ⇒ Object 
  
  
  
  
    
      
70
71
72 
     | 
    
      # File 'lib/chargebee/models/estimate.rb', line 70
def self.gift_subscription(params, env=nil, ={})
  Request.send('post', uri_path("estimates","gift_subscription"), params, env, )
end
     | 
  
 
    
      
  
  
    .gift_subscription_for_items(params, env = nil, headers = {})  ⇒ Object 
  
  
  
  
    
      
74
75
76 
     | 
    
      # File 'lib/chargebee/models/estimate.rb', line 74
def self.gift_subscription_for_items(params, env=nil, ={})
  Request.send('post', uri_path("estimates","gift_subscription_for_items"), params, env, )
end
     | 
  
 
    
      
  
  
    .pause_subscription(id, params = {}, env = nil, headers = {})  ⇒ Object 
  
  
  
  
    
      
62
63
64 
     | 
    
      # File 'lib/chargebee/models/estimate.rb', line 62
def self.pause_subscription(id, params={}, env=nil, ={})
  Request.send('post', uri_path("subscriptions",id.to_s,"pause_subscription_estimate"), params, env, )
end
     | 
  
 
    
      
  
  
    .regenerate_invoice_estimate(id, params = {}, env = nil, headers = {})  ⇒ Object 
  
  
  
  
    
      
42
43
44 
     | 
    
      # File 'lib/chargebee/models/estimate.rb', line 42
def self.regenerate_invoice_estimate(id, params={}, env=nil, ={})
  Request.send('post', uri_path("subscriptions",id.to_s,"regenerate_invoice_estimate"), params, env, )
end
     | 
  
 
    
      
  
  
    .renewal_estimate(id, params = {}, env = nil, headers = {})  ⇒ Object 
  
  
  
  
    
      
34
35
36 
     | 
    
      # File 'lib/chargebee/models/estimate.rb', line 34
def self.renewal_estimate(id, params={}, env=nil, ={})
  Request.send('get', uri_path("subscriptions",id.to_s,"renewal_estimate"), params, env, )
end
     | 
  
 
    
      
  
  
    .resume_subscription(id, params = {}, env = nil, headers = {})  ⇒ Object 
  
  
  
  
    
      
66
67
68 
     | 
    
      # File 'lib/chargebee/models/estimate.rb', line 66
def self.resume_subscription(id, params={}, env=nil, ={})
  Request.send('post', uri_path("subscriptions",id.to_s,"resume_subscription_estimate"), params, env, )
end
     | 
  
 
    
      
  
  
    .upcoming_invoices_estimate(id, env = nil, headers = {})  ⇒ Object 
  
  
  
  
    
      
46
47
48 
     | 
    
      # File 'lib/chargebee/models/estimate.rb', line 46
def self.upcoming_invoices_estimate(id, env=nil, ={})
  Request.send('get', uri_path("customers",id.to_s,"upcoming_invoices_estimate"), {}, env, )
end
     | 
  
 
    
      
  
  
    .update_subscription(params, env = nil, headers = {})  ⇒ Object 
  
  
  
  
    
      
26
27
28 
     | 
    
      # File 'lib/chargebee/models/estimate.rb', line 26
def self.update_subscription(params, env=nil, ={})
  Request.send('post', uri_path("estimates","update_subscription"), params, env, )
end
     | 
  
 
    
      
  
  
    .update_subscription_for_items(params, env = nil, headers = {})  ⇒ Object 
  
  
  
  
    
      
30
31
32 
     | 
    
      # File 'lib/chargebee/models/estimate.rb', line 30
def self.update_subscription_for_items(params, env=nil, ={})
  Request.send('post', uri_path("estimates","update_subscription_for_items"), params, env, )
end
     |