Jira.js - Jira Cloud API library
    Preparing search index...

    Function createClient

    • Parameters

      • clientType: Agile
      • 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

    • Parameters

      • clientType: Version2
      • 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 Version2.Version2Client

    • Parameters

      • clientType: Version3
      • 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 Version3.Version3Client

    • Parameters

      • clientType: ServiceDesk
      • 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 ServiceDesk.ServiceDeskClient

    Settings

    Member Visibility