Class: ZuoraRestClient::Client

Inherits:

Object

Object
ZuoraRestClient::Client

Defined in:: lib/zuora_rest_client/client.rb

Constant Summary collapse

DEFAULT_CLIENT_OPTIONS =

{
logger: Logger.new($stdout),
log_level: :error,
log: true }

DEFAULT_AQUA_QUERY_OPTIONS =

{
wait_for_completed_result: true,
max_wait: 3600,
poll_delay: 2 }

DEFAULT_EXPORT_OPTIONS =

{
format: :csv,
zip: false,
name: nil,
encrypted: false,
max_wait: 3600,
poll_delay: 2 }

Instance Method Summary collapse

Constructor Details

#initialize(username, password, environment = :production, options = {}) ⇒ `Client`

Returns a new instance of Client.

# File 'lib/zuora_rest_client/client.rb', line 33

def initialize(username, password, environment = :production, options = {})
  @client_options = {}.merge(DEFAULT_CLIENT_OPTIONS).merge(options)
  @connection = ZuoraRestClient::Connection.new(username, password, environment, options)
end

Instance Method Details

#accept_entity_connection(entity_connection_id, zuora_version = nil) ⇒ `Object`



730
731
732

# File 'lib/zuora_rest_client/client.rb', line 730

def accept_entity_connection(entity_connection_id, zuora_version = nil)
  @connection.rest_put("/entity-connections/#{entity_connection_id}/accept", nil, zuora_version)
end

#accept_user_access(username, zuora_version = nil) ⇒ `Object`



1996
1997
1998

# File 'lib/zuora_rest_client/client.rb', line 1996

def accept_user_access(username, zuora_version = nil)
  @connection.rest_put("/users/#{username}/accept-access", nil, zuora_version)
end

#activate_accounting_code(accounting_code_id, zuora_version = nil) ⇒ `Object`



96
97
98

# File 'lib/zuora_rest_client/client.rb', line 96

def activate_accounting_code(accounting_code_id, zuora_version = nil)
  @connection.rest_put("/accounting-codes/#{accounting_code_id}/activate", nil, zuora_version)
end

#add_attachment(source_filename_or_io, source_content_type, associated_object_type, associated_object_key, description = nil, zuora_version = nil) ⇒ `Object`

Attachments                                                               #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 276

def add_attachment(source_filename_or_io, source_content_type, associated_object_type, associated_object_key, description = nil, zuora_version = nil)
  payload = { file: Faraday::UploadIO(source_filename_or_io, source_content_type) }
  uri = Addressable::URI.parse('/attachments')
  query_values = { associatedObjectType: associated_object_type.to_s, associatedObjectKey: associated_object_key.to_s }
  query_values[:description] = description if !description.nil?
  uri.query_values = query_values
  @connection.rest_post(uri.to_s, payload, zuora_version, false)
end

#amend(request, zuora_version = nil) ⇒ `Object`

Actions                                                                   #
                                                                          #



44
45
46

# File 'lib/zuora_rest_client/client.rb', line 44

def amend(request, zuora_version = nil)
  @connection.rest_post('/action/amend', request, zuora_version)
end

#apply_credit_memo(credit_memo_id, request, zuora_version = nil) ⇒ `Object`



473
474
475

# File 'lib/zuora_rest_client/client.rb', line 473

def apply_credit_memo(credit_memo_id, request, zuora_version = nil)
  @connection.rest_post("/creditmemos/#{credit_memo_id}/apply", request, zuora_version)
end

#apply_payment(payment_id, request, zuora_version = nil) ⇒ `Object`



1251
1252
1253

# File 'lib/zuora_rest_client/client.rb', line 1251

def apply_payment(payment_id, request, zuora_version = nil)
  @connection.rest_post("/payments/#{payment_id}/apply", request, zuora_version)
end

#aqua_query(request, options = {}) ⇒ `Object`

AQuA                                                                      #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 238

def aqua_query(request, options = {})
  aqua_query_options = {}.merge(DEFAULT_AQUA_QUERY_OPTIONS).merge(options)
  result = @connection.app_post('/apps/api/batch-query/', request)
  logger.debug "********* AQUA POST QUERY RESULT: #{result.inspect}"

  raise "Error: #{result.message}" if result.status.downcase == 'error'

  if aqua_query_options[:wait_for_completed_result]
    poll_started = false
    FirePoll.poll(nil, aqua_query_options[:max_wait]) do
      sleep aqua_query_options[:poll_delay] if poll_started
      poll_started = true
      result = get_aqua_job_result(result.id)
      logger.debug "********* CURRENT AQUA JOB STATUS: #{result.inspect}"
      raise "Error: #{result.message}" if result.status.downcase == 'error'
      result.status.downcase != 'submitted' && result.status.downcase.end_with?('ed')
    end

    logger.debug "********* FINAL AQUA JOB STATUS: #{result.inspect}"
  end

  result
end

#cancel_credit_memo(credit_memo_id, zuora_version = nil) ⇒ `Object`



515
516
517

# File 'lib/zuora_rest_client/client.rb', line 515

def cancel_credit_memo(credit_memo_id, zuora_version = nil)
  @connection.rest_post("/creditmemos/#{credit_memo_id}/cancel", nil, zuora_version)
end

#cancel_debit_memo(debit_memo_id, zuora_version = nil) ⇒ `Object`



579
580
581

# File 'lib/zuora_rest_client/client.rb', line 579

def cancel_debit_memo(debit_memo_id, zuora_version = nil)
  @connection.rest_post("/debitmemos/#{debit_memo_id}/cancel", nil, zuora_version)
end

#cancel_journal_run(journal_run_number, zuora_version = nil) ⇒ `Object`



1060
1061
1062

# File 'lib/zuora_rest_client/client.rb', line 1060

def cancel_journal_run(journal_run_number, zuora_version = nil)
  @connection.rest_put("/journal-runs/#{journal_run_number}/cancel", nil, zuora_version)
end

#cancel_payment(payment_id, zuora_version = nil) ⇒ `Object`



1281
1282
1283

# File 'lib/zuora_rest_client/client.rb', line 1281

def cancel_payment(payment_id, zuora_version = nil)
  @connection.rest_post("/payments/#{payment_id}/cancel", nil, zuora_version)
end

#cancel_refund(refund_id, zuora_version = nil) ⇒ `Object`



1549
1550
1551

# File 'lib/zuora_rest_client/client.rb', line 1549

def cancel_refund(refund_id, zuora_version = nil)
  @connection.rest_post("/refunds/#{refund_id}/cancel", zuora_version)
end

#cancel_subscription(subscription_key, request, zuora_version = nil) ⇒ `Object`



1807
1808
1809

# File 'lib/zuora_rest_client/client.rb', line 1807

def cancel_subscription(subscription_key, request, zuora_version = nil)
  @connection.rest_put("/subscriptions/#{subscription_key}/cancel", request, zuora_version)
end

#cancel_summary_journal_entry(journal_entry_number, zuora_version = nil) ⇒ `Object`



1857
1858
1859

# File 'lib/zuora_rest_client/client.rb', line 1857

def cancel_summary_journal_entry(journal_entry_number, zuora_version = nil)
  @connection.rest_put("/journal-entries/#{journal_entry_number}/cancel", nil, zuora_version)
end

#close_accounting_period(accounting_period_id, zuora_version = nil) ⇒ `Object`

Accounting Periods                                                        #
                                                                          #



122
123
124

# File 'lib/zuora_rest_client/client.rb', line 122

def close_accounting_period(accounting_period_id, zuora_version = nil)
  @connection.rest_put("/accounting-periods/#{accounting_period_id}/close", nil, zuora_version)
end

#create(request, zuora_version = nil) ⇒ `Object`



48
49
50

# File 'lib/zuora_rest_client/client.rb', line 48

def create(request, zuora_version = nil)
  @connection.rest_post('/action/create', request, zuora_version)
end

#create_account(request, zuora_version = nil) ⇒ `Object`

Accounts                                                                  #
                                                                          #



166
167
168

# File 'lib/zuora_rest_client/client.rb', line 166

def create_account(request, zuora_version = nil)
  @connection.rest_post('/accounts', request, zuora_version)
end

#create_account_object(request, zuora_version = nil) ⇒ `Object`



182
183
184

# File 'lib/zuora_rest_client/client.rb', line 182

def create_account_object(request, zuora_version = nil)
  @connection.rest_post('/object/account', request, zuora_version)
end

#create_accounting_code(request, zuora_version = nil) ⇒ `Object`

Accounting Codes                                                          #
                                                                          #



86
87
88

# File 'lib/zuora_rest_client/client.rb', line 86

def create_accounting_code(request, zuora_version = nil)
  @connection.rest_post('/accounting-codes', request, zuora_version)
end

#create_accounting_period(request, zuora_version = nil) ⇒ `Object`



130
131
132

# File 'lib/zuora_rest_client/client.rb', line 130

def create_accounting_period(request, zuora_version = nil)
  @connection.rest_post('/accounting-periods', request, zuora_version)
end

#create_amendment_object(request, zuora_version = nil) ⇒ `Object`



214
215
216

# File 'lib/zuora_rest_client/client.rb', line 214

def create_amendment_object(request, zuora_version = nil)
  @connection.rest_post('/object/amendment', request, zuora_version)
end

#create_bill_run_object(request, zuora_version = nil) ⇒ `Object`

Bill Run                                                                  #
                                                                          #



309
310
311

# File 'lib/zuora_rest_client/client.rb', line 309

def create_bill_run_object(request, zuora_version = nil)
  @connection.rest_post('/object/bill-run', request, zuora_version)
end

#create_billing_preview(request, zuora_version = nil) ⇒ `Object`



1121
1122
1123

# File 'lib/zuora_rest_client/client.rb', line 1121

def create_billing_preview(request, zuora_version = nil)
  @connection.rest_post('/operations/billing-preview', request, zuora_version)
end

#create_billing_preview_run(request, zuora_version = nil) ⇒ `Object`

Billing Preview Run                                                       #
                                                                          #



333
334
335

# File 'lib/zuora_rest_client/client.rb', line 333

def create_billing_preview_run(request, zuora_version = nil)
  @connection.rest_post('/billing-preview-runs', request, zuora_version)
end

#create_contact_object(request, zuora_version = nil) ⇒ `Object`

Contacts                                                                  #
                                                                          #



397
398
399

# File 'lib/zuora_rest_client/client.rb', line 397

def create_contact_object(request, zuora_version = nil)
  @connection.rest_post('/object/contact', request, zuora_version)
end

#create_credit_memo_from_charge(request, zuora_version = nil) ⇒ `Object`



501
502
503

# File 'lib/zuora_rest_client/client.rb', line 501

def create_credit_memo_from_charge(request, zuora_version = nil)
  @connection.rest_post('/creditmemos', request, zuora_version)
end

#create_credit_memo_from_invoice(invoice_id, request, zuora_version = nil) ⇒ `Object`



493
494
495

# File 'lib/zuora_rest_client/client.rb', line 493

def create_credit_memo_from_invoice(invoice_id, request, zuora_version = nil)
  @connection.rest_post("/creditmemos/invoice/#{invoice_id}", request, zuora_version)
end

#create_credit_memo_pdf(credit_memo_id, zuora_version = nil) ⇒ `Object`



519
520
521

# File 'lib/zuora_rest_client/client.rb', line 519

def create_credit_memo_pdf(credit_memo_id, zuora_version = nil)
  @connection.rest_post("/creditmemos/#{credit_memo_id}/pdfs", nil, zuora_version)
end

#create_debit_memo_from_charge(request, zuora_version = nil) ⇒ `Object`



559
560
561

# File 'lib/zuora_rest_client/client.rb', line 559

def create_debit_memo_from_charge(request, zuora_version = nil)
  @connection.rest_post("/debitmemos", request, zuora_version)
end

#create_debit_memo_from_invoice(invoice_id, request, zuora_version = nil) ⇒ `Object`



555
556
557

# File 'lib/zuora_rest_client/client.rb', line 555

def create_debit_memo_from_invoice(invoice_id, request, zuora_version = nil)
  @connection.rest_post("/debitmemos/invoice/#{invoice_id}", request, zuora_version)
end

#create_debit_memo_pdf(debit_memo_id, zuora_version = nil) ⇒ `Object`



569
570
571

# File 'lib/zuora_rest_client/client.rb', line 569

def create_debit_memo_pdf(debit_memo_id, zuora_version = nil)
  @connection.rest_post("/debitmemos/#{debit_memo_id}/pdfs", nil, zuora_version)
end

#create_entity(request, zuora_version = nil) ⇒ `Object`

Entities                                                                  #
                                                                          #



688
689
690

# File 'lib/zuora_rest_client/client.rb', line 688

def create_entity(request, zuora_version = nil)
  @connection.rest_post('/entities', request, zuora_version)
end

#create_export_object(request, zuora_version = nil) ⇒ `Object`

Exports                                                                   #
                                                                          #



748
749
750

# File 'lib/zuora_rest_client/client.rb', line 748

def create_export_object(request, zuora_version = nil)
  @connection.rest_post('/object/export', request, zuora_version)
end

#create_invoice_adjustment_object(request, zuora_version = nil) ⇒ `Object`

Invoice Adjustments                                                       #
                                                                          #



886
887
888

# File 'lib/zuora_rest_client/client.rb', line 886

def create_invoice_adjustment_object(request, zuora_version = nil)
  @connection.rest_post('/object/invoice-adjustment', request, zuora_version)
end

#create_invoice_object(request, zuora_version = nil) ⇒ `Object`



1002
1003
1004

# File 'lib/zuora_rest_client/client.rb', line 1002

def create_invoice_object(request, zuora_version = nil)
  @connection.rest_post('/object/invoice', request, zuora_version)
end

#create_invoice_payment_object(request, zuora_version = nil) ⇒ `Object`

Invoice Payments                                                          #
                                                                          #



942
943
944

# File 'lib/zuora_rest_client/client.rb', line 942

def create_invoice_payment_object(request, zuora_version = nil)
  @connection.rest_post('/object/invoice-payment', request, zuora_version)
end

#create_journal_run(request, zuora_version = nil) ⇒ `Object`

Journal Runs                                                              #
                                                                          #



1048
1049
1050

# File 'lib/zuora_rest_client/client.rb', line 1048

def create_journal_run(request, zuora_version = nil)
  @connection.rest_post('/journal-runs', request, zuora_version)
