Pagination query params, sort, sort_type, and page are not documented in the Freshteam OpenAPI spec, though pagination is supported on these endpoints:

• GET /job_postings: ft.jobPostings.list()
• GET /time_offs: ft.timeOffs.list()

Which means, codegen does not generate query params for pagination for their respective methods. Which means their respective methods in the API SDK cannot support pagination. :-|

• Get access to Freshdesk OpenAPI specs
• Generate code from Freshdesk OpenAPI spec
• Write methods for the proxy layer to expose those methods

Some endpoints allow adding ?include= query parameter to the URL to fetch additional resources. These need to be discovered and documented, where applicable.

• employees #38
• branches
• departments
• subDepartments
• businessUnits
• teams
• levels
• timeOffs
• roles
• jobPostings
• candidateSources
• userFunctions
• newHires

• Get access to Freshservice OpenAPI specs
• Generate code from Freshservice OpenAPI spec
• Write methods for the proxy layer to expose those methods
• Update docs

Add a documentation site (maybe with 11ty) under the ./docs/ directory.

Pages:

• Getting Started (Install and Introduction)
• Sample codes (Where to find them)
• Usage Guide (Current README.md)
• API (output from Typedoc in ./docs/api/)

Have the content ready for announcing on forum but don't announce

• applicants.list()
• employees.list()
• jobPostings.list()
• newHires.get()
• timeOffs.list()

Vuepress is resulting in a lot of security vulnerabilities because of its transient dependencies, even though it is only a dev dependency. We should move away from Vuepress and maybe work towards a unified doc.

Currently, query parameters and model properties use camelCase, while the REST APIs use snake_case.

Keeping consistent case style will mean we can directly refer to API Reference documentation to use with query methods.

This will also impact all model conventions, which means we will have to update existing examples.

This relates to #19, where the query parameters were converted to a different casing.

• Modify ApiClient.mustache to use axios instead of superagent
• Update dependency in package.json

• Create a serverless app under examples/app
• Test using the app from "../dist"

Repo: https://github.com/freshworks-developers/api-sdk-samples

Publish the content created from npm run build:docs at a URL that we can link for docs for the package.

Create a serverless app for Freshteam that shows how to set up and use this lib in an app running on the Freshworks Dev Platform.

• Location: examples/serverless-freshteam
• Import lib from: dist/

Some endpoints return paginated data. SDK methods should expose arguments to navigate a paginated list.

I tried to use the API SDK for the first time in a data-sync use case, and I found that we need to be able to pass response headers back to the user. Currently, we ignore headers and just send the response data as objects.

But, consider this, when calling GET /employees, pagination details are sent using the response headers total-objects, total-pages and link (URL to the next page). So, if I am running a scheduled function that syncs the list of Freshteam employees to another system, then the scheduled function needs to remember the link or the total-pages value to fetch the next page.

We are trying to list active jobs from our Freshteam account in our website. We have followed the instructions and are able to fetch jobs, but they are jobs which are in Trash..

If you see the API documentation, and specifically query parameters for the job listing, you see status - can be one of draft, published, internal, private, on_hold, closed. There is nodeleted query parameter - to filter by deleted != true

We raised a Support ticket with Freshteam #124126 12 days back. They said today

It is developed by the marketplace team. In this SDK there is no delete query param itself. So we request you to raise a support ticket in the developer community so that it will be handled by them. Or you can raise an issue in the GitHub repo:

Can we please add this? Here is the failing code snippet - pretty much from the documentation.

const { Freshteam } = require("@freshworks/api-sdk");

const ft = new Freshteam(`${process.env.FRESHTEAM_DOMAIN}.freshteam.com`, process.env.FRESHTEAM_API_KEY);

const getJobs = async () => {
    let obj = {
        status: ["published"]
    };
    try {
        const resp = await ft.jobPostings.list(obj);
        const jobs = await resp.json();
        console.log(jobs);
    } catch (err) {
        console.log(err);
    }
}
const allJobs = getJobs();

output.txt