API usability notes

[mfridman]

This ticket tracks API usability of the various methods.

• GetFaxOutbox
• GetFaxInbox

---

• DeleteFax

Delete fax (despite what the official docs state) deletes items based on ID only. Currently a user has to pass in a slice of string representing fax job ID's as ID's or filenames. Consider changing the function signature from:
DeleteFax(ids []string, direction string) (*DeleteResp, error)
to
DeleteFax(direction string, id ...int) (*DeleteResp, error)

Pros:

• easier to read (imo)
• brings method's signature inline with the rest of the pkg; i.e., using int for ID's instead of string

Cons:

• may cause confusion to pkg users. SRFax docs specify ability to use filename, sFaxFileName_, or ID, sFaxDetailsID_. But from using their API deletes are only triggered when a valid ID is present. For this reason a string was passed in, to be able to support a mixture of filename and ID's

---

• GetMulFaxStatus ... change sig to use int instead of string
• RetrieveFax ... change sig to use int instead of string