landslider 0.5.7 → 0.5.9

data/lib/landslider/entities/ws_opportunity_status.rb

@@ -0,0 +1,17 @@
+
+class Landslider
+
+	class WsOpportunityStatus < WsEntity
+		
+		# @return [Integer]
+		attr_reader :opportunity_status_id
+
+		# @return [String]
+		attr_reader :opportunity_status
+				
+		# @return [WsOpportunityStatus]
+		attr_reader :parent_opportunity_status
+
+	end
+	
+end

data/lib/landslider/entities/ws_payment_term.rb

@@ -0,0 +1,17 @@
+
+class Landslider
+
+	class WsPaymentTerm < WsEntity
+		
+		# @return [Integer]
+		attr_reader :payment_term_id
+		
+		# @return [String]
+		attr_reader :description
+		
+		# @return [Boolean]
+		attr_reader :default_value
+		
+	end
+	
+end

data/lib/landslider/entities/ws_pick_list_item.rb

@@ -0,0 +1,14 @@
+
+class Landslider
+
+	class WsPickListItem < Object
+		
+		# @return [Integer]
+		attr_reader :id, :list_type_id
+		
+		# @return [String]
+		attr_reader :display_string
+		
+	end
+	
+end

data/lib/landslider/entities/ws_primary_entity.rb

@@ -0,0 +1,11 @@
+
+class Landslider
+
+	class WsPrimaryEntity < WsEntity
+		
+		# @return [Boolean]
+		attr_reader :suppress_id_validation
+
+	end
+	
+end

data/lib/landslider/entities/ws_product.rb

@@ -0,0 +1,35 @@
+class Landslider
+	
+	class WsProduct < WsEntity
+		
+		# @return [Integer]
+		attr_reader :product_id
+		
+		# @return [String]
+		attr_reader :product_name, :source_id, :description_text, :product_code
+		
+		# @return [Integer]
+		attr_reader :create_by, :update_by
+		
+		# @return [Date]
+		attr_reader :created_on, :updated_on
+		
+		# @return [WsDurationType]
+		attr_reader :duration_type
+		
+		# @return [WsProduct]
+		attr_reader :parent_product
+		
+		# @return [WsProductFamily]
+		attr_reader :product_family
+
+		# @param [Handsoap::XmlMason::Node] msg
+		# @return [Handsoap::XmlMason::Node]
+		def soapify_for(msg)
+		end
+		
+	end
+	
+end
+
+

data/lib/landslider/entities/ws_product_family.rb

@@ -0,0 +1,17 @@
+
+class Landslider
+
+	class WsProductFamily < WsEntity
+		
+		# @return [Integer]
+		attr_reader :product_family_id, :parent_product_family_id
+		
+		# @return [String]
+		attr_reader :product_family, :description, :parent_product_family
+		
+		# @return [Date]
+		attr_reader :archived_on
+		
+	end
+	
+end

data/lib/landslider/entities/ws_product_result.rb

@@ -0,0 +1,12 @@
+class Landslider
+
+	class WsProductResult < WsResult
+		
+		# @return [WsProduct]
+		attr_reader :product
+		
+		# @return [Boolean]
+		attr_reader :is_created
+	end
+	
+end

data/lib/landslider/entities/ws_record_upsert_result.rb

@@ -0,0 +1,13 @@
+
+class Landslider
+
+	class WsRecordUpsertResult < WsEntity
+		
+		# @return [Integer]
+		attr_reader :id
+		
+		# @return [Boolean]
+		attr_reader :is_created
+	end
+	
+end

data/lib/landslider/entities/ws_result.rb

@@ -0,0 +1,16 @@
+class Landslider
+
+	class WsResult
+		
+		# @return [Boolean]
+		attr_reader :error
+		
+		# @return [Integer]
+		attr_reader :error_code_id
+		
+		# @return [String]
+		attr_reader :result_msg
+		
+	end
+
+end

data/lib/landslider/entities/ws_search.rb