end

#create_payment(request, zuora_version = nil) ⇒ `Object`



1259
1260
1261

# File 'lib/zuora_rest_client/client.rb', line 1259

def create_payment(request, zuora_version = nil)
  @connection.rest_post('/payments', request, zuora_version)
end

#create_payment_method(request, zuora_version = nil) ⇒ `Object`

Payment Method                                                            #
                                                                          #



1173
1174
1175

# File 'lib/zuora_rest_client/client.rb', line 1173

def create_payment_method(request, zuora_version = nil)
  @connection.rest_post('/payment-methods/credit-cards', request, zuora_version)
end

#create_payment_method_decryption(request, zuora_version = nil) ⇒ `Object`



1191
1192
1193

# File 'lib/zuora_rest_client/client.rb', line 1191

def create_payment_method_decryption(request, zuora_version = nil)
  @connection.rest_post('/payment-methods/decryption', request, zuora_version)
end

#create_payment_method_object(request, zuora_version = nil) ⇒ `Object`



1195
1196
1197

# File 'lib/zuora_rest_client/client.rb', line 1195

def create_payment_method_object(request, zuora_version = nil)
  @connection.rest_post('/object/payment-method', request, zuora_version)
end

#create_payment_object(request, zuora_version = nil) ⇒ `Object`



1297
1298
1299

# File 'lib/zuora_rest_client/client.rb', line 1297

def create_payment_object(request, zuora_version = nil)
  @connection.rest_post('/object/payment', request, zuora_version)
end

#create_product_object(request, zuora_version = nil) ⇒ `Object`

Products                                                                  #
                                                                          #



1399
1400
1401

# File 'lib/zuora_rest_client/client.rb', line 1399

def create_product_object(request, zuora_version = nil)
  @connection.rest_post('/object/product', request, zuora_version)
end

#create_product_rate_plan_object(request, zuora_version = nil) ⇒ `Object`



1375
1376
1377

# File 'lib/zuora_rest_client/client.rb', line 1375

def create_product_rate_plan_object(request, zuora_version = nil)
  @connection.rest_post('/object/product-rate-plan', request, zuora_version)
end

#create_refund_object(request, zuora_version = nil) ⇒ `Object`



1553
1554
1555

# File 'lib/zuora_rest_client/client.rb', line 1553

def create_refund_object(request, zuora_version = nil)
  @connection.rest_post('/object/refund', request, zuora_version)
end

#create_revenue_schedule_for_credit_memo_item_distribute_by_date_range(credit_memo_item_id, request, zuora_version = nil) ⇒ `Object`



1697
1698
1699

# File 'lib/zuora_rest_client/client.rb', line 1697

def create_revenue_schedule_for_credit_memo_item_distribute_by_date_range(credit_memo_item_id, request, zuora_version = nil)
  @connection.rest_post("/revenue-schedules/credit-memo-items/#{credit_memo_item_id}/distribute-revenue-with-date-range", request, zuora_version)
end

#create_revenue_schedule_for_credit_memo_item_distribute_manually(credit_memo_item_id, request, zuora_version = nil) ⇒ `Object`



1705
1706
1707

# File 'lib/zuora_rest_client/client.rb', line 1705

def create_revenue_schedule_for_credit_memo_item_distribute_manually(credit_memo_item_id, request, zuora_version = nil)
  @connection.rest_post("/revenue-schedules/credit-memo-items/#{credit_memo_item_id}", request, zuora_version)
end

#create_revenue_schedule_for_debit_memo_item_distribute_by_date_range(debit_memo_item_id, request, zuora_version = nil) ⇒ `Object`



1701
1702
1703

# File 'lib/zuora_rest_client/client.rb', line 1701

def create_revenue_schedule_for_debit_memo_item_distribute_by_date_range(debit_memo_item_id, request, zuora_version = nil)
  @connection.rest_post("/revenue-schedules/debit-memo-items/#{debit_memo_item_id}/distribute-revenue-with-date-range", request, zuora_version)
end

#create_revenue_schedule_for_debit_memo_item_distribute_manually(debit_memo_item_id, request, zuora_version = nil) ⇒ `Object`



1713
1714
1715

# File 'lib/zuora_rest_client/client.rb', line 1713

def create_revenue_schedule_for_debit_memo_item_distribute_manually(debit_memo_item_id, request, zuora_version = nil)
  @connection.rest_post("/revenue-schedules/debit-memo-items/#{debit_memo_item_id}", request, zuora_version)
end

#create_revenue_schedule_for_invoice_item_adjustment_distribute_by_date_range(invoice_item_adjustment_id, request, zuora_version = nil) ⇒ `Object`



1651
1652
1653

# File 'lib/zuora_rest_client/client.rb', line 1651

def create_revenue_schedule_for_invoice_item_adjustment_distribute_by_date_range(invoice_item_adjustment_id, request, zuora_version = nil)
  @connection.rest_post("/revenue-schedules/invoice-item-adjustments/#{invoice_item_adjustment_id}/distribute-revenue-with-date-range", request, zuora_version)
end

#create_revenue_schedule_for_invoice_item_adjustment_distribute_manually(invoice_item_adjustment_id, request, zuora_version = nil) ⇒ `Object`



1655
1656
1657

# File 'lib/zuora_rest_client/client.rb', line 1655

def create_revenue_schedule_for_invoice_item_adjustment_distribute_manually(invoice_item_adjustment_id, request, zuora_version = nil)
  @connection.rest_post("/revenue-schedules/invoice-items/#{invoice_item_adjustment_id}", request, zuora_version)
end

#create_revenue_schedule_for_invoice_item_distribute_by_date_range(invoice_item_id, request, zuora_version = nil) ⇒ `Object`

Revenue Schedules                                                         #
                                                                          #



1639
1640
1641

# File 'lib/zuora_rest_client/client.rb', line 1639

def create_revenue_schedule_for_invoice_item_distribute_by_date_range(invoice_item_id, request, zuora_version = nil)
  @connection.rest_post("/revenue-schedules/invoice-items/#{invoice_item_id}/distribute-revenue-with-date-range", request, zuora_version)
end

#create_revenue_schedule_for_invoice_item_distribute_manually(invoice_item_id, request, zuora_version = nil) ⇒ `Object`



1643
1644
1645

# File 'lib/zuora_rest_client/client.rb', line 1643

def create_revenue_schedule_for_invoice_item_distribute_manually(invoice_item_id, request, zuora_version = nil)
  @connection.rest_post("/revenue-schedules/invoice-items/#{invoice_item_id}", request, zuora_version)
end

#create_revenue_schedule_on_subscription_charge(charge_id, request, zuora_version = nil) ⇒ `Object`



1659
1660
1661

# File 'lib/zuora_rest_client/client.rb', line 1659

def create_revenue_schedule_on_subscription_charge(charge_id, request, zuora_version = nil)
  @connection.rest_post("/revenue-schedules/subscription-charges/#{charge_id}", request, zuora_version)
end

#create_subscription(request, zuora_version = nil) ⇒ `Object`



1777
1778
1779

# File 'lib/zuora_rest_client/client.rb', line 1777

def create_subscription(request, zuora_version = nil)
  @connection.rest_post('/subscriptions', request, zuora_version)
end

#create_summary_journal_entry(request, zuora_version = nil) ⇒ `Object`

Summary Journal Entries                                                   #
                                                                          #



1839
1840
1841

# File 'lib/zuora_rest_client/client.rb', line 1839

def create_summary_journal_entry(request, zuora_version = nil)
  @connection.rest_post('/journal-entries', request, zuora_version)
end

#create_taxation_item_for_credit_memo(memo_id, request, zuora_version = nil) ⇒ `Object`



1883
1884
1885

# File 'lib/zuora_rest_client/client.rb', line 1883

def create_taxation_item_for_credit_memo(memo_id, request, zuora_version = nil)
  @connection.rest_post("/taxationitems/creditmemo/#{memo_id}", request, zuora_version)
end

#create_taxation_item_for_debit_memo(memo_id, request, zuora_version = nil) ⇒ `Object`



1887
1888
1889

# File 'lib/zuora_rest_client/client.rb', line 1887

def create_taxation_item_for_debit_memo(memo_id, request, zuora_version = nil)
  @connection.rest_post("/taxationitems/debitmemo/#{memo_id}", request, zuora_version)
end

#create_taxation_item_object(request, zuora_version = nil) ⇒ `Object`



1891
1892
1893

# File 'lib/zuora_rest_client/client.rb', line 1891

def create_taxation_item_object(request, zuora_version = nil)
  @connection.rest_post('/object/taxation-item', request, zuora_version)
end

#create_unit_of_measure_object(request, zuora_version = nil) ⇒ `Object`

Unit of Measure                                                           #
                                                                          #



1933
1934
1935

# File 'lib/zuora_rest_client/client.rb', line 1933

def create_unit_of_measure_object(request, zuora_version = nil)
  @connection.rest_post('/object/unit-of-measure', request, zuora_version)
end

#create_usage_object(request, zuora_version = nil) ⇒ `Object`



1968
1969
1970

# File 'lib/zuora_rest_client/client.rb', line 1968

def create_usage_object(request, zuora_version = nil)
  @connection.rest_post('/object/usage', request, zuora_version)
end

#deactivate_accounting_code(accounting_code_id, zuora_version = nil) ⇒ `Object`



100
101
102

# File 'lib/zuora_rest_client/client.rb', line 100

def deactivate_accounting_code(accounting_code_id, zuora_version = nil)
  @connection.rest_put("/accounting-codes/#{accounting_code_id}/deactivate", nil, zuora_version)
end

#decrypt_rsa_signature(request, zuora_version = nil) ⇒ `Object`



1737
1738
1739

# File 'lib/zuora_rest_client/client.rb', line 1737

def decrypt_rsa_signature(request, zuora_version = nil)
  @connection.rest_post('/rsa-signatures/decrypt', request, zuora_version)
end

#delete(request, zuora_version = nil) ⇒ `Object`



52
53
54

# File 'lib/zuora_rest_client/client.rb', line 52

def delete(request, zuora_version = nil)
  @connection.rest_post('/action/delete', request, zuora_version)
end

#delete_account_object(account_id, zuora_version = nil) ⇒ `Object`



196
197
198

# File 'lib/zuora_rest_client/client.rb', line 196

def delete_account_object(account_id, zuora_version = nil)
  @connection.rest_delete("/object/account/#{account_id}", zuora_version)
end

#delete_accounting_code(accounting_code_id, zuora_version = nil) ⇒ `Object`



104
105
106

# File 'lib/zuora_rest_client/client.rb', line 104

def delete_accounting_code(accounting_code_id, zuora_version = nil)
  @connection.rest_delete("/accounting-codes/#{accounting_code_id}", zuora_version)
end

#delete_accounting_period(accounting_period_id, zuora_version = nil) ⇒ `Object`



148
149
150

# File 'lib/zuora_rest_client/client.rb', line 148

def delete_accounting_period(accounting_period_id, zuora_version = nil)
  @connection.rest_delete("/accounting-periods/#{accounting_period_id}", zuora_version)
end

#delete_amendment_object(amendment_id, zuora_version = nil) ⇒ `Object`



228
229
230

# File 'lib/zuora_rest_client/client.rb', line 228

def delete_amendment_object(amendment_id, zuora_version = nil)
  @connection.rest_delete("/object/amendment/#{amendment_id}", zuora_version)
end

#delete_attachment(attachment_id, zuora_version = nil) ⇒ `Object`



299
300
301

# File 'lib/zuora_rest_client/client.rb', line 299

def delete_attachment(attachment_id, zuora_version = nil)
  @connection.rest_delete("/attachments/#{attachment_id}", zuora_version)
end

#delete_bill_run_object(bill_run_id, zuora_version = nil) ⇒ `Object`



323
324
325

# File 'lib/zuora_rest_client/client.rb', line 323

def delete_bill_run_object(bill_run_id, zuora_version = nil)
  @connection.rest_delete("/object/bill-run/#{bill_run_id}", zuora_version)
end

#delete_communication_profile_object(communication_profile_id, zuora_version = nil) ⇒ `Object`



387
388
389

# File 'lib/zuora_rest_client/client.rb', line 387

def delete_communication_profile_object(communication_profile_id, zuora_version = nil)
  @connection.rest_delete("/object/communication-profile/#{communication_profile_id}", zuora_version)
end

#delete_contact_object(contact_id, zuora_version = nil) ⇒ `Object`



411
412
413

# File 'lib/zuora_rest_client/client.rb', line 411

def delete_contact_object(contact_id, zuora_version = nil)
  @connection.rest_delete("/object/contact/#{contact_id}", zuora_version)
end

#delete_credit_balance_adjustment_object(credit_balance_adjustment_id, zuora_version = nil) ⇒ `Object`



427
428
429

# File 'lib/zuora_rest_client/client.rb', line 427

def delete_credit_balance_adjustment_object(credit_balance_adjustment_id, zuora_version = nil)
  @connection.rest_delete("/object/credit-balance-adjustment/#{credit_balance_adjustment_id}", zuora_version)
end

#delete_credit_memo(credit_memo_id, zuora_version = nil) ⇒ `Object`



441
442
443

# File 'lib/zuora_rest_client/client.rb', line 441

def delete_credit_memo(credit_memo_id, zuora_version = nil)
  @connection.rest_delete("/creditmemos/#{credit_memo_id}", zuora_version)
end

#delete_debit_memo(debit_memo_id, zuora_version = nil) ⇒ `Object`



587
588
589

# File 'lib/zuora_rest_client/client.rb', line 587

def delete_debit_memo(debit_memo_id, zuora_version = nil)
  @connection.rest_delete("/debitmemos/#{debit_memo_id}", zuora_version)
end

#delete_entity(entity_id, zuora_version = nil) ⇒ `Object`



706
707
708

# File 'lib/zuora_rest_client/client.rb', line 706

def delete_entity(entity_id, zuora_version = nil)
  @connection.rest_delete("/entities/#{entity_id}", zuora_version)
end

#delete_export_object(export_id, zuora_version = nil) ⇒ `Object`



758
759
760

# File 'lib/zuora_rest_client/client.rb', line 758

def delete_export_object(export_id, zuora_version = nil)
  @connection.rest_delete("/object/export/#{export_id}", zuora_version)
end

#delete_feature_object(feature_id, zuora_version = nil) ⇒ `Object`



828
829
830

