Module: AvaTax::Client::EcmEventNotifications

Defined in:
lib/avatax/client/ecmeventnotifications.rb

Instance Method Summary collapse

Instance Method Details

#delete_afc_event_notifications(model, options = {}) ⇒ FetchResult

Delete AFC event notifications.

Security Policies

  • This API depends on the following active services:Required (all): ECMPremiumComms, ECMProComms. Swagger Name: AvaTaxClient

Parameters:

  • isDlq (Boolean) —

    Specify true to delete event notifications from the dead letter queue; otherwise, specify false.

  • model (Object) —

    Details of the event you want to delete.

Returns:

  • (FetchResult) 


15
16
 
# File 'lib/avatax/client/ecmeventnotifications.rb', line 15

def delete_afc_event_notifications(model, options={})        path = "/api/v2/event-notifications/afc"
delete(path, model, options, AvaTax::VERSION)      end

#delete_event_notifications(companyId, model) ⇒ FetchResult

Delete company event notifications

Security Policies

  • This API depends on the following active services:Required (all): ECMPro, ECMPremium. Swagger Name: AvaTaxClient

Parameters:

  • companyId (Integer) —

    The unique ID number of the company that recorded these event notifications.

  • model (Object) —

    Details of the event you want to delete.

Returns:

  • (FetchResult) 


27
28
 
# File 'lib/avatax/client/ecmeventnotifications.rb', line 27

def delete_event_notifications(companyId, model)        path = "/api/v2/event-notifications/companies/#{companyId}"
delete(path, model, {}, AvaTax::VERSION)      end

#get_event_notifications(companyId) ⇒ FetchResult

Retrieve company event notifications.

Security Policies

  • This API depends on the following active services:Required (all): ECMPro, ECMPremium. Swagger Name: AvaTaxClient

Parameters:

  • companyId (Integer) —

    The unique ID number of the company that recorded these event notifications.

Returns:

  • (FetchResult) 


38
39
 
# File 'lib/avatax/client/ecmeventnotifications.rb', line 38

def get_event_notifications(companyId)        path = "/api/v2/event-notifications/companies/#{companyId}"
get(path, {}, AvaTax::VERSION)      end

#list_afc_event_notifications(options = {}) ⇒ FetchResult

Retrieve AFC event notifications

Security Policies

  • This API depends on the following active services:Required (all): ECMPremiumComms, ECMProComms. Swagger Name: AvaTaxClient

Parameters:

  • isDlq (Boolean) —

    Specify true to retrieve event notifications from the dead letter queue; otherwise, specify false.

Returns:

  • (FetchResult) 


49
50
 
# File 'lib/avatax/client/ecmeventnotifications.rb', line 49

def list_afc_event_notifications(options={})        path = "/api/v2/event-notifications/afc"
get(path, options, AvaTax::VERSION)      end