Class ByProjectKeySubscriptionsRequestBuilder

Index

Constructors

constructor

new ByProjectKeySubscriptionsRequestBuilder(args): ByProjectKeySubscriptionsRequestBuilder
Parameters
- args: {
      baseUri?: string;
      executeRequest: executeRequest;
      pathArgs: {
          projectKey: string;
      };
  }
  - Optional baseUri?: string
  - executeRequest: executeRequest
  - pathArgs: {
    projectKey: string;
    }
    - 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;
    };
}

Type declaration

Optional baseUri?: string
executeRequest: executeRequest
pathArgs: {
projectKey: string;
}
- projectKey: string

Methods

get

get(methodArgs?): ApiRequest<SubscriptionPagedQueryResponse>
Parameters
- Optional methodArgs: {
      headers?: {
          [key: string]: string | string[];
      };
      queryArgs?: {
          limit?: number;
          offset?: number;
          sort?: string | string[];
          where?: string | string[];
          withTotal?: boolean;
          [key: string]: QueryParam;
      };
  }
  - Optional headers?: {
    [key: string]: string | string[];
    }
    - [key: string]: string | string[]
  - Optional queryArgs?: {
        limit?: number;
        offset?: number;
        sort?: string | string[];
        where?: string | string[];
        withTotal?: boolean;
        [key: string]: QueryParam;
    }
    - [key: string]: QueryParam
    - Optional limit?: number
    - Optional offset?: number
    - Optional sort?: string | string[]
    - Optional where?: string | string[]
    - Optional withTotal?: boolean
Returns ApiRequest<SubscriptionPagedQueryResponse>
- Defined in generated/client/subscriptions/by-project-key-subscriptions-request-builder.ts:52

head

head(methodArgs?): ApiRequest<void>
Checks if a Subscription exists for a given Query Predicate. Returns a 200 OK status if any Subscriptions match the Query Predicate or a 404 Not Found otherwise.
Parameters
- Optional methodArgs: {
      headers?: {
          [key: string]: string | string[];
      };
      queryArgs?: {
          where?: string | string[];
          [key: string]: QueryParam;
      };
  }
  - Optional headers?: {
    [key: string]: string | string[];
    }
    - [key: string]: string | string[]
  - Optional queryArgs?: {
    where?: string | string[];
    [key: string]: QueryParam;
    }
    - [key: string]: QueryParam
    - Optional where?: string | string[]
Returns ApiRequest<void>
- Defined in generated/client/subscriptions/by-project-key-subscriptions-request-builder.ts:82

post

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

withId

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

withKey

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

Class ByProjectKeySubscriptionsRequestBuilder

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional baseUri?: string

executeRequest: executeRequest

pathArgs: { projectKey: string; }

projectKey: string

Returns ByProjectKeySubscriptionsRequestBuilder

Properties

Protected Readonly args

Type declaration

Optional baseUri?: string

executeRequest: executeRequest

pathArgs: { projectKey: string; }

projectKey: string

Methods

get

Parameters

Optional headers?: { [key: string]: string | string[]; }

[key: string]: string | string[]

Optional queryArgs?: { limit?: number; offset?: number; sort?: string | string[]; where?: string | string[]; withTotal?: boolean; [key: string]: QueryParam; }

[key: string]: QueryParam

Optional limit?: number

Optional offset?: number

Optional sort?: string | string[]

Optional where?: string | string[]

Optional withTotal?: boolean

Returns ApiRequest<SubscriptionPagedQueryResponse>

head

Parameters

Optional headers?: { [key: string]: string | string[]; }

[key: string]: string | string[]

Optional queryArgs?: { where?: string | string[]; [key: string]: QueryParam; }

[key: string]: QueryParam

Optional where?: string | string[]

Returns ApiRequest<void>

post

Parameters

body: SubscriptionDraft

Optional headers?: { [key: string]: string | string[]; }

[key: string]: string | string[]

Returns ApiRequest<Subscription>

withId

Parameters

ID: string

Returns ByProjectKeySubscriptionsByIDRequestBuilder

withKey

Parameters

key: string

Returns ByProjectKeySubscriptionsKeyByKeyRequestBuilder

Settings

Member Visibility

Theme

On This Page

`Optional` baseUri?: string

pathArgs: {
projectKey: string;
}

`Protected` `Readonly` args

`Optional` baseUri?: string

pathArgs: {
projectKey: string;
}

`Optional` headers?: {
[key: string]: string | string[];
}

`Optional` queryArgs?: {
limit?: number;
offset?: number;
sort?: string | string[];
where?: string | string[];
withTotal?: boolean;
[key: string]: QueryParam;
}

`Optional` limit?: number

`Optional` offset?: number

`Optional` sort?: string | string[]

`Optional` where?: string | string[]

`Optional` withTotal?: boolean

`Optional` headers?: {
[key: string]: string | string[];
}

`Optional` queryArgs?: {
where?: string | string[];
[key: string]: QueryParam;
}

`Optional` where?: string | string[]

`Optional` headers?: {
[key: string]: string | string[];
}