Class: ErpIntegration::Fulfil::Resources::Webhook

Inherits:
ApiResource
  • Object
show all
Defined in:
lib/erp_integration/fulfil/resources/webhook.rb

Constant Summary

Constants included from PaginationMethods

PaginationMethods::DEFAULT_LIMIT, PaginationMethods::DEFAULT_OFFSET, PaginationMethods::MAX_LIMIT

Instance Attribute Summary

Attributes inherited from ApiResource

#resource_klass

Attributes included from QueryMethods

#or_clauses, #selected_fields, #where_clauses

Attributes included from PaginationMethods

#limit_value, #offset_value, #page_number

Instance Method Summary collapse

Methods inherited from ApiResource

#all, api_keys_pool, api_keys_pool=, client, config, #count, #each, #find_each, #initialize, model_name, model_name=

Methods included from QueryMethods

#or, #or!, #select, #select!, #where, #where!, #where_domain, #where_ilike, #where_in, #where_less_or_equal_to, #where_less_than, #where_like, #where_more_or_equal_to, #where_more_than, #where_not, #where_not_in

Methods included from Persistence

#create, #destroy, #update

Methods included from PaginationMethods

#limit, #limit!, #offset, #offset!, #page, #page!

Methods included from FinderMethods

#find, #find_by, #find_by!

Methods included from Context

#context?, #with_context

Constructor Details

This class inherits a constructor from ErpIntegration::Fulfil::ApiResource

Instance Method Details

#archive(id) ⇒ Boolean

Archives the webhook with the given ID.

Parameters:

  • id (Integer) —

    The ID of the webhook to archive.

Returns:

  • (Boolean) —

    Whether the webhook was archived successfully or not.



14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/erp_integration/fulfil/resources/webhook.rb', line 14

def archive(id)
  client.put("model/#{model_name}/archive", [[id]])
  true
rescue ErpIntegration::HttpError::BadRequest
  false
# Workaround: Fulfil api does not return a json when status code is 200
# (a.k.a. "Ok") and faraday is having an error when trying to parse it.
# Let's skip the parse error and move on.
rescue Faraday::ParsingError
  true
end

#restore(id) ⇒ Boolean

Restores the webhook with the given ID.

Parameters:

  • id (Integer) —

    The ID of the webhook to be restored.

Returns:

  • (Boolean) —

    Whether the webhook was restored successfully or not.



29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/erp_integration/fulfil/resources/webhook.rb', line 29

def restore(id)
  client.put("model/#{model_name}/restore", [[id]])
  true
rescue ErpIntegration::HttpError::BadRequest
  false
# Workaround: Fulfil api does not return a json when status code is 200
# (a.k.a. "Ok") and faraday is having an error when trying to parse it.
# Let's skip the parse error and move on.
rescue Faraday::ParsingError
  true
end