anteris-dev/autotask-client-generator

There is no license information available for the latest version (v1.1.0) of this package.

This package is the brains behind the Autotask API client. It generates each service class using the Autotask API as its guide.

Maintainers

Details

github.com/Anteris-Dev/autotask-client-generator

Source

Issues

Installs: 114

Dependents: 1

Suggesters: 0

Security: 0

Stars: 2

Watchers: 3

Forks: 2

Open Issues: 4

v1.1.0 2023-05-24 21:07 UTC

Requires

Unknown License d3c641ceebe2541b938f733c2a31cb5c1c9a822d

  • Aidan Casey <aidan.casey.woop@anteris.com>

This package is auto-updated.

Last update: 2024-10-25 00:13:57 UTC

README

This package is the brains behind the Autotask API client. It generates each service class using the Autotask API as its guide.

To Install

Run composer require --dev anteris-dev/autotask-client-generator

Commands

This package provides command line commands. These are listed below.

Make Endpoint

Running vendor/bin/autotask make:endpoint <entity> will create new endpoint classes for <entity>. <entity> should be the singular or plural form of an Autotask endpoint (e.g. "Ticket" or "Tickets" respectively).

You may pass the argument --output=<directory> to set the directory to write these classes in.

You may pass the argument --force to overwrite existing classes.

You may pass the argument --no-cache to redownload the entity information from Autotask.

Make Defaults

Running vendor/bin/autotask make:defaults will create new endpoint classes for all known Autotask endpoints.

You may pass the argument --output=<directory> to set the directory to write these classes in.

You may pass the argument --force to overwrite existing classes.

You may pass the argument --no-cache to redownload the entity information from Autotask.

Make Support Files

Running vendor/bin/autotask make:support-files will generate support classes that are used across multiple domains. Examples of these classes are http clients, entity classes, etc.

You may pass the argument --output=<directory> to set the directory to write these classes in.

You may pass the argument --force to overwrite existing classes.

Directory Structure

  • /bin - Contains the command line logic for the autotask command.
  • /src - Contains the generator source code.
    • /Commands - Contains any Symfony commands that the autotask command supports.
    • /Generators - Contains classes concerned with converting entity information into an actual class.
    • /Helpers - Contains static function helpers that are used throughout the package.
    • /Responses - Contains data transfer objects for storing the entity information responses from Autotask.
    • /Support - Contains any classes used across multiple domains.
    • /Writers - Contains classes concerned with writing strings to files.
    • Generator.php - The main generator class. In charge of everything.
  • /templates - Contains Twig templates for the generated package.
    • /Package - These templates are related to the actual package.
    • /Tests - These templates are related to the package tests.