@@ -0,0 +1,55 @@
+
+class Landslider
+
+	class WsSearch
+		
+		# @param [Hash] params
+		# An optional Hash to specify first_result_position and total_results_requested
+		def initialize(params={})
+		    @first_result_position = params.fetch(:first_result_position) if params.key?(:first_result_position)
+		    @total_results_requested = params.fetch(:total_results_requested) if params.key?(:total_results_requested)
+		end
+		
+		# @param [Integer] value num
+		# Sets the starting index of records you want to retrieve. defaults to 1
+		attr_writer :first_result_position
+		
+		# @param [Integer] value num
+		# Sets the maximum number of records to retrieve. defaults to 25
+		attr_writer :total_results_requested
+		
+		# @param [String] value date
+		# Sets a Date to search records updated on or after
+		attr_writer :updated_on
+		
+		# @param [String] value
+		# system source id search?
+		attr_writer :source_id
+		
+		# @param [Boolean] value
+		attr_writer :return_deleted_records, :allow_duplicate_criterion
+		
+		# @param [WsSearchCriterion] value 
+		# WsSearchCriterion is only documented to work with these APIs
+		# * getAccounts
+		# * getOpportunities
+		# * getProductFamilies
+		# * GetDurationTypes
+		attr_writer :search_criteria
+	
+		# Adds the search xml
+		# @param [Handsoap::XmlMason::Node] msg
+		# @return [Handsoap::XmlMason::Node]
+		def soapify_for(msg)
+			msg.add 'firstResultPosition', @first_result_position || DEFAULT_FIRST_RESULT_POSITION
+			msg.add 'totalResultsRequested', @total_results_requested || DEFAULT_TOTAL_RESULTS_REQUESTED
+			msg.add 'updatedOn', @updated_on unless @updated_on.nil?
+			unless @search_criteria.nil?
+				@search_criteria.soapify_for(msg)
+			end
+		
+		end
+
+	end
+
+end

data/lib/landslider/entities/ws_search_criterion.rb

@@ -0,0 +1,121 @@
+class Landslider
+	
+	class WsSearchCriterion
+		
+		# @return [String]
+		attr_reader :field_id, :operator
+		
+		# @return [String]
+		attr_reader :query_value
+
+		# @param [String] field_id 
+		#
+		# Currently Searchable Account Fields:
+		# * AccountId
+		# * AccountName
+		# * AccountNumber
+		# * AccountShortName
+		# * AccountType
+		# * AccountTypeId
+		# * ArchivedOn
+		# * BillingAddressCity
+		# * BillingAddressCountry
+		# * BillingAddressState
+		# * BillingAddressStreet
+		# * BillingAddressZip
+		# * CreatedById
+		# * CreatedDate
+		# * Division
+		# * Fax
+		# * LastUpdatedById
+		# * LastUpdatedDate
+		# * MainAddressCity
+		# * MainAddressCountry
+		# * MainAddressState
+		# * MainAddressStreet
+		# * MainAddressZip
+		# * NewsKeywords
+		# * OwnerId
+		# * ParentAccount
+		# * ParentAccountId
+		# * Phone
+		# * PrimaryContactId, 
+		# * QuickbooksLastSynced
+		# * ShippingAddressCity
+		# * ShippingAddressCountry
+		# * ShippingAddressState
+		# * ShippingAddressStreet
+		# * ShippingAddressZip
+		# * SourceSystemId
+		# * SyncWithQuickBooks
+		# * Ticker
+		# * Url
+		#
+		# Currently Searchable Opportunity Fields:
+		# * AccountId
+		# * AccountName
+		# * ArchivedOn, ClosedDate
+		# * ComputedConfidence
+		# * ComputedForecastDate
+		# * CreatedById
+		# * CreatedDate
+		# * CurrentPhaseId
+		# * CurrentPhaseName
+		# * DealValue
+		# * Description
+		# * IsHot
+		# * LastUpdatedById, 
+		# * LastUpdatedDate
+		# * LeadSource
+		# * LeadSourceId
+		# * Name, OpportunityId
+		# * OverriddenConfidence
+		# * OverriddenForecastDate
+		# * OverrideComments
+		# * OwnerId
+		# * PaymentTerms
+		# * PaymentTermsId
+		# * QuickbooksLastSyncedQuickbooksTransactionType
+		# * SellingProcess
+		# * SellingProcessId
+		# * SourceSystemId
+		# * StartDate
+		# * Status
+		# * StatusId
+		# * StatusReason
+		# * StatusReasonId
+		# * SuspendedDate
+		#
+		# Currently Searchable Duration Type Fields:
+		# * DurationType
+		# * DurationTypeId
+		#
+		# Currently Searchable Product Family Fields:
+		# * Description
+		# * ParentProductFamily
+		# * ParentProductFamilyId
+		# * ProductFamily
+		# * ProductFamilyId
+		# @param [String, WsSearchOperator] operator Contains,SoundsLike,Equals,NotEquals
+		# 	LessThan,LessThanOrEqual,GreaterThan,GreaterThanOrEqual
+		# 		Empty,NotEmpty,True,False,In,NotIn
+		# @param [String, WsSearchOperator] query_value string to search for
+		def initialize(field_id, operator, query_value)
+			@field_id = field_id
+			@operator = operator
+			@query_value = query_value
+		end
+	
+		# Adds the search criteria xml
+		# @param [Handsoap::XmlMason::Node] msg xml node
+		# @return [Handsoap::XmlMason::Node]
+		def soapify_for(msg)
+			msg.add('searchCriteria') { |crit|
+				crit.add 'fieldId', @field_id
+				crit.add 'operator', @operator
+				crit.add 'queryValue', @query_value unless @query_value.nil?
+			}
+		end
+	end
+	
+end

