Class: ConnectWise::MarketplaceImportsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MarketplaceImportsApi

Returns a new instance of MarketplaceImportsApi.



17
18
19
 
# File 'lib/connect_wise/api/marketplace_imports_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/marketplace_imports_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#get_system_marketplaceimport_getdefinition_by_id(id, client_id, opts = {}) ⇒ MarketplaceImport

Get MarketplaceImport

Parameters:

  • id (Integer) —

    getdefinitionId

  • 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/marketplace_imports_api.rb', line 34

def get_system_marketplaceimport_getdefinition_by_id(id, client_id, opts = {})
  data, _status_code, _headers = get_system_marketplaceimport_getdefinition_by_id_with_http_info(id, client_id, opts)
  data
end

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

Get MarketplaceImport

Parameters:

  • id (Integer) —

    getdefinitionId

  • 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<(MarketplaceImport, Integer, Hash)>) —

    MarketplaceImport 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/marketplace_imports_api.rb', line 52

def get_system_marketplaceimport_getdefinition_by_id_with_http_info(id, client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: MarketplaceImportsApi.get_system_marketplaceimport_getdefinition_by_id ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  raise ArgumentError, "Missing the required parameter 'id' when calling MarketplaceImportsApi.get_system_marketplaceimport_getdefinition_by_id" 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 MarketplaceImportsApi.get_system_marketplaceimport_getdefinition_by_id" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/system/marketplaceimport/getdefinition/{id}'.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] || 'MarketplaceImport'

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

  new_options = opts.merge(
    operation: :'MarketplaceImportsApi.get_system_marketplaceimport_getdefinition_by_id',
    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: MarketplaceImportsApi#get_system_marketplaceimport_getdefinition_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#post_system_marketplaceimport_import(client_id, marketplace_import, opts = {}) ⇒ MarketplaceImport

Post MarketplaceImport

Parameters:

  • client_id (String)
  • marketplace_import (MarketplaceImport) —

    marketplaceImport

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

    the optional parameters

Returns:



111
112
113
114
 
# File 'lib/connect_wise/api/marketplace_imports_api.rb', line 111

def post_system_marketplaceimport_import(client_id, marketplace_import, opts = {})
  data, _status_code, _headers = post_system_marketplaceimport_import_with_http_info(client_id, marketplace_import, opts)
  data
end

#post_system_marketplaceimport_import_with_http_info(client_id, marketplace_import, opts = {}) ⇒ Array<(MarketplaceImport, Integer, Hash)>

Post MarketplaceImport

Parameters:

  • client_id (String)
  • marketplace_import (MarketplaceImport) —

    marketplaceImport

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

    the optional parameters

Returns:

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

    MarketplaceImport data, response status code and response headers

Raises:

  • (ArgumentError) 


121
122
123
124
125
126
127
128
129
130
131
132
133
134
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
 
# File 'lib/connect_wise/api/marketplace_imports_api.rb', line 121

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

  # resource path
  local_var_path = '/system/marketplaceimport/import'

  # query parameters
  query_params = opts[:query_params] || {}

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  header_params['Content-Type'] = content_type unless content_type.nil?
  header_params[:clientId] = client_id

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(marketplace_import)

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

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

  new_options = opts.merge(
    operation: :'MarketplaceImportsApi.post_system_marketplaceimport_import',
    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(:POST, local_var_path, new_options)
  @api_client.config.logger.debug "API called: MarketplaceImportsApi#post_system_marketplaceimport_import\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end