Class ByProjectKeyRecurrencePoliciesRequestBuilder

Index

Constructors

constructor

new ByProjectKeyRecurrencePoliciesRequestBuilder(
    args: {
        baseUri?: string;
        executeRequest: executeRequest;
        pathArgs: { projectKey: string };
    },
): ByProjectKeyRecurrencePoliciesRequestBuilder
Parameters
- args: {
      baseUri?: string;
      executeRequest: executeRequest;
      pathArgs: { projectKey: string };
  }
Returns ByProjectKeyRecurrencePoliciesRequestBuilder
- Defined in generated/client/recurrence-policies/by-project-key-recurrence-policies-request-builder.ts:18

Properties

`Protected` `Readonly`args

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

Methods

get

get(
    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;
        };
    },
): ApiRequest<RecurrencePolicyPagedQueryResponse>
Retrieves Recurrence Policies in the Project.
```
The `view_recurring_orders:{projectKey}` scope is deprecated for use on this endpoint. Update your clients to use the `view_recurrence_policies:{projectKey}` scope instead. For more information, see the [Deprecations and removals](/api/deprecations-and-removals#recurrence-policies) list.
```
Parameters
- OptionalmethodArgs: {
      headers?: { [key: string]: string | string[] };
      queryArgs?: {
          expand?: string | string[];
          limit?: number;
          offset?: number;
          sort?: string | string[];
          where?: string | string[];
          withTotal?: boolean;
          [key: string]: QueryParam;
      };
  }
Returns ApiRequest<RecurrencePolicyPagedQueryResponse>
- Defined in generated/client/recurrence-policies/by-project-key-recurrence-policies-request-builder.ts:58

head

head(
    methodArgs?: {
        headers?: { [key: string]: string | string[] };
        queryArgs?: { where?: string | string[]; [key: string]: QueryParam };
    },
): ApiRequest<void>
Checks if one or more Recurrence Policies exist for the provided query predicate. Returns a 200 status if any Recurrence Policies match the query predicate, or a NotFound error otherwise.
```
The `view_recurring_orders:{projectKey}` scope is deprecated for use on this endpoint. Update your clients to use the `view_recurrence_policies:{projectKey}` scope instead. For more information, see the [Deprecations and removals](/api/deprecations-and-removals#recurrence-policies) list.
```
Parameters
- OptionalmethodArgs: {
  headers?: { [key: string]: string | string[] };
  queryArgs?: { where?: string | string[]; [key: string]: QueryParam };
  }
Returns ApiRequest<void>
- Defined in generated/client/recurrence-policies/by-project-key-recurrence-policies-request-builder.ts:92

post

post(
    methodArgs: {
        body: RecurrencePolicyDraft;
        headers?: { [key: string]: string | string[] };
        queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
    },
): ApiRequest<RecurrencePolicy>
Creates a Recurrence Policy in the Project.
```
The `manage_recurring_orders:{projectKey}` scope is deprecated for use on this endpoint. Update your clients to use the `manage_recurrence_policies:{projectKey}` scope instead. For more information, see the [Deprecations and removals](/api/deprecations-and-removals#recurrence-policies) list.
```
Parameters
- methodArgs: {
      body: RecurrencePolicyDraft;
      headers?: { [key: string]: string | string[] };
      queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
  }
Returns ApiRequest<RecurrencePolicy>
- Defined in generated/client/recurrence-policies/by-project-key-recurrence-policies-request-builder.ts:121

withId

withId(
childPathArgs: { ID: string },
): ByProjectKeyRecurrencePoliciesByIDRequestBuilder
Parameters
- childPathArgs: { ID: string }
Returns ByProjectKeyRecurrencePoliciesByIDRequestBuilder
- Defined in generated/client/recurrence-policies/by-project-key-recurrence-policies-request-builder.ts:39

withKey

withKey(
childPathArgs: { key: string },
): ByProjectKeyRecurrencePoliciesKeyByKeyRequestBuilder
Parameters
- childPathArgs: { key: string }
Returns ByProjectKeyRecurrencePoliciesKeyByKeyRequestBuilder
- Defined in generated/client/recurrence-policies/by-project-key-recurrence-policies-request-builder.ts:27

Class ByProjectKeyRecurrencePoliciesRequestBuilder

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ByProjectKeyRecurrencePoliciesRequestBuilder

Properties

`Protected` `Readonly`args

Methods

get

Parameters

Returns ApiRequest<RecurrencePolicyPagedQueryResponse>

head

Parameters

Returns ApiRequest<void>

post

Parameters

Returns ApiRequest<RecurrencePolicy>

withId

Parameters

Returns ByProjectKeyRecurrencePoliciesByIDRequestBuilder

withKey

Parameters

Returns ByProjectKeyRecurrencePoliciesKeyByKeyRequestBuilder

Settings

On This Page

Class ByProjectKeyRecurrencePoliciesRequestBuilder

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ByProjectKeyRecurrencePoliciesRequestBuilder

Properties

Protected Readonlyargs

Methods

get

Parameters

Returns ApiRequest<RecurrencePolicyPagedQueryResponse>

head

Parameters

Returns ApiRequest<void>

post

Parameters

Returns ApiRequest<RecurrencePolicy>

withId

Parameters

Returns ByProjectKeyRecurrencePoliciesByIDRequestBuilder

withKey

Parameters

Returns ByProjectKeyRecurrencePoliciesKeyByKeyRequestBuilder

Settings

On This Page

`Protected` `Readonly`args