From 94230438ad255c208ba90e06d43a97a42d76a45b Mon Sep 17 00:00:00 2001 From: ajimae <32770340+ajimae@users.noreply.github.com> Date: Wed, 8 May 2024 12:09:55 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20commerce?= =?UTF-8?q?tools/commercetools-sdk-typescript@4550cf097071f27aaea4c7c21b16?= =?UTF-8?q?e09ac4d14f92=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/ClientBuilder.html | 4 ++-- functions/Process.html | 2 +- functions/createAuthForAnonymousSessionFlow.html | 2 +- functions/createAuthForClientCredentialsFlow.html | 2 +- functions/createAuthForPasswordFlow.html | 2 +- functions/createAuthForRefreshTokenFlow.html | 2 +- functions/createAuthWithExistingToken.html | 2 +- functions/createClient.html | 2 +- functions/createCorrelationIdMiddleware.html | 2 +- functions/createHttpClient.html | 2 +- functions/createLoggerMiddleware.html | 2 +- functions/createQueueMiddleware.html | 2 +- functions/createUserAgentMiddleware.html | 2 +- functions/getErrorByCode.html | 2 +- index.html | 2 +- interfaces/ClientRequest.html | 4 ++-- modules.html | 2 +- types/ActionGroup.html | 2 +- types/AfterExecutionMiddlewareOptions.html | 2 +- types/AnonymousAuthMiddlewareOptions.html | 2 +- types/ApiRequestBuilder.html | 2 +- types/AuthMiddlewareBaseOptions.html | 2 +- types/AuthMiddlewareOptions.html | 2 +- types/AuthOptions.html | 2 +- types/AuthRequest.html | 2 +- types/BeforeExecutionMiddlewareOptions.html | 2 +- types/Client.html | 2 +- types/ClientAuthOptions.html | 2 +- types/ClientOptions.html | 2 +- types/ClientResponse.html | 2 +- types/ClientResult.html | 2 +- types/CorrelationIdMiddlewareOptions.html | 2 +- types/Credentials.html | 2 +- types/CustomAuthOptions.html | 2 +- types/Dispatch.html | 2 +- types/ExistingTokenMiddlewareOptions.html | 2 +- types/GenericOmit.html | 2 +- types/HttpErrorType.html | 2 +- types/HttpMiddlewareOptions.html | 2 +- types/HttpUserAgentOptions.html | 2 +- types/JsonObject.html | 2 +- types/LoggerMiddlewareOptions.html | 2 +- types/MethodType.html | 2 +- types/Middleware.html | 2 +- types/MiddlewareRequest.html | 2 +- types/MiddlewareResponse.html | 2 +- types/Next.html | 2 +- types/Nullable.html | 2 +- types/PasswordAuthMiddlewareOptions.html | 2 +- types/ProcessFn.html | 2 +- types/ProcessOptions.html | 2 +- types/ProcessResult.html | 2 +- types/QueryParam.html | 2 +- types/QueueMiddlewareOptions.html | 2 +- types/RefreshAuthMiddlewareOptions.html | 2 +- types/RequestOptions.html | 2 +- types/RequestState.html | 2 +- types/RequestStateStore.html | 2 +- types/ServiceBuilder.html | 2 +- types/ServiceBuilderDefaultParams.html | 2 +- types/ServiceBuilderDefinition.html | 2 +- types/ServiceBuilderInstance.html | 2 +- types/ServiceBuilderParams.html | 2 +- types/SuccessResult.html | 2 +- types/SyncAction.html | 2 +- types/SyncActionConfig.html | 2 +- types/Task.html | 2 +- types/TelemetryOptions.html | 2 +- types/TokenCache.html | 2 +- types/TokenCacheOptions.html | 2 +- types/TokenInfo.html | 2 +- types/TokenStore.html | 2 +- types/UpdateAction.html | 2 +- types/UserAgentMiddlewareOptions.html | 2 +- types/UserAuthOptions.html | 2 +- types/ValiadateOption.html | 2 +- types/VariableMap.html | 2 +- types/executeRequest.html | 2 +- types/executeRequestOptions.html | 2 +- types/requestBaseOptions.html | 2 +- 80 files changed, 82 insertions(+), 82 deletions(-) diff --git a/classes/ClientBuilder.html b/classes/ClientBuilder.html index 16b100310..09dc913ec 100644 --- a/classes/ClientBuilder.html +++ b/classes/ClientBuilder.html @@ -1,4 +1,4 @@ -ClientBuilder | @commercetools/sdk-client-v2

Class ClientBuilder

Constructors

constructor +ClientBuilder | @commercetools/sdk-client-v2

Class ClientBuilder

Constructors

constructor

Properties

afterMiddleware authMiddleware beforeMiddleware @@ -28,4 +28,4 @@ withRefreshTokenFlow withTelemetryMiddleware withUserAgentMiddleware -

Constructors

constructor

Properties

Private afterMiddleware

afterMiddleware: Middleware

Private authMiddleware

authMiddleware: Middleware

Private beforeMiddleware

beforeMiddleware: Middleware

Private correlationIdMiddleware

correlationIdMiddleware: Middleware

Private httpMiddleware

httpMiddleware: Middleware

Private loggerMiddleware

loggerMiddleware: Middleware

Private middlewares

middlewares: Middleware[] = []

Private projectKey

projectKey: string

Private queueMiddleware

queueMiddleware: Middleware

Private telemetryMiddleware

telemetryMiddleware: Middleware

Private userAgentMiddleware

userAgentMiddleware: Middleware

Methods

build

defaultClient

withAfterExecutionMiddleware

withAnonymousSessionFlow

withAuthMiddleware

withBeforeExecutionMiddleware

withClientCredentialsFlow

withCorrelationIdMiddleware

withExistingTokenFlow

withHttpMiddleware

withLoggerMiddleware

withMiddleware

withPasswordFlow

withProjectKey

withQueueMiddleware

withRefreshTokenFlow

withTelemetryMiddleware

withUserAgentMiddleware

Settings

Member Visibility

Theme

On This Page

constructorafterMiddlewareauthMiddlewarebeforeMiddlewarecorrelationIdMiddlewarehttpMiddlewareloggerMiddlewaremiddlewaresprojectKeyqueueMiddlewaretelemetryMiddlewareuserAgentMiddlewarebuilddefaultClientwithAfterExecutionMiddlewarewithAnonymousSessionFlowwithAuthMiddlewarewithBeforeExecutionMiddlewarewithClientCredentialsFlowwithCorrelationIdMiddlewarewithExistingTokenFlowwithHttpMiddlewarewithLoggerMiddlewarewithMiddlewarewithPasswordFlowwithProjectKeywithQueueMiddlewarewithRefreshTokenFlowwithTelemetryMiddlewarewithUserAgentMiddleware
\ No newline at end of file +

Constructors

constructor

Properties

Private afterMiddleware

afterMiddleware: Middleware

Private authMiddleware

authMiddleware: Middleware

Private beforeMiddleware

beforeMiddleware: Middleware

Private correlationIdMiddleware

correlationIdMiddleware: Middleware

Private httpMiddleware

httpMiddleware: Middleware

Private loggerMiddleware

loggerMiddleware: Middleware

Private middlewares

middlewares: Middleware[] = []

Private projectKey

projectKey: string

Private queueMiddleware

queueMiddleware: Middleware

Private telemetryMiddleware

telemetryMiddleware: Middleware

Private userAgentMiddleware

userAgentMiddleware: Middleware

Methods

build

defaultClient

withAfterExecutionMiddleware

withAnonymousSessionFlow

withAuthMiddleware

withBeforeExecutionMiddleware

withClientCredentialsFlow

withCorrelationIdMiddleware

withExistingTokenFlow

withHttpMiddleware

withLoggerMiddleware

withMiddleware

withPasswordFlow

withProjectKey

withQueueMiddleware

withRefreshTokenFlow

withTelemetryMiddleware

withUserAgentMiddleware

Settings

Member Visibility

Theme

On This Page

constructorafterMiddlewareauthMiddlewarebeforeMiddlewarecorrelationIdMiddlewarehttpMiddlewareloggerMiddlewaremiddlewaresprojectKeyqueueMiddlewaretelemetryMiddlewareuserAgentMiddlewarebuilddefaultClientwithAfterExecutionMiddlewarewithAnonymousSessionFlowwithAuthMiddlewarewithBeforeExecutionMiddlewarewithClientCredentialsFlowwithCorrelationIdMiddlewarewithExistingTokenFlowwithHttpMiddlewarewithLoggerMiddlewarewithMiddlewarewithPasswordFlowwithProjectKeywithQueueMiddlewarewithRefreshTokenFlowwithTelemetryMiddlewarewithUserAgentMiddleware
\ No newline at end of file diff --git a/functions/Process.html b/functions/Process.html index 773e7ed89..08987d308 100644 --- a/functions/Process.html +++ b/functions/Process.html @@ -1 +1 @@ -Process | @commercetools/sdk-client-v2

Function Process

  • Process<T>(request, fn, processOpt): Promise<{
        body: {
            count: number;
            limit: number;
            offset: number;
            results: T[];
        };
        statusCode: 200;
    }[]>

  • Type Parameters

    • T = any

    Parameters

    Returns Promise<{
        body: {
            count: number;
            limit: number;
            offset: number;
            results: T[];
        };
        statusCode: 200;
    }[]>

Settings

Member Visibility

Theme

\ No newline at end of file +Process | @commercetools/sdk-client-v2

Function Process

  • Process<T>(request, fn, processOpt): Promise<{
        body: {
            count: number;
            limit: number;
            offset: number;
            results: T[];
        };
        statusCode: 200;
    }[]>

  • Type Parameters

    • T = any

    Parameters

    Returns Promise<{
        body: {
            count: number;
            limit: number;
            offset: number;
            results: T[];
        };
        statusCode: 200;
    }[]>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/createAuthForAnonymousSessionFlow.html b/functions/createAuthForAnonymousSessionFlow.html index 4d6d825dc..db28e3ee0 100644 --- a/functions/createAuthForAnonymousSessionFlow.html +++ b/functions/createAuthForAnonymousSessionFlow.html @@ -1 +1 @@ -createAuthForAnonymousSessionFlow | @commercetools/sdk-client-v2

Function createAuthForAnonymousSessionFlow

Settings

Member Visibility

Theme

\ No newline at end of file +createAuthForAnonymousSessionFlow | @commercetools/sdk-client-v2

Function createAuthForAnonymousSessionFlow

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/createAuthForClientCredentialsFlow.html b/functions/createAuthForClientCredentialsFlow.html index 322252c62..3001535ed 100644 --- a/functions/createAuthForClientCredentialsFlow.html +++ b/functions/createAuthForClientCredentialsFlow.html @@ -1 +1 @@ -createAuthForClientCredentialsFlow | @commercetools/sdk-client-v2

Function createAuthForClientCredentialsFlow

Settings

Member Visibility

Theme

\ No newline at end of file +createAuthForClientCredentialsFlow | @commercetools/sdk-client-v2

Function createAuthForClientCredentialsFlow

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/createAuthForPasswordFlow.html b/functions/createAuthForPasswordFlow.html index c7d5d5bf8..89fce5fd0 100644 --- a/functions/createAuthForPasswordFlow.html +++ b/functions/createAuthForPasswordFlow.html @@ -1 +1 @@ -createAuthForPasswordFlow | @commercetools/sdk-client-v2

