Class ByProjectKeyOrdersOrderNumberByOrderNumberRequestBuilder

Index

Constructors

Properties

Methods

delete get head post

Constructors

constructor

new ByProjectKeyOrdersOrderNumberByOrderNumberRequestBuilder(
    args: {
        baseUri?: string;
        executeRequest: executeRequest;
        pathArgs: { orderNumber: string; projectKey: string };
    },
): ByProjectKeyOrdersOrderNumberByOrderNumberRequestBuilder
Parameters
- args: {
      baseUri?: string;
      executeRequest: executeRequest;
      pathArgs: { orderNumber: string; projectKey: string };
  }
Returns ByProjectKeyOrdersOrderNumberByOrderNumberRequestBuilder
- Defined in generated/client/orders/by-project-key-orders-order-number-by-order-number-request-builder.ts:12

Properties

`Protected` `Readonly`args

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

Methods

delete

delete(
    methodArgs: {
        headers?: { [key: string]: string | string[] };
        queryArgs: {
            dataErasure?: boolean;
            expand?: string | string[];
            version: number;
            [key: string]: QueryParam;
        };
    },
): ApiRequest<Order>
Deletes an Order in the Project. Deleting an Order produces the OrderDeleted Message.
Parameters
- methodArgs: {
      headers?: { [key: string]: string | string[] };
      queryArgs: {
          dataErasure?: boolean;
          expand?: string | string[];
          version: number;
          [key: string]: QueryParam;
      };
  }
Returns ApiRequest<Order>
- Defined in generated/client/orders/by-project-key-orders-order-number-by-order-number-request-builder.ts:103

get

get(
    methodArgs?: {
        headers?: { [key: string]: string | string[] };
        queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
    },
): ApiRequest<Order>
Retrieves an Order with the provided orderNumber.
Parameters
- OptionalmethodArgs: {
  headers?: { [key: string]: string | string[] };
  queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
  }
Returns ApiRequest<Order>
- Defined in generated/client/orders/by-project-key-orders-order-number-by-order-number-request-builder.ts:25

head

head(
methodArgs?: { headers?: { [key: string]: string | string[] } },
): ApiRequest<void>
Checks if an Order exists with the provided orderNumber. Returns a 200 status if the Order exists, or a 404 status otherwise.
Parameters
- OptionalmethodArgs: { headers?: { [key: string]: string | string[] } }
Returns ApiRequest<void>
- Defined in generated/client/orders/by-project-key-orders-order-number-by-order-number-request-builder.ts:51

post

post(
    methodArgs: {
        body: OrderUpdate;
        headers?: { [key: string]: string | string[] };
        queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
    },
): ApiRequest<Order>
Updates an Order in the Project using one or more update actions.
Parameters
- methodArgs: {
      body: OrderUpdate;
      headers?: { [key: string]: string | string[] };
      queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
  }
Returns ApiRequest<Order>
- Defined in generated/client/orders/by-project-key-orders-order-number-by-order-number-request-builder.ts:72