Module: Ruconomic::API::DistributionKey

Extended by:
WebService
Defined in:
lib/ruconomic/api/distribution_key.rb

Class Method Summary collapse

Class Method Details

.find_by_nameHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

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

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


95
96
97
98
99
# 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/ta/ruconomic#contributing"
  end
end

.find_by_numberHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

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

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


71
72
73
74
75
# 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/ta/ruconomic#contributing"
  end
end

.find_by_number_listHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

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.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


83
84
85
86
87
# 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/ta/ruconomic#contributing"
  end
end

.get_allHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Return handles for all distributions keys.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


59
60
61
62
63
# 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/ta/ruconomic#contributing"
  end
end

.get_dataHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

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

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


36
37
38
39
40
# 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/ta/ruconomic#contributing"
  end
end

.get_data_arrayHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

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

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


48
49
50
51
52
# 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/ta/ruconomic#contributing"
  end
end

.get_departmentsHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

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

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


107
108
109
110
111
# 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/ta/ruconomic#contributing"
  end
end

.get_is_accessibleHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

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

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


167
168
169
170
171
# 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/ta/ruconomic#contributing"
  end
end

.get_nameHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

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

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


143
144
145
146
147
# 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/ta/ruconomic#contributing"
  end
end

.get_numberHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

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

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


131
132
133
134
135
# 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/ta/ruconomic#contributing"
  end
end

.get_percentagesHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

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

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


119
120
121
122
123
# 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/ta/ruconomic#contributing"
  end
end

.set_is_accessibleHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

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

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


179
180
181
182
183
# 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/ta/ruconomic#contributing"
  end
end

.set_nameHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

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

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


155
156
157
158
159
# 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/ta/ruconomic#contributing"
  end
end

.update_from_dataHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

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

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


24
25
26
27
28
# 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/ta/ruconomic#contributing"
  end
end

.update_from_data_arrayHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

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

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


12
13
14
15
16
# 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/ta/ruconomic#contributing"
  end
end