Function createAuthForPasswordFlow

Settings

Member Visibility

Theme

\ No newline at end of file +createAuthForPasswordFlow | @commercetools/sdk-client-v2

Function createAuthForPasswordFlow

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/createAuthForRefreshTokenFlow.html b/functions/createAuthForRefreshTokenFlow.html index 05640c4cd..27f2ab891 100644 --- a/functions/createAuthForRefreshTokenFlow.html +++ b/functions/createAuthForRefreshTokenFlow.html @@ -1 +1 @@ -createAuthForRefreshTokenFlow | @commercetools/sdk-client-v2

Function createAuthForRefreshTokenFlow

Settings

Member Visibility

Theme

\ No newline at end of file +createAuthForRefreshTokenFlow | @commercetools/sdk-client-v2

Function createAuthForRefreshTokenFlow

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/createAuthWithExistingToken.html b/functions/createAuthWithExistingToken.html index 84908d2fd..3f043093b 100644 --- a/functions/createAuthWithExistingToken.html +++ b/functions/createAuthWithExistingToken.html @@ -1 +1 @@ -createAuthWithExistingToken | @commercetools/sdk-client-v2

Function createAuthWithExistingToken

Settings

Member Visibility

Theme

\ No newline at end of file +createAuthWithExistingToken | @commercetools/sdk-client-v2

Function createAuthWithExistingToken

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/createClient.html b/functions/createClient.html index 413fec2be..352dd4ab9 100644 --- a/functions/createClient.html +++ b/functions/createClient.html @@ -1 +1 @@ -createClient | @commercetools/sdk-client-v2

Function createClient

Settings

Member Visibility

Theme

\ No newline at end of file +createClient | @commercetools/sdk-client-v2

Function createClient

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/createCorrelationIdMiddleware.html b/functions/createCorrelationIdMiddleware.html index 92a9dc497..1982ce7ef 100644 --- a/functions/createCorrelationIdMiddleware.html +++ b/functions/createCorrelationIdMiddleware.html @@ -1 +1 @@ -createCorrelationIdMiddleware | @commercetools/sdk-client-v2

Function createCorrelationIdMiddleware

Settings

Member Visibility

Theme

\ No newline at end of file +createCorrelationIdMiddleware | @commercetools/sdk-client-v2

Function createCorrelationIdMiddleware

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/createHttpClient.html b/functions/createHttpClient.html index 1dd2f6233..b10d192f8 100644 --- a/functions/createHttpClient.html +++ b/functions/createHttpClient.html @@ -1 +1 @@ -createHttpClient | @commercetools/sdk-client-v2

Function createHttpClient

Settings

Member Visibility

Theme

\ No newline at end of file +createHttpClient | @commercetools/sdk-client-v2

Function createHttpClient

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/createLoggerMiddleware.html b/functions/createLoggerMiddleware.html index 05d611fd4..0d83b8ca8 100644 --- a/functions/createLoggerMiddleware.html +++ b/functions/createLoggerMiddleware.html @@ -1 +1 @@ -createLoggerMiddleware | @commercetools/sdk-client-v2

Function createLoggerMiddleware

Settings

Member Visibility

Theme

\ No newline at end of file +createLoggerMiddleware | @commercetools/sdk-client-v2

Function createLoggerMiddleware

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/createQueueMiddleware.html b/functions/createQueueMiddleware.html index fc8fe3f57..ba88a2a7a 100644 --- a/functions/createQueueMiddleware.html +++ b/functions/createQueueMiddleware.html @@ -1 +1 @@ -createQueueMiddleware | @commercetools/sdk-client-v2

Function createQueueMiddleware

Settings

Member Visibility

Theme

\ No newline at end of file +createQueueMiddleware | @commercetools/sdk-client-v2

Function createQueueMiddleware

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/createUserAgentMiddleware.html b/functions/createUserAgentMiddleware.html index a0c6ffe23..bb09f216c 100644 --- a/functions/createUserAgentMiddleware.html +++ b/functions/createUserAgentMiddleware.html @@ -1 +1 @@ -createUserAgentMiddleware | @commercetools/sdk-client-v2

Function createUserAgentMiddleware

Settings

Member Visibility

Theme

\ No newline at end of file +createUserAgentMiddleware | @commercetools/sdk-client-v2

Function createUserAgentMiddleware

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/getErrorByCode.html b/functions/getErrorByCode.html index a1dd34ffa..e29b383cb 100644 --- a/functions/getErrorByCode.html +++ b/functions/getErrorByCode.html @@ -1 +1 @@ -getErrorByCode | @commercetools/sdk-client-v2

Function getErrorByCode

  • getErrorByCode(code): ((this, ...args) => void)

  • Parameters

    • code: number

    Returns ((this, ...args) => void)

      • (this, ...args): void

      • Parameters

        • this: any
        • Rest ...args: unknown[]

        Returns void

Settings

Member Visibility

Theme

\ No newline at end of file +getErrorByCode | @commercetools/sdk-client-v2

Function getErrorByCode

  • getErrorByCode(code): ((this, ...args) => void)

  • Parameters

    • code: number

    Returns ((this, ...args) => void)

      • (this, ...args): void

      • Parameters

        • this: any
        • Rest ...args: unknown[]

        Returns void

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/index.html b/index.html index 665ac16cb..41de697be 100644 --- a/index.html +++ b/index.html @@ -8,4 +8,4 @@ 
const {
  ClientBuilder,
  createAuthForClientCredentialsFlow,
  createHttpClient,
} = require('@commercetools/sdk-client-v2')
const { createApiBuilderFromCtpClient } = require('@commercetools/platform-sdk')
const fetch = require('node-fetch')

const projectKey = 'mc-project-key'
const authMiddlewareOptions = {
  host: 'https://auth.europe-west1.gcp.commercetools.com',
  projectKey,
  credentials: {
    clientId: 'mc-client-id',
    clientSecret: 'mc-client-secrets',
  },
  oauthUri: '/oauth/token', // - optional: custom oauthUri
  scopes: [`manage_project:${projectKey}`],
  fetch,
}

const httpMiddlewareOptions = {
  host: 'https://api.europe-west1.gcp.commercetools.com',
  fetch,
}

const client = new ClientBuilder()
  .withProjectKey(projectKey)
  .withMiddleware(createAuthForClientCredentialsFlow(authMiddlewareOptions))
  .withMiddleware(createHttpClient(httpMiddlewareOptions))
  .withUserAgentMiddleware()
  .build()

// or
const client = new ClientBuilder()
  .withProjectKey(projectKey)
  .withClientCredentialsFlow(authMiddlewareOptions)
  .withHttpMiddleware(httpMiddlewareOptions)
  .withUserAgentMiddleware()
  .build()

const apiRoot = createApiBuilderFromCtpClient(client)

// calling the Composable Commerce functions
// get project details
apiRoot
  .withProjectKey({
    projectKey,
  })
  .get()
  .execute()
  .then((x) => {
    /*...*/
  })

// create a productType
apiRoot
  .withProjectKey({ projectKey })
  .productTypes()
  .post({
    body: { name: 'product-type-name', description: 'some description' },
  })
  .execute()
  .then((x) => {
    /*...*/
  })

// create a product
apiRoot
  .withProjectKey({ projectKey })
  .products()
  .post({
    body: {
      name: { en: 'our-great-product-name' },
      productType: {
        typeId: 'product-type',
        id: 'some-product-type-id',
      },
      slug: { en: 'some-slug' },
    },
  })
  .execute()
  .then((x) => {
    /*...*/
  })

// -----------------------------------------------------------------------
// The sdk-client-v2 also has support for the old syntax
import {
  createClient,
  createHttpClient,
  createAuthForClientCredentialsFlow,
} from '@commercetools/sdk-client-v2'
import { createApiBuilderFromCtpClient } from '@commercetools/platform-sdk'
import fetch from 'node-fetch'

const projectKey = 'some_project_key'

const authMiddleware = createAuthForClientCredentialsFlow({
  host: 'https://auth.europe-west1.gcp.commercetools.com',
  projectKey,
  credentials: {
    clientId: 'some_id',
    clientSecret: 'some_secret',
  },
  fetch,
})

const httpMiddleware = createHttpClient({
  host: 'https://api.europe-west1.gcp.commercetools.com',
  fetch,
})

const ctpClient = createClient({
  middlewares: [authMiddleware, httpMiddleware],
})

const apiRoot = createApiBuilderFromCtpClient(ctpClient)

apiRoot
  .withProjectKey({
    projectKey,
  })
  .get()
  .execute()
  .then((x) => {
    /*...*/
  })

apiRoot
  .withProjectKey({ projectKey })
  .productTypes()
  .post({
    body: { name: 'product-type-name', description: 'some description' },
  })
  .execute()
  .then((x) => {
    /*...*/
  })

apiRoot
  .withProjectKey({ projectKey })
  .products()
  .post({
    body: {
      name: { en: 'our-great-product-name' },
      productType: {
        typeId: 'product-type',
        id: 'some-product-type-id',
      },
      slug: { en: 'some-slug' },
    },
  })
  .execute()
  .then((x) => {
    /*...*/
  })

See full usage example here

-

Settings

Member Visibility

Theme

On This Page

Commercetools Composable Commerce TypeScript SDK client
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Commercetools Composable Commerce TypeScript SDK client
\ No newline at end of file diff --git a/interfaces/ClientRequest.html b/interfaces/ClientRequest.html index 6907569c0..8eefe24de 100644 --- a/interfaces/ClientRequest.html +++ b/interfaces/ClientRequest.html @@ -1,4 +1,4 @@ -ClientRequest | @commercetools/sdk-client-v2

Interface ClientRequest

interface ClientRequest {
    baseUri?: string;
    body?: any;
    headers?: VariableMap;
    method: MethodType;
    pathVariables?: VariableMap;
    queryParams?: VariableMap;
    uri?: string;
    uriTemplate?: string;
}

Properties

baseUri? +ClientRequest | @commercetools/sdk-client-v2

Interface ClientRequest

interface ClientRequest {
    baseUri?: string;
    body?: any;
    headers?: VariableMap;
    method: MethodType;
    pathVariables?: VariableMap;
    queryParams?: VariableMap;
    uri?: string;
    uriTemplate?: string;
}

Properties

baseUri? body? headers? method @@ -6,4 +6,4 @@ queryParams? uri? uriTemplate? -

Properties

Optional baseUri

baseUri?: string

Optional body

body?: any

Optional headers

headers?: VariableMap

method

method: MethodType

Optional pathVariables

pathVariables?: VariableMap

Optional queryParams

queryParams?: VariableMap

Optional uri

uri?: string

Optional uriTemplate

uriTemplate?: string

Settings

Member Visibility

Theme

On This Page

baseUribodyheadersmethodpathVariablesqueryParamsuriuriTemplate
\ No newline at end of file +

Properties

Optional baseUri

baseUri?: string

Optional body

body?: any

Optional headers

headers?: VariableMap

method

method: MethodType

Optional pathVariables

pathVariables?: VariableMap

Optional queryParams

queryParams?: VariableMap

Optional uri

uri?: string

Optional uriTemplate

uriTemplate?: string

Settings

Member Visibility

Theme

On This Page

