Method: PlatformRest::Integration#patch

Defined in:
lib/platform_rest/integration.rb

#patch(params = {}) ⇒ Object

Updates information about an integration

Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, integration.*, or integration.patch.

Parameters:

  • string applicationId - ID associated with the application

  • string integrationId - ID associated with the integration

  • hash integration - Object containing new properties of the integration (api.losant.com/#/definitions/integrationPatch)

  • string losantdomain - Domain scope of request (rarely needed)

  • boolean _actions - Return resource actions in response

  • boolean _links - Return resource link in response

  • boolean _embedded - Return embedded resources in response

Responses:

Errors:

Raises:

  • (ArgumentError) 


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
 
# File 'lib/platform_rest/integration.rb', line 151

def patch(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { _actions: false, _links: true, _embedded: true }
  headers = {}
  body = nil

  raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
  raise ArgumentError.new("integrationId is required") unless params.has_key?(:integrationId)
  raise ArgumentError.new("integration is required") unless params.has_key?(:integration)

  body = params[:integration] if params.has_key?(:integration)
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
  query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)

  path = "/applications/#{params[:applicationId]}/integrations/#{params[:integrationId]}"

  @client.request(
    method: :patch,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end