Class ByProjectKeySubscriptionsRequestBuilder

Index

Constructors

Properties

Methods

get head post withId withKey

Constructors

constructor

new ByProjectKeySubscriptionsRequestBuilder(
    args: {
        baseUri?: string;
        executeRequest: executeRequest;
        pathArgs: { projectKey: string };
    },
): ByProjectKeySubscriptionsRequestBuilder
Parameters
- args: {
      baseUri?: string;
      executeRequest: executeRequest;
      pathArgs: { projectKey: string };
  }
Returns ByProjectKeySubscriptionsRequestBuilder
- Defined in generated/client/subscriptions/by-project-key-subscriptions-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?: {
            limit?: number;
            offset?: number;
            sort?: string | string[];
            where?: string | string[];
            withTotal?: boolean;
            [key: string]: QueryParam;
        };
    },
): ApiRequest<SubscriptionPagedQueryResponse>
Parameters
- OptionalmethodArgs: {
      headers?: { [key: string]: string | string[] };
      queryArgs?: {
          limit?: number;
          offset?: number;
          sort?: string | string[];
          where?: string | string[];
          withTotal?: boolean;
          [key: string]: QueryParam;
      };
  }
Returns ApiRequest<SubscriptionPagedQueryResponse>
- Defined in generated/client/subscriptions/by-project-key-subscriptions-request-builder.ts:52

head

head(
    methodArgs?: {
        headers?: { [key: string]: string | string[] };
        queryArgs?: { where?: string | string[]; [key: string]: QueryParam };
    },
): ApiRequest<void>
Checks if one or more Subscriptions exist for the provided query predicate. Returns a 200 status if any Subscriptions match the query predicate, or a 404 status otherwise.
Parameters
- OptionalmethodArgs: {
  headers?: { [key: string]: string | string[] };
  queryArgs?: { where?: string | string[]; [key: string]: QueryParam };
  }
Returns ApiRequest<void>
- Defined in generated/client/subscriptions/by-project-key-subscriptions-request-builder.ts:82

post

post(
    methodArgs: {
        body: SubscriptionDraft;
        headers?: { [key: string]: string | string[] };
    },
): ApiRequest<Subscription>
A test notification is sent to ensure the correct configuration of the Destination. If the notification cannot be delivered, the Subscription will not be created. The payload of the test notification is of type ResourceCreated for the resourceTypeId subscription.
Parameters
- methodArgs: { body: SubscriptionDraft; headers?: { [key: string]: string | string[] } }
Returns ApiRequest<Subscription>
- Defined in generated/client/subscriptions/by-project-key-subscriptions-request-builder.ts:109

withId

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

withKey

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