# File 'lib/zuora_rest_client/client.rb', line 828

def delete_feature_object(feature_id, zuora_version = nil)
  @connection.rest_delete("/object/feature/#{feature_id}", zuora_version)
end

#delete_import_object(import_id, zuora_version = nil) ⇒ `Object`



876
877
878

# File 'lib/zuora_rest_client/client.rb', line 876

def delete_import_object(import_id, zuora_version = nil)
  @connection.rest_delete("/object/import/#{import_id}", zuora_version)
end

#delete_invoice_adjustment_object(invoice_adjustment_id, zuora_version = nil) ⇒ `Object`



900
901
902

# File 'lib/zuora_rest_client/client.rb', line 900

def delete_invoice_adjustment_object(invoice_adjustment_id, zuora_version = nil)
  @connection.rest_delete("/object/invoice-adjustment/#{invoice_adjustment_id}", zuora_version)
end

#delete_invoice_item_adjustment_object(invoice_item_adjustment_id, zuora_version = nil) ⇒ `Object`



916
917
918

# File 'lib/zuora_rest_client/client.rb', line 916

def delete_invoice_item_adjustment_object(invoice_item_adjustment_id, zuora_version = nil)
  @connection.rest_delete("/object/invoice-item-adjustment/#{invoice_item_adjustment_id}", zuora_version)
end

#delete_invoice_item_object(invoice_item_id, zuora_version = nil) ⇒ `Object`



932
933
934

# File 'lib/zuora_rest_client/client.rb', line 932

def delete_invoice_item_object(invoice_item_id, zuora_version = nil)
  @connection.rest_delete("/object/invoice-item/#{invoice_item_id}", zuora_version)
end

#delete_invoice_object(invoice_id, zuora_version = nil) ⇒ `Object`



1016
1017
1018

# File 'lib/zuora_rest_client/client.rb', line 1016

def delete_invoice_object(invoice_id, zuora_version = nil)
  @connection.rest_delete("/object/invoice/#{invoice_id}", zuora_version)
end

#delete_invoice_payment_object(invoice_payment_id, zuora_version = nil) ⇒ `Object`



956
957
958

# File 'lib/zuora_rest_client/client.rb', line 956

def delete_invoice_payment_object(invoice_payment_id, zuora_version = nil)
  @connection.rest_delete("/object/invoice-payment/#{invoice_payment_id}", zuora_version)
end

#delete_invoice_split_item_object(invoice_split_item_id, zuora_version = nil) ⇒ `Object`



972
973
974

# File 'lib/zuora_rest_client/client.rb', line 972

def delete_invoice_split_item_object(invoice_split_item_id, zuora_version = nil)
  @connection.rest_delete("/object/invoice-split-item/#{invoice_split_item_id}", zuora_version)
end

#delete_invoice_split_object(invoice_split_id, zuora_version = nil) ⇒ `Object`



988
989
990

# File 'lib/zuora_rest_client/client.rb', line 988

def delete_invoice_split_object(invoice_split_id, zuora_version = nil)
  @connection.rest_delete("/object/invoice-split/#{invoice_split_id}", zuora_version)
end

#delete_journal_run(journal_run_number, zuora_version = nil) ⇒ `Object`



1056
1057
1058

# File 'lib/zuora_rest_client/client.rb', line 1056

def delete_journal_run(journal_run_number, zuora_version = nil)
  @connection.rest_delete("/journal-runs/#{journal_run_number}", zuora_version)
end

#delete_payment(payment_id, zuora_version = nil) ⇒ `Object`



1289
1290
1291

# File 'lib/zuora_rest_client/client.rb', line 1289

def delete_payment(payment_id, zuora_version = nil)
  @connection.rest_delete("/payments/#{payment_id}", zuora_version)
end

#delete_payment_method(payment_method_id, zuora_version = nil) ⇒ `Object`



1187
1188
1189

# File 'lib/zuora_rest_client/client.rb', line 1187

def delete_payment_method(payment_method_id, zuora_version = nil)
  @connection.rest_delete("/payment-methods/credit-cards/#{payment_method_id}", zuora_version)
end

#delete_payment_method_object(payment_method_id, zuora_version = nil) ⇒ `Object`



1209
1210
1211

# File 'lib/zuora_rest_client/client.rb', line 1209

def delete_payment_method_object(payment_method_id, zuora_version = nil)
  @connection.rest_delete("/object/payment-method/#{payment_method_id}", zuora_version)
end

#delete_payment_method_snapshot_object(payment_method_snapshot_id, zuora_version = nil) ⇒ `Object`



1147
1148
1149

# File 'lib/zuora_rest_client/client.rb', line 1147

def delete_payment_method_snapshot_object(payment_method_snapshot_id, zuora_version = nil)
  @connection.rest_delete("/object/payment-method-snapshot/#{payment_method_snapshot_id}", zuora_version)
end

#delete_payment_method_transaction_log_object(payment_method_transaction_log_id, zuora_version = nil) ⇒ `Object`



1163
1164
1165

# File 'lib/zuora_rest_client/client.rb', line 1163

def delete_payment_method_transaction_log_object(payment_method_transaction_log_id, zuora_version = nil)
  @connection.rest_delete("/object/payment-method-transaction-log/#{payment_method_transaction_log_id}", zuora_version)
end

#delete_payment_object(payment_id, zuora_version = nil) ⇒ `Object`



1311
1312
1313

# File 'lib/zuora_rest_client/client.rb', line 1311

def delete_payment_object(payment_id, zuora_version = nil)
  @connection.rest_delete("/object/payment/#{payment_id}", zuora_version)
end

#delete_payment_transaction_log_object(payment_transaction_log_id, zuora_version = nil) ⇒ `Object`



1225
1226
1227

# File 'lib/zuora_rest_client/client.rb', line 1225

def delete_payment_transaction_log_object(payment_transaction_log_id, zuora_version = nil)
  @connection.rest_delete("/object/payment-transaction-log/#{payment_transaction_log_id}", zuora_version)
end

#delete_product_feature_object(product_feature_id, zuora_version = nil) ⇒ `Object`



1327
1328
1329

# File 'lib/zuora_rest_client/client.rb', line 1327

def delete_product_feature_object(product_feature_id, zuora_version = nil)
  @connection.rest_delete("/object/product-feature/#{product_feature_id}", zuora_version)
end

#delete_product_object(product_id, zuora_version = nil) ⇒ `Object`



1413
1414
1415

# File 'lib/zuora_rest_client/client.rb', line 1413

def delete_product_object(product_id, zuora_version = nil)
  @connection.rest_delete("/object/product/#{product_id}", zuora_version)
end

#delete_product_rate_plan_charge_object(product_rate_plan_charge_id, zuora_version = nil) ⇒ `Object`



1359
1360
1361

# File 'lib/zuora_rest_client/client.rb', line 1359

def delete_product_rate_plan_charge_object(product_rate_plan_charge_id, zuora_version = nil)
  @connection.rest_delete("/object/product-rate-plan-charge/#{product_rate_plan_charge_id}", zuora_version)
end

#delete_product_rate_plan_charge_tier_object(product_rate_plan_charge_tier_id, zuora_version = nil) ⇒ `Object`



1343
1344
1345

# File 'lib/zuora_rest_client/client.rb', line 1343

def delete_product_rate_plan_charge_tier_object(product_rate_plan_charge_tier_id, zuora_version = nil)
  @connection.rest_delete("/object/product-rate-plan-charge-tier/#{product_rate_plan_charge_tier_id}", zuora_version)
end

#delete_product_rate_plan_object(product_rate_plan_id, zuora_version = nil) ⇒ `Object`



1389
1390
1391

# File 'lib/zuora_rest_client/client.rb', line 1389

def delete_product_rate_plan_object(product_rate_plan_id, zuora_version = nil)
  @connection.rest_delete("/object/product-rate-plan/#{product_rate_plan_id}", zuora_version)
end

#delete_rate_plan_charge_object(rate_plan_charge_id, zuora_version = nil) ⇒ `Object`



1455
1456
1457

# File 'lib/zuora_rest_client/client.rb', line 1455

def delete_rate_plan_charge_object(rate_plan_charge_id, zuora_version = nil)
  @connection.rest_delete("/object/rate-plan-charge/#{rate_plan_charge_id}", zuora_version)
end

#delete_rate_plan_charge_tier_object(rate_plan_charge_tier_id, zuora_version = nil) ⇒ `Object`



1439
1440
1441

# File 'lib/zuora_rest_client/client.rb', line 1439

def delete_rate_plan_charge_tier_object(rate_plan_charge_tier_id, zuora_version = nil)
  @connection.rest_delete("/object/rate-plan-charge-tier/#{rate_plan_charge_tier_id}", zuora_version)
end

#delete_rate_plan_object(rate_plan_id, zuora_version = nil) ⇒ `Object`



1471
1472
1473

# File 'lib/zuora_rest_client/client.rb', line 1471

def delete_rate_plan_object(rate_plan_id, zuora_version = nil)
  @connection.rest_delete("/object/rate-plan/#{rate_plan_id}", zuora_version)
end

#delete_refund(refund_id, zuora_version = nil) ⇒ `Object`



1517
1518
1519

# File 'lib/zuora_rest_client/client.rb', line 1517

def delete_refund(refund_id, zuora_version = nil)
  @connection.rest_delete("/refunds/#{refund_id}", zuora_version)
end

#delete_refund_invoice_payment_object(refund_invoice_payment_id, zuora_version = nil) ⇒ `Object`



1487
1488
1489

# File 'lib/zuora_rest_client/client.rb', line 1487

def delete_refund_invoice_payment_object(refund_invoice_payment_id, zuora_version = nil)
  @connection.rest_delete("/object/refund-invoice-payment/#{refund_invoice_payment_id}", zuora_version)
end

#delete_refund_object(refund_id, zuora_version = nil) ⇒ `Object`



1567
1568
1569

# File 'lib/zuora_rest_client/client.rb', line 1567

def delete_refund_object(refund_id, zuora_version = nil)
  @connection.rest_delete("/object/refund/#{refund_id}", zuora_version)
end

#delete_refund_transaction_log_object(refund_transaction_log_id, zuora_version = nil) ⇒ `Object`



1503
1504
1505

# File 'lib/zuora_rest_client/client.rb', line 1503

def delete_refund_transaction_log_object(refund_transaction_log_id, zuora_version = nil)
  @connection.rest_delete("/object/refund-transaction-log/#{refund_transaction_log_id}", zuora_version)
end

#delete_revenue_schedule(revenue_schedule_number, zuora_version = nil) ⇒ `Object`



1681
1682
1683

# File 'lib/zuora_rest_client/client.rb', line 1681

def delete_revenue_schedule(revenue_schedule_number, zuora_version = nil)
  @connection.rest_delete("/revenue-schedules/#{revenue_schedule_number}", zuora_version)
end

#delete_subscription_object(subscription_id, zuora_version = nil) ⇒ `Object`



1829
1830
1831

# File 'lib/zuora_rest_client/client.rb', line 1829

def delete_subscription_object(subscription_id, zuora_version = nil)
  @connection.rest_delete("/object/subscription/#{subscription_id}", zuora_version)
end

#delete_subscription_product_feature_object(product_feature_id, zuora_version = nil) ⇒ `Object`



1763
1764
1765

# File 'lib/zuora_rest_client/client.rb', line 1763

def delete_subscription_product_feature_object(product_feature_id, zuora_version = nil)
  @connection.rest_delete("/object/subscription-product-feature/#{subscription_product_feature_id}", zuora_version)
end

#delete_summary_journal_entry(journal_entry_number, zuora_version = nil) ⇒ `Object`



1853
1854
1855

# File 'lib/zuora_rest_client/client.rb', line 1853

def delete_summary_journal_entry(journal_entry_number, zuora_version = nil)
  @connection.rest_delete("/journal-entries/#{journal_entry_number}", zuora_version)
end

#delete_taxation_item(taxation_item_id, zuora_version = nil) ⇒ `Object`



1875
1876
1877

# File 'lib/zuora_rest_client/client.rb', line 1875

def delete_taxation_item(taxation_item_id, zuora_version = nil)
  @connection.rest_delete("/taxationitems/#{taxation_item_id}", zuora_version)
end

#delete_taxation_item_object(taxation_item_id, zuora_version = nil) ⇒ `Object`



1905
1906
1907

# File 'lib/zuora_rest_client/client.rb', line 1905

def delete_taxation_item_object(taxation_item_id, zuora_version = nil)
  @connection.rest_delete("/object/taxation-item/#{taxation_item_id}", zuora_version)
end

#delete_unit_of_measure_object(unit_of_measure_id, zuora_version = nil) ⇒ `Object`



1947
1948
1949

# File 'lib/zuora_rest_client/client.rb', line 1947

def delete_unit_of_measure_object(unit_of_measure_id, zuora_version = nil)
  @connection.rest_delete("/object/unit-of-measure/#{unit_of_measure_id}", zuora_version)
end

#delete_usage_object(usage_id, zuora_version = nil) ⇒ `Object`



1982
1983
1984

# File 'lib/zuora_rest_client/client.rb', line 1982

def delete_usage_object(usage_id, zuora_version = nil)
  @connection.rest_delete("/object/usage/#{usage_id}", zuora_version)
end

#deny_entity_connection(entity_connection_id, zuora_version = nil) ⇒ `Object`



734
735
736

# File 'lib/zuora_rest_client/client.rb', line 734

def deny_entity_connection(entity_connection_id, zuora_version = nil)
  @connection.rest_put("/entity-connections/#{entity_connection_id}/deny", nil, zuora_version)
end

#deny_user_access(username, zuora_version = nil) ⇒ `Object`



2000
2001
2002

# File 'lib/zuora_rest_client/client.rb', line 2000

def deny_user_access(username, zuora_version = nil)
  @connection.rest_put("/users/#{username}/deny-access", nil, zuora_version)
end

#describe_fields(object, field_filter_options = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 631

