Class ByProjectKeyRecurringOrdersKeyByKeyRequestBuilder

Index

Constructors

Properties

Methods

delete get head post

Constructors

constructor

new ByProjectKeyRecurringOrdersKeyByKeyRequestBuilder(
    args: {
        baseUri?: string;
        executeRequest: executeRequest;
        pathArgs: { key: string; projectKey: string };
    },
): ByProjectKeyRecurringOrdersKeyByKeyRequestBuilder
Parameters
- args: {
      baseUri?: string;
      executeRequest: executeRequest;
      pathArgs: { key: string; projectKey: string };
  }
Returns ByProjectKeyRecurringOrdersKeyByKeyRequestBuilder
- Defined in generated/client/recurring-orders/by-project-key-recurring-orders-key-by-key-request-builder.ts:15

Properties

`Protected` `Readonly`args

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

Methods

delete

delete(
    methodArgs: {
        headers?: { [key: string]: string | string[] };
        queryArgs: {
            dataErasure?: boolean;
            expand?: string | string[];
            version: number;
            [key: string]: QueryParam;
        };
    },
): ApiRequest<RecurringOrder>
Deletes a Recurring Order in the Project.
Parameters
- methodArgs: {
      headers?: { [key: string]: string | string[] };
      queryArgs: {
          dataErasure?: boolean;
          expand?: string | string[];
          version: number;
          [key: string]: QueryParam;
      };
  }
Returns ApiRequest<RecurringOrder>
- Defined in generated/client/recurring-orders/by-project-key-recurring-orders-key-by-key-request-builder.ts:110

get

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

head

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

post

post(
    methodArgs: {
        body: RecurringOrderUpdate;
        headers?: { [key: string]: string | string[] };
        queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
    },
): ApiRequest<RecurringOrder>
Updates a Recurring Order using one or more update actions.
```
A Recurring Order can only be updated when it is not processing an Order. Otherwise, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned.
```
Parameters
- methodArgs: {
      body: RecurringOrderUpdate;
      headers?: { [key: string]: string | string[] };
      queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
  }
Returns ApiRequest<RecurringOrder>
- Defined in generated/client/recurring-orders/by-project-key-recurring-orders-key-by-key-request-builder.ts:80