class ConnectWise::CampaignsApi
Attributes
Public Class Methods
# File lib/connectwise-ruby-sdk/api/campaigns_api.rb, line 8 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Get Campaigns Count
@param [Hash] opts the optional parameters @option opts [String] :conditions @return [Count]
# File lib/connectwise-ruby-sdk/api/campaigns_api.rb, line 17 def marketing_campaigns_count_get(opts = {}) data, _status_code, _headers = marketing_campaigns_count_get_with_http_info(opts) return data end
Get Campaigns Count
@param [Hash] opts the optional parameters @option opts [String] :conditions @return [Array<(Count
, Fixnum, Hash)>] Count
data, response status code and response headers
# File lib/connectwise-ruby-sdk/api/campaigns_api.rb, line 27 def marketing_campaigns_count_get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CampaignsApi.marketing_campaigns_count_get ..." end # resource path local_var_path = "/marketing/campaigns/count" # query parameters query_params = {} query_params[:'conditions'] = opts[:'conditions'] if !opts[:'conditions'].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 = ['BasicAuth'] 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 => 'Count') if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#marketing_campaigns_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get Campaigns @param [Hash] opts the optional parameters @option opts [String] :conditions @option opts [String] :order_by @option opts [String] :childconditions @option opts [String] :customfieldconditions @option opts [Integer] :page @option opts [Integer] :page_size @return [Array<Campaign>]
# File lib/connectwise-ruby-sdk/api/campaigns_api.rb, line 72 def marketing_campaigns_get(opts = {}) data, _status_code, _headers = marketing_campaigns_get_with_http_info(opts) return data end
Get Campaigns @param [Hash] opts the optional parameters @option opts [String] :conditions @option opts [String] :order_by @option opts [String] :childconditions @option opts [String] :customfieldconditions @option opts [Integer] :page @option opts [Integer] :page_size @return [Array<(Array<Campaign>, Fixnum, Hash)>] Array<Campaign> data, response status code and response headers
# File lib/connectwise-ruby-sdk/api/campaigns_api.rb, line 87 def marketing_campaigns_get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CampaignsApi.marketing_campaigns_get ..." end # resource path local_var_path = "/marketing/campaigns" # query parameters query_params = {} query_params[:'conditions'] = opts[:'conditions'] if !opts[:'conditions'].nil? query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil? query_params[:'childconditions'] = opts[:'childconditions'] if !opts[:'childconditions'].nil? query_params[:'customfieldconditions'] = opts[:'customfieldconditions'] if !opts[:'customfieldconditions'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].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 = ['BasicAuth'] 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 => 'Array<Campaign>') if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#marketing_campaigns_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get Campaign
Activities Count
@param id @param [Hash] opts the optional parameters @return [Count]
# File lib/connectwise-ruby-sdk/api/campaigns_api.rb, line 132 def marketing_campaigns_id_activities_count_get(id, opts = {}) data, _status_code, _headers = marketing_campaigns_id_activities_count_get_with_http_info(id, opts) return data end
Get Campaign
Activities Count
@param id @param [Hash] opts the optional parameters @return [Array<(Count
, Fixnum, Hash)>] Count
data, response status code and response headers
# File lib/connectwise-ruby-sdk/api/campaigns_api.rb, line 142 def marketing_campaigns_id_activities_count_get_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CampaignsApi.marketing_campaigns_id_activities_count_get ..." end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.marketing_campaigns_id_activities_count_get" end # resource path local_var_path = "/marketing/campaigns/{id}/activities/count".sub('{' + 'id' + '}', 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 = ['BasicAuth'] 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 => 'Count') if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#marketing_campaigns_id_activities_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get Campaign
Activities @param id @param [Hash] opts the optional parameters @option opts [Integer] :page @option opts [Integer] :page_size @return [Array<ActivityReference>]
# File lib/connectwise-ruby-sdk/api/campaigns_api.rb, line 187 def marketing_campaigns_id_activities_get(id, opts = {}) data, _status_code, _headers = marketing_campaigns_id_activities_get_with_http_info(id, opts) return data end
Get Campaign
Activities @param id @param [Hash] opts the optional parameters @option opts [Integer] :page @option opts [Integer] :page_size @return [Array<(Array<ActivityReference>, Fixnum, Hash)>] Array<ActivityReference> data, response status code and response headers
# File lib/connectwise-ruby-sdk/api/campaigns_api.rb, line 199 def marketing_campaigns_id_activities_get_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CampaignsApi.marketing_campaigns_id_activities_get ..." end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.marketing_campaigns_id_activities_get" end # resource path local_var_path = "/marketing/campaigns/{id}/activities".sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].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 = ['BasicAuth'] 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 => 'Array<ActivityReference>') if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#marketing_campaigns_id_activities_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete Campaign
By Id @param id @param [Hash] opts the optional parameters @return [nil]
# File lib/connectwise-ruby-sdk/api/campaigns_api.rb, line 244 def marketing_campaigns_id_delete(id, opts = {}) marketing_campaigns_id_delete_with_http_info(id, opts) return nil end
Delete Campaign
By Id @param id @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/connectwise-ruby-sdk/api/campaigns_api.rb, line 254 def marketing_campaigns_id_delete_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CampaignsApi.marketing_campaigns_id_delete ..." end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.marketing_campaigns_id_delete" end # resource path local_var_path = "/marketing/campaigns/{id}".sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters header_params = {} # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['BasicAuth'] data, status_code, headers = @api_client.call_api(:DELETE, 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: CampaignsApi#marketing_campaigns_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get Campaign
By Id @param id @param [Hash] opts the optional parameters @return [Campaign]
# File lib/connectwise-ruby-sdk/api/campaigns_api.rb, line 294 def marketing_campaigns_id_get(id, opts = {}) data, _status_code, _headers = marketing_campaigns_id_get_with_http_info(id, opts) return data end
Get Campaign
By Id @param id @param [Hash] opts the optional parameters @return [Array<(Campaign
, Fixnum, Hash)>] Campaign
data, response status code and response headers
# File lib/connectwise-ruby-sdk/api/campaigns_api.rb, line 304 def marketing_campaigns_id_get_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CampaignsApi.marketing_campaigns_id_get ..." end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.marketing_campaigns_id_get" end # resource path local_var_path = "/marketing/campaigns/{id}".sub('{' + 'id' + '}', 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 = ['BasicAuth'] 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 => 'Campaign') if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#marketing_campaigns_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get Campaign
Opportunities Count
@param id @param [Hash] opts the optional parameters @return [Count]
# File lib/connectwise-ruby-sdk/api/campaigns_api.rb, line 347 def marketing_campaigns_id_opportunities_count_get(id, opts = {}) data, _status_code, _headers = marketing_campaigns_id_opportunities_count_get_with_http_info(id, opts) return data end
Get Campaign
Opportunities Count
@param id @param [Hash] opts the optional parameters @return [Array<(Count
, Fixnum, Hash)>] Count
data, response status code and response headers
# File lib/connectwise-ruby-sdk/api/campaigns_api.rb, line 357 def marketing_campaigns_id_opportunities_count_get_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CampaignsApi.marketing_campaigns_id_opportunities_count_get ..." end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.marketing_campaigns_id_opportunities_count_get" end # resource path local_var_path = "/marketing/campaigns/{id}/opportunities/count".sub('{' + 'id' + '}', 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 = ['BasicAuth'] 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 => 'Count') if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#marketing_campaigns_id_opportunities_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get Campaign
Opportunities @param id @param [Hash] opts the optional parameters @option opts [Integer] :page @option opts [Integer] :page_size @return [Array<OpportunityReference>]
# File lib/connectwise-ruby-sdk/api/campaigns_api.rb, line 402 def marketing_campaigns_id_opportunities_get(id, opts = {}) data, _status_code, _headers = marketing_campaigns_id_opportunities_get_with_http_info(id, opts) return data end
Get Campaign
Opportunities @param id @param [Hash] opts the optional parameters @option opts [Integer] :page @option opts [Integer] :page_size @return [Array<(Array<OpportunityReference>, Fixnum, Hash)>] Array<OpportunityReference> data, response status code and response headers
# File lib/connectwise-ruby-sdk/api/campaigns_api.rb, line 414 def marketing_campaigns_id_opportunities_get_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CampaignsApi.marketing_campaigns_id_opportunities_get ..." end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.marketing_campaigns_id_opportunities_get" end # resource path local_var_path = "/marketing/campaigns/{id}/opportunities".sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].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 = ['BasicAuth'] 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 => 'Array<OpportunityReference>') if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#marketing_campaigns_id_opportunities_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update Campaign
@param id @param operations @param [Hash] opts the optional parameters @return [Campaign]
# File lib/connectwise-ruby-sdk/api/campaigns_api.rb, line 460 def marketing_campaigns_id_patch(id, operations, opts = {}) data, _status_code, _headers = marketing_campaigns_id_patch_with_http_info(id, operations, opts) return data end
Update Campaign
@param id @param operations @param [Hash] opts the optional parameters @return [Array<(Campaign
, Fixnum, Hash)>] Campaign
data, response status code and response headers
# File lib/connectwise-ruby-sdk/api/campaigns_api.rb, line 471 def marketing_campaigns_id_patch_with_http_info(id, operations, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CampaignsApi.marketing_campaigns_id_patch ..." end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.marketing_campaigns_id_patch" end # verify the required parameter 'operations' is set if @api_client.config.client_side_validation && operations.nil? fail ArgumentError, "Missing the required parameter 'operations' when calling CampaignsApi.marketing_campaigns_id_patch" end # resource path local_var_path = "/marketing/campaigns/{id}".sub('{' + 'id' + '}', 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']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(operations) auth_names = ['BasicAuth'] data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Campaign') if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#marketing_campaigns_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Replace Campaign
@param id @param campaign @param [Hash] opts the optional parameters @return [Campaign]
# File lib/connectwise-ruby-sdk/api/campaigns_api.rb, line 521 def marketing_campaigns_id_put(id, campaign, opts = {}) data, _status_code, _headers = marketing_campaigns_id_put_with_http_info(id, campaign, opts) return data end
Replace Campaign
@param id @param campaign @param [Hash] opts the optional parameters @return [Array<(Campaign
, Fixnum, Hash)>] Campaign
data, response status code and response headers
# File lib/connectwise-ruby-sdk/api/campaigns_api.rb, line 532 def marketing_campaigns_id_put_with_http_info(id, campaign, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CampaignsApi.marketing_campaigns_id_put ..." end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.marketing_campaigns_id_put" end # verify the required parameter 'campaign' is set if @api_client.config.client_side_validation && campaign.nil? fail ArgumentError, "Missing the required parameter 'campaign' when calling CampaignsApi.marketing_campaigns_id_put" end # resource path local_var_path = "/marketing/campaigns/{id}".sub('{' + 'id' + '}', 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']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(campaign) auth_names = ['BasicAuth'] 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 => 'Campaign') if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#marketing_campaigns_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create Campaign
@param campaign @param [Hash] opts the optional parameters @return [Campaign]
# File lib/connectwise-ruby-sdk/api/campaigns_api.rb, line 581 def marketing_campaigns_post(campaign, opts = {}) data, _status_code, _headers = marketing_campaigns_post_with_http_info(campaign, opts) return data end
Create Campaign
@param campaign @param [Hash] opts the optional parameters @return [Array<(Campaign
, Fixnum, Hash)>] Campaign
data, response status code and response headers
# File lib/connectwise-ruby-sdk/api/campaigns_api.rb, line 591 def marketing_campaigns_post_with_http_info(campaign, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CampaignsApi.marketing_campaigns_post ..." end # verify the required parameter 'campaign' is set if @api_client.config.client_side_validation && campaign.nil? fail ArgumentError, "Missing the required parameter 'campaign' when calling CampaignsApi.marketing_campaigns_post" end # resource path local_var_path = "/marketing/campaigns" # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(campaign) auth_names = ['BasicAuth'] 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 => 'Campaign') if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#marketing_campaigns_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end