def describe_fields(object, field_filter_options = {}, zuora_version = nil)

  return [] if object.nil? || object == ''

  # Invoke Zuora describe
  results = describe_object(object, zuora_version)
  results = results.fields

  # Filter results
  results.select! do |field|

    match = true

    # Process field filters
    %w(selectable createable updateable filterable custom).each do |option|
      if field_filter_options[option.to_sym] == true
        match &&= field[option.to_sym]
      elsif field_filter_options[option.to_sym] == false
        match &&= !field[option.to_sym]
      end
    end

    # Process nested field filters
    %w(soap export).each do |context|
      if field_filter_options["#{context}able".to_sym] == true
        match &&= field.contexts.include?(context)
      elsif field_filter_options["#{context}able".to_sym] == false
        match &&= !field.contexts.include?(context)
      end
    end

    match
  end

  # Sort results by field name
  results.sort! { |a, b| a.name <=> b.name }

  results
end

#describe_object(object = '', zuora_version = nil) ⇒ `Object`

Describe                                                                  #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 605

def describe_object(object = '', zuora_version = nil)
  path = "/describe/#{object}"
  path = "/#{zuora_version.to_s}#{path}" if !zuora_version.nil?
  result = @connection.rest_get(path)
  if result.respond_to?(:objects)

    # Listing all objects
    result = result.objects.object

  elsif result.respond_to?(:object)

    # Returning single object
    result = result.object
    result.fields = result.fields.field if result.fields
    result.related_objects = result.related_objects.object if result.related_objects
    result.fields.map! do |field|
      field.contexts = field.contexts.context if field.contexts
      field.options = field.options.option if field.options
      field
    end

  end

  result
end

#describe_related_objects(object, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 671

def describe_related_objects(object, zuora_version = nil)

  return [] if object.nil? || object == ''

  # Invoke Zuora describe
  results = describe_object(object, zuora_version)
  results = results.related_objects

  results
end

#disconnect_entity_connection(entity_connection_id, zuora_version = nil) ⇒ `Object`



738
739
740

# File 'lib/zuora_rest_client/client.rb', line 738

def disconnect_entity_connection(entity_connection_id, zuora_version = nil)
  @connection.rest_put("/entity-connections/#{entity_connection_id}/disconnect", nil, zuora_version)
end

#distribute_revenue_across_accounting_periods(revenue_schedule_number, request, zuora_version = nil) ⇒ `Object`



1669
1670
1671

# File 'lib/zuora_rest_client/client.rb', line 1669

def distribute_revenue_across_accounting_periods(revenue_schedule_number, request, zuora_version = nil)
  @connection.rest_put("/revenue-schedules/#{revenue_schedule_number}/distribute-revenue-across-accounting-periods", request, zuora_version)
end

#distribute_revenue_by_date_range(revenue_schedule_number, request, zuora_version = nil) ⇒ `Object`



1677
1678
1679

# File 'lib/zuora_rest_client/client.rb', line 1677

def distribute_revenue_by_date_range(revenue_schedule_number, request, zuora_version = nil)
  @connection.rest_put("/revenue-schedules/#{revenue_schedule_number}/distribute-revenue-with-date-range", request, zuora_version)
end

#distribute_revenue_on_specific_date(revenue_schedule_number, request, zuora_version = nil) ⇒ `Object`



1673
1674
1675

# File 'lib/zuora_rest_client/client.rb', line 1673

def distribute_revenue_on_specific_date(revenue_schedule_number, request, zuora_version = nil)
  @connection.rest_put("/revenue-schedules/#{revenue_schedule_number}/distribute-revenue-on-specific-date", request, zuora_version)
end

#edit_attachment(attachment_id, request, zuora_version = nil) ⇒ `Object`



295
296
297

# File 'lib/zuora_rest_client/client.rb', line 295

def edit_attachment(attachment_id, request, zuora_version = nil)
  @connection.rest_put("/attachments/#{attachment_id}", request, zuora_version)
end

#execute(request, zuora_version = nil) ⇒ `Object`



56
57
58

# File 'lib/zuora_rest_client/client.rb', line 56

def execute(request, zuora_version = nil)
  @connection.rest_post('/action/execute', request, zuora_version)
end

#export(export_zoql, destination_io, options = {}, delete_export_from_server = true) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 762

def export(export_zoql, destination_io, options = {}, delete_export_from_server = true)

  export_options = {}.merge(DEFAULT_EXPORT_OPTIONS).merge(options)

  # Construct export request
  export_request = {
      Format: export_options[:format].to_s,
      Query: export_zoql,
      Zip: export_options[:zip],
      Encrypted: export_options[:encrypted] }
  if !export_options[:name].nil?
    export_request[:Name] = export_options[:name]
  end

  # Submit create export request
  create_export_result = create_export_result(export_request)
  logger.debug "********* EXPORT CREATE RESULT: #{create_export_result.inspect}"
  unless create_export_result.Success
    raise "Error creating export: #{create_export_result.Errors.map { |error| error.message }.join('; ')}"
  end

  # Poll Zuora until CSV is ready for download
  poll_started = false
  export_record = nil
  FirePoll.poll(nil, export_options[:max_wait]) do
    sleep export_options[:poll_delay] if poll_started
    poll_started = true
    poll_query_request = {
        queryString: "SELECT Id, FileId, Status, StatusReason FROM Export WHERE Id = '#{create_export_result.Id}'" }
    poll_query_result = query(poll_query_request)
    export_record = poll_query_result.records.first
    logger.debug "********* CURRENT EXPORT STATUS: #{export_record.Status}"
    export_record.Status.end_with? 'ed'
  end

  # Check status and if complete, output file to destination IO
  logger.debug "********* FINAL EXPORT STATUS: #{export_record.Status}"
  case export_record.Status
    when 'Completed'
      get_file(export_zobject.FileId, destination_io)
    when 'Canceled'
      raise "Error downloading file: #{export_record.Status} - #{export_record.StatusReason}"
    when 'Failed'
      raise "Error downloading file: #{export_record.Status} - #{export_record.StatusReason}"
  end

  # If requested, delete export from server
  if delete_export_from_server
    delete_export_object(export_record.Id)
  end

  export_record
end

#generate(request, zuora_version = nil) ⇒ `Object`



60
61
62

# File 'lib/zuora_rest_client/client.rb', line 60

def generate(request, zuora_version = nil)
  @connection.rest_post('/action/generate', request, zuora_version)
end

#generate_oauth_token(request, zuora_version = nil) ⇒ `Object`

OAuth                                                                     #
                                                                          #



1107
1108
1109

# File 'lib/zuora_rest_client/client.rb', line 1107

def generate_oauth_token(request, zuora_version = nil)
  @connection.rest_post('/oauth/token', request, zuora_version)
end

#generate_quote_document(request, zuora_version = nil) ⇒ `Object`

Quotes Document                                                           #
                                                                          #



1423
1424
1425

# File 'lib/zuora_rest_client/client.rb', line 1423

def generate_quote_document(request, zuora_version = nil)
  @connection.rest_post('/quotes/document', request, zuora_version)
end

#generate_rsa_signature(request, zuora_version = nil) ⇒ `Object`

RSA Signatures                                                            #
                                                                          #



1733
1734
1735

# File 'lib/zuora_rest_client/client.rb', line 1733

def generate_rsa_signature(request, zuora_version = nil)
  @connection.rest_post('/rsa-signatures', request, zuora_version)
end

#get_accessible_entities_for_user(username, zuora_version = nil) ⇒ `Object`



2004
2005
2006

# File 'lib/zuora_rest_client/client.rb', line 2004

def get_accessible_entities_for_user(username, zuora_version = nil)
  @connection.rest_get("/users/#{username}/accessible-entities", zuora_version)
end

#get_account(account_key, zuora_version = nil) ⇒ `Object`



170
171
172

# File 'lib/zuora_rest_client/client.rb', line 170

def get_account(account_key, zuora_version = nil)
  @connection.rest_get("/accounts/#{account_key}", zuora_version)
end

#get_account_summary(account_key, zuora_version = nil) ⇒ `Object`



178
179
180

# File 'lib/zuora_rest_client/client.rb', line 178

def get_account_summary(account_key, zuora_version = nil)
  @connection.rest_get("/accounts/#{account_key}/summary", zuora_version)
end

#get_accounting_period(accounting_period_id, zuora_version = nil) ⇒ `Object`



140
141
142

# File 'lib/zuora_rest_client/client.rb', line 140

def get_accounting_period(accounting_period_id, zuora_version = nil)
  @connection.rest_get("/accounting-periods/#{accounting_period_id}", zuora_version)
end

#get_all_accounting_codes(query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 90

