Freshdesk Export v0.1.1 FreshdeskExport View Source

Link to this section Summary

Functions

Returns a single ticket. Requires an id as a parameter

Returns a list of all of the tickets from a Freshdesk instance. By default it will start on page 1 but accepts an integer start_page as a parameter for starting on a page greater than or equal to 1

Returns a list of tickets on a specific page. Requires a page number as a parameter

Naturally, the get/request functions will return a descending list of data. This function utilizes Enum.reverse() to switch it to an ascending list instead. |> your ticket lists to this function for ease of use

By default, this function will create a directory structure of “data/json” and store a JSON file in the json directory with a unix timestamp in the title to make sure the file is unique. Alternatively, you can provide a second custom path parameter to save it to by providing a string for a folder name or utilizing Path.join()/1 or Path.join()/2. You can also provide a custom filename as a third parameter if unix timestamps aren’t your thing. Furthermore, parent directories will be created automatically so feel free to provide a longer path as the second parameter. Otherwise, you can simply |> your ticket lists to this function for ease of use if the defaults are good enough

Link to this section Functions

Returns a single ticket. Requires an id as a parameter.

Link to this function get_tickets(start_page \\ 1) View Source

Returns a list of all of the tickets from a Freshdesk instance. By default it will start on page 1 but accepts an integer start_page as a parameter for starting on a page greater than or equal to 1.

Returns a list of tickets on a specific page. Requires a page number as a parameter.

Naturally, the get/request functions will return a descending list of data. This function utilizes Enum.reverse() to switch it to an ascending list instead. |> your ticket lists to this function for ease of use.

Link to this function write_json(data, save_path \\ Path.join("data", "json"), filename \\ "freshdesk-export-" <> Integer.to_string(DateTime.to_unix(DateTime.utc_now()))) View Source

By default, this function will create a directory structure of “data/json” and store a JSON file in the json directory with a unix timestamp in the title to make sure the file is unique. Alternatively, you can provide a second custom path parameter to save it to by providing a string for a folder name or utilizing Path.join()/1 or Path.join()/2. You can also provide a custom filename as a third parameter if unix timestamps aren’t your thing. Furthermore, parent directories will be created automatically so feel free to provide a longer path as the second parameter. Otherwise, you can simply |> your ticket lists to this function for ease of use if the defaults are good enough.