Class ByProjectKeyCategoriesRequestBuilder

Constructors

constructor

Properties

args

Methods

get head post withId withKey

Constructors

constructor

Properties

Protected Readonly args

args: {
    baseUri?: string;
    executeRequest: executeRequest;
    pathArgs: {
        projectKey: string;
    };
}

Type declaration

  • Optional baseUri?: string
  • executeRequest: executeRequest
  • pathArgs: {
        projectKey: string;
    }
    • projectKey: string

Methods

get

  • get(methodArgs?): ApiRequest<CategoryPagedQueryResponse>

  • Either the scope view_products:{projectKey} or view_categories:{projectKey} is required.

    Parameters

    • Optional methodArgs: {
          headers?: {
              [key: string]: string | string[];
          };
          queryArgs?: {
              expand?: string | string[];
              limit?: number;
              offset?: number;
              sort?: string | string[];
              where?: string | string[];
              withTotal?: boolean;
              [key: string]: QueryParam;
          };
      }
      • Optional headers?: {
            [key: string]: string | string[];
        }
        • [key: string]: string | string[]
      • Optional queryArgs?: {
            expand?: string | string[];
            limit?: number;
            offset?: number;
            sort?: string | string[];
            where?: string | string[];
            withTotal?: boolean;
            [key: string]: QueryParam;
        }
        • [key: string]: QueryParam
        • Optional expand?: string | string[]
        • Optional limit?: number
        • Optional offset?: number
        • Optional sort?: string | string[]
        • Optional where?: string | string[]
        • Optional withTotal?: boolean

    Returns ApiRequest<CategoryPagedQueryResponse>

head

  • head(methodArgs?): ApiRequest<void>

  • Checks if a Category exists for on a given Query Predicate. Returns a 200 OK status if any Categories match the Query Predicate or a 404 Not Found otherwise.

    Parameters

    • Optional methodArgs: {
          headers?: {
              [key: string]: string | string[];
          };
          queryArgs?: {
              where?: string | string[];
              [key: string]: QueryParam;
          };
      }
      • Optional headers?: {
            [key: string]: string | string[];
        }
        • [key: string]: string | string[]
      • Optional queryArgs?: {
            where?: string | string[];
            [key: string]: QueryParam;
        }
        • [key: string]: QueryParam
        • Optional where?: string | string[]

    Returns ApiRequest<void>

post

  • post(methodArgs): ApiRequest<Category>

  • Either the scope manage_products:{projectKey} or manage_categories:{projectKey} is required.

    Creating a Category produces the [CategoryCreated](ctp:api:type:CategoryCreatedMessage) Message.

    Parameters

    • methodArgs: {
          body: CategoryDraft;
          headers?: {
              [key: string]: string | string[];
          };
          queryArgs?: {
              expand?: string | string[];
              [key: string]: QueryParam;
          };
      }
      • body: CategoryDraft
      • Optional headers?: {
            [key: string]: string | string[];
        }
        • [key: string]: string | string[]
      • Optional queryArgs?: {
            expand?: string | string[];
            [key: string]: QueryParam;
        }
        • [key: string]: QueryParam
        • Optional expand?: string | string[]

    Returns ApiRequest<Category>

withId

withKey

Settings

Member Visibility

Theme

On This Page

constructorargsgetheadpostwithIdwithKey