class DocuSign_eSign::BillingApi

get_billing_plan(billing_plan_id) click to toggle source

Get the billing plan details. Retrieves the billing plan details for the specified billing plan ID. @param billing_plan_id The ID of the billing plan being accessed. @return [BillingPlanResponse]

# File lib/docusign_esign/api/billing_api.rb, line 82
def get_billing_plan(billing_plan_id)
  data, _status_code, _headers = get_billing_plan_with_http_info(billing_plan_id)
  return data
end

get_billing_plan_with_http_info(billing_plan_id) click to toggle source

Get the billing plan details. Retrieves the billing plan details for the specified billing plan ID. @param billing_plan_id The ID of the billing plan being accessed. @return [Array<(BillingPlanResponse, Fixnum, Hash)>] BillingPlanResponse data, response status code and response headers

# File lib/docusign_esign/api/billing_api.rb, line 91
def get_billing_plan_with_http_info(billing_plan_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BillingApi.get_billing_plan ..."
  end
  # verify the required parameter 'billing_plan_id' is set
  fail ArgumentError, "Missing the required parameter 'billing_plan_id' when calling BillingApi.get_billing_plan" if billing_plan_id.nil?
  # resource path
  local_var_path = "/v2.1/billing_plans/{billingPlanId}".sub('{format}','json').sub('{' + 'billingPlanId' + '}', billing_plan_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BillingPlanResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#get_billing_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

get_credit_card_info(account_id) click to toggle source

Get metadata for a given credit card. This method returns information about a credit card associated with an account. @param account_id The external account number (int) or account ID Guid. @return [CreditCardInformation]

# File lib/docusign_esign/api/billing_api.rb, line 131
def get_credit_card_info(account_id)
  data, _status_code, _headers = get_credit_card_info_with_http_info(account_id)
  return data
end

get_credit_card_info_with_http_info(account_id) click to toggle source

Get metadata for a given credit card. This method returns information about a credit card associated with an account. @param account_id The external account number (int) or account ID Guid. @return [Array<(CreditCardInformation, Fixnum, Hash)>] CreditCardInformation data, response status code and response headers

# File lib/docusign_esign/api/billing_api.rb, line 140
def get_credit_card_info_with_http_info(account_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BillingApi.get_credit_card_info ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.get_credit_card_info" if account_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/billing_plan/credit_card".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CreditCardInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#get_credit_card_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

get_downgrade_request_billing_info(account_id) click to toggle source

Returns downgrade plan information for the specified account.

@param account_id The external account number (int) or account ID Guid. @return [DowngradRequestBillingInfoResponse]

# File lib/docusign_esign/api/billing_api.rb, line 180
def get_downgrade_request_billing_info(account_id)
  data, _status_code, _headers = get_downgrade_request_billing_info_with_http_info(account_id)
  return data
end

get_downgrade_request_billing_info_with_http_info(account_id) click to toggle source

Returns downgrade plan information for the specified account.

@param account_id The external account number (int) or account ID Guid. @return [Array<(DowngradRequestBillingInfoResponse, Fixnum, Hash)>] DowngradRequestBillingInfoResponse data, response status code and response headers

# File lib/docusign_esign/api/billing_api.rb, line 189
def get_downgrade_request_billing_info_with_http_info(account_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BillingApi.get_downgrade_request_billing_info ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.get_downgrade_request_billing_info" if account_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/billing_plan/downgrade".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DowngradRequestBillingInfoResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#get_downgrade_request_billing_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

get_invoice(account_id, invoice_id) click to toggle source

# File lib/docusign_esign/api/billing_api.rb, line 230
def get_invoice(account_id, invoice_id)
  data, _status_code, _headers = get_invoice_with_http_info(account_id, invoice_id)
  return data
end

get_invoice_with_http_info(account_id, invoice_id) click to toggle source

# File lib/docusign_esign/api/billing_api.rb, line 240
def get_invoice_with_http_info(account_id, invoice_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BillingApi.get_invoice ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.get_invoice" if account_id.nil?
  # verify the required parameter 'invoice_id' is set
  fail ArgumentError, "Missing the required parameter 'invoice_id' when calling BillingApi.get_invoice" if invoice_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/billing_invoices/{invoiceId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'invoiceId' + '}', invoice_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BillingInvoice')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#get_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

get_payment(account_id, payment_id) click to toggle source

Gets billing payment information for a specific payment. Retrieves the information for a specified payment. Privileges required: account administrator @param account_id The external account number (int) or account ID Guid. @param payment_id @return [BillingPaymentItem]

# File lib/docusign_esign/api/billing_api.rb, line 283
def get_payment(account_id, payment_id)
  data, _status_code, _headers = get_payment_with_http_info(account_id, payment_id)
  return data
end

get_payment_with_http_info(account_id, payment_id) click to toggle source

Gets billing payment information for a specific payment. Retrieves the information for a specified payment. Privileges required: account administrator @param account_id The external account number (int) or account ID Guid. @param payment_id @return [Array<(BillingPaymentItem, Fixnum, Hash)>] BillingPaymentItem data, response status code and response headers

# File lib/docusign_esign/api/billing_api.rb, line 293
def get_payment_with_http_info(account_id, payment_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BillingApi.get_payment ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.get_payment" if account_id.nil?
  # verify the required parameter 'payment_id' is set
  fail ArgumentError, "Missing the required parameter 'payment_id' when calling BillingApi.get_payment" if payment_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/billing_payments/{paymentId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'paymentId' + '}', payment_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BillingPaymentItem')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#get_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

get_plan(account_id, options = DocuSign_eSign::GetPlanOptions.default) click to toggle source

Get Account Billing Plan Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card. By default the successor plan and credit card information is included in the response. This information can be excluded from the response by adding the appropriate optional query string with the `setting` set to *false*. Response The response returns the billing plan information, including the currency code, for the plan. The `billingPlan` and `succesorPlans` property values are the same as those shown in the [ML:Get Billing Plan Details] reference. the `billingAddress` and `creditCardInformation` property values are the same as those shown in the [ML:Update Billing Plan] reference. ###### Note: When credit card number information is shown, a mask is applied to the response so that only the last 4 digits of the card number are visible. @param account_id The external account number (int) or account ID Guid. @param DocuSign_eSign::GetPlanOptions Options for modifying the behavior of the function. @return [AccountBillingPlanResponse]

# File lib/docusign_esign/api/billing_api.rb, line 336
def get_plan(account_id, options = DocuSign_eSign::GetPlanOptions.default)
  data, _status_code, _headers = get_plan_with_http_info(account_id, options)
  return data
end

get_plan_with_http_info(account_id, options = DocuSign_eSign::GetPlanOptions.default) click to toggle source

Get Account Billing Plan Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card. By default the successor plan and credit card information is included in the response. This information can be excluded from the response by adding the appropriate optional query string with the `setting` set to *false*. Response The response returns the billing plan information, including the currency code, for the plan. The `billingPlan` and `succesorPlans` property values are the same as those shown in the [ML:Get Billing Plan Details] reference. the `billingAddress` and `creditCardInformation` property values are the same as those shown in the [ML:Update Billing Plan] reference. ###### Note: When credit card number information is shown, a mask is applied to the response so that only the last 4 digits of the card number are visible. @param account_id The external account number (int) or account ID Guid. @param DocuSign_eSign::GetPlanOptions Options for modifying the behavior of the function. @return [Array<(AccountBillingPlanResponse, Fixnum, Hash)>] AccountBillingPlanResponse data, response status code and response headers

# File lib/docusign_esign/api/billing_api.rb, line 346
def get_plan_with_http_info(account_id, options = DocuSign_eSign::GetPlanOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BillingApi.get_plan ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.get_plan" if account_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/billing_plan".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'include_credit_card_information'] = options.include_credit_card_information if !options.include_credit_card_information.nil?
  query_params[:'include_downgrade_information'] = options.include_downgrade_information if !options.include_downgrade_information.nil?
  query_params[:'include_metadata'] = options.include_metadata if !options.include_metadata.nil?
  query_params[:'include_successor_plans'] = options.include_successor_plans if !options.include_successor_plans.nil?
  query_params[:'include_tax_exempt_id'] = options.include_tax_exempt_id if !options.include_tax_exempt_id.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AccountBillingPlanResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#get_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

list_billing_plans() click to toggle source

Gets the list of available billing plans. Retrieves a list of the billing plans associated with a distributor. @return [BillingPlansResponse]

# File lib/docusign_esign/api/billing_api.rb, line 390
def list_billing_plans()
  data, _status_code, _headers = list_billing_plans_with_http_info()
  return data
end

list_billing_plans_with_http_info() click to toggle source

Gets the list of available billing plans. Retrieves a list of the billing plans associated with a distributor. @return [Array<(BillingPlansResponse, Fixnum, Hash)>] BillingPlansResponse data, response status code and response headers

# File lib/docusign_esign/api/billing_api.rb, line 398
def list_billing_plans_with_http_info()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BillingApi.list_billing_plans ..."
  end
  # resource path
  local_var_path = "/v2.1/billing_plans".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BillingPlansResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#list_billing_plans\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

list_invoices(account_id, options = DocuSign_eSign::ListInvoicesOptions.default) click to toggle source

Get a List of Billing Invoices Retrieves a list of invoices for the account. If the from date or to date queries are not specified, the response returns invoices for the last 365 days. Privileges required: account administrator @param account_id The external account number (int) or account ID Guid. @param DocuSign_eSign::ListInvoicesOptions Options for modifying the behavior of the function. @return [BillingInvoicesResponse]

# File lib/docusign_esign/api/billing_api.rb, line 437
def list_invoices(account_id, options = DocuSign_eSign::ListInvoicesOptions.default)
  data, _status_code, _headers = list_invoices_with_http_info(account_id, options)
  return data
end

list_invoices_past_due(account_id) click to toggle source

Get a list of past due invoices. Returns a list past due invoices for the account and notes if payment can be made through the REST API. Privileges Required: account administrator @param account_id The external account number (int) or account ID Guid. @return [BillingInvoicesSummary]

# File lib/docusign_esign/api/billing_api.rb, line 489
def list_invoices_past_due(account_id)
  data, _status_code, _headers = list_invoices_past_due_with_http_info(account_id)
  return data
end

list_invoices_past_due_with_http_info(account_id) click to toggle source

Get a list of past due invoices. Returns a list past due invoices for the account and notes if payment can be made through the REST API. Privileges Required: account administrator @param account_id The external account number (int) or account ID Guid. @return [Array<(BillingInvoicesSummary, Fixnum, Hash)>] BillingInvoicesSummary data, response status code and response headers

# File lib/docusign_esign/api/billing_api.rb, line 498
def list_invoices_past_due_with_http_info(account_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BillingApi.list_invoices_past_due ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.list_invoices_past_due" if account_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/billing_invoices_past_due".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BillingInvoicesSummary')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#list_invoices_past_due\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

list_invoices_with_http_info(account_id, options = DocuSign_eSign::ListInvoicesOptions.default) click to toggle source

Get a List of Billing Invoices Retrieves a list of invoices for the account. If the from date or to date queries are not specified, the response returns invoices for the last 365 days. Privileges required: account administrator @param account_id The external account number (int) or account ID Guid. @param DocuSign_eSign::ListInvoicesOptions Options for modifying the behavior of the function. @return [Array<(BillingInvoicesResponse, Fixnum, Hash)>] BillingInvoicesResponse data, response status code and response headers

# File lib/docusign_esign/api/billing_api.rb, line 447
def list_invoices_with_http_info(account_id, options = DocuSign_eSign::ListInvoicesOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BillingApi.list_invoices ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.list_invoices" if account_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/billing_invoices".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'from_date'] = options.from_date if !options.from_date.nil?
  query_params[:'to_date'] = options.to_date if !options.to_date.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BillingInvoicesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#list_invoices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

list_payments(account_id, options = DocuSign_eSign::ListPaymentsOptions.default) click to toggle source

Gets payment information for one or more payments. Retrieves a list containing information about one or more payments. If the from date or to date queries are not used, the response returns payment information for the last 365 days. Privileges required: account administrator @param account_id The external account number (int) or account ID Guid. @param DocuSign_eSign::ListPaymentsOptions Options for modifying the behavior of the function. @return [BillingPaymentsResponse]

# File lib/docusign_esign/api/billing_api.rb, line 539
def list_payments(account_id, options = DocuSign_eSign::ListPaymentsOptions.default)
  data, _status_code, _headers = list_payments_with_http_info(account_id, options)
  return data
end

list_payments_with_http_info(account_id, options = DocuSign_eSign::ListPaymentsOptions.default) click to toggle source

Gets payment information for one or more payments. Retrieves a list containing information about one or more payments. If the from date or to date queries are not used, the response returns payment information for the last 365 days. Privileges required: account administrator @param account_id The external account number (int) or account ID Guid. @param DocuSign_eSign::ListPaymentsOptions Options for modifying the behavior of the function. @return [Array<(BillingPaymentsResponse, Fixnum, Hash)>] BillingPaymentsResponse data, response status code and response headers

# File lib/docusign_esign/api/billing_api.rb, line 549
def list_payments_with_http_info(account_id, options = DocuSign_eSign::ListPaymentsOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BillingApi.list_payments ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.list_payments" if account_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/billing_payments".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'from_date'] = options.from_date if !options.from_date.nil?
  query_params[:'to_date'] = options.to_date if !options.to_date.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BillingPaymentsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#list_payments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

make_payment(account_id, billing_payment_request) click to toggle source

Posts a payment to a past due invoice. Posts a payment to a past due invoice. ###### Note: This can only be used if the `paymentAllowed` value for a past due invoice is true. This can be determined calling [ML:GetBillingInvoicesPastDue]. The response returns information for a single payment, if a payment ID was used in the endpoint, or a list of payments. If the from date or to date queries or payment ID are not used, the response returns payment information for the last 365 days. If the request was for a single payment ID, the `nextUri` and `previousUri` properties are not returned. Privileges required: account administrator @param account_id The external account number (int) or account ID Guid. @param billing_payment_request (optional parameter) @return [BillingPaymentResponse]

# File lib/docusign_esign/api/billing_api.rb, line 592
def make_payment(account_id, billing_payment_request)
  data, _status_code, _headers = make_payment_with_http_info(account_id,  billing_payment_request)
  return data
end

make_payment_with_http_info(account_id, billing_payment_request) click to toggle source

Posts a payment to a past due invoice. Posts a payment to a past due invoice. ###### Note: This can only be used if the `paymentAllowed` value for a past due invoice is true. This can be determined calling [ML:GetBillingInvoicesPastDue]. The response returns information for a single payment, if a payment ID was used in the endpoint, or a list of payments. If the from date or to date queries or payment ID are not used, the response returns payment information for the last 365 days. If the request was for a single payment ID, the `nextUri` and `previousUri` properties are not returned. Privileges required: account administrator @param account_id The external account number (int) or account ID Guid. @param billing_payment_request (optional parameter) @return [Array<(BillingPaymentResponse, Fixnum, Hash)>] BillingPaymentResponse data, response status code and response headers

# File lib/docusign_esign/api/billing_api.rb, line 602
def make_payment_with_http_info(account_id, billing_payment_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BillingApi.make_payment ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.make_payment" if account_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/billing_payments".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(billing_payment_request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BillingPaymentResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#make_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

purchase_envelopes(account_id, purchased_envelopes_information) click to toggle source

Reserverd: Purchase additional envelopes. Reserved: At this time, this endpoint is limited to DocuSign internal use only. Completes the purchase of envelopes for your account. The actual purchase is done as part of an internal workflow interaction with an envelope vendor. @param account_id The external account number (int) or account ID Guid. @param purchased_envelopes_information (optional parameter) @return [nil]

# File lib/docusign_esign/api/billing_api.rb, line 643
def purchase_envelopes(account_id, purchased_envelopes_information)
  purchase_envelopes_with_http_info(account_id,  purchased_envelopes_information)
  return nil
end

purchase_envelopes_with_http_info(account_id, purchased_envelopes_information) click to toggle source

Reserverd: Purchase additional envelopes. Reserved: At this time, this endpoint is limited to DocuSign internal use only. Completes the purchase of envelopes for your account. The actual purchase is done as part of an internal workflow interaction with an envelope vendor. @param account_id The external account number (int) or account ID Guid. @param purchased_envelopes_information (optional parameter) @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/docusign_esign/api/billing_api.rb, line 653
def purchase_envelopes_with_http_info(account_id, purchased_envelopes_information)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BillingApi.purchase_envelopes ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.purchase_envelopes" if account_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/billing_plan/purchased_envelopes".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(purchased_envelopes_information)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#purchase_envelopes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

update_downgrade_account_billing_plan(account_id, downgrade_billing_plan_information) click to toggle source

Queues downgrade billing plan request for an account.

@param account_id The external account number (int) or account ID Guid. @param downgrade_billing_plan_information (optional parameter) @return [DowngradePlanUpdateResponse]

# File lib/docusign_esign/api/billing_api.rb, line 693
def update_downgrade_account_billing_plan(account_id, downgrade_billing_plan_information)
  data, _status_code, _headers = update_downgrade_account_billing_plan_with_http_info(account_id,  downgrade_billing_plan_information)
  return data
end

update_downgrade_account_billing_plan_with_http_info(account_id, downgrade_billing_plan_information) click to toggle source

Queues downgrade billing plan request for an account.

@param account_id The external account number (int) or account ID Guid. @param downgrade_billing_plan_information (optional parameter) @return [Array<(DowngradePlanUpdateResponse, Fixnum, Hash)>] DowngradePlanUpdateResponse data, response status code and response headers

# File lib/docusign_esign/api/billing_api.rb, line 703
def update_downgrade_account_billing_plan_with_http_info(account_id, downgrade_billing_plan_information)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BillingApi.update_downgrade_account_billing_plan ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.update_downgrade_account_billing_plan" if account_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/billing_plan/downgrade".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(downgrade_billing_plan_information)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DowngradePlanUpdateResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#update_downgrade_account_billing_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

update_plan(account_id, billing_plan_information, options = DocuSign_eSign::UpdatePlanOptions.default) click to toggle source

Updates the account billing plan. Updates the billing plan information, billing address, and credit card information for the specified account. @param account_id The external account number (int) or account ID Guid. @param billing_plan_information (optional parameter) @param DocuSign_eSign::UpdatePlanOptions Options for modifying the behavior of the function. @return [BillingPlanUpdateResponse]

# File lib/docusign_esign/api/billing_api.rb, line 745
def update_plan(account_id, billing_plan_information, options = DocuSign_eSign::UpdatePlanOptions.default)
  data, _status_code, _headers = update_plan_with_http_info(account_id,  billing_plan_information, options)
  return data
end

update_plan_with_http_info(account_id, billing_plan_information, options = DocuSign_eSign::UpdatePlanOptions.default) click to toggle source

Updates the account billing plan. Updates the billing plan information, billing address, and credit card information for the specified account. @param account_id The external account number (int) or account ID Guid. @param billing_plan_information (optional parameter) @param DocuSign_eSign::UpdatePlanOptions Options for modifying the behavior of the function. @return [Array<(BillingPlanUpdateResponse, Fixnum, Hash)>] BillingPlanUpdateResponse data, response status code and response headers

# File lib/docusign_esign/api/billing_api.rb, line 756
def update_plan_with_http_info(account_id, billing_plan_information, options = DocuSign_eSign::UpdatePlanOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BillingApi.update_plan ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.update_plan" if account_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/billing_plan".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'preview_billing_plan'] = options.preview_billing_plan if !options.preview_billing_plan.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(billing_plan_information)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BillingPlanUpdateResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#update_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

class DocuSign_eSign::BillingApi

Attributes

Public Class Methods

Public Instance Methods