Class OrderDefaultAdapterRestSdk

Default Adapter for Order

Description

This class is used to define the default adapter for Order. This adapter uses the REST SDK to communicate with Order functionality.

Implements

Constructors

constructor

Properties

createOrderPath getOrderPath getOrdersForUserPath internalToken orderServiceEndpoint updateOrderPath DEFAULT_CREATE_ORDER_PATH DEFAULT_GET_ORDERS_FOR_USER_PATH DEFAULT_GET_ORDER_PATH DEFAULT_UPDATE_ORDER_PATH

Order

createOrder getOrder getOrdersForUser updateOrder

Constructors

constructor

Properties

Private createOrderPath

createOrderPath: string

Private getOrderPath

getOrderPath: string

Private getOrdersForUserPath

getOrdersForUserPath: string

Private internalToken

internalToken: string

Private orderServiceEndpoint

orderServiceEndpoint: string

Private updateOrderPath

updateOrderPath: string

Static Private Readonly DEFAULT_CREATE_ORDER_PATH

DEFAULT_CREATE_ORDER_PATH: "/orgs/:orgId/orders" = '/orgs/:orgId/orders'

Static Private Readonly DEFAULT_GET_ORDERS_FOR_USER_PATH

DEFAULT_GET_ORDERS_FOR_USER_PATH: "/users/:userId/orders" = '/users/:userId/orders'

Static Private Readonly DEFAULT_GET_ORDER_PATH

DEFAULT_GET_ORDER_PATH: "/orgs/:orgId/orders/:orderId" = '/orgs/:orgId/orders/:orderId'

Static Private Readonly DEFAULT_UPDATE_ORDER_PATH

DEFAULT_UPDATE_ORDER_PATH: "/orgs/:orgId/orders/:orderId" = '/orgs/:orgId/orders/:orderId'

Order

createOrder

  • createOrder(args, requestContext?): Promise<ExpandedOrder>

  • API for creating a single order

    Parameters

    • args: {
          options?: {
              expand?: string;
          };
          order: Partial<CreateOrderRequest>;
          orgId: string;
      }

      Input containing parameters for creating order.

      • Optional options?: {
            expand?: string;
        }
        • Optional expand?: string
      • order: Partial<CreateOrderRequest>
      • orgId: string
    • Optional requestContext: RequestContext

    Returns Promise<ExpandedOrder>

    Order data that was created.

    Description

    This API is used to create a single order in the Order service.

getOrder

  • getOrder(args, requestContext?): Promise<ExpandedOrder>

  • API for getting an order

    Parameters

    • args: {
          expand?: string;
          orderId: string;
          orgId: string;
      }

      Input containing parameters for fetching an order.

      • Optional expand?: string
      • orderId: string
      • orgId: string
    • Optional requestContext: RequestContext

    Returns Promise<ExpandedOrder>

    The order.

    Description

    This API is used to get an order from the Order service.

getOrdersForUser

  • getOrdersForUser(args, requestContext?): Promise<PaginatedQueryResult<Order>>

  • API for getting orders for a user

    Parameters

    • args: {
          options?: {
              queryOptions?: PaginatedListQueryOptions;
          };
          userId: string;
      }

      Input containing parameters for fetching orders.

      • Optional options?: {
            queryOptions?: PaginatedListQueryOptions;
        }
        • Optional queryOptions?: PaginatedListQueryOptions
      • userId: string
    • Optional requestContext: RequestContext

    Returns Promise<PaginatedQueryResult<Order>>

    Paginated list of orders for the user.

    Description

    This API is used to get orders for a user from the Order service.

updateOrder

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc