module Ruconomic::API::DistributionKey

Public Class Methods

find_by_name() click to toggle source

Returns handles for the distribution keys with the given name. Parameters: name: The name to search for.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=DistributionKey_FindByName @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/distribution_key.rb, line 95
def self.find_by_name
  response = invoke('DistributionKey_FindByName') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
find_by_number() click to toggle source

Returns a handle for the distribution key with the given number. Parameters: number: The number to search for.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=DistributionKey_FindByNumber @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/distribution_key.rb, line 71
def self.find_by_number
  response = invoke('DistributionKey_FindByNumber') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
find_by_number_list() click to toggle source

Returns an array with handles for the distribution keys corresponding to the given numbers. If a distribution key with a given number does not exist then the array contains nothing at that index. Parameters: numbers: The numbers to search for.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=DistributionKey_FindByNumberList @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/distribution_key.rb, line 83
def self.find_by_number_list
  response = invoke('DistributionKey_FindByNumberList') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
get_all() click to toggle source

Return handles for all distributions keys.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=DistributionKey_GetAll @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/distribution_key.rb, line 59
def self.get_all
  response = invoke('DistributionKey_GetAll') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
get_data() click to toggle source

Returns a distribution key data object for a given distribution key. Parameters: entityHandle: A handle for the distribution key.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=DistributionKey_GetData @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/distribution_key.rb, line 36
def self.get_data
  response = invoke('DistributionKey_GetData') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
get_data_array() click to toggle source

Returns distribution key data objects for a given set of distribution key handles. Parameters: entityHandles: An array of the distribution key handles.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=DistributionKey_GetDataArray @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/distribution_key.rb, line 48
def self.get_data_array
  response = invoke('DistributionKey_GetDataArray') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
get_departments() click to toggle source

Gets the departments of a distribution key. Parameters: distributionKeyHandle: Handle for the distribution key.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=DistributionKey_GetDepartments @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/distribution_key.rb, line 107
def self.get_departments
  response = invoke('DistributionKey_GetDepartments') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
get_is_accessible() click to toggle source

Gets whether a distributionkey is accessible. Parameters: accountHandle: Handle for the account.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=DistributionKey_GetIsAccessible @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/distribution_key.rb, line 167
def self.get_is_accessible
  response = invoke('DistributionKey_GetIsAccessible') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
get_name() click to toggle source

Gets the name of a distribution key. Parameters: distributionKeyHandle: Handle for the distribution key.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=DistributionKey_GetName @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/distribution_key.rb, line 143
def self.get_name
  response = invoke('DistributionKey_GetName') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
get_number() click to toggle source

Gets the number of a distribution key. Parameters: distributionKeyHandle: Handle for the distribution key.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=DistributionKey_GetNumber @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/distribution_key.rb, line 131
def self.get_number
  response = invoke('DistributionKey_GetNumber') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
get_percentages() click to toggle source

Gets the percentage distributions for the departments of a distribution key. Parameters: distributionKeyHandle: Handle for the distribution key.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=DistributionKey_GetPercentages @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/distribution_key.rb, line 119
def self.get_percentages
  response = invoke('DistributionKey_GetPercentages') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
set_is_accessible() click to toggle source

Sets whether a distributionkey is accessible. Parameters: accountHandle: Handle for the account. value: Value that indicates whether the account should be accessible.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=DistributionKey_SetIsAccessible @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/distribution_key.rb, line 179
def self.set_is_accessible
  response = invoke('DistributionKey_SetIsAccessible') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
set_name() click to toggle source

Sets the name of a distribution key. Parameters: distributionKeyHandle: Handle for the distribution key. value: The new name of the distribution key.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=DistributionKey_SetName @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/distribution_key.rb, line 155
def self.set_name
  response = invoke('DistributionKey_SetName') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
update_from_data() click to toggle source

Updates a distribution key from a data object. Parameters: data: The data object.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=DistributionKey_UpdateFromData @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/distribution_key.rb, line 24
def self.update_from_data
  response = invoke('DistributionKey_UpdateFromData') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end
update_from_data_array() click to toggle source

Update distribution keys from data objects. Parameters: dataArray: The array of data objects.

@note TODO: This method was autogenerated from the WSDL - see github.com/coherify/ruconomic#contributing“ @see api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=DistributionKey_UpdateFromDataArray @return [Hash] The body content of the SOAP response.

# File lib/ruconomic/api/distribution_key.rb, line 12
def self.update_from_data_array
  response = invoke('DistributionKey_UpdateFromDataArray') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
  end
end