Module: Helio::APIOperations::Save

Included in:
CustomerList, Participant
Defined in:
lib/helio/api_operations/save.rb

Defined Under Namespace

Modules: ClassMethods

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



72
73
74
 
# File 'lib/helio/api_operations/save.rb', line 72

def self.included(base)
  base.extend(ClassMethods)
end

Instance Method Details

#save(params = {}, opts = {}) ⇒ Object

Creates or updates an API resource.

If the resource doesn’t yet have an assigned ID and the resource is one that can be created, then the method attempts to create the resource. The resource is updated otherwise.

Attributes

  • params - Overrides any parameters in the resource’s serialized data and includes them in the create or update. If :req_url: is included in the list, it overrides the update URL used for the create or update.

  • opts - A Hash of additional options (separate from the params / object values) to be added to the request. E.g. to allow for an idempotency_key to be passed in the request headers, or for the api_token to be overwritten. See APIOperations::Request.request.



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/helio/api_operations/save.rb', line 47

def save(params = {}, opts = {})
  # We started unintentionally (sort of) allowing attributes sent to
  # +save+ to override values used during the update. So as not to break
  # the API, this makes that official here.
  update_attributes(params)

  # Now remove any parameters that look like object attributes.
  params = params.reject { |k, _| respond_to?(k) }

  values = serialize_params(self).merge(params)

  request_method = if self['id']
    :put
  else
    :post
  end

  # note that id gets removed here our call to #url above has already
  # generated a uri for this object with an identifier baked in
  values.delete(:id)

  resp, opts = request(request_method, save_url, values, opts)
  initialize_from(resp.data, opts)
end