SW Combine SDK
    Preparing search index...

    Class ApiResource

    API resource for utility endpoints

    https://www.swcombine.com/ws/v2.0/documentation/api/helloworld/ SW Combine API Documentation

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    getResources helloAuth helloWorld permissions rateLimits time

    Constructors

    Methods

    • Print a HelloWorld message @requires_auth No

      Returns Promise<string>

      Plain string "Hello World"

      const message = await client.api.helloWorld();
      console.log(message); // "Hello World"

    • Get list of available web services permissions @requires_auth No

      Returns Promise<Permission[]>

      const permissions = await client.api.permissions();
      permissions.forEach(p => console.log(p.attributes.name, p.attributes.description));

    • Get current rate limit status for all endpoint patterns @requires_auth No (shows public IP rate limits)

      Returns Promise<RateLimitEntry[]>

      Array of rate limit entries, one per endpoint pattern

      const rateLimits = await client.api.rateLimits();
      rateLimits.forEach(rl => {
        console.log(`${rl.attributes.pattern}: ${rl.attributes.remaining}/${rl.attributes.limit}`);
      });

    • Get current time or convert times

      Parameters

      • Optionaloptions: { cgt?: string; time?: number }

        Optional conversion parameters

        • Optionalcgt?: string

          CGT format time to convert

        • Optionaltime?: number

          Unix timestamp to convert

      Returns Promise<TimeResponse>

      // Get current time
      const current = await client.api.time();
      // Convert CGT to unix
      const converted = await client.api.time({ cgt: '2023-12-01 12:00:00' });
      // Convert unix to CGT
      const converted = await client.api.time({ time: 1701432000 });

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods