Hierarchy

  • default
    • MenuItems

Constructors

  • Parameters

    • __namedParameters: EndpointOptions

    Returns MenuItems

Methods

  • Returns a list of Menu Items. See api docs.

    Required token: Bearer token

    Success response schema: Success schema

    Failure response schema: Error schema

    Example:

    const response = await client.menuItems.list({
    bearer_token: '7381273269536713689562374856'
    })

    Parameters

    • options: _DeepAnyObjectObject<RequiredAccountToken & IQuery & Record<string, any>>

    Returns Promise<IMenuItemsResult>

  • Returns a single Menu Item. See api docs.

    Required token: Bearer token

    Success response schema: Success schema

    Failure response schema: Error schema

    Example:

    const response = await client.menuItems.show({
    bearer_token: '7381273269536713689562374856',
    id: '2'
    })

    Parameters

    • options: _DeepAnyObjectObject<RequiredAccountToken & IQuery & {
          id: string;
      }>

    Returns Promise<IMenuItemResult>

  • Creates a new Menu Item and returns its attributes. See api docs.

    Required token: Bearer token

    Success response schema: Success schema

    Failure response schema: Error schema

    Example:

    const response = await client.menuItems.create({
    bearer_token: '7381273269536713689562374856',
    menu_item: {
    name: 'T-Shirts',
    code: 'MEN-TS',
    subtitle: 'Shop T-Shirts',
    destination: 'https://getvendo.com',
    menu_id: 1,
    new_window: true,
    item_type: 'Link',
    linked_resource_type: 'URL',
    linked_resource_id: 1
    }
    })

    Parameters

    • options: _DeepAnyObjectObject<RequiredAccountToken & IQuery & MenuItemParams>

    Returns Promise<IMenuItemResult>

  • Update selected Menu Item. See api docs.

    Required token: Bearer token

    Success response schema: Success schema

    Failure response schema: Error schema

    Example:

    const response = await client.menuItems.update({
    bearer_token: '7381273269536713689562374856',
    id: '1',
    menu_item: {
    name: 'T-Shirts',
    code: 'MEN-TS',
    subtitle: 'Shop T-Shirts',
    destination: 'https://getvendo.com',
    menu_id: 1,
    new_window: true,
    item_type: 'Link',
    linked_resource_type: 'URL',
    linked_resource_id: 1
    }
    })

    Parameters

    • options: _DeepAnyObjectObject<RequiredAccountToken & IQuery & MenuItemParams & {
          id: string;
      }>

    Returns Promise<IMenuItemResult>

  • This endpoint removes the specified Menu Item. See api docs.

    Required token: Bearer token

    Success response schema: Success schema

    Failure response schema: Error schema

    Example:

    const response = await client.menuItems.remove({
    bearer_token: '7381273269536713689562374856',
    id: '1'
    })

    Parameters

    • options: _DeepAnyObjectObject<RequiredAccountToken & Record<string, unknown> & {
          id: string;
      }>

    Returns Promise<NoContentResult>

  • This endpoint repositions the specified Menu Item. See api docs.

    Required token: Bearer token

    Success response schema: Success schema

    Failure response schema: Error schema

    Example:

    const response = await client.menuItems.reposition({
    bearer_token: '7381273269536713689562374856',
    id: '1',
    menu_item: {
    new_parent_id: 1,
    new_position_idx: 1
    }
    })

    Parameters

    • options: _DeepAnyObjectObject<RequiredAccountToken & Record<string, unknown> & MenuItemRepositionParams & {
          id: string;
      }>

    Returns Promise<IMenuItemResult>

  • Type Parameters

    • ResponseType = JsonApiResponse

    Parameters

    • method: HttpMethod
    • url: string
    • Optional tokens: IToken
    • Optional params: any
    • Optional responseParsing: ResponseParsing

    Returns Promise<ResultResponse<ResponseType>>

  • The HTTP error code returned by Spree is not indicative of its response shape. This function determines the information provided by Spree and uses everything available.

    Parameters

    • error: default

    Returns ErrorType

  • Parameters

    • error: Error

    Returns default

  • Parameters

    • error: default

    Returns default

  • Parameters

    • tokens: IToken

    Returns {
        [headerName: string]: string;
    }

    • [headerName: string]: string

Properties

fetcher: Fetcher

Generated using TypeDoc