class ZuoraRestClient::Client

Constants

DEFAULT_AQUA_QUERY_OPTIONS
DEFAULT_CLIENT_OPTIONS
DEFAULT_EXPORT_OPTIONS

Attributes

connection[R]

Public Class Methods

new(username, password, environment = :production, options = {}) click to toggle source
# File lib/zuora_rest_client/client.rb, line 35
def initialize(username, password, environment = :production, options = {})
  @client_options = {}.merge(DEFAULT_CLIENT_OPTIONS).merge(options)
  @connection = ZuoraRestClient::Connection.new(username, password, environment, options)
end

Public Instance Methods

accept_entity_connection(entity_connection_id, zuora_version = nil) click to toggle source
# File lib/zuora_rest_client/client.rb, line 732
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 2004
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 98
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) click to toggle source
#

Attachments #

#
# File lib/zuora_rest_client/client.rb, line 278
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) click to toggle source
#

Actions #

#
# File lib/zuora_rest_client/client.rb, line 46
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 475
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1259
def apply_payment(payment_id, request, zuora_version = nil)
  @connection.rest_post("/payments/#{payment_id}/apply", request, zuora_version)
end
aqua_query(request, options = {}) click to toggle source
#

AQuA #

#
# File lib/zuora_rest_client/client.rb, line 240
def aqua_query(request, options = {})
  aqua_query_options = {}.merge(DEFAULT_AQUA_QUERY_OPTIONS).merge(options)
  result = @connection.rest_post('/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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 517
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 581
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1068
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1289
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1557
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1815
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1865
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) click to toggle source
#

Accounting Periods #

#
# File lib/zuora_rest_client/client.rb, line 124
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 50
def create(request, zuora_version = nil)
  @connection.rest_post('/action/create', request, zuora_version)
end
create_account(request, zuora_version = nil) click to toggle source
#

Accounts #

#
# File lib/zuora_rest_client/client.rb, line 168
def create_account(request, zuora_version = nil)
  @connection.rest_post('/accounts', request, zuora_version)
end
create_account_object(request, zuora_version = nil) click to toggle source
# File lib/zuora_rest_client/client.rb, line 184
def create_account_object(request, zuora_version = nil)
  @connection.rest_post('/object/account', request, zuora_version)
end
create_accounting_code(request, zuora_version = nil) click to toggle source
#

Accounting Codes #

#
# File lib/zuora_rest_client/client.rb, line 88
def create_accounting_code(request, zuora_version = nil)
  @connection.rest_post('/accounting-codes', request, zuora_version)
end
create_accounting_period(request, zuora_version = nil) click to toggle source
# File lib/zuora_rest_client/client.rb, line 132
def create_accounting_period(request, zuora_version = nil)
  @connection.rest_post('/accounting-periods', request, zuora_version)
end
create_amendment_object(request, zuora_version = nil) click to toggle source
# File lib/zuora_rest_client/client.rb, line 216
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) click to toggle source
#

Bill Run #

#
# File lib/zuora_rest_client/client.rb, line 311
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1129
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) click to toggle source
#

Billing Preview Run #

#
# File lib/zuora_rest_client/client.rb, line 335
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) click to toggle source
#

Contacts #

#
# File lib/zuora_rest_client/client.rb, line 399
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 503
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 495
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 521
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 561
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 557
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 571
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) click to toggle source
#

Entities #

#
# File lib/zuora_rest_client/client.rb, line 690
def create_entity(request, zuora_version = nil)
  @connection.rest_post('/entities', request, zuora_version)
end
create_export_object(request, zuora_version = nil) click to toggle source
#

Exports #

#
# File lib/zuora_rest_client/client.rb, line 750
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) click to toggle source
#

Invoice Adjustments #

#
# File lib/zuora_rest_client/client.rb, line 888
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1010
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) click to toggle source
#

Invoice Payments #

#
# File lib/zuora_rest_client/client.rb, line 944
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) click to toggle source
#

Journal Runs #

#
# File lib/zuora_rest_client/client.rb, line 1056
def create_journal_run(request, zuora_version = nil)
  @connection.rest_post('/journal-runs', request, zuora_version)
end
create_payment(request, zuora_version = nil) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1267
def create_payment(request, zuora_version = nil)
  @connection.rest_post('/payments', request, zuora_version)
end
create_payment_method(request, zuora_version = nil) click to toggle source
#

Payment Method #

#
# File lib/zuora_rest_client/client.rb, line 1181
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1199
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1203
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1305
def create_payment_object(request, zuora_version = nil)
  @connection.rest_post('/object/payment', request, zuora_version)
