lib/avatax/client/contacts.rb in avatax-20.7.0 vs lib/avatax/client/contacts.rb in avatax-20.7.1

- old
+ new

@@ -13,32 +13,26 @@ # # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. # @param companyId [Integer] The ID of the company that owns this contact. # @param model [ContactModel[]] The contacts you wish to create. # @return [ContactModel[]] - def create_contacts(companyId, model) - path = "/api/v2/companies/#{companyId}/contacts" - post(path, model) - end + def create_contacts(companyId, model) path = "/api/v2/companies/#{companyId}/contacts" + post(path, model) end - # Delete a single contact # # Mark the existing contact object at this URL as deleted. # # ### Security Policies # # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. # @param companyId [Integer] The ID of the company that owns this contact. # @param id [Integer] The ID of the contact you wish to delete. # @return [ErrorDetail[]] - def delete_contact(companyId, id) - path = "/api/v2/companies/#{companyId}/contacts/#{id}" - delete(path) - end + def delete_contact(companyId, id) path = "/api/v2/companies/#{companyId}/contacts/#{id}" + delete(path) end - # Retrieve a single contact # # Get the contact object identified by this URL. # A 'contact' is a person associated with a company who is designated to handle certain responsibilities of # a tax collecting and filing entity. @@ -47,16 +41,13 @@ # # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. # @param companyId [Integer] The ID of the company for this contact # @param id [Integer] The primary key of this contact # @return [Object] - def get_contact(companyId, id) - path = "/api/v2/companies/#{companyId}/contacts/#{id}" - get(path) - end + def get_contact(companyId, id) path = "/api/v2/companies/#{companyId}/contacts/#{id}" + get(path) end - # Retrieve contacts for this company # # List all contact objects assigned to this company. # # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . @@ -69,16 +60,13 @@ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. # @return [FetchResult] - def list_contacts_by_company(companyId, options={}) - path = "/api/v2/companies/#{companyId}/contacts" - get(path, options) - end + def list_contacts_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/contacts" + get(path, options) end - # Retrieve all contacts # # Get multiple contact objects across all companies. # A 'contact' is a person associated with a company who is designated to handle certain responsibilities of # a tax collecting and filing entity. @@ -92,16 +80,13 @@ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. # @return [FetchResult] - def query_contacts(options={}) - path = "/api/v2/contacts" - get(path, options) - end + def query_contacts(options={}) path = "/api/v2/contacts" + get(path, options) end - # Update a single contact # # Replace the existing contact object at this URL with an updated object. # A 'contact' is a person associated with a company who is designated to handle certain responsibilities of # a tax collecting and filing entity. @@ -113,13 +98,10 @@ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. # @param companyId [Integer] The ID of the company that this contact belongs to. # @param id [Integer] The ID of the contact you wish to update # @param model [Object] The contact you wish to update. # @return [Object] - def update_contact(companyId, id, model) - path = "/api/v2/companies/#{companyId}/contacts/#{id}" - put(path, model) - end - + def update_contact(companyId, id, model) path = "/api/v2/companies/#{companyId}/contacts/#{id}" + put(path, model) end end end end \ No newline at end of file