data/lib/landslider/entities/ws_search_operator.rb

@@ -0,0 +1,59 @@
+
+class Landslider
+	
+	# A list of operators that can be used with WsSearchCriterion
+	class WsSearchOperator
+
+		# returns values that contain the given search string
+		CONTAINS='Contains'
+		
+		# returns values that "sound like" the given search string (smythe = smith)
+		SOUNDS_LIKE='SoundsLike'
+		
+		# returns values that start with the given search string
+		STARTS_WITH='StartsWith'
+		
+		# returns values that end with the given search string
+		ENDS_WITH='EndsWith'
+		
+		# returns values that do not contain the given search string
+		DOES_NOT_CONTAIN='DoesNotContain'
+		
+		# returns values that are identically equal (case-insensitive) the given search value
+		EQUALS='Equals'
+		
+		# returns values that are not  equal (case-insensitive) the given search value
+		NOT_EQUALS='NotEquals'
+		
+		# returns values that are less than the given search value
+		LESS_THAN='LessThan'
+		
+		# returns values that are less than or equal to the given search value
+		LESS_THAN_OR_EQUAL='LessThanOrEqual'
+		
+		# returns values that are greater than the given search value
+		GREATER_THAN='GreaterThan'
+		
+		# returns values that are greater than or equal to the given search value
+		GREATER_THAN_OR_EQUAL='GreaterThanOrEqual'
+		
+		# returns values that are empty (null)
+		EMPTY='Empty'
+		
+		# returns values that are not empty (not null)
+		NOT_EMPTY='NotEmpty'
+		
+		# returns values that are logically True
+		TRUE='True'
+		
+		# returns values that are logically False
+		FALSE='False'
+		
+		# returns values that are in the specified list
+		IN='In'
+		
+		# returns values that are not in the specified list
+		NOT_IN='NotIn'
+	end
+	
+end

data/lib/landslider/entities/ws_selling_process.rb

@@ -0,0 +1,17 @@
+
+class Landslider
+
+	class WsSellingProcess < Object
+		
+		# @return [Integer]
+		attr_writer :process_id
+		
+		# @return [String]
+		attr_writer :process_name
+		
+		# @return [WsEntityType]
+		attr_writer :entity_type
+		
+	end
+	
+end

data/lib/landslider/entities/ws_user.rb

@@ -0,0 +1,10 @@
+
+class Landslider
+
+	class WsUser < WsEntity
+		
+		# @return [String]
+		attr_reader :username, :password, :api_key
+	end
+	
+end

data/lib/landslider/entities/ws_user_search.rb

@@ -0,0 +1,20 @@
+class Landslider
+	
+	class WsUserSearch < WsSearch
+		
+		# @return [String]
+		attr_reader :user_name
+
+		# @param [String] user_name a user name
+		def initialize(user_name)
+			@user_name = user_name
+		end
+
+		# @param [Handsoap::XmlMason::Node] msg
+		# @return [Handsoap::XmlMason::Node]
+		def soapify_for(msg)
+			raise 'not implemented'
+		end
+	end
+	
+end

data/lib/landslider/entities.rb

@@ -0,0 +1,46 @@
+require 'landslider/entities/ws_entity'
+require 'landslider/entities/ws_result'
+require 'landslider/entities/ws_primary_entity'
+
+require 'landslider/entities/ws_search'
+require 'landslider/entities/ws_search_criterion'
+require 'landslider/entities/ws_search_operator'
+
+require 'landslider/entities/ws_account'
+require 'landslider/entities/ws_account_note'
+require 'landslider/entities/ws_account_note_search'
+require 'landslider/entities/ws_address'
+
+require 'landslider/entities/ws_contact'
+require 'landslider/entities/ws_contact_note'
+require 'landslider/entities/ws_contact_note_search'
+require 'landslider/entities/ws_contact_search'
+require 'landslider/entities/ws_employee'
+
+require 'landslider/entities/ws_lead'
+require 'landslider/entities/ws_lead_contact'
+require 'landslider/entities/ws_lead_note'
+require 'landslider/entities/ws_lead_note_search'
+require 'landslider/entities/ws_lead_search'
+
+require 'landslider/entities/ws_my_list'
+require 'landslider/entities/ws_note'
+require 'landslider/entities/ws_opportunity'
+require 'landslider/entities/ws_opportunity_note'
+require 'landslider/entities/ws_opportunity_note_search'
+require 'landslider/entities/ws_opportunity_status'
+
+require 'landslider/entities/ws_payment_term'
+
+require 'landslider/entities/ws_pick_list_item'
+require 'landslider/entities/ws_product'
+require 'landslider/entities/ws_product_family'
+require 'landslider/entities/ws_product_result'
+
+
+require 'landslider/entities/ws_search'
+require 'landslider/entities/ws_selling_process'
+require 'landslider/entities/ws_user'
+
+
+