end
create_product_object(request, zuora_version = nil) click to toggle source
#

Products #

#
# File lib/zuora_rest_client/client.rb, line 1407
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1383
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1561
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1705
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1713
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1709
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1721
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1659
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1663
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) click to toggle source
#

Revenue Schedules #

#
# File lib/zuora_rest_client/client.rb, line 1647
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1651
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1667
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1785
def create_subscription(request, zuora_version = nil)
  @connection.rest_post('/subscriptions', request, zuora_version)
end
create_summary_journal_entry(request, zuora_version = nil) click to toggle source
#

Summary Journal Entries #

#
# File lib/zuora_rest_client/client.rb, line 1847
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1891
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1895
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1899
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) click to toggle source
#

Unit of Measure #

#
# File lib/zuora_rest_client/client.rb, line 1941
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1976
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 102
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1745
def decrypt_rsa_signature(request, zuora_version = nil)
  @connection.rest_post('/rsa-signatures/decrypt', request, zuora_version)
end
delete(request, zuora_version = nil) click to toggle source
# File lib/zuora_rest_client/client.rb, line 54
def delete(request, zuora_version = nil)
  @connection.rest_post('/action/delete', request, zuora_version)
end
delete_account_object(account_id, zuora_version = nil) click to toggle source
# File lib/zuora_rest_client/client.rb, line 198
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 106
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 150
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 230
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 301
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 325
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 389
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 413
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 429
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 443
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 589
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 708
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 760
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 830
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 878
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 902
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 918
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 934
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1024
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 958
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 974
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 990
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1064
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1297
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1195
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1217
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1155
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1171
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1319
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1233
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1335
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1421
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1367
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1351
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1397
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1463
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1447
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1479
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1525
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1495
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1575
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1511
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1689
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1837
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1771
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1861
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1883
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1913
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1955
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1990
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 736
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 2008
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 633
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) click to toggle source
#

Describe #

#
# File lib/zuora_rest_client/client.rb, line 607
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
disconnect_entity_connection(entity_connection_id, zuora_version = nil) click to toggle source
# File lib/zuora_rest_client/client.rb, line 740
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1677
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1685
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1681
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 297
def edit_attachment(attachment_id, request, zuora_version = nil)
  @connection.rest_put("/attachments/#{attachment_id}", request, zuora_version)
end
execute(request, zuora_version = nil) click to toggle source
# File lib/zuora_rest_client/client.rb, line 58
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 764
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 62
def generate(request, zuora_version = nil)
  @connection.rest_post('/action/generate', request, zuora_version)
end
generate_oauth_token(request, zuora_version = nil) click to toggle source
#

OAuth #

#
# File lib/zuora_rest_client/client.rb, line 1115
def generate_oauth_token(request, zuora_version = nil)
  @connection.rest_post('/oauth/token', request, zuora_version)
end
generate_quote_document(request, zuora_version = nil) click to toggle source
#

Quotes Document #

#
# File lib/zuora_rest_client/client.rb, line 1431
def generate_quote_document(request, zuora_version = nil)
  @connection.rest_post('/quotes/document', request, zuora_version)
end
generate_rsa_signature(request, zuora_version = nil) click to toggle source
#

RSA Signatures #

#
# File lib/zuora_rest_client/client.rb, line 1741
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 2012
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 172
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 180
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 142
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 92
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 136
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1271
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1539
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1729
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1851
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) click to toggle source
#

Amendments #

#
# File lib/zuora_rest_client/client.rb, line 208
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 212
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 264
def get_aqua_job_result(job_id)
  @connection.rest_get("/batch-query/jobs/#{job_id}")
end
get_billing_preview_run(billing_preview_run_id, zuora_version = nil) click to toggle source
# File lib/zuora_rest_client/client.rb, line 339
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) click to toggle source
#

Notification History #

#
# File lib/zuora_rest_client/client.rb, line 1097
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 373
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) click to toggle source
#

Charge Revenue Summaries #

#
# File lib/zuora_rest_client/client.rb, line 369
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) click to toggle source
#

Credit Memos #

#
# File lib/zuora_rest_client/client.rb, line 439
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 455
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 479
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 513
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 499
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 485
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 469
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 507
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) click to toggle source
#

Custom Exchange Rates #

#
# File lib/zuora_rest_client/client.rb, line 531
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 585
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) click to toggle source
#

Debit Memos #

#
# File lib/zuora_rest_client/client.rb, line 553
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 575
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 565
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1103
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 694
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 704
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) click to toggle source
#