def get_all_accounting_codes(query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse('/accounting-codes')
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_all_accounting_periods(query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 134

def get_all_accounting_periods(query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse('/accounting-periods')
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_all_payments(query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1263

def get_all_payments(query_params = {}, zuora_version = nil)
  uri = Addressable::URI.new('/payments')
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_all_refunds(query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1531

def get_all_refunds(query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse('/refunds')
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_all_revenue_schedules_of_product_charges(charge_id, account_id, query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1721

def get_all_revenue_schedules_of_product_charges(charge_id, account_id, query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse("/revenue-schedules/product-charges/#{charge_id}/#{account_id}")
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_all_summary_journal_entries_for_journal_run(journal_run_number, query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1843

def get_all_summary_journal_entries_for_journal_run(journal_run_number, query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse("/journal-entries/journal-runs/#{journal_run_number}")
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_amendment(amendment_key, zuora_version = nil) ⇒ `Object`

Amendments                                                                #
                                                                          #



206
207
208

# File 'lib/zuora_rest_client/client.rb', line 206

def get_amendment(amendment_key, zuora_version = nil)
  @connection.rest_get("/amendments/#{amendment_key}", zuora_version)
end

#get_amendment_by_subscription_id(subscription_id, zuora_version = nil) ⇒ `Object`



210
211
212

# File 'lib/zuora_rest_client/client.rb', line 210

def get_amendment_by_subscription_id(subscription_id, zuora_version = nil)
  @connection.rest_get("/amendments/subscriptions/#{subscription_id}", zuora_version)
end

#get_aqua_job_result(job_id) ⇒ `Object`



262
263
264

# File 'lib/zuora_rest_client/client.rb', line 262

def get_aqua_job_result(job_id)
  @connection.app_get("/apps/api/batch-query/jobs/#{job_id}")
end

#get_billing_preview_run(billing_preview_run_id, zuora_version = nil) ⇒ `Object`



337
338
339

# File 'lib/zuora_rest_client/client.rb', line 337

def get_billing_preview_run(billing_preview_run_id, zuora_version = nil)
  @connection.rest_get("/billing-preview-runs/#{billing_preview_run_id}", zuora_version)
end

#get_callout_notification_history(query_params = {}, zuora_version = nil) ⇒ `Object`

Notification History                                                      #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 1089

def get_callout_notification_history(query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse('/notification-history/callout')
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_charge_summary_details_by_charge_id(charge_id, zuora_version = nil) ⇒ `Object`



371
372
373

# File 'lib/zuora_rest_client/client.rb', line 371

def get_charge_summary_details_by_charge_id(charge_id, zuora_version = nil)
  @connection.rest_get("/charge-revenue-summaries/subscription-charges/#{charge_id}", zuora_version)
end

#get_charge_summary_details_by_crs_number(crs_number, zuora_version = nil) ⇒ `Object`

Charge Revenue Summaries                                                  #
                                                                          #



367
368
369

# File 'lib/zuora_rest_client/client.rb', line 367

def get_charge_summary_details_by_crs_number(crs_number, zuora_version = nil)
  @connection.rest_get("/charge-revenue-summaries/#{crs_number}", zuora_version)
end

#get_credit_memo(credit_memo_id, zuora_version = nil) ⇒ `Object`

Credit Memos                                                              #
                                                                          #



437
438
439

# File 'lib/zuora_rest_client/client.rb', line 437

def get_credit_memo(credit_memo_id, zuora_version = nil)
  @connection.rest_get("/creditmemos/#{credit_memo_id}", zuora_version)
end

#get_credit_memo_item(credit_memo_id, credit_memo_item_id, zuora_version = nil) ⇒ `Object`



453
454
455

# File 'lib/zuora_rest_client/client.rb', line 453

def get_credit_memo_item(credit_memo_id, credit_memo_item_id, zuora_version = nil)
  @connection.rest_get("/creditmemos/#{credit_memo_id}/items/#{credit_memo_item_id}", zuora_version)
end

#get_credit_memo_items(credit_memo_id, query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 477

def get_credit_memo_items(credit_memo_id, query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse("/creditmemos/#{credit_memo_id}/items")
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_credit_memo_part(credit_memo_id, part_id, zuora_version = nil) ⇒ `Object`



511
512
513

# File 'lib/zuora_rest_client/client.rb', line 511

def get_credit_memo_part(credit_memo_id, part_id, zuora_version = nil)
  @connection.rest_get("/creditmemos/#{credit_memo_id}/parts/#{part_id}", zuora_version)
end

#get_credit_memo_part_item(credit_memo_id, part_id, item_part_id, zuora_version = nil) ⇒ `Object`



497
498
499

# File 'lib/zuora_rest_client/client.rb', line 497

def get_credit_memo_part_item(credit_memo_id, part_id, item_part_id, zuora_version = nil)
  @connection.rest_get("/creditmemos/#{credit_memo_id}/parts/#{part_id}/itemparts/#{item_part_id}", zuora_version)
end

#get_credit_memo_part_items(credit_memo_id, part_id, query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 483

def get_credit_memo_part_items(credit_memo_id, part_id, query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse("/creditmemos/#{credit_memo_id}/parts/#{part_id}/itemparts")
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_credit_memo_parts(credit_memo_id, query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 467

def get_credit_memo_parts(credit_memo_id, query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse("/creditmemos/#{credit_memo_id}/parts")
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_credit_memos(query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 505

def get_credit_memos(query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse('/creditmemos')
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_custom_exchange_rates(currency, start_date, end_date, zuora_version = nil) ⇒ `Object`

Custom Exchange Rates                                                     #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 529

def get_custom_exchange_rates(currency, start_date, end_date, zuora_version = nil)
  if start_date.is_a? Date
    start_date = start_date.iso8601
  elsif start_date.is_a? DateTime
    start_date = start_date.to_date.iso8601
  end
  if end_date.is_a? Date
    end_date = end_date.iso8601
  elsif end_date.is_a? DateTime
    end_date = end_date.to_date.iso8601
  end
  uri = Addressable::URI.parse("/custom-exchange-rates/#{currency}")
  uri.query_values = { startDate: start_date, endDate: end_date }
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_debit_memo(debit_memo_id, zuora_version = nil) ⇒ `Object`



583
584
585

# File 'lib/zuora_rest_client/client.rb', line 583

def get_debit_memo(debit_memo_id, zuora_version = nil)
  @connection.rest_get("/debitmemos/#{debit_memo_id}", zuora_version)
end

#get_debit_memo_item(debit_memo_id, debit_memo_item_id, zuora_version = nil) ⇒ `Object`

Debit Memos                                                               #
                                                                          #



551
552
553

# File 'lib/zuora_rest_client/client.rb', line 551

def get_debit_memo_item(debit_memo_id, debit_memo_item_id, zuora_version = nil)
  @connection.rest_get("/debitmemos/#{debit_memo_id}/items/#{debit_memo_item_id}", zuora_version)
end

#get_debit_memo_items(debit_memo_id, query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 573

def get_debit_memo_items(debit_memo_id, query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse("/debitmemos/#{debit_memo_id}/items")
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_debit_memos(query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 563

def get_debit_memos(query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse('/debitmemos')
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_email_notification_history(query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1095

def get_email_notification_history(query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse('/notification-history/email')
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_entities(query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 692

def get_entities(query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse('/entities')
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_entity(entity_id, zuora_version = nil) ⇒ `Object`



702
703
704

# File 'lib/zuora_rest_client/client.rb', line 702

def get_entity(entity_id, zuora_version = nil)
  @connection.rest_get("/entities/#{entity_id}", zuora_version)
end

#get_entity_connections(query_params = {}, zuora_version = nil) ⇒ `Object`

Entity Connections                                                        #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 720

def get_entity_connections(query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse('/entity-connections')
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_file(file_id, destination_io, zuora_version = nil) ⇒ `Object`

Get Files                                                                 #
                                                                          #



838
839
840

# File 'lib/zuora_rest_client/client.rb', line 838

def get_file(file_id, destination_io, zuora_version = nil)
  @connection.rest_streamed_get("/files/#{file_id}", destination_io, zuora_version)
end

#get_hosted_pages(query_params = {}, zuora_version = nil) ⇒ `Object`

Hosted Pages                                                              #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 858

def get_hosted_pages(query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse('/hostedpages')
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_invoice_pdf_by(identifying_field_sym, identifier, destination_io) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1020

def get_invoice_pdf_by(identifying_field_sym, identifier, destination_io)
  raise "Unsupported identifying_field_sym. Expected: :id or :invoice_number, Actual: #{identifying_field_sym}" if ![:id, :invoice_number].include?(identifying_field_sym)

  # Set IO to binary mode
  destination_io.try(:binmode)

  # Query invoice Id or number
  results = query({ queryString: "select Id, Body from Invoice where #{identifying_field_sym.to_s.camelize} = '#{identifier.gsub("'", %q(\\\'))}'" })
  raise "Cannot find invoice where #{identifying_field_sym.to_s.camelize} = '#{identifier}'" if results.size == 0

  # Write body to IO
  invoice = results.records.first
  destination_io.try(:write, Base64.decode64(invoice.Body))

  # Set pointer to beginning of file
  destination_io.try(:rewind)

  # Return nothing
  nil

end

#get_invoice_transactions(account_key, query_params = {}, zuora_version = nil) ⇒ `Object`

Transactions                                                              #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 1915

def get_invoice_transactions(account_key, query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse("/transactions/invoices/accounts/#{account_key}")
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_journal_run(journal_run_number, zuora_version = nil) ⇒ `Object`



1052
1053
1054

# File 'lib/zuora_rest_client/client.rb', line 1052

def get_journal_run(journal_run_number, zuora_version = nil)
  @connection.rest_get("/journal-runs/#{journal_run_number}", zuora_version)
end

#get_last_aqua_job_result(partner, project) ⇒ `Object`



266
267
268

# File 'lib/zuora_rest_client/client.rb', line 266

def get_last_aqua_job_result(partner, project)
  @connection.app_get("/apps/api/batch-query/jobs/partner/#{partner}/project/#{project}")
end

#get_mass_action_result(bulk_key, zuora_version = nil) ⇒ `Object`



1075
1076
1077

# File 'lib/zuora_rest_client/client.rb', line 1075

def get_mass_action_result(bulk_key, zuora_version = nil)
  @connection.rest_get("/bulk/#{bulk_key}", zuora_version)
end

#get_payment(payment_id, zuora_version = nil) ⇒ `Object`



1285
1286
1287

# File 'lib/zuora_rest_client/client.rb', line 1285

def get_payment(payment_id, zuora_version = nil)
  @connection.rest_get("/payments/#{payment_id}", zuora_version)
end

#get_payment_gateways(zuora_version = nil) ⇒ `Object`

Payment Gateways                                                          #
                                                                          #



1131
1132
1133

# File 'lib/zuora_rest_client/client.rb', line 1131

def get_payment_gateways(zuora_version = nil)
  @connection.rest_get('/paymentgateways', zuora_version)
end

#get_payment_methods(account_key, query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1177

def get_payment_methods(account_key, query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse("/payment-methods/credit-cards/accounts/#{account_key}")
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_payment_part(payment_id, part_id, zuora_version = nil) ⇒ `Object`



1269
1270
1271

# File 'lib/zuora_rest_client/client.rb', line 1269

def get_payment_part(payment_id, part_id, zuora_version = nil)
  @connection.rest_get("/payments/#{payment_id}/parts/#{part_id}", zuora_version)
end

#get_payment_part_item(payment_id, part_id, item_part_id, zuora_version = nil) ⇒ `Object`



1273
1274
1275

# File 'lib/zuora_rest_client/client.rb', line 1273

def get_payment_part_item(payment_id, part_id, item_part_id, zuora_version = nil)
  @connection.rest_get("/payments/#{payment_id}/parts/#{part_id}/itemparts/#{item_part_id}", zuora_version)
end

#get_payment_part_items(payment_id, part_id, query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1245

def get_payment_part_items(payment_id, part_id, query_params = {}, zuora_version = nil)
  uri = Addressable::URI.new("/payments/#{payment_id}/parts/#{part_id}/itemparts")
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_payment_parts(payment_id, query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1239

def get_payment_parts(payment_id, query_params = {}, zuora_version = nil)
  uri = Addressable::URI.new("/payments/#{payment_id}/parts")
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_payment_transactions(account_key, query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1921

def get_payment_transactions(account_key, query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse("/transactions/payments/accounts/#{account_key}")
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_product(product_id, zuora_version = nil) ⇒ `Object`



353
354
355

# File 'lib/zuora_rest_client/client.rb', line 353

def get_product(product_id, zuora_version = nil)
  @connection.rest_get("/catalog/product/#{product_id}", zuora_version)
end

#get_product_catalog(query_params = {}, zuora_version = nil) ⇒ `Object`

Catalog                                                                   #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 347

def get_product_catalog(query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse('/catalog/products')
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_product_rate_plans(product_id, query_params = {}, zuora_version = nil) ⇒ `Object`

Product Rate Plans                                                        #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 1369

def get_product_rate_plans(product_id, query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse("/rateplan/#{product_id}/productRatePlan")
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_refund(refund_id, zuora_version = nil) ⇒ `Object`

Refunds                                                                   #
                                                                          #



1513
1514
1515

# File 'lib/zuora_rest_client/client.rb', line 1513

def get_refund(refund_id, zuora_version = nil)
  @connection.rest_get("/refunds/#{refund_id}", zuora_version)
end

#get_refund_part(refund_id, refund_part_id, zuora_version = nil) ⇒ `Object`



1541
1542
1543

# File 'lib/zuora_rest_client/client.rb', line 1541

def get_refund_part(refund_id, refund_part_id, zuora_version = nil)
  @connection.rest_get("/refunds/#{refund_id}/parts/#{refund_part_id}", zuora_version)
end

#get_refund_part_item(refund_id, refund_part_id, item_part_id, zuora_version = nil) ⇒ `Object`



1545
1546
1547

# File 'lib/zuora_rest_client/client.rb', line 1545

def get_refund_part_item(refund_id, refund_part_id, item_part_id, zuora_version = nil)
  @connection.rest_get("/refunds/#{refund_id}/parts/#{refund_part_id}/itemparts/#{item_part_id}", zuora_version)
end

#get_refund_part_items(refund_id, refund_part_id, query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1525

def get_refund_part_items(refund_id, refund_part_id, query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse("/refunds/#{refund_id}/parts/#{refund_part_id}/itemparts")
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_refund_parts(refund_id, zuora_version = nil) ⇒ `Object`



1537
1538
1539

# File 'lib/zuora_rest_client/client.rb', line 1537

def get_refund_parts(refund_id, zuora_version = nil)
  @connection.rest_get("/refunds/#{refund_id}/parts", zuora_version)
end

#get_revenue_automation_start_date(zuora_version = nil) ⇒ `Object`

Settings                                                                  #
                                                                          #



1747
1748
1749

# File 'lib/zuora_rest_client/client.rb', line 1747

def get_revenue_automation_start_date(zuora_version = nil)
  @connection.rest_get('/settings/finance/revenue-automation-start-date', zuora_version)
end

#get_revenue_event_details(event_number, zuora_version = nil) ⇒ `Object`

Revenue Events                                                            #
                                                                          #



1577
1578
1579

# File 'lib/zuora_rest_client/client.rb', line 1577

def get_revenue_event_details(event_number, zuora_version = nil)
  @connection.rest_get("/revenue-events/#{event_number}", zuora_version)
end

#get_revenue_event_for_revenue_schedule(revenue_schedule_number, query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1581

def get_revenue_event_for_revenue_schedule(revenue_schedule_number, query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse("/revenue-events/revenue-schedules/#{revenue_schedule_number}")
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_revenue_items_by_crs_number(crs_number, query_params = {}, zuora_version = nil) ⇒ `Object`

Revenue Items                                                             #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 1593

def get_revenue_items_by_crs_number(crs_number, query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse("/revenue-items/charge-revenue-summaries/#{crs_number}")
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_revenue_items_by_revenue_event_number(event_number, query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1599

def get_revenue_items_by_revenue_event_number(event_number, query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse("/revenue-items/revenue-events/#{event_number}")
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_revenue_items_by_revenue_schedule(revenue_schedule_number, query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1609

def get_revenue_items_by_revenue_schedule(revenue_schedule_number, query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse("/revenue-items/revenue-schedules/#{revenue_schedule_number}")
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_revenue_recognition_rule_by_product_rate_plan_charge(charge_id, zuora_version = nil) ⇒ `Object`



1629
1630
1631

# File 'lib/zuora_rest_client/client.rb', line 1629

def get_revenue_recognition_rule_by_product_rate_plan_charge(charge_id, zuora_version = nil)
  @connection.rest_get("/revenue-recognition-rules/product-charges/#{charge_id}", zuora_version)
end

#get_revenue_recognition_rule_by_subscription_charge(charge_id, zuora_version = nil) ⇒ `Object`

Revenue Rules                                                             #
                                                                          #



1625
1626
1627

# File 'lib/zuora_rest_client/client.rb', line 1625

def get_revenue_recognition_rule_by_subscription_charge(charge_id, zuora_version = nil)
  @connection.rest_get("/revenue-recognition-rules/subscription-charges/#{charge_id}", zuora_version)
end

#get_revenue_schedule_by_credit_memo_item(credit_memo_item_id, zuora_version = nil) ⇒ `Object`



1709
1710
1711

# File 'lib/zuora_rest_client/client.rb', line 1709

def get_revenue_schedule_by_credit_memo_item(credit_memo_item_id, zuora_version = nil)
  @connection.rest_get("/revenue-schedules/credit-memo-items/#{credit_memo_item_id}", zuora_version)
end

#get_revenue_schedule_by_debit_memo_item(debit_memo_item_id, zuora_version = nil) ⇒ `Object`



1717
1718
1719

# File 'lib/zuora_rest_client/client.rb', line 1717

def get_revenue_schedule_by_debit_memo_item(debit_memo_item_id, zuora_version = nil)
  @connection.rest_get("/revenue-schedules/debit-memo-items/#{debit_memo_item_id}", zuora_version)
end

#get_revenue_schedule_by_invoice_item(invoice_item_id, zuora_version = nil) ⇒ `Object`



1647
1648
1649

# File 'lib/zuora_rest_client/client.rb', line 1647

def get_revenue_schedule_by_invoice_item(invoice_item_id, zuora_version = nil)
  @connection.rest_get("/revenue-schedules/invoice-items/#{invoice_item_id}", zuora_version)
end

#get_revenue_schedule_by_invoice_item_adjustment(invoice_item_adjustement_id, zuora_version = nil) ⇒ `Object`



1689
1690
1691

# File 'lib/zuora_rest_client/client.rb', line 1689

def get_revenue_schedule_by_invoice_item_adjustment(invoice_item_adjustement_id, zuora_version = nil)
  @connection.rest_get("/revenue-schedules/invoice-item-adjustments/#{invoice_item_adjustement_id}", zuora_version)
end

#get_revenue_schedule_by_subscription_charge(charge_id, query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1663

def get_revenue_schedule_by_subscription_charge(charge_id, query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse("/revenue-schedules/subscription-charges/#{charge_id}")
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_revenue_schedule_details(revenue_schedule_number, zuora_version = nil) ⇒ `Object`



1685
1686
1687

# File 'lib/zuora_rest_client/client.rb', line 1685

def get_revenue_schedule_details(revenue_schedule_number, zuora_version = nil)
  @connection.rest_get("/revenue-schedules/#{revenue_schedule_number}", zuora_version)
end

#get_subscription_by_key(subscription_key, query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1791

def get_subscription_by_key(subscription_key, query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse("/subscriptions/#{subscription_key}")
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_subscription_by_key_and_version(subscription_key, version, query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1797

def get_subscription_by_key_and_version(subscription_key, version, query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse("/subscriptions/#{subscription_key}/versions/#{version}")
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_subscriptions_by_account(account_key, query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1781

def get_subscriptions_by_account(account_key, query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse("/subscriptions/accounts/#{account_key}")
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#get_summary_journal_entry(journal_entry_number, zuora_version = nil) ⇒ `Object`



1849
1850
1851

# File 'lib/zuora_rest_client/client.rb', line 1849

def get_summary_journal_entry(journal_entry_number, zuora_version = nil)
  @connection.rest_get("/journal-entries/#{journal_entry_number}", zuora_version)
end

#get_taxation_item(taxation_item_id, zuora_version = nil) ⇒ `Object`

Taxation Item                                                             #
                                                                          #



1871
1872
1873

# File 'lib/zuora_rest_client/client.rb', line 1871

def get_taxation_item(taxation_item_id, zuora_version = nil)
  @connection.rest_get("/taxationitems/#{taxation_item_id}", zuora_version)
end

#get_usage(account_key, query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1962

def get_usage(account_key, query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse("/usage/accounts/#{account_key}")
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

#hmac_signature(request, zuora_version = nil) ⇒ `Object`

HMAC Signatures                                                           #
                                                                          #



848
849
850

# File 'lib/zuora_rest_client/client.rb', line 848

def hmac_signature(request, zuora_version = nil)
  @connection.rest_post('/hmac-signatures', request, zuora_version)
end

#initiate_entity_connection(request, zuora_version = nil) ⇒ `Object`



726
727
728

# File 'lib/zuora_rest_client/client.rb', line 726

def initiate_entity_connection(request, zuora_version = nil)
  @connection.rest_post('/entity-connections', request, zuora_version)
end

#invoice_and_collect(request, zuora_version = nil) ⇒ `Object`

Operations                                                                #
                                                                          #



1117
1118
1119

# File 'lib/zuora_rest_client/client.rb', line 1117

def invoice_and_collect(request, zuora_version = nil)
  @connection.rest_post('/operations/invoice-collect', request, zuora_version)
end

#pending_close_accounting_period(accounting_period_id, zuora_version = nil) ⇒ `Object`



126
127
128

# File 'lib/zuora_rest_client/client.rb', line 126

def pending_close_accounting_period(accounting_period_id, zuora_version = nil)
  @connection.rest_put("/accounting-periods/#{accounting_period_id}/pending-close", nil, zuora_version)
end

#perform_mass_action(source_filename_or_io, source_content_type, params_hash, zuora_version = nil) ⇒ `Object`

Mass Updater                                                              #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 1070

def perform_mass_action(source_filename_or_io, source_content_type, params_hash, zuora_version = nil)
  payload = { file: Faraday::UploadIO(source_filename_or_io, source_content_type), params: params_hash }
  @connection.rest_post('/bulk', payload, zuora_version, false)
end

#post_credit_memo(credit_memo_id, zuora_version = nil) ⇒ `Object`



449
450
451

# File 'lib/zuora_rest_client/client.rb', line 449

def post_credit_memo(credit_memo_id, zuora_version = nil)
  @connection.rest_post("/creditmemos/#{credit_memo_id}/post", nil, zuora_version)
end

#post_debit_memo(debit_memo_id, zuora_version = nil) ⇒ `Object`



595
596
597

# File 'lib/zuora_rest_client/client.rb', line 595

def post_debit_memo(debit_memo_id, zuora_version = nil)
  @connection.rest_post("/debitmemos/#{debit_memo_id}/post", nil, zuora_version)
end

#post_usage(source_filename_or_io, source_content_type, zuora_version = nil) ⇒ `Object`

Usage                                                                     #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 1957

def post_usage(source_filename_or_io, source_content_type, zuora_version = nil)
  payload = { file: Faraday::UploadIO(source_filename_or_io, source_content_type) }
  @connection.rest_post('/usage', payload, zuora_version, false)
end

#preview_subscription(request, zuora_version = nil) ⇒ `Object`

Subscriptions                                                             #
                                                                          #



1773
1774
1775

# File 'lib/zuora_rest_client/client.rb', line 1773

def preview_subscription(request, zuora_version = nil)
  @connection.rest_post('/subscriptions/preview', request, zuora_version)
end

#provision_entity(entity_id, zuora_version = nil) ⇒ `Object`



710
711
712

# File 'lib/zuora_rest_client/client.rb', line 710

def provision_entity(entity_id, zuora_version = nil)
  @connection.rest_put("/entities/#{entity_id}/provision", nil, zuora_version)
end

#query(request, zuora_version = nil) ⇒ `Object`



64
65
66

# File 'lib/zuora_rest_client/client.rb', line 64

def query(request, zuora_version = nil)
  @connection.rest_post('/action/query', request, zuora_version)
end

#query_accounting_code(accounting_code_id, zuora_version = nil) ⇒ `Object`



108
109
110

# File 'lib/zuora_rest_client/client.rb', line 108

def query_accounting_code(accounting_code_id, zuora_version = nil)
  @connection.rest_get("/accounting-codes/#{accounting_code_id}", zuora_version)
end

#query_credit_memos_by_account(request, query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 461

def query_credit_memos_by_account(request, query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse('/creditmemos/query')
  uri.query_values = query_params
  @connection.rest_post(uri.to_s, request, zuora_version)
end

#query_more(request, zuora_version = nil) ⇒ `Object`



68
69
70

# File 'lib/zuora_rest_client/client.rb', line 68

def query_more(request, zuora_version = nil)
  @connection.rest_post('/action/queryMore', request, zuora_version)
end

#refund_credit_memo(credit_memo_id, request, zuora_version = nil) ⇒ `Object`



457
458
459

# File 'lib/zuora_rest_client/client.rb', line 457

def refund_credit_memo(credit_memo_id, request, zuora_version = nil)
  @connection.rest_post("/creditmemos/#{credit_memo_id}/refund", request, zuora_version)
end

#refund_payment(payment_id, request, zuora_version = nil) ⇒ `Object`



1255
1256
1257

# File 'lib/zuora_rest_client/client.rb', line 1255

def refund_payment(payment_id, request, zuora_version = nil)
  @connection.rest_post("/payments/#{payment_id}/refund", request, zuora_version)
end

#renew_subscription(subscription_key, request, zuora_version = nil) ⇒ `Object`



1803
1804
1805

# File 'lib/zuora_rest_client/client.rb', line 1803

def renew_subscription(subscription_key, request, zuora_version = nil)
  @connection.rest_put("/subscriptions/#{subscription_key}/renew", request, zuora_version)
end

#reopen_accounting_period(accounting_period_id, zuora_version = nil) ⇒ `Object`



152
153
154

# File 'lib/zuora_rest_client/client.rb', line 152

def reopen_accounting_period(accounting_period_id, zuora_version = nil)
  @connection.rest_put("/accounting-periods/#{accounting_period_id}/reopen", nil, zuora_version)
end

#resume_subscription(subscription_key, request, zuora_version = nil) ⇒ `Object`



1811
1812
1813

# File 'lib/zuora_rest_client/client.rb', line 1811

def resume_subscription(subscription_key, request, zuora_version = nil)
  @connection.rest_put("/subscriptions/#{subscription_key}/resume", request, zuora_version)
end

#retrieve_account_object(account_id, fields = nil, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 186

def retrieve_account_object(account_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/account/#{account_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_amendment_object(amendment_id, fields = nil, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 218

def retrieve_amendment_object(amendment_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/amendment/#{amendment_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_bill_run_object(bill_run_id, fields = nil, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 313

def retrieve_bill_run_object(bill_run_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/bill-run/#{bill_run_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_communication_profile_object(communication_profile_id, fields = nil, zuora_version = nil) ⇒ `Object`

Communication Profiles                                                    #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 381

def retrieve_communication_profile_object(communication_profile_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/communication-profile/#{communication_profile_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_contact_object(contact_id, fields = nil, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 401

def retrieve_contact_object(contact_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/contact/#{contact_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get("/object/contact/#{contact_id}", zuora_version)
end

#retrieve_credit_balance_adjustment_object(credit_balance_adjustment_id, fields = nil, zuora_version = nil) ⇒ `Object`

Credit Balance Adjustments                                                #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 421

def retrieve_credit_balance_adjustment_object(credit_balance_adjustment_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/credit-balance-adjustment/#{credit_balance_adjustment_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_export_object(export_id, fields = nil, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 752

def retrieve_export_object(export_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/export/#{export_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_feature_object(feature_id, fields = nil, zuora_version = nil) ⇒ `Object`

Features                                                                  #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 822

def retrieve_feature_object(feature_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/feature/#{feature_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_import_object(import_id, fields = nil, zuora_version = nil) ⇒ `Object`

Imports                                                                   #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 870

def retrieve_import_object(import_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/import/#{import_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_invoice_adjustment_object(invoice_adjustment_id, fields = nil, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 890

def retrieve_invoice_adjustment_object(invoice_adjustment_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/invoice-adjustment/#{invoice_adjustment_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_invoice_item_adjustment_object(invoice_item_adjustment_id, fields = nil, zuora_version = nil) ⇒ `Object`

Invoice Item Adjustments                                                  #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 910

def retrieve_invoice_item_adjustment_object(invoice_item_adjustment_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/invoice-item-adjustment/#{invoice_item_adjustment_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_invoice_item_object(invoice_item_id, fields = nil, zuora_version = nil) ⇒ `Object`

Invoice Items                                                             #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 926

def retrieve_invoice_item_object(invoice_item_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/invoice-item/#{invoice_item_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_invoice_object(invoice_id, fields = nil, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1006

def retrieve_invoice_object(invoice_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/invoice/#{invoice_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_invoice_payment_object(invoice_payment_id, fields = nil, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 946

def retrieve_invoice_payment_object(invoice_payment_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/invoice-payment/#{invoice_payment_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_invoice_split_item_object(invoice_split_item_id, fields = nil, zuora_version = nil) ⇒ `Object`

Invoice Split Items                                                       #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 966

def retrieve_invoice_split_item_object(invoice_split_item_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/invoice-split-item/#{invoice_split_item_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_invoice_split_object(invoice_split_id, fields = nil, zuora_version = nil) ⇒ `Object`

Invoice Splits                                                            #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 982

def retrieve_invoice_split_object(invoice_split_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/invoice-split/#{invoice_split_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_payment_method_object(payment_method_id, fields = nil, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1199

def retrieve_payment_method_object(payment_method_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/payment-method/#{payment_method_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_payment_method_snapshot_object(payment_method_snapshot_id, fields = nil, zuora_version = nil) ⇒ `Object`

Payment Method Snapshots                                                  #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 1141

def retrieve_payment_method_snapshot_object(payment_method_snapshot_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/payment-method-snapshot/#{payment_method_snapshot_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_payment_method_transaction_log_object(payment_method_transaction_log_id, fields = nil, zuora_version = nil) ⇒ `Object`

Payment Method Transaction Logs                                           #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 1157

def retrieve_payment_method_transaction_log_object(payment_method_transaction_log_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/payment-method-transaction-log/#{payment_method_transaction_log_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_payment_object(payment_id, fields = nil, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1301

def retrieve_payment_object(payment_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/payment/#{payment_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_payment_transaction_log_object(payment_transaction_log_id, fields = nil, zuora_version = nil) ⇒ `Object`

Payment Transaction Logs                                                  #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 1219

def retrieve_payment_transaction_log_object(payment_transaction_log_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/payment-transaction-log/#{payment_transaction_log_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_product_feature_object(product_feature_id, fields = nil, zuora_version = nil) ⇒ `Object`

Product Features                                                          #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 1321

def retrieve_product_feature_object(product_feature_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/product-feature/#{product_feature_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_product_object(product_id, fields = nil, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1403

def retrieve_product_object(product_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/product/#{product_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_product_rate_plan_charge_object(product_rate_plan_charge_id, fields = nil, zuora_version = nil) ⇒ `Object`

Product Rate Plan Charges                                                 #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 1353

def retrieve_product_rate_plan_charge_object(product_rate_plan_charge_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/product-rate-plan-charge/#{product_rate_plan_charge_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_product_rate_plan_charge_tier_object(product_rate_plan_charge_tier_id, fields = nil, zuora_version = nil) ⇒ `Object`

Product Rate Plan Charge Tiers                                            #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 1337

def retrieve_product_rate_plan_charge_tier_object(product_rate_plan_charge_tier_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/product-rate-plan-charge-tier/#{product_rate_plan_charge_tier_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_product_rate_plan_object(product_rate_plan_id, fields = nil, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1379

def retrieve_product_rate_plan_object(product_rate_plan_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/product-rate-plan/#{product_rate_plan_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_rate_plan_charge_object(rate_plan_charge_id, fields = nil, zuora_version = nil) ⇒ `Object`

Rate Plan Charges                                                         #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 1449

def retrieve_rate_plan_charge_object(rate_plan_charge_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/rate-plan-charge/#{rate_plan_charge_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_rate_plan_charge_tier_object(rate_plan_charge_tier_id, fields = nil, zuora_version = nil) ⇒ `Object`

Rate Plan Charge Tiers                                                    #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 1433

def retrieve_rate_plan_charge_tier_object(rate_plan_charge_tier_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/rate-plan-charge-tier/#{rate_plan_charge_tier_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_rate_plan_object(rate_plan_id, fields = nil, zuora_version = nil) ⇒ `Object`

Rate Plans                                                                #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 1465

def retrieve_rate_plan_object(rate_plan_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/rate-plan/#{rate_plan_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_refund_invoice_payment_object(refund_invoice_payment_id, fields = nil, zuora_version = nil) ⇒ `Object`

Refund Invoice Payments                                                   #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 1481

def retrieve_refund_invoice_payment_object(refund_invoice_payment_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/refund-invoice-payment/#{refund_invoice_payment_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_refund_object(refund_id, fields = nil, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1557

def retrieve_refund_object(refund_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/refund/#{refund_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_refund_transaction_log_object(refund_transaction_log_id, fields = nil, zuora_version = nil) ⇒ `Object`

Refund Transaction Logs                                                   #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 1497

def retrieve_refund_transaction_log_object(refund_transaction_log_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/refund-transaction-log/#{refund_transaction_log_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_subscription_object(subscription_id, fields = nil, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1819

def retrieve_subscription_object(subscription_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/subscription/#{subscription_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get("/object/subscription/#{subscription_id}", zuora_version)
end

#retrieve_subscription_product_feature_object(subscription_product_feature_id, fields = nil, zuora_version = nil) ⇒ `Object`

Subscription Product Features                                             #
                                                                          #

# File 'lib/zuora_rest_client/client.rb', line 1757

def retrieve_subscription_product_feature_object(subscription_product_feature_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/subscription-product-feature/#{subscription_product_feature_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_taxation_item_object(taxation_item_id, fields = nil, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1895

def retrieve_taxation_item_object(taxation_item_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/taxation-item/#{taxation_item_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_unit_of_measure_object(unit_of_measure_id, fields = nil, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1937

def retrieve_unit_of_measure_object(unit_of_measure_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/unit-of-measure/#{unit_of_measure_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#retrieve_usage_object(usage_id, fields = nil, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 1972

def retrieve_usage_object(usage_id, fields = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/object/usage/#{usage_id}")
  uri.query_values = { fields: fields.to_s } if !fields.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end

#reverse_invoice(invoice_id, zuora_version = nil) ⇒ `Object`

Invoices                                                                  #
                                                                          #



998
999
1000

# File 'lib/zuora_rest_client/client.rb', line 998

def reverse_invoice(invoice_id, zuora_version = nil)
  @connection.rest_put("/invoices/#{invoice_id}/reverse", nil, zuora_version)
end

#run_trial_balance_on_accounting_period(accounting_period_id, zuora_version = nil) ⇒ `Object`



156
157
158

# File 'lib/zuora_rest_client/client.rb', line 156

def run_trial_balance_on_accounting_period(accounting_period_id, zuora_version = nil)
  @connection.rest_put("/accounting-periods/#{accounting_period_id}/run-trial_balance", nil, zuora_version)
end

#send_user_access_request(username, request, zuora_version = nil) ⇒ `Object`

Users                                                                     #
                                                                          #



1992
1993
1994

# File 'lib/zuora_rest_client/client.rb', line 1992

def send_user_access_request(username, request, zuora_version = nil)
  @connection.rest_put("/users/#{username}/request-access", request, zuora_version)
end

#share_product_with_entities(product_id, request, zuora_version = nil) ⇒ `Object`



357
358
359

# File 'lib/zuora_rest_client/client.rb', line 357

def share_product_with_entities(product_id, request, zuora_version = nil)
  @connection.rest_put("/catalog/products/#{product_id}/share", request, zuora_version)
end

#stop_mass_action(bulk_key, zuora_version = nil) ⇒ `Object`



1079
1080
1081

# File 'lib/zuora_rest_client/client.rb', line 1079

def stop_mass_action(bulk_key, zuora_version = nil)
  @connection.rest_put("/bulk/#{bulk_key}/stop", zuora_version)
end



72
73
74

# File 'lib/zuora_rest_client/client.rb', line 72

def subscribe(request, zuora_version = nil)
  @connection.rest_post('/action/subscribe', request, zuora_version)
end

#suspend_subscription(subscription_key, request, zuora_version = nil) ⇒ `Object`



1815
1816
1817

# File 'lib/zuora_rest_client/client.rb', line 1815

def suspend_subscription(subscription_key, request, zuora_version = nil)
  @connection.rest_put("/subscriptions/#{subscription_key}/suspend", request, zuora_version)
end

#transfer_payment(payment_id, request, zuora_version = nil) ⇒ `Object`



1277
1278
1279

# File 'lib/zuora_rest_client/client.rb', line 1277

def transfer_payment(payment_id, request, zuora_version = nil)
  @connection.rest_post("/payments/#{payment_id}/accounts", request, zuora_version)
end

#unapply_credit_memo(credit_memo_id, zuora_version = nil) ⇒ `Object`



489
490
491

# File 'lib/zuora_rest_client/client.rb', line 489

def unapply_credit_memo(credit_memo_id, zuora_version = nil)
  @connection.rest_post("/creditmemos/#{credit_memo_id}/unapply", request, zuora_version)
end

#unapply_payment(payment_id, request, zuora_version = nil) ⇒ `Object`

Payments                                                                  #
                                                                          #



1235
1236
1237

# File 'lib/zuora_rest_client/client.rb', line 1235

def unapply_payment(payment_id, request, zuora_version = nil)
  @connection.rest_post("/payments/#{payment_id}/unapply", request, zuora_version)
end

#update(request, zuora_version = nil) ⇒ `Object`



76
77
78

# File 'lib/zuora_rest_client/client.rb', line 76

def update(request, zuora_version = nil)
  @connection.rest_post('/action/update', request, zuora_version)
end

#update_account(account_key, request, zuora_version = nil) ⇒ `Object`



174
175
176

# File 'lib/zuora_rest_client/client.rb', line 174

def update_account(account_key, request, zuora_version = nil)
  @connection.rest_put("/accounts/#{account_key}", request, zuora_version)
end

#update_account_object(account_id, request, zuora_version = nil) ⇒ `Object`



192
193
194

# File 'lib/zuora_rest_client/client.rb', line 192

def update_account_object(account_id, request, zuora_version = nil)
  @connection.rest_put("/object/account/#{account_id}", request, zuora_version)
end

#update_accounting_code(accounting_code_id, request, zuora_version = nil) ⇒ `Object`



112
113
114

# File 'lib/zuora_rest_client/client.rb', line 112

def update_accounting_code(accounting_code_id, request, zuora_version = nil)
  @connection.rest_put("/accounting-codes/#{accounting_code_id}", request, zuora_version)
end

#update_accounting_period(accounting_period_id, request, zuora_version = nil) ⇒ `Object`



144
145
146

# File 'lib/zuora_rest_client/client.rb', line 144

def update_accounting_period(accounting_period_id, request, zuora_version = nil)
  @connection.rest_put("/accounting-periods/#{accounting_period_id}", request, zuora_version)
end

#update_amendment_object(amendment_id, request, zuora_version = nil) ⇒ `Object`



224
225
226

# File 'lib/zuora_rest_client/client.rb', line 224

def update_amendment_object(amendment_id, request, zuora_version = nil)
  @connection.rest_put("/object/amendment/#{amendment_id}", request, zuora_version)
end

#update_bill_run_object(bill_run_id, request, zuora_version = nil) ⇒ `Object`



319
320
321

# File 'lib/zuora_rest_client/client.rb', line 319

def update_bill_run_object(bill_run_id, request, zuora_version = nil)
  @connection.rest_put("/object/bill-run/#{bill_run_id}", request, zuora_version)
end

#update_contact_object(contact_id, request, zuora_version = nil) ⇒ `Object`



407
408
409

# File 'lib/zuora_rest_client/client.rb', line 407

def update_contact_object(contact_id, request, zuora_version = nil)
  @connection.rest_put("/object/contact/#{contact_id}", request, zuora_version)
end

#update_credit_memo(credit_memo_id, request, zuora_version = nil) ⇒ `Object`



445
446
447

# File 'lib/zuora_rest_client/client.rb', line 445

def update_credit_memo(credit_memo_id, request, zuora_version = nil)
  @connection.rest_put("/creditmemos/#{credit_memo_id}", request, zuora_version)
end

#update_debit_memo(debit_memo_id, request, zuora_version = nil) ⇒ `Object`



591
592
593

# File 'lib/zuora_rest_client/client.rb', line 591

def update_debit_memo(debit_memo_id, request, zuora_version = nil)
  @connection.rest_put("/debitmemos/#{debit_memo_id}", request, zuora_version)
end

#update_entity(entity_id, request, zuora_version = nil) ⇒ `Object`



698
699
700

# File 'lib/zuora_rest_client/client.rb', line 698

def update_entity(entity_id, request, zuora_version = nil)
  @connection.rest_put("/entities/#{entity_id}", request, zuora_version)
end

#update_invoice_adjustment_object(invoice_adjustment_id, request, zuora_version = nil) ⇒ `Object`



896
897
898

# File 'lib/zuora_rest_client/client.rb', line 896

def update_invoice_adjustment_object(invoice_adjustment_id, request, zuora_version = nil)
  @connection.rest_put("/object/invoice-adjustment/#{invoice_adjustment_id}", request, zuora_version)
end

#update_invoice_object(invoice_id, request, zuora_version = nil) ⇒ `Object`



1012
1013
1014

# File 'lib/zuora_rest_client/client.rb', line 1012

def update_invoice_object(invoice_id, request, zuora_version = nil)
  @connection.rest_put("/object/invoice/#{invoice_id}", request, zuora_version)
end

#update_invoice_payment_object(invoice_payment_id, request, zuora_version = nil) ⇒ `Object`



952
953
954

# File 'lib/zuora_rest_client/client.rb', line 952

def update_invoice_payment_object(invoice_payment_id, request, zuora_version = nil)
  @connection.rest_put("/object/invoice-payment/#{invoice_payment_id}", request, zuora_version)
end

#update_payment(payment_id, request, zuora_version = nil) ⇒ `Object`



1293
1294
1295

# File 'lib/zuora_rest_client/client.rb', line 1293

def update_payment(payment_id, request, zuora_version = nil)
  @connection.rest_put("/payments/#{payment_id}", request, zuora_version)
end

#update_payment_method(payment_method_id, request, zuora_version = nil) ⇒ `Object`



1183
1184
1185

# File 'lib/zuora_rest_client/client.rb', line 1183

def update_payment_method(payment_method_id, request, zuora_version = nil)
  @connection.rest_put("/payment-methods/credit-cards/#{payment_method_id}", request, zuora_version)
end

#update_payment_method_object(payment_method_id, request, zuora_version = nil) ⇒ `Object`



1205
1206
1207

# File 'lib/zuora_rest_client/client.rb', line 1205

def update_payment_method_object(payment_method_id, request, zuora_version = nil)
  @connection.rest_put("/object/payment-method/#{payment_method_id}", request, zuora_version)
end

#update_payment_object(payment_id, request, zuora_version = nil) ⇒ `Object`



1307
1308
1309

# File 'lib/zuora_rest_client/client.rb', line 1307

def update_payment_object(payment_id, request, zuora_version = nil)
  @connection.rest_put("/object/payment/#{payment_id}", request, zuora_version)
end

#update_product_object(product_id, request, zuora_version = nil) ⇒ `Object`



1409
1410
1411

# File 'lib/zuora_rest_client/client.rb', line 1409

def update_product_object(product_id, request, zuora_version = nil)
  @connection.rest_put("/object/product/#{product_id}", request, zuora_version)
end

#update_product_rate_plan_object(product_rate_plan_id, request, zuora_version = nil) ⇒ `Object`



1385
1386
1387

# File 'lib/zuora_rest_client/client.rb', line 1385

def update_product_rate_plan_object(product_rate_plan_id, request, zuora_version = nil)
  @connection.rest_put("/object/product-rate-plan/#{product_rate_plan_id}", request, zuora_version)
end

#update_refund(refund_id, request, zuora_version = nil) ⇒ `Object`



1521
1522
1523

# File 'lib/zuora_rest_client/client.rb', line 1521

def update_refund(refund_id, request, zuora_version = nil)
  @connection.rest_put("/refunds/#{refund_id}", request, zuora_version)
end

#update_refund_object(refund_id, request, zuora_version = nil) ⇒ `Object`



1563
1564
1565

# File 'lib/zuora_rest_client/client.rb', line 1563

def update_refund_object(refund_id, request, zuora_version = nil)
  @connection.rest_put("/object/refund/#{refund_id}", request, zuora_version)
end

#update_revenue_items_by_revenue_event_number(event_number, request, zuora_version = nil) ⇒ `Object`



1605
1606
1607

# File 'lib/zuora_rest_client/client.rb', line 1605

def update_revenue_items_by_revenue_event_number(event_number, request, zuora_version = nil)
  @connection.rest_put("/revenue-items/revenue-events/#{event_number}", request, zuora_version)
end

#update_revenue_items_by_revenue_schedule(revenue_schedule_number, request, zuora_version = nil) ⇒ `Object`



1615
1616
1617

# File 'lib/zuora_rest_client/client.rb', line 1615

def update_revenue_items_by_revenue_schedule(revenue_schedule_number, request, zuora_version = nil)
  @connection.rest_put("/revenue-items/revenue-schedules/#{revenue_schedule_number}", request, zuora_version)
end

#update_revenue_schedule_basic_information(revenue_schedule_number, request, zuora_version = nil) ⇒ `Object`



1693
1694
1695

# File 'lib/zuora_rest_client/client.rb', line 1693

def update_revenue_schedule_basic_information(revenue_schedule_number, request, zuora_version = nil)
  @connection.rest_put("/revenue-schedules/#{revenue_schedule_number}/basic-information", request, zuora_version)
end

#update_subscription(subscription_key, request, zuora_version = nil) ⇒ `Object`



1787
1788
1789

# File 'lib/zuora_rest_client/client.rb', line 1787

def update_subscription(subscription_key, request, zuora_version = nil)
  @connection.rest_put("/subscriptions/#{subscription_key}", request, zuora_version)
end

#update_subscription_object(subscription_id, request, zuora_version = nil) ⇒ `Object`



1825
1826
1827

# File 'lib/zuora_rest_client/client.rb', line 1825

def update_subscription_object(subscription_id, request, zuora_version = nil)
  @connection.rest_put("/object/subscription/#{subscription_id}", request, zuora_version)
end

#update_summary_journal_entry_basic_information(journal_entry_number, request, zuora_version = nil) ⇒ `Object`



1861
1862
1863

# File 'lib/zuora_rest_client/client.rb', line 1861

def update_summary_journal_entry_basic_information(journal_entry_number, request, zuora_version = nil)
  @connection.rest_put("/journal-entries/#{journal_entry_number}/basic-information", request, zuora_version)
end

#update_taxation_item(taxation_item_id, request, zuora_version = nil) ⇒ `Object`



1879
1880
1881

# File 'lib/zuora_rest_client/client.rb', line 1879

def update_taxation_item(taxation_item_id, request, zuora_version = nil)
  @connection.rest_put("/taxationitems/#{taxation_item_id}", request, zuora_version)
end

#update_taxation_item_object(taxation_item_id, request, zuora_version = nil) ⇒ `Object`



1901
1902
1903

# File 'lib/zuora_rest_client/client.rb', line 1901

def update_taxation_item_object(taxation_item_id, request, zuora_version = nil)
  @connection.rest_put("/object/taxation-item/#{taxation_item_id}", request, zuora_version)
end

#update_unit_of_measure_object(unit_of_measure_id, request, zuora_version = nil) ⇒ `Object`



1943
1944
1945

# File 'lib/zuora_rest_client/client.rb', line 1943

def update_unit_of_measure_object(unit_of_measure_id, request, zuora_version = nil)
  @connection.rest_put("/object/unit-of-measure/#{unit_of_measure_id}", request, zuora_version)
end

#update_usage_object(usage_id, request, zuora_version = nil) ⇒ `Object`



1978
1979
1980

# File 'lib/zuora_rest_client/client.rb', line 1978

def update_usage_object(usage_id, request, zuora_version = nil)
  @connection.rest_put("/object/usage/#{usage_id}", request, zuora_version)
end

#view_attachment(attachment_id, zuora_version = nil) ⇒ `Object`



291
292
293

# File 'lib/zuora_rest_client/client.rb', line 291

def view_attachment(attachment_id, zuora_version = nil)
  @connection.rest_get("/attachments/#{attachment_id}", zuora_version)
end

#view_attachment_list(associated_object_type, associated_object_key, query_params = {}, zuora_version = nil) ⇒ `Object`

# File 'lib/zuora_rest_client/client.rb', line 285

def view_attachment_list(associated_object_type, associated_object_key, query_params = {}, zuora_version = nil)
  uri = Addressable::URI.parse("/attachments/#{associated_object_type}/#{associated_object_key}")
  uri.query_values = query_params
  @connection.rest_get(uri.to_s, zuora_version)
end

Class: ZuoraRestClient::Client

Constant Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(username, password, environment = :production, options = {}) ⇒ Client

Instance Method Details

#accept_entity_connection(entity_connection_id, zuora_version = nil) ⇒ Object

#accept_user_access(username, zuora_version = nil) ⇒ Object

#activate_accounting_code(accounting_code_id, zuora_version = nil) ⇒ Object

#add_attachment(source_filename_or_io, source_content_type, associated_object_type, associated_object_key, description = nil, zuora_version = nil) ⇒ Object

#amend(request, zuora_version = nil) ⇒ Object

#apply_credit_memo(credit_memo_id, request, zuora_version = nil) ⇒ Object

#apply_payment(payment_id, request, zuora_version = nil) ⇒ Object

#aqua_query(request, options = {}) ⇒ Object

#cancel_credit_memo(credit_memo_id, zuora_version = nil) ⇒ Object

#cancel_debit_memo(debit_memo_id, zuora_version = nil) ⇒ Object

#cancel_journal_run(journal_run_number, zuora_version = nil) ⇒ Object

#cancel_payment(payment_id, zuora_version = nil) ⇒ Object

#cancel_refund(refund_id, zuora_version = nil) ⇒ Object

#cancel_subscription(subscription_key, request, zuora_version = nil) ⇒ Object

#cancel_summary_journal_entry(journal_entry_number, zuora_version = nil) ⇒ Object

#close_accounting_period(accounting_period_id, zuora_version = nil) ⇒ Object

#create(request, zuora_version = nil) ⇒ Object

#create_account(request, zuora_version = nil) ⇒ Object

#create_account_object(request, zuora_version = nil) ⇒ Object

#create_accounting_code(request, zuora_version = nil) ⇒ Object

#create_accounting_period(request, zuora_version = nil) ⇒ Object

#create_amendment_object(request, zuora_version = nil) ⇒ Object

#create_bill_run_object(request, zuora_version = nil) ⇒ Object

#create_billing_preview(request, zuora_version = nil) ⇒ Object

#create_billing_preview_run(request, zuora_version = nil) ⇒ Object

#create_contact_object(request, zuora_version = nil) ⇒ Object

#create_credit_memo_from_charge(request, zuora_version = nil) ⇒ Object

#create_credit_memo_from_invoice(invoice_id, request, zuora_version = nil) ⇒ Object

#create_credit_memo_pdf(credit_memo_id, zuora_version = nil) ⇒ Object

#create_debit_memo_from_charge(request, zuora_version = nil) ⇒ Object

#create_debit_memo_from_invoice(invoice_id, request, zuora_version = nil) ⇒ Object

#create_debit_memo_pdf(debit_memo_id, zuora_version = nil) ⇒ Object

#create_entity(request, zuora_version = nil) ⇒ Object

#create_export_object(request, zuora_version = nil) ⇒ Object

#create_invoice_adjustment_object(request, zuora_version = nil) ⇒ Object

#create_invoice_object(request, zuora_version = nil) ⇒ Object

#create_invoice_payment_object(request, zuora_version = nil) ⇒ Object

#create_journal_run(request, zuora_version = nil) ⇒ Object

#create_payment(request, zuora_version = nil) ⇒ Object

#create_payment_method(request, zuora_version = nil) ⇒ Object

#create_payment_method_decryption(request, zuora_version = nil) ⇒ Object

#create_payment_method_object(request, zuora_version = nil) ⇒ Object

#create_payment_object(request, zuora_version = nil) ⇒ Object

#create_product_object(request, zuora_version = nil) ⇒ Object

#create_product_rate_plan_object(request, zuora_version = nil) ⇒ Object

#create_refund_object(request, zuora_version = nil) ⇒ Object

#create_revenue_schedule_for_credit_memo_item_distribute_by_date_range(credit_memo_item_id, request, zuora_version = nil) ⇒ Object

#create_revenue_schedule_for_credit_memo_item_distribute_manually(credit_memo_item_id, request, zuora_version = nil) ⇒ Object

#create_revenue_schedule_for_debit_memo_item_distribute_by_date_range(debit_memo_item_id, request, zuora_version = nil) ⇒ Object

#create_revenue_schedule_for_debit_memo_item_distribute_manually(debit_memo_item_id, request, zuora_version = nil) ⇒ Object

#create_revenue_schedule_for_invoice_item_adjustment_distribute_by_date_range(invoice_item_adjustment_id, request, zuora_version = nil) ⇒ Object

#create_revenue_schedule_for_invoice_item_adjustment_distribute_manually(invoice_item_adjustment_id, request, zuora_version = nil) ⇒ Object

#create_revenue_schedule_for_invoice_item_distribute_by_date_range(invoice_item_id, request, zuora_version = nil) ⇒ Object

#create_revenue_schedule_for_invoice_item_distribute_manually(invoice_item_id, request, zuora_version = nil) ⇒ Object

#create_revenue_schedule_on_subscription_charge(charge_id, request, zuora_version = nil) ⇒ Object

#create_subscription(request, zuora_version = nil) ⇒ Object

#create_summary_journal_entry(request, zuora_version = nil) ⇒ Object

#create_taxation_item_for_credit_memo(memo_id, request, zuora_version = nil) ⇒ Object

#create_taxation_item_for_debit_memo(memo_id, request, zuora_version = nil) ⇒ Object

#create_taxation_item_object(request, zuora_version = nil) ⇒ Object

#create_unit_of_measure_object(request, zuora_version = nil) ⇒ Object

#create_usage_object(request, zuora_version = nil) ⇒ Object

#deactivate_accounting_code(accounting_code_id, zuora_version = nil) ⇒ Object

#decrypt_rsa_signature(request, zuora_version = nil) ⇒ Object

#delete(request, zuora_version = nil) ⇒ Object

#delete_account_object(account_id, zuora_version = nil) ⇒ Object

#delete_accounting_code(accounting_code_id, zuora_version = nil) ⇒ Object

#delete_accounting_period(accounting_period_id, zuora_version = nil) ⇒ Object

#delete_amendment_object(amendment_id, zuora_version = nil) ⇒ Object

#delete_attachment(attachment_id, zuora_version = nil) ⇒ Object

#delete_bill_run_object(bill_run_id, zuora_version = nil) ⇒ Object

#delete_communication_profile_object(communication_profile_id, zuora_version = nil) ⇒ Object

#delete_contact_object(contact_id, zuora_version = nil) ⇒ Object

#delete_credit_balance_adjustment_object(credit_balance_adjustment_id, zuora_version = nil) ⇒ Object

#initialize(username, password, environment = :production, options = {}) ⇒ `Client`

#accept_entity_connection(entity_connection_id, zuora_version = nil) ⇒ `Object`

#accept_user_access(username, zuora_version = nil) ⇒ `Object`

#activate_accounting_code(accounting_code_id, zuora_version = nil) ⇒ `Object`

#add_attachment(source_filename_or_io, source_content_type, associated_object_type, associated_object_key, description = nil, zuora_version = nil) ⇒ `Object`

#amend(request, zuora_version = nil) ⇒ `Object`

#apply_credit_memo(credit_memo_id, request, zuora_version = nil) ⇒ `Object`

#apply_payment(payment_id, request, zuora_version = nil) ⇒ `Object`

#aqua_query(request, options = {}) ⇒ `Object`

#cancel_credit_memo(credit_memo_id, zuora_version = nil) ⇒ `Object`

#cancel_debit_memo(debit_memo_id, zuora_version = nil) ⇒ `Object`

#cancel_journal_run(journal_run_number, zuora_version = nil) ⇒ `Object`

#cancel_payment(payment_id, zuora_version = nil) ⇒ `Object`

#cancel_refund(refund_id, zuora_version = nil) ⇒ `Object`

#cancel_subscription(subscription_key, request, zuora_version = nil) ⇒ `Object`

#cancel_summary_journal_entry(journal_entry_number, zuora_version = nil) ⇒ `Object`

#close_accounting_period(accounting_period_id, zuora_version = nil) ⇒ `Object`

#create(request, zuora_version = nil) ⇒ `Object`

#create_account(request, zuora_version = nil) ⇒ `Object`

#create_account_object(request, zuora_version = nil) ⇒ `Object`

#create_accounting_code(request, zuora_version = nil) ⇒ `Object`

#create_accounting_period(request, zuora_version = nil) ⇒ `Object`

#create_amendment_object(request, zuora_version = nil) ⇒ `Object`

#create_bill_run_object(request, zuora_version = nil) ⇒ `Object`

#create_billing_preview(request, zuora_version = nil) ⇒ `Object`

#create_billing_preview_run(request, zuora_version = nil) ⇒ `Object`

#create_contact_object(request, zuora_version = nil) ⇒ `Object`

#create_credit_memo_from_charge(request, zuora_version = nil) ⇒ `Object`

#create_credit_memo_from_invoice(invoice_id, request, zuora_version = nil) ⇒ `Object`

#create_credit_memo_pdf(credit_memo_id, zuora_version = nil) ⇒ `Object`

#create_debit_memo_from_charge(request, zuora_version = nil) ⇒ `Object`

#create_debit_memo_from_invoice(invoice_id, request, zuora_version = nil) ⇒ `Object`

#create_debit_memo_pdf(debit_memo_id, zuora_version = nil) ⇒ `Object`

#create_entity(request, zuora_version = nil) ⇒ `Object`

#create_export_object(request, zuora_version = nil) ⇒ `Object`

#create_invoice_adjustment_object(request, zuora_version = nil) ⇒ `Object`

#create_invoice_object(request, zuora_version = nil) ⇒ `Object`

#create_invoice_payment_object(request, zuora_version = nil) ⇒ `Object`

#create_journal_run(request, zuora_version = nil) ⇒ `Object`

#create_payment(request, zuora_version = nil) ⇒ `Object`

#create_payment_method(request, zuora_version = nil) ⇒ `Object`

#create_payment_method_decryption(request, zuora_version = nil) ⇒ `Object`

#create_payment_method_object(request, zuora_version = nil) ⇒ `Object`

#create_payment_object(request, zuora_version = nil) ⇒ `Object`

#create_product_object(request, zuora_version = nil) ⇒ `Object`

#create_product_rate_plan_object(request, zuora_version = nil) ⇒ `Object`

#create_refund_object(request, zuora_version = nil) ⇒ `Object`

#create_revenue_schedule_for_credit_memo_item_distribute_by_date_range(credit_memo_item_id, request, zuora_version = nil) ⇒ `Object`

#create_revenue_schedule_for_credit_memo_item_distribute_manually(credit_memo_item_id, request, zuora_version = nil) ⇒ `Object`

#create_revenue_schedule_for_debit_memo_item_distribute_by_date_range(debit_memo_item_id, request, zuora_version = nil) ⇒ `Object`

#create_revenue_schedule_for_debit_memo_item_distribute_manually(debit_memo_item_id, request, zuora_version = nil) ⇒ `Object`

#create_revenue_schedule_for_invoice_item_adjustment_distribute_by_date_range(invoice_item_adjustment_id, request, zuora_version = nil) ⇒ `Object`

#create_revenue_schedule_for_invoice_item_adjustment_distribute_manually(invoice_item_adjustment_id, request, zuora_version = nil) ⇒ `Object`

#create_revenue_schedule_for_invoice_item_distribute_by_date_range(invoice_item_id, request, zuora_version = nil) ⇒ `Object`

#create_revenue_schedule_for_invoice_item_distribute_manually(invoice_item_id, request, zuora_version = nil) ⇒ `Object`

#create_revenue_schedule_on_subscription_charge(charge_id, request, zuora_version = nil) ⇒ `Object`

#create_subscription(request, zuora_version = nil) ⇒ `Object`

#create_summary_journal_entry(request, zuora_version = nil) ⇒ `Object`

#create_taxation_item_for_credit_memo(memo_id, request, zuora_version = nil) ⇒ `Object`

#create_taxation_item_for_debit_memo(memo_id, request, zuora_version = nil) ⇒ `Object`

#create_taxation_item_object(request, zuora_version = nil) ⇒ `Object`

#create_unit_of_measure_object(request, zuora_version = nil) ⇒ `Object`

#create_usage_object(request, zuora_version = nil) ⇒ `Object`

#deactivate_accounting_code(accounting_code_id, zuora_version = nil) ⇒ `Object`

#decrypt_rsa_signature(request, zuora_version = nil) ⇒ `Object`

#delete(request, zuora_version = nil) ⇒ `Object`

#delete_account_object(account_id, zuora_version = nil) ⇒ `Object`

#delete_accounting_code(accounting_code_id, zuora_version = nil) ⇒ `Object`

#delete_accounting_period(accounting_period_id, zuora_version = nil) ⇒ `Object`

#delete_amendment_object(amendment_id, zuora_version = nil) ⇒ `Object`

#delete_attachment(attachment_id, zuora_version = nil) ⇒ `Object`

#delete_bill_run_object(bill_run_id, zuora_version = nil) ⇒ `Object`

#delete_communication_profile_object(communication_profile_id, zuora_version = nil) ⇒ `Object`

#delete_contact_object(contact_id, zuora_version = nil) ⇒ `Object`

#delete_credit_balance_adjustment_object(credit_balance_adjustment_id, zuora_version = nil) ⇒ `Object`

#delete_credit_memo(credit_memo_id, zuora_version = nil) ⇒ `Object`

#delete_debit_memo(debit_memo_id, zuora_version = nil) ⇒ `Object`

#delete_entity(entity_id, zuora_version = nil) ⇒ `Object`

#delete_export_object(export_id, zuora_version = nil) ⇒ `Object`

#delete_feature_object(feature_id, zuora_version = nil) ⇒ `Object`