Class: ConnectWise::CampaignTypeInfosApi

Inherits:
Object
  • Object
show all
Defined in:
lib/connect_wise/api/campaign_type_infos_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CampaignTypeInfosApi

Returns a new instance of CampaignTypeInfosApi.



17
18
19
 
# File 'lib/connect_wise/api/campaign_type_infos_api.rb', line 17

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/connect_wise/api/campaign_type_infos_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#get_marketing_campaigns_types_by_id_info(id, client_id, opts = {}) ⇒ CampaignTypeInfo

Get CampaignTypeInfo

Parameters:

  • id (Integer) —

    typeId

  • client_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Returns:



34
35
36
37
 
# File 'lib/connect_wise/api/campaign_type_infos_api.rb', line 34

def get_marketing_campaigns_types_by_id_info(id, client_id, opts = {})
  data, _status_code, _headers = get_marketing_campaigns_types_by_id_info_with_http_info(id, client_id, opts)
  data
end

#get_marketing_campaigns_types_by_id_info_with_http_info(id, client_id, opts = {}) ⇒ Array<(CampaignTypeInfo, Integer, Hash)>

Get CampaignTypeInfo

Parameters:

  • id (Integer) —

    typeId

  • client_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Returns:

  • (Array<(CampaignTypeInfo, Integer, Hash)>) —

    CampaignTypeInfo data, response status code and response headers

Raises:

  • (ArgumentError) 


52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/connect_wise/api/campaign_type_infos_api.rb', line 52

def get_marketing_campaigns_types_by_id_info_with_http_info(id, client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: CampaignTypeInfosApi.get_marketing_campaigns_types_by_id_info ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  raise ArgumentError, "Missing the required parameter 'id' when calling CampaignTypeInfosApi.get_marketing_campaigns_types_by_id_info" if @api_client.config.client_side_validation && id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling CampaignTypeInfosApi.get_marketing_campaigns_types_by_id_info" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/marketing/campaigns/types/{id}/info'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:conditions] = opts[:conditions] unless opts[:conditions].nil?
  query_params[:childConditions] = opts[:child_conditions] unless opts[:child_conditions].nil?
  query_params[:customFieldConditions] = opts[:custom_field_conditions] unless opts[:custom_field_conditions].nil?
  query_params[:orderBy] = opts[:order_by] unless opts[:order_by].nil?
  query_params[:fields] = opts[:fields] unless opts[:fields].nil?
  query_params[:page] = opts[:page] unless opts[:page].nil?
  query_params[:pageSize] = opts[:page_size] unless opts[:page_size].nil?
  query_params[:pageId] = opts[:page_id] unless opts[:page_id].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CampaignTypeInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'CampaignTypeInfosApi.get_marketing_campaigns_types_by_id_info',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  @api_client.config.logger.debug "API called: CampaignTypeInfosApi#get_marketing_campaigns_types_by_id_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_marketing_campaigns_types_info(client_id, opts = {}) ⇒ Array<CampaignTypeInfo>

Get List of CampaignTypeInfos

Parameters:

  • client_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Returns:



118
119
120
121
 
# File 'lib/connect_wise/api/campaign_type_infos_api.rb', line 118

def get_marketing_campaigns_types_info(client_id, opts = {})
  data, _status_code, _headers = get_marketing_campaigns_types_info_with_http_info(client_id, opts)
  data
end

#get_marketing_campaigns_types_info_count(client_id, opts = {}) ⇒ Count

Get Count of CampaignTypeInfos

Parameters:

  • client_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Returns:



199
200
201
202
 
# File 'lib/connect_wise/api/campaign_type_infos_api.rb', line 199

def get_marketing_campaigns_types_info_count(client_id, opts = {})
  data, _status_code, _headers = get_marketing_campaigns_types_info_count_with_http_info(client_id, opts)
  data
end

#get_marketing_campaigns_types_info_count_with_http_info(client_id, opts = {}) ⇒ Array<(Count, Integer, Hash)>

Get Count of CampaignTypeInfos

Parameters:

  • client_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Returns:

  • (Array<(Count, Integer, Hash)>) —

    Count data, response status code and response headers

Raises:

  • (ArgumentError) 


216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/connect_wise/api/campaign_type_infos_api.rb', line 216

def get_marketing_campaigns_types_info_count_with_http_info(client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: CampaignTypeInfosApi.get_marketing_campaigns_types_info_count ...' if @api_client.config.debugging
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling CampaignTypeInfosApi.get_marketing_campaigns_types_info_count" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/marketing/campaigns/types/info/count'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:conditions] = opts[:conditions] unless opts[:conditions].nil?
  query_params[:childConditions] = opts[:child_conditions] unless opts[:child_conditions].nil?
  query_params[:customFieldConditions] = opts[:custom_field_conditions] unless opts[:custom_field_conditions].nil?
  query_params[:orderBy] = opts[:order_by] unless opts[:order_by].nil?
  query_params[:fields] = opts[:fields] unless opts[:fields].nil?
  query_params[:page] = opts[:page] unless opts[:page].nil?
  query_params[:pageSize] = opts[:page_size] unless opts[:page_size].nil?
  query_params[:pageId] = opts[:page_id] unless opts[:page_id].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Count'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'CampaignTypeInfosApi.get_marketing_campaigns_types_info_count',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  @api_client.config.logger.debug "API called: CampaignTypeInfosApi#get_marketing_campaigns_types_info_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_marketing_campaigns_types_info_with_http_info(client_id, opts = {}) ⇒ Array<(Array<CampaignTypeInfo>, Integer, Hash)>

Get List of CampaignTypeInfos

Parameters:

  • client_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Returns:

  • (Array<(Array<CampaignTypeInfo>, Integer, Hash)>) —

    Array<CampaignTypeInfo> data, response status code and response headers

Raises:

  • (ArgumentError) 


135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/connect_wise/api/campaign_type_infos_api.rb', line 135

def get_marketing_campaigns_types_info_with_http_info(client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: CampaignTypeInfosApi.get_marketing_campaigns_types_info ...' if @api_client.config.debugging
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling CampaignTypeInfosApi.get_marketing_campaigns_types_info" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/marketing/campaigns/types/info'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:conditions] = opts[:conditions] unless opts[:conditions].nil?
  query_params[:childConditions] = opts[:child_conditions] unless opts[:child_conditions].nil?
  query_params[:customFieldConditions] = opts[:custom_field_conditions] unless opts[:custom_field_conditions].nil?
  query_params[:orderBy] = opts[:order_by] unless opts[:order_by].nil?
  query_params[:fields] = opts[:fields] unless opts[:fields].nil?
  query_params[:page] = opts[:page] unless opts[:page].nil?
  query_params[:pageSize] = opts[:page_size] unless opts[:page_size].nil?
  query_params[:pageId] = opts[:page_id] unless opts[:page_id].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<CampaignTypeInfo>'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'CampaignTypeInfosApi.get_marketing_campaigns_types_info',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  @api_client.config.logger.debug "API called: CampaignTypeInfosApi#get_marketing_campaigns_types_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end