Entity Connections #

#
# File lib/zuora_rest_client/client.rb, line 722
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) click to toggle source
#

Get Files #

#
# File lib/zuora_rest_client/client.rb, line 840
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) click to toggle source
#

Hosted Pages #

#
# File lib/zuora_rest_client/client.rb, line 860
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_files(invoice_id, page_size = nil, zuora_version = nil) click to toggle source
#

Invoices #

#
# File lib/zuora_rest_client/client.rb, line 1000
def get_invoice_files(invoice_id, page_size = nil, zuora_version = nil)
  uri = Addressable::URI.parse("/invoices/#{invoice_id}/files")
  uri.query_values = { pageSize: page_size.to_s } if !page_size.nil?
  @connection.rest_get(uri.to_s, zuora_version)
end
get_invoice_pdf_by(identifying_field_sym, identifier, destination_io) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1028
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) click to toggle source
#

Transactions #

#
# File lib/zuora_rest_client/client.rb, line 1923
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1060
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 268
def get_last_aqua_job_result(partner, project)
  @connection.rest_get("/batch-query/jobs/partner/#{partner}/project/#{project}")
end
get_mass_action_result(bulk_key, zuora_version = nil) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1083
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1293
def get_payment(payment_id, zuora_version = nil)
  @connection.rest_get("/payments/#{payment_id}", zuora_version)
end
get_payment_gateways(zuora_version = nil) click to toggle source
#

Payment Gateways #

#
# File lib/zuora_rest_client/client.rb, line 1139
def get_payment_gateways(zuora_version = nil)
  @connection.rest_get('/paymentgateways', zuora_version)
end
get_payment_methods(account_key, query_params = {}, zuora_version = nil) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1185
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1277
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1281
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1253
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1247
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1929
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 355
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) click to toggle source
#

Catalog #

#
# File lib/zuora_rest_client/client.rb, line 349
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) click to toggle source
#

Product Rate Plans #

#
# File lib/zuora_rest_client/client.rb, line 1377
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) click to toggle source
#

Refunds #

#
# File lib/zuora_rest_client/client.rb, line 1521
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1549
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1553
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1533
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1545
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) click to toggle source
#

Settings #

#
# File lib/zuora_rest_client/client.rb, line 1755
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) click to toggle source
#

Revenue Events #

#
# File lib/zuora_rest_client/client.rb, line 1585
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1589
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) click to toggle source
#

Revenue Items #

#
# File lib/zuora_rest_client/client.rb, line 1601
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1607
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1617
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1637
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) click to toggle source
#

Revenue Rules #

#
# File lib/zuora_rest_client/client.rb, line 1633
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1717
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1725
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1655
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1697
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1671
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1693
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1799
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1805
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1789
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1857
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) click to toggle source
#

Taxation Item #

#
# File lib/zuora_rest_client/client.rb, line 1879
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1970
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) click to toggle source
#

HMAC Signatures #

#
# File lib/zuora_rest_client/client.rb, line 850
def hmac_signature(request, zuora_version = nil)
  @connection.rest_post('/hmac-signatures', request, zuora_version)
end
initiate_entity_connection(request, zuora_version = nil) click to toggle source
# File lib/zuora_rest_client/client.rb, line 728
def initiate_entity_connection(request, zuora_version = nil)
  @connection.rest_post('/entity-connections', request, zuora_version)
end
invoice_and_collect(request, zuora_version = nil) click to toggle source
#

Operations #

#
# File lib/zuora_rest_client/client.rb, line 1125
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 128
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) click to toggle source
#

Mass Updater #

#
# File lib/zuora_rest_client/client.rb, line 1078
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 451
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 597
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) click to toggle source
#

Usage #

#
# File lib/zuora_rest_client/client.rb, line 1965
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) click to toggle source
#

Subscriptions #

#
# File lib/zuora_rest_client/client.rb, line 1781
def preview_subscription(request, zuora_version = nil)
  @connection.rest_post('/subscriptions/preview', request, zuora_version)
end
provision_entity(entity_id, zuora_version = nil) click to toggle source
# File lib/zuora_rest_client/client.rb, line 712
def provision_entity(entity_id, zuora_version = nil)
  @connection.rest_put("/entities/#{entity_id}/provision", nil, zuora_version)
end
query(request, zuora_version = nil) click to toggle source
# File lib/zuora_rest_client/client.rb, line 66
def query(request, zuora_version = nil)
  @connection.rest_post('/action/query', request, zuora_version)