baseUribodyheadersmethodpathVariablesqueryParamsuriuriTemplate
\ No newline at end of file diff --git a/modules.html b/modules.html index 9545cf40f..0c8240aeb 100644 --- a/modules.html +++ b/modules.html @@ -76,4 +76,4 @@ createQueueMiddleware createUserAgentMiddleware getErrorByCode -

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/ActionGroup.html b/types/ActionGroup.html index 10b838e6b..9f7f4eae8 100644 --- a/types/ActionGroup.html +++ b/types/ActionGroup.html @@ -1 +1 @@ -ActionGroup | @commercetools/sdk-client-v2

Type alias ActionGroup

ActionGroup: {
    group: "ignore" | "allow";
    type: string;
}

Type declaration

  • group: "ignore" | "allow"
  • type: string

Settings

Member Visibility

Theme

\ No newline at end of file +ActionGroup | @commercetools/sdk-client-v2

Type alias ActionGroup

ActionGroup: {
    group: "ignore" | "allow";
    type: string;
}

Type declaration

  • group: "ignore" | "allow"
  • type: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/AfterExecutionMiddlewareOptions.html b/types/AfterExecutionMiddlewareOptions.html index 84a4d7257..31e0cbec0 100644 --- a/types/AfterExecutionMiddlewareOptions.html +++ b/types/AfterExecutionMiddlewareOptions.html @@ -1 +1 @@ -AfterExecutionMiddlewareOptions | @commercetools/sdk-client-v2

Type alias AfterExecutionMiddlewareOptions

AfterExecutionMiddlewareOptions: {
    middleware: ((options?) => Middleware);
    [key: string]: any;
}

Type declaration

Settings

Member Visibility

Theme

\ No newline at end of file +AfterExecutionMiddlewareOptions | @commercetools/sdk-client-v2

Type alias AfterExecutionMiddlewareOptions

AfterExecutionMiddlewareOptions: {
    middleware: ((options?) => Middleware);
    [key: string]: any;
}

Type declaration

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/AnonymousAuthMiddlewareOptions.html b/types/AnonymousAuthMiddlewareOptions.html index 99f915b40..b19437ec6 100644 --- a/types/AnonymousAuthMiddlewareOptions.html +++ b/types/AnonymousAuthMiddlewareOptions.html @@ -1 +1 @@ -AnonymousAuthMiddlewareOptions | @commercetools/sdk-client-v2

Type alias AnonymousAuthMiddlewareOptions

AnonymousAuthMiddlewareOptions: {
    credentials: {
        anonymousId?: string;
        clientId: string;
        clientSecret: string;
    };
    fetch?: any;
    host: string;
    oauthUri?: string;
    projectKey: string;
    scopes?: string[];
    tokenCache?: TokenCache;
}

Type declaration

  • credentials: {
        anonymousId?: string;
        clientId: string;
        clientSecret: string;
    }
    • Optional anonymousId?: string
    • clientId: string
    • clientSecret: string
  • Optional fetch?: any
  • host: string
  • Optional oauthUri?: string
  • projectKey: string
  • Optional scopes?: string[]
  • Optional tokenCache?: TokenCache

Settings

Member Visibility

Theme

\ No newline at end of file +AnonymousAuthMiddlewareOptions | @commercetools/sdk-client-v2

Type alias AnonymousAuthMiddlewareOptions

AnonymousAuthMiddlewareOptions: {
    credentials: {
        anonymousId?: string;
        clientId: string;
        clientSecret: string;
    };
    fetch?: any;
    host: string;
    oauthUri?: string;
    projectKey: string;
    scopes?: string[];
    tokenCache?: TokenCache;
}

Type declaration

  • credentials: {
        anonymousId?: string;
        clientId: string;
        clientSecret: string;
    }
    • Optional anonymousId?: string
    • clientId: string
    • clientSecret: string
  • Optional fetch?: any
  • host: string
  • Optional oauthUri?: string
  • projectKey: string
  • Optional scopes?: string[]
  • Optional tokenCache?: TokenCache

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/ApiRequestBuilder.html b/types/ApiRequestBuilder.html index f022df24a..f27c148ff 100644 --- a/types/ApiRequestBuilder.html +++ b/types/ApiRequestBuilder.html @@ -1 +1 @@ -ApiRequestBuilder | @commercetools/sdk-client-v2

Type alias ApiRequestBuilder

ApiRequestBuilder: {
    [key: string]: ServiceBuilder;
}

Type declaration

Settings

Member Visibility

Theme

\ No newline at end of file +ApiRequestBuilder | @commercetools/sdk-client-v2

Type alias ApiRequestBuilder

ApiRequestBuilder: {
    [key: string]: ServiceBuilder;
}

Type declaration

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/AuthMiddlewareBaseOptions.html b/types/AuthMiddlewareBaseOptions.html index d297644d8..3d0c3bcfc 100644 --- a/types/AuthMiddlewareBaseOptions.html +++ b/types/AuthMiddlewareBaseOptions.html @@ -1 +1 @@ -AuthMiddlewareBaseOptions | @commercetools/sdk-client-v2

Type alias AuthMiddlewareBaseOptions

AuthMiddlewareBaseOptions: requestBaseOptions & {
    fetch?: any;
    request: MiddlewareRequest;
}

Type declaration

Settings

Member Visibility

Theme

\ No newline at end of file +AuthMiddlewareBaseOptions | @commercetools/sdk-client-v2

Type alias AuthMiddlewareBaseOptions

AuthMiddlewareBaseOptions: requestBaseOptions & {
    fetch?: any;
    request: MiddlewareRequest;
}

Type declaration

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/AuthMiddlewareOptions.html b/types/AuthMiddlewareOptions.html index aa679d97c..38489d108 100644 --- a/types/AuthMiddlewareOptions.html +++ b/types/AuthMiddlewareOptions.html @@ -1,3 +1,3 @@ AuthMiddlewareOptions | @commercetools/sdk-client-v2

Type alias AuthMiddlewareOptions

AuthMiddlewareOptions: {
    credentials: Credentials;
    fetch?: any;
    host: string;
    oauthUri?: string;
    projectKey: string;
    scopes?: string[];
    tokenCache?: TokenCache;
}

Type declaration

  • credentials: Credentials
  • Optional fetch?: any

    fix until we understand how to type the new node-fetch version

    -
  • host: string
  • Optional oauthUri?: string
  • projectKey: string
  • Optional scopes?: string[]
  • Optional tokenCache?: TokenCache

Settings

Member Visibility

Theme

