Class AgileClient

constructor

• new AgileClient(
      config: {
          authentication?:
              | { basic: { apiToken: string; email: string } }
              | { oauth2: { accessToken: string } };
          baseRequestConfig?: any;
          host: string;
          middlewares?: {
              onError?: (...args: [any, ...unknown[]]) => void;
              onResponse?: (...args: [any, ...unknown[]]) => void;
          };
          noCheckAtlassianToken?: boolean;
          strictGDPR?: boolean;
      },
  ): Agile.AgileClient

  Parameters

  • config: {
        authentication?:
            | { basic: { apiToken: string; email: string } }
            | { oauth2: { accessToken: string } };
        baseRequestConfig?: any;
        host: string;
        middlewares?: {
            onError?: (...args: [any, ...unknown[]]) => void;
            onResponse?: (...args: [any, ...unknown[]]) => void;
        };
        noCheckAtlassianToken?: boolean;
        strictGDPR?: boolean;
    }

    • Optionalauthentication?:
          | { basic: { apiToken: string; email: string } }
          | { oauth2: { accessToken: string } }

    • OptionalbaseRequestConfig?: any

    • host: string

    • Optionalmiddlewares?: {
          onError?: (...args: [any, ...unknown[]]) => void;
          onResponse?: (...args: [any, ...unknown[]]) => void;
      }

    • OptionalnoCheckAtlassianToken?: boolean

      Adds 'X-Atlassian-Token': 'no-check' to each request header

    • OptionalstrictGDPR?: boolean

  Returns Agile.AgileClient

backlog

board

builds

deployments

developmentInformation

devopsComponents

epic

featureFlags

issue

operations

remoteLinks

securityInformation

sprint