Ruby SDK Samples - Record Operations
Get a Record
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def get_record
module_api_name = 'module_api_name'
entity_id = 'entity_id'
record_instance = ZCRMSDK::Operations::ZCRMRecord.get_instance(module_api_name, entity_id)
api_res = record_instance.get
record = api_res.data
print 'module_api_name '
print record.module_api_name
print "\n id "
print record.entity_id
line_items = record.line_items
line_items.each do |line_item|
print "\n id "
print line_item.id
product = line_item.product
print "\n entity_id "
print product.entity_id
print "\n lookup_label "
print product.lookup_label
print "\n Product_Code "
print product.field_data['Product_Code']
print "\n list_price "
print line_item.list_price
print "\n quantity "
print line_item.quantity
print "\n description "
print line_item.description
print "\n total "
print line_item.total
print "\n discount "
print line_item.discount
print "\n total_after_discount "
print line_item.total_after_discount
print "\n tax_amount "
print line_item.tax_amount
print "\n net_total "
print line_item.net_total
print "\n delete_flag "
print line_item.delete_flag
line_taxes = line_item.line_tax
next if line_taxes.nil?
line_taxes.each do |line_tax|
print "\n name "
print line_tax.name
print "\n percentage "
print line_tax.percentage
print "\n value "
print line_tax.value
end
end
owner = record.owner
unless owner.nil?
print "\n id "
print owner.id
print "\n name "
print owner.name
end
created_by = record.created_by
unless created_by.nil?
print "\n id "
print created_by.id
print "\n name "
print created_by.name
end
modified_by = record.modified_by
unless owner.nil?
print "\n id "
print modified_by.id
print "\n name "
print modified_by.name
end
print "\n created_time "
print record.created_time
print "\n modified_time "
print record.modified_time
print record.properties
participants = record.participants
participants.each do |participant|
print "\n name "
print participant.name
print "\n email "
print participant.email
print "\n is_invited "
print participant.is_invited
print "\n status "
print participant.status
print "\n type "
print participant.type
end
pricing_instances = record.price_details
pricing_instances.each do |pricing_instance|
print "\n id "
print pricing_instance.id
print "\n discount "
print pricing_instance.discount
print "\n to_range "
print pricing_instance.to_range
print "\n from_range "
print pricing_instance.from_range
end
layout = record.layout
unless layout.nil?
print "\n id "
print layout.id
print "\n name "
print layout.name
end
tax_list = record.tax_list
tax_list.each do |tax|
print "\n name "
print tax.name
end
print record.last_activity_time
tags = record.tags
tags.each do |tag|
print "\n id "
print tag.id
print "\n name "
print tag.name
end
fields = record.field_data
fields.each do |key, field_value|
print "\n key "
print key
print "\t field_value "
print field_value
end
print "\n "
end
obj = Test.new
obj.get_record
Create a Record
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def create_record
module_api_name = 'module_api_name'
record_instance = ZCRMSDK::Operations::ZCRMRecord.get_instance(module_api_name, nil)
record_instance.field_data = Array('Last_Name' => 'ruby_lead1')
response = record_instance.create
rescue ZCRMSDK::Utility::ZCRMException => e
print e.status_code
print e.error_message
print e.exception_code
print e.error_details
print e.error_content
print "\n"
print response.code
print "\n"
print response.message
print "\n"
print response.details
end
obj = Test.new
obj.create_record
Update a Record
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def update_record
module_api_name = 'module_api_name'
record_id = 'record_id'
record_instance = ZCRMSDK::Operations::ZCRMRecord.get_instance(module_api_name, record_id)
record_instance.field_data = Array('Last_Name' => 'ruby_lead1')
response = record_instance.update
print "\n"
print response.code
print "\n"
print response.message
print "\n"
print response.details
end
obj = Test.new
obj.update_record
Delete a Record
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def delete_record
module_api_name = 'module_api_name'
record_id = 'record_id'
record_instance = ZCRMSDK::Operations::ZCRMRecord.get_instance(module_api_name, record_id)
response = record_instance.delete
print "\n"
print response.code
print "\n"
print response.message
print "\n"
print response.details
end
obj = Test.new
obj.delete_record
Convert a Record
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def convert_record
module_api_name = 'module_api_name'
record_id = 'record_id'
record_instance = ZCRMSDK::Operations::ZCRMRecord.get_instance(module_api_name, record_id)
deal = ZCRMSDK::Operations::ZCRMRecord.get_instance('deals', nil)
deal.field_data = { 'Deal_Name' => 'test3', 'stage' => 'Qualification', 'Closing_Date' => '2016-03-30' }
details = {'overwrite' => TRUE, 'notify_new_entity_owner' => TRUE}
response = record_instance.convert(nil, details)
response.each do |key, value|
print "\n" + key + "\t" + value.to_s
end
rescue ZCRMSDK::Utility::ZCRMException => e
print e.status_code
print "\n"
print e.error_message
print "\n"
print e.exception_code
print "\n"
print e.error_details
print "\n"
print e.error_content
end
obj = Test.new
obj.convert_record
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def get_relatedlist_records
module_api_name = 'module_api_name'
related_list_api_name = 'related_list_api_name'
record_id = 'record_id'
record_instance = ZCRMSDK::Operations::ZCRMRecord.get_instance(module_api_name, record_id)
api_res = record_instance.get_relatedlist_records(related_list_api_name)
records = api_res.data
records.each do |record|
print 'module_api_name '
print record.module_api_name
print "\n id "
print record.entity_id
line_items = record.line_items
line_items.each do |line_item|
print "\n id "
print line_item.id
product = line_item.product
print "\n entity_id "
print product.entity_id
print "\n lookup_label "
print product.lookup_label
print "\n Product_Code "
print product.field_data['Product_Code']
print "\n list_price "
print line_item.list_price
print "\n quantity "
print line_item.quantity
print "\n description "
print line_item.description
print "\n total "
print line_item.total
print "\n discount "
print line_item.discount
print "\n total_after_discount "
print line_item.total_after_discount
print "\n tax_amount "
print line_item.tax_amount
print "\n net_total "
print line_item.net_total
print "\n delete_flag "
print line_item.delete_flag
line_taxes = line_item.line_tax
next if line_taxes.nil?
line_taxes.each do |line_tax|
print "\n name "
print line_tax.name
print "\n percentage "
print line_tax.percentage
print "\n value "
print line_tax.value
end
end
owner = record.owner
unless owner.nil?
print "\n id "
print owner.id
print "\n name "
print owner.name
end
created_by = record.created_by
unless created_by.nil?
print "\n id "
print created_by.id
print "\n name "
print created_by.name
end
modified_by = record.modified_by
unless owner.nil?
print "\n id "
print modified_by.id
print "\n name "
print modified_by.name
end
print "\n created_time "
print record.created_time
print "\n modified_time "
print record.modified_time
print record.properties
participants = record.participants
participants.each do |participant|
print "\n name "
print participant.name
print "\n email "
print participant.email
print "\n is_invited "
print participant.is_invited
print "\n status "
print participant.status
print "\n type "
print participant.type
end
pricing_instances = record.price_details
pricing_instances.each do |pricing_instance|
print "\n id "
print pricing_instance.id
print "\n discount "
print pricing_instance.discount
print "\n to_range "
print pricing_instance.to_range
print "\n from_range "
print pricing_instance.from_range
end
layout = record.layout
unless layout.nil?
print "\n id "
print layout.id
print "\n name "
print layout.name
end
tax_list = record.tax_list
tax_list.each do |tax|
print "\n name "
print tax.name
end
print record.last_activity_time
tags = record.tags
tags.each do |tag|
print "\n id "
print tag.id
print "\n name "
print tag.name
end
fields = record.field_data
fields.each do |key, field_value|
print "\n key "
print key
print "\t field_value "
print field_value
end
print "\n "
end
end
obj = Test.new
obj.get_relatedlist_records
Tags of a record
Add Tags
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def add_tags
module_api_name = 'module_api_name'
record_id = 'record_id'
record_instance = ZCRMSDK::Operations::ZCRMRecord.get_instance(module_api_name, record_id)
tagnames = []
tagnames.push('asdsdad')
tagnames.push('asdsasdddad')
res = record_instance.add_tags(tagnames)
print "\n"
print res.code
print "\n"
print res.message
print "\n"
print res.details
end
obj = Test.new
obj.add_tags
Tags in a Record
Remove Tags
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def remove_tags
module_api_name = 'module_api_name'
record_id = 'record_id'
record_instance = ZCRMSDK::Operations::ZCRMRecord.get_instance(module_api_name, record_id)
tagnames = []
tagnames.push('asdsdad')
tagnames.push('asdsasdddad')
res = record_instance.remove_tags(tagnames)
print "\n"
print res.code
print "\n"
print res.message
print "\n"
print res.details
end
obj = Test.new
obj.remove_tags
Delete Tag
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def delete_tag
tag_id = 'tag_id'
tag_instance = ZCRMSDK::Operations::ZCRMTag.get_instance(tag_id)
res = tag_instance.delete
print "\n"
print res.code
print "\n"
print res.message
print "\n"
print res.details
end
obj = Test.new
obj.delete_tag
Merge Tags
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def merge_tag
tag_id = 'tag_id'
tag_id_to_merge = 'tag_id_to_merge'
tag_instance = ZCRMSDK::Operations::ZCRMTag.get_instance(tag_id)
tag_to_merge = ZCRMSDK::Operations::ZCRMTag.get_instance(tag_id_to_merge)
res = tag_instance.merge(tag_to_merge)
print "\n"
print res.code
print "\n"
print res.message
print "\n"
print res.details
end
obj = Test.new
obj.merge_tag
Update Tag
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def update_tag
tag_id = 'tag_id'
tag_instance = ZCRMSDK::Operations::ZCRMTag.get_instance(tag_id, 'asdadsad')
tag_instance.module_apiname = 'Leads'
res = tag_instance.update
print "\n"
print res.code
print "\n"
print res.message
print "\n"
print res.details
end
obj = Test.new
obj.update_tag
Attachments in a Record
Get Attachments
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def get_attachments
module_api_name = 'module_api_name'
record_id = 'record_id'
record = ZCRMSDK::Operations::ZCRMRecord.get_instance(module_api_name, record_id)
page = 1
per_page = 20
res = record.get_attachments(page, per_page)# page, per_page is not mandatory
attachment = res.data
attachment.each do |zcrmattachment_ins|
print zcrmattachment_ins.id
print "\n"
print zcrmattachment_ins.file_name
print "\n"
print zcrmattachment_ins.type
owner = zcrmattachment_ins.owner
unless owner.nil?
print "\n"
print owner.id
print "\n"
print owner.name
end
created_by = zcrmattachment_ins.created_by
unless created_by.nil?
print "\n"
print created_by.id
print "\n"
print created_by.name
end
modified_by = zcrmattachment_ins.modified_by
unless modified_by.nil?
print "\n"
print modified_by.id
print "\n"
print modified_by.name
end
print "\n"
print zcrmattachment_ins.created_time
print "\n"
print zcrmattachment_ins.file_id
print "\n"
print zcrmattachment_ins.modified_time
print "\n"
print zcrmattachment_ins.attachment_type
print "\n"
print zcrmattachment_ins.parent_module
print "\n"
print zcrmattachment_ins.parent_id
print "\n"
print zcrmattachment_ins.parent_name
print "\n"
print zcrmattachment_ins.size
print "\n"
print zcrmattachment_ins.is_editable
print "\n"
print zcrmattachment_ins.link_url
print "\n"
end
end
obj = Test.new
obj.get_attachments
Upload an Attachment
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def upload_attachment
filepath = 'filepath'
module_api_name = 'module_api_name'
record_id = 'record_id'
record = ZCRMSDK::Operations::ZCRMRecord.get_instance(module_api_name, record_id)
res = record.upload_attachment(filepath)
print res.code
print "\n"
print res.message
print "\n"
print res.details
end
obj = Test.new
obj.upload_attachment
Upload Link as an Attachment
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def upload_link_as_attachment
attachment_url = 'attachment_url'
module_api_name = 'module_api_name'
record_id = 'record_id'
record = ZCRMSDK::Operations::ZCRMRecord.get_instance(module_api_name, record_id)
res = record.upload_link_as_attachment(attachment_url)
print res.code
print "\n"
print res.message
print "\n"
print res.details
end
obj = Test.new
obj.upload_link_as_attachment
Download an Attachment
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def download_attachment
attachment_id = 'attachment_id'
module_api_name = 'module_api_name'
record_id = 'record_id'
record = ZCRMSDK::Operations::ZCRMRecord.get_instance(module_api_name, record_id)
res = record.download_attachment(attachment_id)
print res.inspect
filepath = 'filepath/' + res.filename
File.write(filepath, res.response)
print res.code
print "\n"
print res.message
print "\n"
print res.details
end
obj = Test.new
obj.download_attachment
Delete an Attachment
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def delete_attachment
module_api_name = 'module_api_name'
record_id = 'record_id'
record = ZCRMSDK::Operations::ZCRMRecord.get_instance(module_api_name, record_id)
res = record.delete_attachment(attachment_id)
print res.code
print "\n"
print res.message
print "\n"
print res.details
end
obj = Test.new
obj.delete_attachment
Images in a Record
Upload a Photo
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def upload_photo
filepath = 'filepath'
module_api_name = 'module_api_name'
record_id = 'record_id'
record = ZCRMSDK::Operations::ZCRMRecord.get_instance(module_api_name, record_id)
res = record.upload_photo(filepath)
print res.inspect
print res.code
print "\n"
print res.message
print "\n"
print res.details
end
obj = Test.new
obj.upload_photo
Download a Photo
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def download_photo
module_api_name = 'module_api_name'
record_id = 'record_id'
record = ZCRMSDK::Operations::ZCRMRecord.get_instance(module_api_name, record_id)
res = record.download_photo
filepath = '/Users/pravesh-8541/asd/' + res.filename
File.write(filepath, res.response)
end
obj = Test.new
obj.download_photo
Delete a Photo
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def delete_photo
module_api_name = 'module_api_name'
record_id = 'record_id'
record = ZCRMSDK::Operations::ZCRMRecord.get_instance(module_api_name, record_id)
res = record.delete_photo
print res.code
print "\n"
print res.message
print "\n"
print res.details
end
obj = Test.new
obj.delete_photo
Interlinking Records
Add Relation between Records
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def add_relation
module_api_name = 'module_api_name'
record_id = 'record_id'
related_record_module_api_name = 'related_record_module_api_name'
related_record_id = 'related_record_id'
record = ZCRMSDK::Operations::ZCRMRecord.get_instance(module_api_name, record_id)
junction_record = ZCRMSDK::Operations::ZCRMJunctionRecord.get_instance(related_record_module_api_name, related_record_id)
res = record.add_relation(junction_record)
print res.code
print "\n"
print res.message
print "\n"
print res.details
end
obj = Test.new
obj.add_relation
Remove Relation between Records
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def remove_relation
module_api_name = 'module_api_name'
record_id = 'record_id'
related_record_module_api_name = 'related_record_module_api_name'
related_record_id = 'related_record_id'
record = ZCRMSDK::Operations::ZCRMRecord.get_instance(module_api_name, record_id)
junction_record = ZCRMSDK::Operations::ZCRMJunctionRecord.get_instance(related_record_module_api_name, related_record_id)
res = record.remove_relation(junction_record)
print res.code
print "\n"
print res.message
print "\n"
print res.details
end
obj = Test.new
obj.remove_relation
Notes in a Record
Add Note
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def add_note
module_api_name = 'module_api_name'
record_id = 'record_id'
record = ZCRMSDK::Operations::ZCRMRecord.get_instance(module_api_name, record_id)
note = ZCRMSDK::Operations::ZCRMNote.get_instance(record, nil)
note.title = 'Adssadasdasd'
note.content = 'Adssadasdasd'
res = record.add_note(nil)
print res.code
print "\n"
print res.message
print "\n"
print res.details
end
obj = Test.new
obj.add_note
Update Note
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def update_note
module_api_name = 'module_api_name'
record_id = 'record_id'
note_id = 'note_id'
record = ZCRMSDK::Operations::ZCRMRecord.get_instance(module_api_name, record_id)
note = ZCRMSDK::Operations::ZCRMNote.get_instance(record, note_id)
note.title = 'Adssadasdasd'
note.content = 'Adssadasdasd'
res = record.update_note(note)
print res.code
print "\n"
print res.message
print "\n"
print res.details
end
obj = Test.new
obj.update_note
Delete Note
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def delete_note(module_api_name, record_id, note_id)
module_api_name = 'module_api_name'
record_id = 'record_id'
note_id = 'note_id'
record = ZCRMSDK::Operations::ZCRMRecord.get_instance(module_api_name, record_id)
note = ZCRMSDK::Operations::ZCRMNote.get_instance(record, note_id)
res = record.delete_note(note)
print res.code
print "\n"
print res.message
print "\n"
print res.details
end
obj = Test.new
obj.delete_note
Get Notes
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def get_notes
module_api_name = 'module_api_name'
record_id = 'record_id'
record = ZCRMSDK::Operations::ZCRMRecord.get_instance(module_api_name, record_id)
res = record.get_notes(nil, nil, 1, 20)
notes = res.data
notes.each do |zcrmnote_ins|
print zcrmnote_ins.id
print "\n"
print zcrmnote_ins.title
print "\n"
print zcrmnote_ins.content
owner = zcrmnote_ins.owner
unless owner.nil?
print "\n"
print owner.id
print "\n"
print owner.name
end
created_by = zcrmnote_ins.created_by
unless created_by.nil?
print "\n"
print created_by.id
print "\n"
print created_by.name
end
modified_by = zcrmnote_ins.modified_by
unless modified_by.nil?
print "\n"
print modified_by.id
print "\n"
print modified_by.name
end
print "\n"
print zcrmnote_ins.created_time
print "\n"
print zcrmnote_ins.modified_time
print "\n"
print zcrmnote_ins.is_voice_note
print "\n"
print zcrmnote_ins.parent_module
print "\n"
print zcrmnote_ins.parent_id
print "\n"
print zcrmnote_ins.parent_name
print "\n"
print zcrmnote_ins.size
print "\n"
print zcrmnote_ins.is_editable
print "\n"
attachments = zcrmnote_ins.attachments
next if attachments.nil?
attachments.each do |zcrmattachment_ins|
print zcrmattachment_ins.id
print "\n"
print zcrmattachment_ins.file_name
print "\n"
print zcrmattachment_ins.type
owner = zcrmattachment_ins.owner
unless owner.nil?
print "\n"
print owner.id
print "\n"
print owner.name
end
created_by = zcrmattachment_ins.created_by
unless created_by.nil?
print "\n"
print created_by.id
print "\n"
print created_by.name
end
modified_by = zcrmattachment_ins.modified_by
unless modified_by.nil?
print "\n"
print modified_by.id
print "\n"
print modified_by.name
end
print "\n"
print zcrmattachment_ins.created_time
print "\n"
print zcrmattachment_ins.file_id
print "\n"
print zcrmattachment_ins.modified_time
print "\n"
print zcrmattachment_ins.attachment_type
print "\n"
print zcrmattachment_ins.parent_module
print "\n"
print zcrmattachment_ins.parent_id
print "\n"
print zcrmattachment_ins.parent_name
print "\n"
print zcrmattachment_ins.size
print "\n"
print zcrmattachment_ins.is_editable
print "\n"
print zcrmattachment_ins.link_url
print "\n"
end
end
end
obj = Test.new
obj.get_notes
Upload Attachment to a Note
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def upload_attachment_to_note
module_api_name = 'module_api_name'
entity_id = 'entity_id'
note_id = 'note_id'
file_path = 'file_path'
record_ins = ZCRMSDK::Operations::ZCRMRecord.get_instance(module_api_name, entity_id)
note = ZCRMSDK::Operations::ZCRMNote.get_instance(record_ins, note_id) #note_id - is not mandatory
note_upload_attachment_res = note.upload_attachment(file_path)
end
obj = Test.new
obj.upload_attachment_to_note
Download Attachment from a Note
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def download_attachment_from_note
note_id = 'note_id'
note_attachment_id = 'note_attachment_id'
note = ZCRMSDK::Operations::ZCRMNote.get_instance(record_ins, note_id) #record_ins - is not mandatory
note_upload_attachment_res = note.download_attachment(note_attachment_id)
print note_upload_attachment_res.inspect
filepath = 'filepath/' + res.filename
File.write(filepath, res.response)
print res.code
print "\n"
print res.message
print "\n"
print res.details
end
obj = Test.new
obj.download_attachment_from_note
Get Attachments from a Note
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def get_attachments_from_note
note_id = 'note_id'
note = ZCRMSDK::Operations::ZCRMNote.get_instance(record_ins, note_id) #record_ins - is not mandatory
note_get_attachment = note.get_attachments.data
note_get_attachment.each do |zcrmattachment_ins|
print zcrmattachment_ins.id
print "\n"
print zcrmattachment_ins.file_name
print "\n"
print zcrmattachment_ins.type
owner = zcrmattachment_ins.owner
unless owner.nil?
print "\n"
print owner.id
print "\n"
print owner.name
end
created_by = zcrmattachment_ins.created_by
unless created_by.nil?
print "\n"
print created_by.id
print "\n"
print created_by.name
end
modified_by = zcrmattachment_ins.modified_by
unless modified_by.nil?
print "\n"
print modified_by.id
print "\n"
print modified_by.name
end
print "\n"
print zcrmattachment_ins.created_time
print "\n"
print zcrmattachment_ins.file_id
print "\n"
print zcrmattachment_ins.modified_time
print "\n"
print zcrmattachment_ins.attachment_type
print "\n"
print zcrmattachment_ins.parent_module
print "\n"
print zcrmattachment_ins.parent_id
print "\n"
print zcrmattachment_ins.parent_name
print "\n"
print zcrmattachment_ins.size
print "\n"
print zcrmattachment_ins.is_editable
print "\n"
end
end
obj = Test.new
obj.get_attachments_from_note
Delete Attachments of a Note
require 'ZCRMSDK'
# THIS CLASS SHOWS THE EXAMPLES
class Test
def initialize
config_details = { 'client_id' => 'client_id', 'client_secret' => 'client_secret', 'redirect_uri' => 'redirect_uri', 'api_base_url' => 'api_base_url', 'api_version' => 'v2', 'current_user_email' => 'user_identifier', 'application_log_file_path' => "path/to/filename.log" ,'log_in_console' => 'true' }
ZCRMSDK::RestClient::ZCRMRestClient.init(config_details)
end
def delete_attachment_of_note
note_id = 'note_id'
note_attachment_id = 'note_attachment_id'
note = ZCRMSDK::Operations::ZCRMNote.get_instance(record_ins, note_id) #record_ins - is not mandatory
note_delete_attachment_res = note.download_attachment(note_attachment_id)
end
obj = Test.new
obj.delete_attachment_of_note