end
query_accounting_code(accounting_code_id, zuora_version = nil) click to toggle source
# File lib/zuora_rest_client/client.rb, line 110
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 463
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 70
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 459
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1263
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1811
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 154
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1819
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 188
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 220
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 315
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) click to toggle source
#

Communication Profiles #

#
# File lib/zuora_rest_client/client.rb, line 383
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 403
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) click to toggle source
#

Credit Balance Adjustments #

#
# File lib/zuora_rest_client/client.rb, line 423
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 754
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) click to toggle source
#

Features #

#
# File lib/zuora_rest_client/client.rb, line 824
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) click to toggle source
#

Imports #

#
# File lib/zuora_rest_client/client.rb, line 872
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 892
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) click to toggle source
#

Invoice Item Adjustments #

#
# File lib/zuora_rest_client/client.rb, line 912
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) click to toggle source
#

Invoice Items #

#
# File lib/zuora_rest_client/client.rb, line 928
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1014
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 948
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) click to toggle source
#

Invoice Split Items #

#
# File lib/zuora_rest_client/client.rb, line 968
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) click to toggle source
#

Invoice Splits #

#
# File lib/zuora_rest_client/client.rb, line 984
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1207
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) click to toggle source
#

Payment Method Snapshots #

#
# File lib/zuora_rest_client/client.rb, line 1149
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) click to toggle source
#

Payment Method Transaction Logs #

#
# File lib/zuora_rest_client/client.rb, line 1165
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1309
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) click to toggle source
#

Payment Transaction Logs #

#
# File lib/zuora_rest_client/client.rb, line 1227
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) click to toggle source
#

Product Features #

#
# File lib/zuora_rest_client/client.rb, line 1329
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1411
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) click to toggle source
#

Product Rate Plan Charges #

#
# File lib/zuora_rest_client/client.rb, line 1361
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) click to toggle source
#

Product Rate Plan Charge Tiers #

#
# File lib/zuora_rest_client/client.rb, line 1345
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1387
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) click to toggle source
#

Rate Plan Charges #

#
# File lib/zuora_rest_client/client.rb, line 1457
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) click to toggle source
#

Rate Plan Charge Tiers #

#
# File lib/zuora_rest_client/client.rb, line 1441
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) click to toggle source
#

Rate Plans #

#
# File lib/zuora_rest_client/client.rb, line 1473
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) click to toggle source
#

Refund Invoice Payments #

#
# File lib/zuora_rest_client/client.rb, line 1489
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1565
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) click to toggle source
#

Refund Transaction Logs #

#
# File lib/zuora_rest_client/client.rb, line 1505
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1827
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) click to toggle source
#

Subscription Product Features #

#
# File lib/zuora_rest_client/client.rb, line 1765
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1903
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1945
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1980
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1006
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 158
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) click to toggle source
#

Users #

#
# File lib/zuora_rest_client/client.rb, line 2000
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 359
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1087
def stop_mass_action(bulk_key, zuora_version = nil)
  @connection.rest_put("/bulk/#{bulk_key}/stop", zuora_version)
end
subscribe(request, zuora_version = nil) click to toggle source
# File lib/zuora_rest_client/client.rb, line 74
def subscribe(request, zuora_version = nil)
  @connection.rest_post('/action/subscribe', request, zuora_version)
end
suspend_subscription(subscription_key, request, zuora_version = nil) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1823
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1285
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 491
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) click to toggle source
#

Payments #

#
# File lib/zuora_rest_client/client.rb, line 1243
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 78
def update(request, zuora_version = nil)
  @connection.rest_post('/action/update', request, zuora_version)
end
update_account(account_key, request, zuora_version = nil) click to toggle source
# File lib/zuora_rest_client/client.rb, line 176
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 194
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 114
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 146
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 226
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 321
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 409
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 447
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 593
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 700
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 898
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1020
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 954
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1301
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1191
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1213
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1315
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1417
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1393
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1529
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1571
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1613
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1623
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1701
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1795
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1833
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1869
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1887
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1909
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1951
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 1986
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 293
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) click to toggle source
# File lib/zuora_rest_client/client.rb, line 287
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

Private Instance Methods

logger() click to toggle source
# File lib/zuora_rest_client/client.rb, line 2018
def logger
  result = @client_options[:logger] || Logger.new($stdout)
  log_level = (@client_options[:log_level] || :info).to_s.upcase
  result.level = Logger::INFO
  result.level = Logger.const_get(log_level) if Logger.const_defined?(log_level)
  result
end