# PushSubscription

Configuration information about a push subscription

## Example Usage

```typescript
import { PushSubscription } from "@apexfintechsolutions/ascend-sdk/models/components";

let value: PushSubscription = {};
```

## Fields

| Field                                                                                                                                                                                                                                                                         | Type                                                                                                                                                                                                                                                                          | Required                                                                                                                                                                                                                                                                      | Description                                                                                                                                                                                                                                                                   | Example                                                                                                                                                                                                                                                                       |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accountGroupId`                                                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                            | The id of the account group to receive events for; The subscription will receive events related to any of the accounts in the specified account group; This can only be set at creation time and is mutually exclusive with client_id and correspondent_id                    |                                                                                                                                                                                                                                                                               |
| `clientId`                                                                                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                            | The id of the client to receive events for; The subscription will receive events related to the specified client, and any of its correspondents and accounts; This can only be set at creation time and is mutually exclusive with correspondent_id and account_group_id      |                                                                                                                                                                                                                                                                               |
| `correspondentId`                                                                                                                                                                                                                                                             | *string*                                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                            | The id of the correspondent to receive events for; The subscription will receive events related to the specified correspondent and any of its accounts; This can only be set at creation time and is mutually exclusive with client_id and account_group_id                   | 01H8MCDXH4HYJJAV921BDKCC83                                                                                                                                                                                                                                                    |
| `displayName`                                                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                            | The user-defined name for the subscription                                                                                                                                                                                                                                    | This is an example HTTP configuration.                                                                                                                                                                                                                                        |
| `eventTypes`                                                                                                                                                                                                                                                                  | *string*[]                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                            | Filter for event types; ["\*"] matches all values; Suffix wildcards using "\*" (e.g. ["account.\*"]) are supported                                                                                                                                                            | [<br/>"position.v1.updated"<br/>]                                                                                                                                                                                                                                             |
| `httpCallback`                                                                                                                                                                                                                                                                | [components.HttpCallback](../../models/components/httpcallback.md)                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                            | The information about an HTTP target callback                                                                                                                                                                                                                                 |                                                                                                                                                                                                                                                                               |
| `name`                                                                                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                            | The resource name of the subscription; Format: subscriptions/{subscription}                                                                                                                                                                                                   | subscriptions/01H8MCDXH4JVH7KVNB2YY42907                                                                                                                                                                                                                                      |
| `owner`                                                                                                                                                                                                                                                                       | *string*                                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                            | The organization that owns the subscription; Format: {org_type}/{org_id} This field can only be set at creation time and if it is not specified, then it will default to the target organization, unless the target is an account group, in which case this field is required | correspondents/01H8MCDXH4HYJJAV921BDKCC83                                                                                                                                                                                                                                     |
| `state`                                                                                                                                                                                                                                                                       | [components.State](../../models/components/state.md)                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                            | The current status of the subscription                                                                                                                                                                                                                                        | CREATING                                                                                                                                                                                                                                                                      |
| `subscriptionId`                                                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                            | The unique identifier for the subscription                                                                                                                                                                                                                                    | 01H8MCDXH4JVH7KVNB2YY42907                                                                                                                                                                                                                                                    |