Class: MergeTicketingClient::ProjectsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ticketing_client/api/projects_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ProjectsApi

Returns a new instance of ProjectsApi.



19
20
21
 
# File 'lib/merge_ticketing_client/api/projects_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/merge_ticketing_client/api/projects_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#projects_list(x_account_token, opts = {}) ⇒ PaginatedProjectList

Returns a list of ‘Project` objects.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

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

    the optional parameters

Options Hash (opts):

  • :created_after (Time) —

    If provided, will only return objects created after this datetime.

  • :created_before (Time) —

    If provided, will only return objects created before this datetime.

  • :cursor (String) —

    The pagination cursor value.

  • :include_deleted_data (Boolean) —

    Whether to include data that was marked as deleted by third party webhooks.

  • :include_remote_data (Boolean) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • :modified_after (Time) —

    If provided, only objects synced by Merge after this date time will be returned.

  • :modified_before (Time) —

    If provided, only objects synced by Merge before this date time will be returned.

  • :page_size (Integer) —

    Number of results to return per page.

  • :remote_id (String) —

    The API provider's ID for the given object.

Returns:



35
36
37
38
 
# File 'lib/merge_ticketing_client/api/projects_api.rb', line 35

def projects_list(, opts = {})
  data, _status_code, _headers = projects_list_with_http_info(, opts)
  data
end

#projects_list_with_http_info(x_account_token, opts = {}) ⇒ Array<(PaginatedProjectList, Integer, Hash)>

Returns a list of &#x60;Project&#x60; objects.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

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

    the optional parameters

Options Hash (opts):

  • :created_after (Time) —

    If provided, will only return objects created after this datetime.

  • :created_before (Time) —

    If provided, will only return objects created before this datetime.

  • :cursor (String) —

    The pagination cursor value.

  • :include_deleted_data (Boolean) —

    Whether to include data that was marked as deleted by third party webhooks.

  • :include_remote_data (Boolean) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • :modified_after (Time) —

    If provided, only objects synced by Merge after this date time will be returned.

  • :modified_before (Time) —

    If provided, only objects synced by Merge before this date time will be returned.

  • :page_size (Integer) —

    Number of results to return per page.

  • :remote_id (String) —

    The API provider&#39;s ID for the given object.

Returns:

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

    PaginatedProjectList data, response status code and response headers



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
105
106
107
108
109
 
# File 'lib/merge_ticketing_client/api/projects_api.rb', line 53

def projects_list_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProjectsApi.projects_list ...'
  end
  # verify the required parameter 'x_account_token' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_token' when calling ProjectsApi.projects_list"
  end
  # resource path
  local_var_path = '/projects'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
  query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
  query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
  query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Account-Token'] = 

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

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

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

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

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

#projects_retrieve(x_account_token, id, opts = {}) ⇒ Project

Returns a ‘Project` object with the given `id`.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

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

    the optional parameters

Options Hash (opts):

  • :include_remote_data (Boolean) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

Returns:



117
118
119
120
 
# File 'lib/merge_ticketing_client/api/projects_api.rb', line 117

def projects_retrieve(, id, opts = {})
  data, _status_code, _headers = projects_retrieve_with_http_info(, id, opts)
  data
end

#projects_retrieve_with_http_info(x_account_token, id, opts = {}) ⇒ Array<(Project, Integer, Hash)>

Returns a &#x60;Project&#x60; object with the given &#x60;id&#x60;.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

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

    the optional parameters

Options Hash (opts):

  • :include_remote_data (Boolean) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

Returns:

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

    Project data, response status code and response headers



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
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/merge_ticketing_client/api/projects_api.rb', line 128

def projects_retrieve_with_http_info(, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProjectsApi.projects_retrieve ...'
  end
  # verify the required parameter 'x_account_token' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_token' when calling ProjectsApi.projects_retrieve"
  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 ProjectsApi.projects_retrieve"
  end
  # resource path
  local_var_path = '/projects/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Account-Token'] = 

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

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

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

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

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

#projects_users_list(x_account_token, parent_id, opts = {}) ⇒ PaginatedUserList

Returns a list of ‘User` objects.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

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

    the optional parameters

Options Hash (opts):

  • :cursor (String) —

    The pagination cursor value.

  • :expand (String) —

    Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

  • :include_deleted_data (Boolean) —

    Whether to include data that was marked as deleted by third party webhooks.

  • :include_remote_data (Boolean) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • :page_size (Integer) —

    Number of results to return per page.

Returns:



192
193
194
195
 
# File 'lib/merge_ticketing_client/api/projects_api.rb', line 192

def projects_users_list(, parent_id, opts = {})
  data, _status_code, _headers = projects_users_list_with_http_info(, parent_id, opts)
  data
end

#projects_users_list_with_http_info(x_account_token, parent_id, opts = {}) ⇒ Array<(PaginatedUserList, Integer, Hash)>

Returns a list of &#x60;User&#x60; objects.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

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

    the optional parameters

Options Hash (opts):

  • :cursor (String) —

    The pagination cursor value.

  • :expand (String) —

    Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

  • :include_deleted_data (Boolean) —

    Whether to include data that was marked as deleted by third party webhooks.

  • :include_remote_data (Boolean) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • :page_size (Integer) —

    Number of results to return per page.

Returns:

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

    PaginatedUserList data, response status code and response headers



207
208
209
210
211
212
213
214
215
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
267
 
# File 'lib/merge_ticketing_client/api/projects_api.rb', line 207

def projects_users_list_with_http_info(, parent_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProjectsApi.projects_users_list ...'
  end
  # verify the required parameter 'x_account_token' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_token' when calling ProjectsApi.projects_users_list"
  end
  # verify the required parameter 'parent_id' is set
  if @api_client.config.client_side_validation && parent_id.nil?
    fail ArgumentError, "Missing the required parameter 'parent_id' when calling ProjectsApi.projects_users_list"
  end
  allowable_values = ["roles", "teams", "teams,roles"]
  if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
    fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/projects/{parent_id}/users'.sub('{' + 'parent_id' + '}', CGI.escape(parent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Account-Token'] = 

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

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

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

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

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