Class: MergeCRMClient::EngagementTypesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_crm_client/api/engagement_types_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EngagementTypesApi

Returns a new instance of EngagementTypesApi.



19
20
21
 
# File 'lib/merge_crm_client/api/engagement_types_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_crm_client/api/engagement_types_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#engagement_types_list(x_account_token, opts = {}) ⇒ PaginatedEngagementTypeList

Returns a list of ‘EngagementType` 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, will only return objects modified after this datetime.

  • :modified_before (Time) —

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

  • :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_crm_client/api/engagement_types_api.rb', line 35

def engagement_types_list(, opts = {})
  data, _status_code, _headers = engagement_types_list_with_http_info(, opts)
  data
end

#engagement_types_list_with_http_info(x_account_token, opts = {}) ⇒ Array<(PaginatedEngagementTypeList, Integer, Hash)>

Returns a list of &#x60;EngagementType&#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, will only return objects modified after this datetime.

  • :modified_before (Time) —

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

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

    PaginatedEngagementTypeList 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_crm_client/api/engagement_types_api.rb', line 53

def engagement_types_list_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EngagementTypesApi.engagement_types_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 EngagementTypesApi.engagement_types_list"
  end
  # resource path
  local_var_path = '/engagement-types'

  # 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] || 'PaginatedEngagementTypeList'

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

  new_options = opts.merge(
    :operation => :"EngagementTypesApi.engagement_types_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: EngagementTypesApi#engagement_types_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#engagement_types_retrieve(x_account_token, id, opts = {}) ⇒ EngagementType

Returns an ‘EngagementType` 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_crm_client/api/engagement_types_api.rb', line 117

def engagement_types_retrieve(, id, opts = {})
  data, _status_code, _headers = engagement_types_retrieve_with_http_info(, id, opts)
  data
end

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

Returns an &#x60;EngagementType&#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<(EngagementType, Integer, Hash)>) —

    EngagementType 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_crm_client/api/engagement_types_api.rb', line 128

def engagement_types_retrieve_with_http_info(, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EngagementTypesApi.engagement_types_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 EngagementTypesApi.engagement_types_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 EngagementTypesApi.engagement_types_retrieve"
  end
  # resource path
  local_var_path = '/engagement-types/{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] || 'EngagementType'

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

  new_options = opts.merge(
    :operation => :"EngagementTypesApi.engagement_types_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: EngagementTypesApi#engagement_types_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end