\ No newline at end of file +
  • host: string
  • Optional oauthUri?: string
  • projectKey: string
  • Optional scopes?: string[]
  • Optional tokenCache?: TokenCache

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/AuthOptions.html b/types/AuthOptions.html index 07cd6baa8..cfff9d0b9 100644 --- a/types/AuthOptions.html +++ b/types/AuthOptions.html @@ -1 +1 @@ -AuthOptions | @commercetools/sdk-client-v2

    Type alias AuthOptions

    AuthOptions: {
        authType?: string;
        credentials: {
            clientId: string;
            clientSecret: string;
        };
        disableRefreshToken?: boolean;
        fetch?: any;
        headers?: JsonObject<string>;
        host: string;
        projectKey?: string;
        scopes?: string[];
        token?: string;
    }

    Type declaration

    • Optional authType?: string
    • credentials: {
          clientId: string;
          clientSecret: string;
      }
      • clientId: string
      • clientSecret: string
    • Optional disableRefreshToken?: boolean
    • Optional fetch?: any
    • Optional headers?: JsonObject<string>
    • host: string
    • Optional projectKey?: string
    • Optional scopes?: string[]
    • Optional token?: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +AuthOptions | @commercetools/sdk-client-v2

    Type alias AuthOptions

    AuthOptions: {
        authType?: string;
        credentials: {
            clientId: string;
            clientSecret: string;
        };
        disableRefreshToken?: boolean;
        fetch?: any;
        headers?: JsonObject<string>;
        host: string;
        projectKey?: string;
        scopes?: string[];
        token?: string;
    }

    Type declaration

    • Optional authType?: string
    • credentials: {
          clientId: string;
          clientSecret: string;
      }
      • clientId: string
      • clientSecret: string
    • Optional disableRefreshToken?: boolean
    • Optional fetch?: any
    • Optional headers?: JsonObject<string>
    • host: string
    • Optional projectKey?: string
    • Optional scopes?: string[]
    • Optional token?: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/AuthRequest.html b/types/AuthRequest.html index 1ef95ad7d..d778a68ab 100644 --- a/types/AuthRequest.html +++ b/types/AuthRequest.html @@ -1 +1 @@ -AuthRequest | @commercetools/sdk-client-v2

    Type alias AuthRequest

    AuthRequest: {
        authType: string;
        basicAuth: string;
        body: string;
        headers?: JsonObject<string>;
        uri: string;
    }

    Type declaration

    • authType: string
    • basicAuth: string
    • body: string
    • Optional headers?: JsonObject<string>
    • uri: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +AuthRequest | @commercetools/sdk-client-v2

    Type alias AuthRequest

    AuthRequest: {
        authType: string;
        basicAuth: string;
        body: string;
        headers?: JsonObject<string>;
        uri: string;
    }

    Type declaration

    • authType: string
    • basicAuth: string
    • body: string
    • Optional headers?: JsonObject<string>
    • uri: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/BeforeExecutionMiddlewareOptions.html b/types/BeforeExecutionMiddlewareOptions.html index d7fbfe808..19896767e 100644 --- a/types/BeforeExecutionMiddlewareOptions.html +++ b/types/BeforeExecutionMiddlewareOptions.html @@ -1 +1 @@ -BeforeExecutionMiddlewareOptions | @commercetools/sdk-client-v2

    Type alias BeforeExecutionMiddlewareOptions

    BeforeExecutionMiddlewareOptions: {
        middleware: ((options?) => Middleware);
        [key: string]: any;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +BeforeExecutionMiddlewareOptions | @commercetools/sdk-client-v2

    Type alias BeforeExecutionMiddlewareOptions

    BeforeExecutionMiddlewareOptions: {
        middleware: ((options?) => Middleware);
        [key: string]: any;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Client.html b/types/Client.html index 118da887e..f1f8a82fb 100644 --- a/types/Client.html +++ b/types/Client.html @@ -1 +1 @@ -Client | @commercetools/sdk-client-v2

    Type alias Client

    Client: {
        execute: ((request) => Promise<any>);
        process: ((request, fn, processOpt) => ProcessResult);
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +Client | @commercetools/sdk-client-v2

    Type alias Client

    Client: {
        execute: ((request) => Promise<any>);
        process: ((request, fn, processOpt) => ProcessResult);
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ClientAuthOptions.html b/types/ClientAuthOptions.html index 240d57c5d..541d437d2 100644 --- a/types/ClientAuthOptions.html +++ b/types/ClientAuthOptions.html @@ -1 +1 @@ -ClientAuthOptions | @commercetools/sdk-client-v2

    Type alias ClientAuthOptions

    ClientAuthOptions: {
        clientId: string;
        clientSecret: string;
    }

    Type declaration

    • clientId: string
    • clientSecret: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ClientAuthOptions | @commercetools/sdk-client-v2

    Type alias ClientAuthOptions

    ClientAuthOptions: {
        clientId: string;
        clientSecret: string;
    }

    Type declaration

    • clientId: string
    • clientSecret: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ClientOptions.html b/types/ClientOptions.html index a3b06e377..898181cf2 100644 --- a/types/ClientOptions.html +++ b/types/ClientOptions.html @@ -1 +1 @@ -ClientOptions | @commercetools/sdk-client-v2

    Type alias ClientOptions

    ClientOptions: {
        middlewares: Middleware[];
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ClientOptions | @commercetools/sdk-client-v2

    Type alias ClientOptions

    ClientOptions: {
        middlewares: Middleware[];
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ClientResponse.html b/types/ClientResponse.html index 121018adc..457ffee9d 100644 --- a/types/ClientResponse.html +++ b/types/ClientResponse.html @@ -1 +1 @@ -ClientResponse | @commercetools/sdk-client-v2

    Type alias ClientResponse<T>

    ClientResponse<T>: {
        body?: T;
        error?: HttpErrorType;
        headers?: JsonObject<string>;
        request?: Object;
        statusCode?: number;
    }

    Type Parameters

    • T = any

    Type declaration

    • Optional body?: T
    • Optional error?: HttpErrorType
    • Optional headers?: JsonObject<string>
    • Optional request?: Object
    • Optional statusCode?: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ClientResponse | @commercetools/sdk-client-v2

    Type alias ClientResponse<T>

    ClientResponse<T>: {
        body?: T;
        error?: HttpErrorType;
        headers?: JsonObject<string>;
        request?: Object;
        statusCode?: number;
    }

    Type Parameters

    • T = any

    Type declaration

    • Optional body?: T
    • Optional error?: HttpErrorType
    • Optional headers?: JsonObject<string>
    • Optional request?: Object
    • Optional statusCode?: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ClientResult.html b/types/ClientResult.html index 79262f838..416f3e30b 100644 --- a/types/ClientResult.html +++ b/types/ClientResult.html @@ -1 +1 @@ -ClientResult | @commercetools/sdk-client-v2

    Type alias ClientResult

    ClientResult: SuccessResult | HttpErrorType

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ClientResult | @commercetools/sdk-client-v2

    Type alias ClientResult

    ClientResult: SuccessResult | HttpErrorType

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/CorrelationIdMiddlewareOptions.html b/types/CorrelationIdMiddlewareOptions.html index 4ade1956d..d7341da70 100644 --- a/types/CorrelationIdMiddlewareOptions.html +++ b/types/CorrelationIdMiddlewareOptions.html @@ -1 +1 @@ -CorrelationIdMiddlewareOptions | @commercetools/sdk-client-v2

    Type alias CorrelationIdMiddlewareOptions

    CorrelationIdMiddlewareOptions: {
        generate: (() => string);
    }

    Type declaration

    • generate: (() => string)
        • (): string

        • Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +CorrelationIdMiddlewareOptions | @commercetools/sdk-client-v2

    Type alias CorrelationIdMiddlewareOptions

    CorrelationIdMiddlewareOptions: {
        generate: (() => string);
    }

    Type declaration

    • generate: (() => string)
        • (): string

        • Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Credentials.html b/types/Credentials.html index 396c43147..8cee931e5 100644 --- a/types/Credentials.html +++ b/types/Credentials.html @@ -1 +1 @@ -Credentials | @commercetools/sdk-client-v2

    Type alias Credentials

    Credentials: {
        anonymousId?: string;
        clientId: string;
        clientSecret: string;
    }

    Type declaration

    • Optional anonymousId?: string
    • clientId: string
    • clientSecret: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +Credentials | @commercetools/sdk-client-v2

    Type alias Credentials

    Credentials: {
        anonymousId?: string;
        clientId: string;
        clientSecret: string;
    }

    Type declaration

    • Optional anonymousId?: string
    • clientId: string
    • clientSecret: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/CustomAuthOptions.html b/types/CustomAuthOptions.html index a25cce82f..f929be254 100644 --- a/types/CustomAuthOptions.html +++ b/types/CustomAuthOptions.html @@ -1 +1 @@ -CustomAuthOptions | @commercetools/sdk-client-v2

    Type alias CustomAuthOptions

    CustomAuthOptions: {
        authType?: string;
        credentials?: {
            clientId: string;
            clientSecret: string;
        };
        disableRefreshToken?: boolean;
        fetch?: any;
        headers?: JsonObject<string>;
        host?: string;
        projectKey?: string;
        scopes?: string[];
        token?: string;
    }

    Type declaration

    • Optional authType?: string
    • Optional credentials?: {
          clientId: string;
          clientSecret: string;
      }
      • clientId: string
      • clientSecret: string
    • Optional disableRefreshToken?: boolean
    • Optional fetch?: any
    • Optional headers?: JsonObject<string>
    • Optional host?: string
    • Optional projectKey?: string
    • Optional scopes?: string[]
    • Optional token?: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +CustomAuthOptions | @commercetools/sdk-client-v2

    Type alias CustomAuthOptions

    CustomAuthOptions: {
        authType?: string;
        credentials?: {
            clientId: string;
            clientSecret: string;
        };
        disableRefreshToken?: boolean;
        fetch?: any;
        headers?: JsonObject<string>;
        host?: string;
        projectKey?: string;
        scopes?: string[];
        token?: string;
    }

    Type declaration

    • Optional authType?: string
    • Optional credentials?: {
          clientId: string;
          clientSecret: string;
      }
      • clientId: string
      • clientSecret: string
    • Optional disableRefreshToken?: boolean
    • Optional fetch?: any
    • Optional headers?: JsonObject<string>
    • Optional host?: string
    • Optional projectKey?: string
    • Optional scopes?: string[]
    • Optional token?: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Dispatch.html b/types/Dispatch.html index 0e234b5aa..17419b160 100644 --- a/types/Dispatch.html +++ b/types/Dispatch.html @@ -1 +1 @@ -Dispatch | @commercetools/sdk-client-v2

    Type alias Dispatch

    Dispatch: ((request, response) => unknown)

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +Dispatch | @commercetools/sdk-client-v2

    Type alias Dispatch

    Dispatch: ((request, response) => unknown)

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ExistingTokenMiddlewareOptions.html b/types/ExistingTokenMiddlewareOptions.html index 3e91d8f59..cffba443e 100644 --- a/types/ExistingTokenMiddlewareOptions.html +++ b/types/ExistingTokenMiddlewareOptions.html @@ -1 +1 @@ -ExistingTokenMiddlewareOptions | @commercetools/sdk-client-v2

    Type alias ExistingTokenMiddlewareOptions

    ExistingTokenMiddlewareOptions: {
        force?: boolean;
    }

    Type declaration

    • Optional force?: boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ExistingTokenMiddlewareOptions | @commercetools/sdk-client-v2

    Type alias ExistingTokenMiddlewareOptions

    ExistingTokenMiddlewareOptions: {
        force?: boolean;
    }

    Type declaration

    • Optional force?: boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/GenericOmit.html b/types/GenericOmit.html index 5ea13f649..e59bbfb29 100644 --- a/types/GenericOmit.html +++ b/types/GenericOmit.html @@ -1 +1 @@ -GenericOmit | @commercetools/sdk-client-v2

    Type alias GenericOmit<T, U>

    GenericOmit<T, U>: Omit<T, U>

    Type Parameters

    • T
    • U extends string | number | symbol

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +GenericOmit | @commercetools/sdk-client-v2

    Type alias GenericOmit<T, U>

    GenericOmit<T, U>: Omit<T, U>

    Type Parameters

    • T
    • U extends string | number | symbol

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/HttpErrorType.html b/types/HttpErrorType.html index c5eef32ab..ced519533 100644 --- a/types/HttpErrorType.html +++ b/types/HttpErrorType.html @@ -1 +1 @@ -HttpErrorType | @commercetools/sdk-client-v2

    Type alias HttpErrorType

    HttpErrorType: {
        body?: JsonObject;
        code: number;
        headers?: JsonObject<string>;
        message: string;
        name: string;
        originalRequest: ClientRequest;
        retryCount?: number;
        status: number;
        statusCode: number;
    }

    Type declaration

    • Optional body?: JsonObject
    • code: number
    • Optional headers?: JsonObject<string>
    • message: string
    • name: string
    • originalRequest: ClientRequest
    • Optional retryCount?: number
    • status: number
    • statusCode: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +HttpErrorType | @commercetools/sdk-client-v2

    Type alias HttpErrorType

    HttpErrorType: {
        body?: JsonObject;
        code: number;
        headers?: JsonObject<string>;
        message: string;
        name: string;
        originalRequest: ClientRequest;
        retryCount?: number;
        status: number;
        statusCode: number;
    }

    Type declaration

    • Optional body?: JsonObject
    • code: number
    • Optional headers?: JsonObject<string>
    • message: string
    • name: string
    • originalRequest: ClientRequest
    • Optional retryCount?: number
    • status: number
    • statusCode: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/HttpMiddlewareOptions.html b/types/HttpMiddlewareOptions.html index a4560eab9..d641dda9a 100644 --- a/types/HttpMiddlewareOptions.html +++ b/types/HttpMiddlewareOptions.html @@ -1 +1 @@ -HttpMiddlewareOptions | @commercetools/sdk-client-v2

    Type alias HttpMiddlewareOptions

    HttpMiddlewareOptions: {
        abortController?: AbortController;
        credentialsMode?: "omit" | "same-origin" | "include";
        enableRetry?: boolean;
        fetch?: any;
        getAbortController?: (() => AbortController);
        headersWithStringBody?: string[];
        host: string;
        includeHeaders?: boolean;
        includeOriginalRequest?: boolean;
        includeRequestInErrorResponse?: boolean;
        includeResponseHeaders?: boolean;
        maskSensitiveHeaderData?: boolean;
        retryConfig?: {
            backoff?: boolean;
            maxDelay?: number;
            maxRetries?: number;
            retryCodes?: (number | string)[];
            retryDelay?: number;
            retryOnAbort?: boolean;
        };
        timeout?: number;
    }

    Type declaration

    • Optional abortController?: AbortController
    • Optional credentialsMode?: "omit" | "same-origin" | "include"
    • Optional enableRetry?: boolean
    • Optional fetch?: any
    • Optional getAbortController?: (() => AbortController)
        • (): AbortController

        • Returns AbortController

    • Optional headersWithStringBody?: string[]
    • host: string
    • Optional includeHeaders?: boolean
    • Optional includeOriginalRequest?: boolean
    • Optional includeRequestInErrorResponse?: boolean
    • Optional includeResponseHeaders?: boolean
    • Optional maskSensitiveHeaderData?: boolean
    • Optional retryConfig?: {
          backoff?: boolean;
          maxDelay?: number;
          maxRetries?: number;
          retryCodes?: (number | string)[];
          retryDelay?: number;
          retryOnAbort?: boolean;
      }
      • Optional backoff?: boolean
      • Optional maxDelay?: number
      • Optional maxRetries?: number
      • Optional retryCodes?: (number | string)[]
      • Optional retryDelay?: number
      • Optional retryOnAbort?: boolean
    • Optional timeout?: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +HttpMiddlewareOptions | @commercetools/sdk-client-v2

    Type alias HttpMiddlewareOptions

    HttpMiddlewareOptions: {
        abortController?: AbortController;
        credentialsMode?: "omit" | "same-origin" | "include";
        enableRetry?: boolean;
        fetch?: any;
        getAbortController?: (() => AbortController);
        headersWithStringBody?: string[];
        host: string;
        includeHeaders?: boolean;
        includeOriginalRequest?: boolean;
        includeRequestInErrorResponse?: boolean;
        includeResponseHeaders?: boolean;
        maskSensitiveHeaderData?: boolean;
        retryConfig?: {
            backoff?: boolean;
            maxDelay?: number;
            maxRetries?: number;
            retryCodes?: (number | string)[];
            retryDelay?: number;
            retryOnAbort?: boolean;
        };
        timeout?: number;
    }

    Type declaration

    • Optional abortController?: AbortController
    • Optional credentialsMode?: "omit" | "same-origin" | "include"
    • Optional enableRetry?: boolean
    • Optional fetch?: any
    • Optional getAbortController?: (() => AbortController)
        • (): AbortController

        • Returns AbortController

    • Optional headersWithStringBody?: string[]
    • host: string
    • Optional includeHeaders?: boolean
    • Optional includeOriginalRequest?: boolean
    • Optional includeRequestInErrorResponse?: boolean
    • Optional includeResponseHeaders?: boolean
    • Optional maskSensitiveHeaderData?: boolean
    • Optional retryConfig?: {
          backoff?: boolean;
          maxDelay?: number;
          maxRetries?: number;
          retryCodes?: (number | string)[];
          retryDelay?: number;
          retryOnAbort?: boolean;
      }
      • Optional backoff?: boolean
      • Optional maxDelay?: number
      • Optional maxRetries?: number
      • Optional retryCodes?: (number | string)[]
      • Optional retryDelay?: number
      • Optional retryOnAbort?: boolean
    • Optional timeout?: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/HttpUserAgentOptions.html b/types/HttpUserAgentOptions.html index 152c50ac7..1764e84c2 100644 --- a/types/HttpUserAgentOptions.html +++ b/types/HttpUserAgentOptions.html @@ -1 +1 @@ -HttpUserAgentOptions | @commercetools/sdk-client-v2

    Type alias HttpUserAgentOptions

    HttpUserAgentOptions: {
        contactEmail?: string;
        contactUrl?: string;
        customAgent?: string;
        libraryName?: string;
        libraryVersion?: string;
        name?: string;
        version?: string;
    }

    Type declaration

    • Optional contactEmail?: string
    • Optional contactUrl?: string
    • Optional customAgent?: string
    • Optional libraryName?: string
    • Optional libraryVersion?: string
    • Optional name?: string
    • Optional version?: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +HttpUserAgentOptions | @commercetools/sdk-client-v2

    Type alias HttpUserAgentOptions

    HttpUserAgentOptions: {
        contactEmail?: string;
        contactUrl?: string;
        customAgent?: string;
        libraryName?: string;
        libraryVersion?: string;
        name?: string;
        version?: string;
    }

    Type declaration

    • Optional contactEmail?: string
    • Optional contactUrl?: string
    • Optional customAgent?: string
    • Optional libraryName?: string
    • Optional libraryVersion?: string
    • Optional name?: string
    • Optional version?: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/JsonObject.html b/types/JsonObject.html index 79342009c..4a65b827c 100644 --- a/types/JsonObject.html +++ b/types/JsonObject.html @@ -1 +1 @@ -JsonObject | @commercetools/sdk-client-v2

    Type alias JsonObject<T>

    JsonObject<T>: {
        [key: string]: T;
    }

    Type Parameters

    • T = unknown

    Type declaration

    • [key: string]: T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +JsonObject | @commercetools/sdk-client-v2

    Type alias JsonObject<T>

    JsonObject<T>: {
        [key: string]: T;
    }

    Type Parameters

    • T = unknown

    Type declaration

    • [key: string]: T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/LoggerMiddlewareOptions.html b/types/LoggerMiddlewareOptions.html index 48f99da9e..0bc195f39 100644 --- a/types/LoggerMiddlewareOptions.html +++ b/types/LoggerMiddlewareOptions.html @@ -1 +1 @@ -LoggerMiddlewareOptions | @commercetools/sdk-client-v2

    Type alias LoggerMiddlewareOptions

    LoggerMiddlewareOptions: {
        logger: ((options?) => Middleware);
        [key: string]: any;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +LoggerMiddlewareOptions | @commercetools/sdk-client-v2

    Type alias LoggerMiddlewareOptions

    LoggerMiddlewareOptions: {
        logger: ((options?) => Middleware);
        [key: string]: any;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/MethodType.html b/types/MethodType.html index bae3f06f0..fbc15d5b4 100644 --- a/types/MethodType.html +++ b/types/MethodType.html @@ -1 +1 @@ -MethodType | @commercetools/sdk-client-v2

    Type alias MethodType

    MethodType: "ACL" | "BIND" | "CHECKOUT" | "CONNECT" | "COPY" | "DELETE" | "GET" | "HEAD" | "LINK" | "LOCK" | "M-SEARCH" | "MERGE" | "MKACTIVITY" | "MKCALENDAR" | "MKCOL" | "MOVE" | "NOTIFY" | "OPTIONS" | "PATCH" | "POST" | "PROPFIND" | "PROPPATCH" | "PURGE" | "PUT" | "REBIND" | "REPORT" | "SEARCH" | "SOURCE" | "SUBSCRIBE" | "TRACE" | "UNBIND" | "UNLINK" | "UNLOCK" | "UNSUBSCRIBE"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +MethodType | @commercetools/sdk-client-v2

    Type alias MethodType

    MethodType: "ACL" | "BIND" | "CHECKOUT" | "CONNECT" | "COPY" | "DELETE" | "GET" | "HEAD" | "LINK" | "LOCK" | "M-SEARCH" | "MERGE" | "MKACTIVITY" | "MKCALENDAR" | "MKCOL" | "MOVE" | "NOTIFY" | "OPTIONS" | "PATCH" | "POST" | "PROPFIND" | "PROPPATCH" | "PURGE" | "PUT" | "REBIND" | "REPORT" | "SEARCH" | "SOURCE" | "SUBSCRIBE" | "TRACE" | "UNBIND" | "UNLINK" | "UNLOCK" | "UNSUBSCRIBE"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Middleware.html b/types/Middleware.html index 6d4c643a3..f3c42ed4b 100644 --- a/types/Middleware.html +++ b/types/Middleware.html @@ -1 +1 @@ -Middleware | @commercetools/sdk-client-v2

    Type alias Middleware

    Middleware: ((next) => Dispatch)

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +Middleware | @commercetools/sdk-client-v2

    Type alias Middleware

    Middleware: ((next) => Dispatch)

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/MiddlewareRequest.html b/types/MiddlewareRequest.html index 3f99f45b8..43ff830cb 100644 --- a/types/MiddlewareRequest.html +++ b/types/MiddlewareRequest.html @@ -1 +1 @@ -MiddlewareRequest | @commercetools/sdk-client-v2

    Type alias MiddlewareRequest

    MiddlewareRequest: ClientRequest

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +MiddlewareRequest | @commercetools/sdk-client-v2

    Type alias MiddlewareRequest

    MiddlewareRequest: ClientRequest

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/MiddlewareResponse.html b/types/MiddlewareResponse.html index 4ff529a1d..06c828b01 100644 --- a/types/MiddlewareResponse.html +++ b/types/MiddlewareResponse.html @@ -1 +1 @@ -MiddlewareResponse | @commercetools/sdk-client-v2

    Type alias MiddlewareResponse

    MiddlewareResponse: {
        body?: JsonObject;
        error?: HttpErrorType;
        headers?: JsonObject<string>;
        request?: JsonObject;
        statusCode: number;
        reject(error): void;
        resolve(response): void;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +MiddlewareResponse | @commercetools/sdk-client-v2

    Type alias MiddlewareResponse

    MiddlewareResponse: {
        body?: JsonObject;
        error?: HttpErrorType;
        headers?: JsonObject<string>;
        request?: JsonObject;
        statusCode: number;
        reject(error): void;
        resolve(response): void;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Next.html b/types/Next.html index 995644d4c..c81a7e159 100644 --- a/types/Next.html +++ b/types/Next.html @@ -1 +1 @@ -Next | @commercetools/sdk-client-v2

    Type alias Next

    Next: ((request, response) => unknown)

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +Next | @commercetools/sdk-client-v2

    Type alias Next

    Next: ((request, response) => unknown)

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Nullable.html b/types/Nullable.html index 880533aab..d3ed7b649 100644 --- a/types/Nullable.html +++ b/types/Nullable.html @@ -1 +1 @@ -Nullable | @commercetools/sdk-client-v2

    Type alias Nullable<T>

    Nullable<T>: T | null

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +Nullable | @commercetools/sdk-client-v2

    Type alias Nullable<T>

    Nullable<T>: T | null

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/PasswordAuthMiddlewareOptions.html b/types/PasswordAuthMiddlewareOptions.html index 68d0df4b9..b2d177257 100644 --- a/types/PasswordAuthMiddlewareOptions.html +++ b/types/PasswordAuthMiddlewareOptions.html @@ -1 +1 @@ -PasswordAuthMiddlewareOptions | @commercetools/sdk-client-v2

    Type alias PasswordAuthMiddlewareOptions

    PasswordAuthMiddlewareOptions: {
        credentials: {
            clientId: string;
            clientSecret: string;
            user: UserAuthOptions;
        };
        fetch?: any;
        host: string;
        oauthUri?: string;
        projectKey: string;
        scopes?: string[];
        tokenCache?: TokenCache;
    }

    Type declaration

    • credentials: {
          clientId: string;
          clientSecret: string;
          user: UserAuthOptions;
      }
    • Optional fetch?: any
    • host: string
    • Optional oauthUri?: string
    • projectKey: string
    • Optional scopes?: string[]
    • Optional tokenCache?: TokenCache

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +PasswordAuthMiddlewareOptions | @commercetools/sdk-client-v2

    Type alias PasswordAuthMiddlewareOptions

    PasswordAuthMiddlewareOptions: {
        credentials: {
            clientId: string;
            clientSecret: string;
            user: UserAuthOptions;
        };
        fetch?: any;
        host: string;
        oauthUri?: string;
        projectKey: string;
        scopes?: string[];
        tokenCache?: TokenCache;
    }

    Type declaration

    • credentials: {
          clientId: string;
          clientSecret: string;
          user: UserAuthOptions;
      }
    • Optional fetch?: any
    • host: string
    • Optional oauthUri?: string
    • projectKey: string
    • Optional scopes?: string[]
    • Optional tokenCache?: TokenCache

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ProcessFn.html b/types/ProcessFn.html index 6022b8fdd..1cbac5937 100644 --- a/types/ProcessFn.html +++ b/types/ProcessFn.html @@ -1 +1 @@ -ProcessFn | @commercetools/sdk-client-v2

    Type alias ProcessFn

    ProcessFn: ((result) => Promise<any>)

    Type declaration

      • (result): Promise<any>

      • Parameters

        Returns Promise<any>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ProcessFn | @commercetools/sdk-client-v2

    Type alias ProcessFn

    ProcessFn: ((result) => Promise<any>)

    Type declaration

      • (result): Promise<any>

      • Parameters

        Returns Promise<any>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ProcessOptions.html b/types/ProcessOptions.html index 5803477a3..30768572c 100644 --- a/types/ProcessOptions.html +++ b/types/ProcessOptions.html @@ -1 +1 @@ -ProcessOptions | @commercetools/sdk-client-v2

    Type alias ProcessOptions

    ProcessOptions: {
        accumulate?: boolean;
        limit?: number;
        sort?: string;
        total?: number;
    }

    Type declaration

    • Optional accumulate?: boolean
    • Optional limit?: number
    • Optional sort?: string
    • Optional total?: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ProcessOptions | @commercetools/sdk-client-v2

    Type alias ProcessOptions

    ProcessOptions: {
        accumulate?: boolean;
        limit?: number;
        sort?: string;
        total?: number;
    }

    Type declaration

    • Optional accumulate?: boolean
    • Optional limit?: number
    • Optional sort?: string
    • Optional total?: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ProcessResult.html b/types/ProcessResult.html index fa34eaf5f..dda19cdad 100644 --- a/types/ProcessResult.html +++ b/types/ProcessResult.html @@ -1 +1 @@ -ProcessResult | @commercetools/sdk-client-v2

    Type alias ProcessResult<T>

    ProcessResult<T>: Promise<{
        body: {
            count: number;
            limit: number;
            offset: number;
            results: T[];
            total?: number;
        };
        statusCode: number;
    }[]>

    Type Parameters

    • T = any

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ProcessResult | @commercetools/sdk-client-v2

    Type alias ProcessResult<T>

    ProcessResult<T>: Promise<{
        body: {
            count: number;
            limit: number;
            offset: number;
            results: T[];
            total?: number;
        };
        statusCode: number;
    }[]>

    Type Parameters

    • T = any

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/QueryParam.html b/types/QueryParam.html index 9d8351a82..63bb11dd6 100644 --- a/types/QueryParam.html +++ b/types/QueryParam.html @@ -1 +1 @@ -QueryParam | @commercetools/sdk-client-v2

    Type alias QueryParam

    QueryParam: string | string[] | number | number[] | boolean | boolean[] | undefined

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +QueryParam | @commercetools/sdk-client-v2

    Type alias QueryParam

    QueryParam: string | string[] | number | number[] | boolean | boolean[] | undefined

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/QueueMiddlewareOptions.html b/types/QueueMiddlewareOptions.html index 7918da7e3..00544c12b 100644 --- a/types/QueueMiddlewareOptions.html +++ b/types/QueueMiddlewareOptions.html @@ -1 +1 @@ -QueueMiddlewareOptions | @commercetools/sdk-client-v2

    Type alias QueueMiddlewareOptions

    QueueMiddlewareOptions: {
        concurrency: number;
    }

    Type declaration

    • concurrency: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +QueueMiddlewareOptions | @commercetools/sdk-client-v2

    Type alias QueueMiddlewareOptions

    QueueMiddlewareOptions: {
        concurrency: number;
    }

    Type declaration

    • concurrency: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/RefreshAuthMiddlewareOptions.html b/types/RefreshAuthMiddlewareOptions.html index 6aa1df973..669481e8f 100644 --- a/types/RefreshAuthMiddlewareOptions.html +++ b/types/RefreshAuthMiddlewareOptions.html @@ -1 +1 @@ -RefreshAuthMiddlewareOptions | @commercetools/sdk-client-v2

    Type alias RefreshAuthMiddlewareOptions

    RefreshAuthMiddlewareOptions: {
        credentials: {
            clientId: string;
            clientSecret: string;
        };
        fetch?: any;
        host: string;
        oauthUri?: string;
        projectKey: string;
        refreshToken: string;
        tokenCache?: TokenCache;
    }

    Type declaration

    • credentials: {
          clientId: string;
          clientSecret: string;
      }
      • clientId: string
      • clientSecret: string
    • Optional fetch?: any
    • host: string
    • Optional oauthUri?: string
    • projectKey: string
    • refreshToken: string
    • Optional tokenCache?: TokenCache

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +RefreshAuthMiddlewareOptions | @commercetools/sdk-client-v2

    Type alias RefreshAuthMiddlewareOptions

    RefreshAuthMiddlewareOptions: {
        credentials: {
            clientId: string;
            clientSecret: string;
        };
        fetch?: any;
        host: string;
        oauthUri?: string;
        projectKey: string;
        refreshToken: string;
        tokenCache?: TokenCache;
    }

    Type declaration

    • credentials: {
          clientId: string;
          clientSecret: string;
      }
      • clientId: string
      • clientSecret: string
    • Optional fetch?: any
    • host: string
    • Optional oauthUri?: string
    • projectKey: string
    • refreshToken: string
    • Optional tokenCache?: TokenCache

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/RequestOptions.html b/types/RequestOptions.html index 8aafcf5fb..e1b08c699 100644 --- a/types/RequestOptions.html +++ b/types/RequestOptions.html @@ -1 +1 @@ -RequestOptions | @commercetools/sdk-client-v2

    Type alias RequestOptions

    RequestOptions: {
        [key: string]: any;
    }

    Type declaration

    • [key: string]: any

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +RequestOptions | @commercetools/sdk-client-v2

    Type alias RequestOptions

    RequestOptions: {
        [key: string]: any;
    }

    Type declaration

    • [key: string]: any

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/RequestState.html b/types/RequestState.html index 97fcc70cd..18927e85c 100644 --- a/types/RequestState.html +++ b/types/RequestState.html @@ -1 +1 @@ -RequestState | @commercetools/sdk-client-v2

    Type alias RequestState

    RequestState: boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +RequestState | @commercetools/sdk-client-v2

    Type alias RequestState

    RequestState: boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/RequestStateStore.html b/types/RequestStateStore.html index e66d09526..58aa50d73 100644 --- a/types/RequestStateStore.html +++ b/types/RequestStateStore.html @@ -1 +1 @@ -RequestStateStore | @commercetools/sdk-client-v2

    Type alias RequestStateStore

    RequestStateStore: {
        get: (() => RequestState);
        set: ((requestState) => void);
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +RequestStateStore | @commercetools/sdk-client-v2

    Type alias RequestStateStore

    RequestStateStore: {
        get: (() => RequestState);
        set: ((requestState) => void);
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ServiceBuilder.html b/types/ServiceBuilder.html index 30dfb724c..ac936d4ea 100644 --- a/types/ServiceBuilder.html +++ b/types/ServiceBuilder.html @@ -1 +1 @@ -ServiceBuilder | @commercetools/sdk-client-v2

    Type alias ServiceBuilder

    ServiceBuilder: {
        features: string[];
        params: ServiceBuilderDefaultParams;
        type: string;
        build(): string;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ServiceBuilder | @commercetools/sdk-client-v2

    Type alias ServiceBuilder

    ServiceBuilder: {
        features: string[];
        params: ServiceBuilderDefaultParams;
        type: string;
        build(): string;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ServiceBuilderDefaultParams.html b/types/ServiceBuilderDefaultParams.html index e95b43254..407e7fe0e 100644 --- a/types/ServiceBuilderDefaultParams.html +++ b/types/ServiceBuilderDefaultParams.html @@ -1 +1 @@ -ServiceBuilderDefaultParams | @commercetools/sdk-client-v2

    Type alias ServiceBuilderDefaultParams

    ServiceBuilderDefaultParams: {
        applyOrderEditTo?: string;
        cartId?: string;
        customerId?: string;
        dataErasure?: string;
        expand: string[];
        id?: string | null;
        location?: {
            country?: string;
            currency?: string;
            state?: string;
        };
        pagination: {
            page: number | null;
            perPage: number | null;
            sort: string[];
            withTotal: boolean | null;
        };
        priceChannel?: string;
        priceCountry?: string;
        priceCurrency?: string;
        priceCustomerGroup?: string;
        query?: {
            operator: "and" | "or";
            where: string[];
        };
        search?: {
            facet: string[];
            filter: string[];
            filterByFacets: string[];
            filterByQuery: string[];
            fuzzy: boolean;
            fuzzyLevel: number;
            markMatchingVariants: boolean;
            text: {
                lang: string;
                value: string;
            } | null;
        };
        searchKeywords: {
            lang: string;
            value: string;
        }[];
        staged?: boolean;
        version?: number;
    }

    Type declaration

    • Optional applyOrderEditTo?: string
    • Optional cartId?: string
    • Optional customerId?: string
    • Optional dataErasure?: string
    • expand: string[]
    • Optional id?: string | null
    • Optional location?: {
          country?: string;
          currency?: string;
          state?: string;
      }
      • Optional country?: string
      • Optional currency?: string
      • Optional state?: string
    • pagination: {
          page: number | null;
          perPage: number | null;
          sort: string[];
          withTotal: boolean | null;
      }
      • page: number | null
      • perPage: number | null
      • sort: string[]
      • withTotal: boolean | null
    • Optional priceChannel?: string
    • Optional priceCountry?: string
    • Optional priceCurrency?: string
    • Optional priceCustomerGroup?: string
    • Optional query?: {
          operator: "and" | "or";
          where: string[];
      }
      • operator: "and" | "or"
      • where: string[]
    • Optional search?: {
          facet: string[];
          filter: string[];
          filterByFacets: string[];
          filterByQuery: string[];
          fuzzy: boolean;
          fuzzyLevel: number;
          markMatchingVariants: boolean;
          text: {
              lang: string;
              value: string;
          } | null;
      }
      • facet: string[]
      • filter: string[]
      • filterByFacets: string[]
      • filterByQuery: string[]
      • fuzzy: boolean
      • fuzzyLevel: number
      • markMatchingVariants: boolean
      • text: {
            lang: string;
            value: string;
        } | null
    • searchKeywords: {
          lang: string;
          value: string;
      }[]
    • Optional staged?: boolean
    • Optional version?: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ServiceBuilderDefaultParams | @commercetools/sdk-client-v2

    Type alias ServiceBuilderDefaultParams

    ServiceBuilderDefaultParams: {
        applyOrderEditTo?: string;
        cartId?: string;
        customerId?: string;
        dataErasure?: string;
        expand: string[];
        id?: string | null;
        location?: {
            country?: string;
            currency?: string;
            state?: string;
        };
        pagination: {
            page: number | null;
            perPage: number | null;
            sort: string[];
            withTotal: boolean | null;
        };
        priceChannel?: string;
        priceCountry?: string;
        priceCurrency?: string;
        priceCustomerGroup?: string;
        query?: {
            operator: "and" | "or";
            where: string[];
        };
        search?: {
            facet: string[];
            filter: string[];
            filterByFacets: string[];
            filterByQuery: string[];
            fuzzy: boolean;
            fuzzyLevel: number;
            markMatchingVariants: boolean;
            text: {
                lang: string;
                value: string;
            } | null;
        };
        searchKeywords: {
            lang: string;
            value: string;
        }[];
        staged?: boolean;
        version?: number;
    }

    Type declaration

    • Optional applyOrderEditTo?: string
    • Optional cartId?: string
    • Optional customerId?: string
    • Optional dataErasure?: string
    • expand: string[]
    • Optional id?: string | null
    • Optional location?: {
          country?: string;
          currency?: string;
          state?: string;
      }
      • Optional country?: string
      • Optional currency?: string
      • Optional state?: string
    • pagination: {
          page: number | null;
          perPage: number | null;
          sort: string[];
          withTotal: boolean | null;
      }
      • page: number | null
      • perPage: number | null
      • sort: string[]
      • withTotal: boolean | null
    • Optional priceChannel?: string
    • Optional priceCountry?: string
    • Optional priceCurrency?: string
    • Optional priceCustomerGroup?: string
    • Optional query?: {
          operator: "and" | "or";
          where: string[];
      }
      • operator: "and" | "or"
      • where: string[]
    • Optional search?: {
          facet: string[];
          filter: string[];
          filterByFacets: string[];
          filterByQuery: string[];
          fuzzy: boolean;
          fuzzyLevel: number;
          markMatchingVariants: boolean;
          text: {
              lang: string;
              value: string;
          } | null;
      }
      • facet: string[]
      • filter: string[]
      • filterByFacets: string[]
      • filterByQuery: string[]
      • fuzzy: boolean
      • fuzzyLevel: number
      • markMatchingVariants: boolean
      • text: {
            lang: string;
            value: string;
        } | null
    • searchKeywords: {
          lang: string;
          value: string;
      }[]
    • Optional staged?: boolean
    • Optional version?: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ServiceBuilderDefinition.html b/types/ServiceBuilderDefinition.html index 2273eb6f4..0f13d69c2 100644 --- a/types/ServiceBuilderDefinition.html +++ b/types/ServiceBuilderDefinition.html @@ -1 +1 @@ -ServiceBuilderDefinition | @commercetools/sdk-client-v2

    Type alias ServiceBuilderDefinition

    ServiceBuilderDefinition: {
        endpoint: string;
        features: string[];
        type: string;
    }

    Type declaration

    • endpoint: string
    • features: string[]
    • type: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ServiceBuilderDefinition | @commercetools/sdk-client-v2

    Type alias ServiceBuilderDefinition

    ServiceBuilderDefinition: {
        endpoint: string;
        features: string[];
        type: string;
    }

    Type declaration

    • endpoint: string
    • features: string[]
    • type: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ServiceBuilderInstance.html b/types/ServiceBuilderInstance.html index 71345e506..72d991245 100644 --- a/types/ServiceBuilderInstance.html +++ b/types/ServiceBuilderInstance.html @@ -1 +1 @@ -ServiceBuilderInstance | @commercetools/sdk-client-v2

    Type alias ServiceBuilderInstance

    ServiceBuilderInstance: {
        byCartId: ((id) => Object);
        byCustomerId: ((id) => Object);
        byId: ((id) => Object);
        byKey: ((key) => Object);
        expand: ((string) => Object);
        page: ((page) => Object);
        perPage: ((amount) => Object);
        sort: ((option) => Object);
        where: ((predicate) => Object);
        whereOperator: ((option) => Object);
        withVersion: ((version) => Object);
        build(): string;
        parse(): string;
        withFullDataErasure(): Object;
        withTotal(value): Object;
    }

    Type declaration

    • byCartId: ((id) => Object)
        • (id): Object

        • Parameters

          • id: string

          Returns Object

    • byCustomerId: ((id) => Object)
        • (id): Object

        • Parameters

          • id: string

          Returns Object

    • byId: ((id) => Object)
        • (id): Object

        • Parameters

          • id: string

          Returns Object

    • byKey: ((key) => Object)
        • (key): Object

        • Parameters

          • key: string

          Returns Object

    • expand: ((string) => Object)
        • (string): Object

        • Parameters

          • string: string

          Returns Object

    • page: ((page) => Object)
        • (page): Object

        • Parameters

          • page: number

          Returns Object

    • perPage: ((amount) => Object)
        • (amount): Object

        • Parameters

          • amount: number

          Returns Object

    • sort: ((option) => Object)
        • (option): Object

        • Parameters

          • option: string

          Returns Object

    • where: ((predicate) => Object)
        • (predicate): Object

        • Parameters

          • predicate: string

          Returns Object

    • whereOperator: ((option) => Object)
        • (option): Object

        • Parameters

          • option: string

          Returns Object

    • withVersion: ((version) => Object)
        • (version): Object

        • Parameters

          • version: number

          Returns Object

    • build:function
    • parse:function
    • withFullDataErasure:function
    • withTotal:function
      • withTotal(value): Object

      • Parameters

        • value: boolean

        Returns Object

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ServiceBuilderInstance | @commercetools/sdk-client-v2

    Type alias ServiceBuilderInstance

    ServiceBuilderInstance: {
        byCartId: ((id) => Object);
        byCustomerId: ((id) => Object);
        byId: ((id) => Object);
        byKey: ((key) => Object);
        expand: ((string) => Object);
        page: ((page) => Object);
        perPage: ((amount) => Object);
        sort: ((option) => Object);
        where: ((predicate) => Object);
        whereOperator: ((option) => Object);
        withVersion: ((version) => Object);
        build(): string;
        parse(): string;
        withFullDataErasure(): Object;
        withTotal(value): Object;
    }

    Type declaration

    • byCartId: ((id) => Object)
        • (id): Object

        • Parameters

          • id: string

          Returns Object

    • byCustomerId: ((id) => Object)
        • (id): Object

        • Parameters

          • id: string

          Returns Object

    • byId: ((id) => Object)
        • (id): Object

        • Parameters

          • id: string

          Returns Object

    • byKey: ((key) => Object)
        • (key): Object

        • Parameters

          • key: string

          Returns Object

    • expand: ((string) => Object)
        • (string): Object

        • Parameters

          • string: string

          Returns Object

    • page: ((page) => Object)
        • (page): Object

        • Parameters

          • page: number

          Returns Object

    • perPage: ((amount) => Object)
        • (amount): Object

        • Parameters

          • amount: number

          Returns Object

    • sort: ((option) => Object)
        • (option): Object

        • Parameters

          • option: string

          Returns Object

    • where: ((predicate) => Object)
        • (predicate): Object

        • Parameters

          • predicate: string

          Returns Object

    • whereOperator: ((option) => Object)
        • (option): Object

        • Parameters

          • option: string

          Returns Object

    • withVersion: ((version) => Object)
        • (version): Object

        • Parameters

          • version: number

          Returns Object

    • build:function
    • parse:function
    • withFullDataErasure:function
    • withTotal:function
      • withTotal(value): Object

      • Parameters

        • value: boolean

        Returns Object

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ServiceBuilderParams.html b/types/ServiceBuilderParams.html index 4199e7229..aee451ebe 100644 --- a/types/ServiceBuilderParams.html +++ b/types/ServiceBuilderParams.html @@ -1 +1 @@ -ServiceBuilderParams | @commercetools/sdk-client-v2

    Type alias ServiceBuilderParams

    ServiceBuilderParams: {
        applyOrderEditTo?: boolean;
        cartId?: string | null;
        container?: string | null;
        country?: string;
        currency?: string;
        customerId?: string | null;
        dataErasure?: string;
        expand?: string[];
        facet?: string[];
        filter?: string[];
        filterByFacets?: string[];
        filterByQuery?: string[];
        fuzzy?: boolean;
        fuzzyLevel?: number;
        id?: string | null;
        key?: string | null;
        markMatchingVariants?: boolean;
        orderNumber?: number;
        page: number | null;
        perPage: number | null;
        priceChannel?: string;
        priceCountry?: string;
        priceCurrency?: string;
        priceCustomerGroup?: string;
        searchKeywords?: {
            language: string;
            value: string;
        }[];
        sort: {
            by: string;
            direction: "asc" | "desc";
        }[];
        staged?: boolean;
        state?: string;
        text?: {
            language?: string;
            value?: string;
        } | null;
        version?: string;
        where?: string[];
        whereOperator?: "and" | "or";
        withTotal: boolean | null;
    }

    Type declaration

    • Optional applyOrderEditTo?: boolean
    • Optional cartId?: string | null
    • Optional container?: string | null
    • Optional country?: string
    • Optional currency?: string
    • Optional customerId?: string | null
    • Optional dataErasure?: string
    • Optional expand?: string[]
    • Optional facet?: string[]
    • Optional filter?: string[]
    • Optional filterByFacets?: string[]
    • Optional filterByQuery?: string[]
    • Optional fuzzy?: boolean
    • Optional fuzzyLevel?: number
    • Optional id?: string | null
    • Optional key?: string | null
    • Optional markMatchingVariants?: boolean
    • Optional orderNumber?: number
    • page: number | null
    • perPage: number | null
    • Optional priceChannel?: string
    • Optional priceCountry?: string
    • Optional priceCurrency?: string
    • Optional priceCustomerGroup?: string
    • Optional searchKeywords?: {
          language: string;
          value: string;
      }[]
    • sort: {
          by: string;
          direction: "asc" | "desc";
      }[]
    • Optional staged?: boolean
    • Optional state?: string
    • Optional text?: {
          language?: string;
          value?: string;
      } | null
    • Optional version?: string
    • Optional where?: string[]
    • Optional whereOperator?: "and" | "or"
    • withTotal: boolean | null

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ServiceBuilderParams | @commercetools/sdk-client-v2

    Type alias ServiceBuilderParams

    ServiceBuilderParams: {
        applyOrderEditTo?: boolean;
        cartId?: string | null;
        container?: string | null;
        country?: string;
        currency?: string;
        customerId?: string | null;
        dataErasure?: string;
        expand?: string[];
        facet?: string[];
        filter?: string[];
        filterByFacets?: string[];
        filterByQuery?: string[];
        fuzzy?: boolean;
        fuzzyLevel?: number;
        id?: string | null;
        key?: string | null;
        markMatchingVariants?: boolean;
        orderNumber?: number;
        page: number | null;
        perPage: number | null;
        priceChannel?: string;
        priceCountry?: string;
        priceCurrency?: string;
        priceCustomerGroup?: string;
        searchKeywords?: {
            language: string;
            value: string;
        }[];
        sort: {
            by: string;
            direction: "asc" | "desc";
        }[];
        staged?: boolean;
        state?: string;
        text?: {
            language?: string;
            value?: string;
        } | null;
        version?: string;
        where?: string[];
        whereOperator?: "and" | "or";
        withTotal: boolean | null;
    }

    Type declaration

    • Optional applyOrderEditTo?: boolean
    • Optional cartId?: string | null
    • Optional container?: string | null
    • Optional country?: string
    • Optional currency?: string
    • Optional customerId?: string | null
    • Optional dataErasure?: string
    • Optional expand?: string[]
    • Optional facet?: string[]
    • Optional filter?: string[]
    • Optional filterByFacets?: string[]
    • Optional filterByQuery?: string[]
    • Optional fuzzy?: boolean
    • Optional fuzzyLevel?: number
    • Optional id?: string | null
    • Optional key?: string | null
    • Optional markMatchingVariants?: boolean
    • Optional orderNumber?: number
    • page: number | null
    • perPage: number | null
    • Optional priceChannel?: string
    • Optional priceCountry?: string
    • Optional priceCurrency?: string
    • Optional priceCustomerGroup?: string
    • Optional searchKeywords?: {
          language: string;
          value: string;
      }[]
    • sort: {
          by: string;
          direction: "asc" | "desc";
      }[]
    • Optional staged?: boolean
    • Optional state?: string
    • Optional text?: {
          language?: string;
          value?: string;
      } | null
    • Optional version?: string
    • Optional where?: string[]
    • Optional whereOperator?: "and" | "or"
    • withTotal: boolean | null

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/SuccessResult.html b/types/SuccessResult.html index fa805e567..529e09193 100644 --- a/types/SuccessResult.html +++ b/types/SuccessResult.html @@ -1 +1 @@ -SuccessResult | @commercetools/sdk-client-v2

    Type alias SuccessResult

    SuccessResult: {
        body: {
            count: number;
            results: JsonObject<JsonObject<string>>;
        };
        headers?: JsonObject<string>;
        statusCode: number;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +SuccessResult | @commercetools/sdk-client-v2

    Type alias SuccessResult

    SuccessResult: {
        body: {
            count: number;
            results: JsonObject<JsonObject<string>>;
        };
        headers?: JsonObject<string>;
        statusCode: number;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/SyncAction.html b/types/SyncAction.html index 8c1e65114..38c7866a1 100644 --- a/types/SyncAction.html +++ b/types/SyncAction.html @@ -1 +1 @@ -SyncAction | @commercetools/sdk-client-v2

    Type alias SyncAction

    SyncAction: {
        buildActions: ((now, before) => UpdateAction[]);
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +SyncAction | @commercetools/sdk-client-v2

    Type alias SyncAction

    SyncAction: {
        buildActions: ((now, before) => UpdateAction[]);
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/SyncActionConfig.html b/types/SyncActionConfig.html index 58090c2ce..8b05d24ee 100644 --- a/types/SyncActionConfig.html +++ b/types/SyncActionConfig.html @@ -1 +1 @@ -SyncActionConfig | @commercetools/sdk-client-v2

    Type alias SyncActionConfig

    SyncActionConfig: {
        shouldOmitEmptyString: boolean;
    }

    Type declaration

    • shouldOmitEmptyString: boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +SyncActionConfig | @commercetools/sdk-client-v2

    Type alias SyncActionConfig

    SyncActionConfig: {
        shouldOmitEmptyString: boolean;
    }

    Type declaration

    • shouldOmitEmptyString: boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Task.html b/types/Task.html index e096199ea..c9e83710b 100644 --- a/types/Task.html +++ b/types/Task.html @@ -1 +1 @@ -Task | @commercetools/sdk-client-v2

    Type alias Task

    Task: {
        next: Next;
        request: MiddlewareRequest;
        response: MiddlewareResponse;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +Task | @commercetools/sdk-client-v2

    Type alias Task

    Task: {
        next: Next;
        request: MiddlewareRequest;
        response: MiddlewareResponse;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/TelemetryOptions.html b/types/TelemetryOptions.html index 95ce1e7ba..bf3810530 100644 --- a/types/TelemetryOptions.html +++ b/types/TelemetryOptions.html @@ -1 +1 @@ -TelemetryOptions | @commercetools/sdk-client-v2

    Type alias TelemetryOptions

    TelemetryOptions: {
        apm?: Function;
        createTelemetryMiddleware: ((options?) => Middleware);
        tracer?: Function;
        userAgent?: string;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +TelemetryOptions | @commercetools/sdk-client-v2

    Type alias TelemetryOptions

    TelemetryOptions: {
        apm?: Function;
        createTelemetryMiddleware: ((options?) => Middleware);
        tracer?: Function;
        userAgent?: string;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/TokenCache.html b/types/TokenCache.html index 638dd3c3f..a77c2de9f 100644 --- a/types/TokenCache.html +++ b/types/TokenCache.html @@ -1 +1 @@ -TokenCache | @commercetools/sdk-client-v2

    Type alias TokenCache

    TokenCache: {
        get: ((tokenCacheOptions?) => TokenStore);
        set: ((cache, tokenCacheOptions?) => void);
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +TokenCache | @commercetools/sdk-client-v2

    Type alias TokenCache

    TokenCache: {
        get: ((tokenCacheOptions?) => TokenStore);
        set: ((cache, tokenCacheOptions?) => void);
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/TokenCacheOptions.html b/types/TokenCacheOptions.html index fb0dbcb3b..8108f258b 100644 --- a/types/TokenCacheOptions.html +++ b/types/TokenCacheOptions.html @@ -1 +1 @@ -TokenCacheOptions | @commercetools/sdk-client-v2

    Type alias TokenCacheOptions

    TokenCacheOptions: {
        clientId: string;
        host: string;
        projectKey: string;
    }

    Type declaration

    • clientId: string
    • host: string
    • projectKey: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +TokenCacheOptions | @commercetools/sdk-client-v2

    Type alias TokenCacheOptions

    TokenCacheOptions: {
        clientId: string;
        host: string;
        projectKey: string;
    }

    Type declaration

    • clientId: string
    • host: string
    • projectKey: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/TokenInfo.html b/types/TokenInfo.html index 8367ffeee..22a688f07 100644 --- a/types/TokenInfo.html +++ b/types/TokenInfo.html @@ -1 +1 @@ -TokenInfo | @commercetools/sdk-client-v2

    Type alias TokenInfo

    TokenInfo: {
        access_token: string;
        expires_at: number;
        expires_in: number;
        refresh_token: string;
        scope?: string;
        token_type?: string;
    }

    Type declaration

    • access_token: string
    • expires_at: number
    • expires_in: number
    • refresh_token: string
    • Optional scope?: string
    • Optional token_type?: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +TokenInfo | @commercetools/sdk-client-v2

    Type alias TokenInfo

    TokenInfo: {
        access_token: string;
        expires_at: number;
        expires_in: number;
        refresh_token: string;
        scope?: string;
        token_type?: string;
    }

    Type declaration

    • access_token: string
    • expires_at: number
    • expires_in: number
    • refresh_token: string
    • Optional scope?: string
    • Optional token_type?: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/TokenStore.html b/types/TokenStore.html index 273c55d9c..542be276e 100644 --- a/types/TokenStore.html +++ b/types/TokenStore.html @@ -1 +1 @@ -TokenStore | @commercetools/sdk-client-v2

    Type alias TokenStore

    TokenStore: {
        expirationTime: number;
        refreshToken?: string;
        token: string;
    }

    Type declaration

    • expirationTime: number
    • Optional refreshToken?: string
    • token: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +TokenStore | @commercetools/sdk-client-v2

    Type alias TokenStore

    TokenStore: {
        expirationTime: number;
        refreshToken?: string;
        token: string;
    }

    Type declaration

    • expirationTime: number
    • Optional refreshToken?: string
    • token: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/UpdateAction.html b/types/UpdateAction.html index 09266d909..d1fcba659 100644 --- a/types/UpdateAction.html +++ b/types/UpdateAction.html @@ -1 +1 @@ -UpdateAction | @commercetools/sdk-client-v2

    Type alias UpdateAction

    UpdateAction: {
        action: string;
        [key: string]: any;
    }

    Type declaration

    • [key: string]: any
    • action: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +UpdateAction | @commercetools/sdk-client-v2

    Type alias UpdateAction

    UpdateAction: {
        action: string;
        [key: string]: any;
    }

    Type declaration

    • [key: string]: any
    • action: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/UserAgentMiddlewareOptions.html b/types/UserAgentMiddlewareOptions.html index 400cbed2c..5a50b1dbd 100644 --- a/types/UserAgentMiddlewareOptions.html +++ b/types/UserAgentMiddlewareOptions.html @@ -1 +1 @@ -UserAgentMiddlewareOptions | @commercetools/sdk-client-v2

    Type alias UserAgentMiddlewareOptions

    UserAgentMiddlewareOptions: {
        contactEmail?: string;
        contactUrl?: string;
        libraryName?: string;
        libraryVersion?: string;
    }

    Type declaration

    • Optional contactEmail?: string
    • Optional contactUrl?: string
    • Optional libraryName?: string
    • Optional libraryVersion?: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +UserAgentMiddlewareOptions | @commercetools/sdk-client-v2

    Type alias UserAgentMiddlewareOptions

    UserAgentMiddlewareOptions: {
        contactEmail?: string;
        contactUrl?: string;
        libraryName?: string;
        libraryVersion?: string;
    }

    Type declaration

    • Optional contactEmail?: string
    • Optional contactUrl?: string
    • Optional libraryName?: string
    • Optional libraryVersion?: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/UserAuthOptions.html b/types/UserAuthOptions.html index 12e51eee9..410242520 100644 --- a/types/UserAuthOptions.html +++ b/types/UserAuthOptions.html @@ -1 +1 @@ -UserAuthOptions | @commercetools/sdk-client-v2

    Type alias UserAuthOptions

    UserAuthOptions: {
        password: string;
        username: string;
    }

    Type declaration

    • password: string
    • username: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +UserAuthOptions | @commercetools/sdk-client-v2

    Type alias UserAuthOptions

    UserAuthOptions: {
        password: string;
        username: string;
    }

    Type declaration

    • password: string
    • username: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ValiadateOption.html b/types/ValiadateOption.html index 17c21db38..57e925654 100644 --- a/types/ValiadateOption.html +++ b/types/ValiadateOption.html @@ -1 +1 @@ -ValiadateOption | @commercetools/sdk-client-v2

    Type alias ValiadateOption

    ValiadateOption: {
        allowedMethods: MethodType;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ValiadateOption | @commercetools/sdk-client-v2

    Type alias ValiadateOption

    ValiadateOption: {
        allowedMethods: MethodType;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/VariableMap.html b/types/VariableMap.html index c80f6e59c..c281b7519 100644 --- a/types/VariableMap.html +++ b/types/VariableMap.html @@ -1 +1 @@ -VariableMap | @commercetools/sdk-client-v2

    Type alias VariableMap

    VariableMap: {
        [key: string]: QueryParam;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +VariableMap | @commercetools/sdk-client-v2

    Type alias VariableMap

    VariableMap: {
        [key: string]: QueryParam;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/executeRequest.html b/types/executeRequest.html index cd6f03e6f..3a58ce929 100644 --- a/types/executeRequest.html +++ b/types/executeRequest.html @@ -1 +1 @@ -executeRequest | @commercetools/sdk-client-v2

    Type alias executeRequest

    executeRequest: ((request) => Promise<ClientResponse>)

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +executeRequest | @commercetools/sdk-client-v2

    Type alias executeRequest

    executeRequest: ((request) => Promise<ClientResponse>)

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/executeRequestOptions.html b/types/executeRequestOptions.html index d24c5b922..35d716d4d 100644 --- a/types/executeRequestOptions.html +++ b/types/executeRequestOptions.html @@ -1 +1 @@ -executeRequestOptions | @commercetools/sdk-client-v2

    Type alias executeRequestOptions

    executeRequestOptions: requestBaseOptions & {
        fetcher: any;
    }

    Type declaration

    • fetcher: any

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +executeRequestOptions | @commercetools/sdk-client-v2

    Type alias executeRequestOptions

    executeRequestOptions: requestBaseOptions & {
        fetcher: any;
    }

    Type declaration

    • fetcher: any

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/requestBaseOptions.html b/types/requestBaseOptions.html index eeaf85cba..d3caf1a25 100644 --- a/types/requestBaseOptions.html +++ b/types/requestBaseOptions.html @@ -1 +1 @@ -requestBaseOptions | @commercetools/sdk-client-v2

    Type alias requestBaseOptions

    requestBaseOptions: {
        basicAuth: string;
        body: string;
        pendingTasks: Task[];
        requestState: RequestStateStore;
        response: MiddlewareResponse;
        tokenCache: TokenCache;
        tokenCacheKey?: TokenCacheOptions;
        url: string;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +requestBaseOptions | @commercetools/sdk-client-v2

    Type alias requestBaseOptions

    requestBaseOptions: {
        basicAuth: string;
        body: string;
        pendingTasks: Task[];
        requestState: RequestStateStore;
        response: MiddlewareResponse;
        tokenCache: TokenCache;
        tokenCacheKey?: TokenCacheOptions;
        url: string;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file