Class: Conexa::RecurringSale

Inherits:
Model show all
Defined in:
lib/conexa/resources/recurring_sale.rb

Constant Summary

Constants inherited from ConexaObject

ConexaObject::RESOURCES

Instance Attribute Summary

Attributes inherited from ConexaObject

#attributes

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Model

all, #class_name, class_name, #create, create, #destroy, destroy, extract_page_size_or_params, #fetch, find_by, find_by_id, #id, #primary_key, primary_key_attribute, #primary_key_name, #save, #set_primary_key, underscored_class_name

Methods included from Deprecatable

#deprecate

Methods inherited from ConexaObject

#==, #[]=, convert, #empty?, #initialize, #respond_to_missing?, #to_hash, #unsaved_attributes

Constructor Details

This class inherits a constructor from Conexa::ConexaObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Conexa::ConexaObject

Class Method Details

.end_recurring_sale(id, params = {}) ⇒ RecurringSale Also known as: set_end_date

Set a recurring sale's end date by ID

Parameters:

  • id (Integer, String) —

    recurring sale ID

Returns:

See Also:



38
39
40
 
# File 'lib/conexa/resources/recurring_sale.rb', line 38

def end_recurring_sale(id, params = {})
  find(id).end_recurring_sale(params)
end

.show_url(*params) ⇒ Object 



30
31
32
 
# File 'lib/conexa/resources/recurring_sale.rb', line 30

def show_url(*params)
  ["/recurringSale", *params].join '/'
end

.url(*params) ⇒ Object 



26
27
28
 
# File 'lib/conexa/resources/recurring_sale.rb', line 26

def url(*params)
  ["/recurringSales", *params].join '/'
end

Instance Method Details

#end_recurring_sale(params = {}) ⇒ self

Set this recurring sale's end date — closing it, or amending an existing closure.

Like the contract endpoint, this one is documented as "encerra uma venda recorrente ativa ou atualiza a data de encerramento".

Parameters:

  • params (Hash) (defaults to: {})

Options Hash (params):

  • :date (String) —

    required, yyyy-MM-dd — the closing date

  • :end_date (String) —

    deprecated alias for :date; the API rejects the endDate it camelizes to

Returns:

  • (self) 


18
19
20
21
22
 
# File 'lib/conexa/resources/recurring_sale.rb', line 18

def end_recurring_sale(params = {})
  params = Util.normalize_end_date_param(params)
  Conexa::Request.patch(self.class.show_url("end", primary_key), params: params).call(class_name)
  self
end

#set_end_date ⇒ self

Set this recurring sale's end date — closing it, or amending an existing closure.

Like the contract endpoint, this one is documented as "encerra uma venda recorrente ativa ou atualiza a data de encerramento".

Parameters:

  • params (Hash)

Returns:

  • (self) 


23
24
25
26
27
 
# File 'lib/conexa/resources/recurring_sale.rb', line 23

def end_recurring_sale(params = {})
  params = Util.normalize_end_date_param(params)
  Conexa::Request.patch(self.class.show_url("end", primary_key), params: params).call(class_name)
  self
end