pingram 1.0.39-alpha.1641 → 1.0.39-alpha.1642

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -146,7 +146,7 @@ export interface BroadcastsApiInterface {
146
146
  getMetrics(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastMetricsResponse>;
147
147
  /**
148
148
  *
149
- * @summary List email broadcasts for the account, newest first. Returns metadata and counters without html or internalTemplate bodies. Paginate with limit (default 50, max 100) and nextToken.
149
+ * @summary List email broadcasts for the account, newest first. Returns metadata without html or internalTemplate bodies. A live-filter audience includes the filter. A raw email audience includes emailCount and omits the addresses. Paginate with limit (default 50, max 100) and nextToken.
150
150
  * @param {number} [limit] Max broadcasts to return (default 50)
151
151
  * @param {string} [nextToken] Pagination token
152
152
  * @param {*} [options] Override http request option.
@@ -155,7 +155,7 @@ export interface BroadcastsApiInterface {
155
155
  */
156
156
  listRaw(requestParameters: ListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListBroadcastsResponse>>;
157
157
  /**
158
- * List email broadcasts for the account, newest first. Returns metadata and counters without html or internalTemplate bodies. Paginate with limit (default 50, max 100) and nextToken.
158
+ * List email broadcasts for the account, newest first. Returns metadata without html or internalTemplate bodies. A live-filter audience includes the filter. A raw email audience includes emailCount and omits the addresses. Paginate with limit (default 50, max 100) and nextToken.
159
159
  */
160
160
  list(limit?: number, nextToken?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListBroadcastsResponse>;
161
161
  /**
@@ -308,11 +308,11 @@ export declare class BroadcastsApi extends runtime.BaseAPI implements Broadcasts
308
308
  */
309
309
  getMetrics(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastMetricsResponse>;
310
310
  /**
311
- * List email broadcasts for the account, newest first. Returns metadata and counters without html or internalTemplate bodies. Paginate with limit (default 50, max 100) and nextToken.
311
+ * List email broadcasts for the account, newest first. Returns metadata without html or internalTemplate bodies. A live-filter audience includes the filter. A raw email audience includes emailCount and omits the addresses. Paginate with limit (default 50, max 100) and nextToken.
312
312
  */
313
313
  listRaw(requestParameters: ListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListBroadcastsResponse>>;
314
314
  /**
315
- * List email broadcasts for the account, newest first. Returns metadata and counters without html or internalTemplate bodies. Paginate with limit (default 50, max 100) and nextToken.
315
+ * List email broadcasts for the account, newest first. Returns metadata without html or internalTemplate bodies. A live-filter audience includes the filter. A raw email audience includes emailCount and omits the addresses. Paginate with limit (default 50, max 100) and nextToken.
316
316
  */
317
317
  list(limit?: number, nextToken?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListBroadcastsResponse>;
318
318
  /**
@@ -379,7 +379,7 @@ class BroadcastsApi extends runtime.BaseAPI {
379
379
  return await response.value();
380
380
  }
381
381
  /**
382
- * List email broadcasts for the account, newest first. Returns metadata and counters without html or internalTemplate bodies. Paginate with limit (default 50, max 100) and nextToken.
382
+ * List email broadcasts for the account, newest first. Returns metadata without html or internalTemplate bodies. A live-filter audience includes the filter. A raw email audience includes emailCount and omits the addresses. Paginate with limit (default 50, max 100) and nextToken.
383
383
  */
384
384
  async listRaw(requestParameters, initOverrides) {
385
385
  const queryParameters = {};
@@ -428,7 +428,7 @@ class BroadcastsApi extends runtime.BaseAPI {
428
428
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ListBroadcastsResponseFromJSON)(jsonValue));
429
429
  }
430
430
  /**
431
- * List email broadcasts for the account, newest first. Returns metadata and counters without html or internalTemplate bodies. Paginate with limit (default 50, max 100) and nextToken.
431
+ * List email broadcasts for the account, newest first. Returns metadata without html or internalTemplate bodies. A live-filter audience includes the filter. A raw email audience includes emailCount and omits the addresses. Paginate with limit (default 50, max 100) and nextToken.
432
432
  */
433
433
  async list(limit, nextToken, initOverrides) {
434
434
  const response = await this.listRaw({ limit: limit, nextToken: nextToken }, initOverrides);
@@ -9,13 +9,19 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import type { BroadcastResponseAudience } from './BroadcastResponseAudience';
12
+ import type { ListBroadcastsResponseBroadcastsInnerAudience } from './ListBroadcastsResponseBroadcastsInnerAudience';
13
13
  /**
14
14
  *
15
15
  * @export
16
16
  * @interface ListBroadcastsResponseBroadcastsInner
17
17
  */
18
18
  export interface ListBroadcastsResponseBroadcastsInner {
19
+ /**
20
+ *
21
+ * @type {ListBroadcastsResponseBroadcastsInnerAudience}
22
+ * @memberof ListBroadcastsResponseBroadcastsInner
23
+ */
24
+ audience: ListBroadcastsResponseBroadcastsInnerAudience;
19
25
  /**
20
26
  * UUIDv7 (time-ordered).
21
27
  * @type {string}
@@ -52,12 +58,6 @@ export interface ListBroadcastsResponseBroadcastsInner {
52
58
  * @memberof ListBroadcastsResponseBroadcastsInner
53
59
  */
54
60
  channel: ListBroadcastsResponseBroadcastsInnerChannelEnum;
55
- /**
56
- *
57
- * @type {BroadcastResponseAudience}
58
- * @memberof ListBroadcastsResponseBroadcastsInner
59
- */
60
- audience: BroadcastResponseAudience;
61
61
  /**
62
62
  *
63
63
  * @type {string}
@@ -19,7 +19,7 @@ exports.ListBroadcastsResponseBroadcastsInnerFromJSON = ListBroadcastsResponseBr
19
19
  exports.ListBroadcastsResponseBroadcastsInnerFromJSONTyped = ListBroadcastsResponseBroadcastsInnerFromJSONTyped;
20
20
  exports.ListBroadcastsResponseBroadcastsInnerToJSON = ListBroadcastsResponseBroadcastsInnerToJSON;
21
21
  exports.ListBroadcastsResponseBroadcastsInnerToJSONTyped = ListBroadcastsResponseBroadcastsInnerToJSONTyped;
22
- const BroadcastResponseAudience_1 = require("./BroadcastResponseAudience");
22
+ const ListBroadcastsResponseBroadcastsInnerAudience_1 = require("./ListBroadcastsResponseBroadcastsInnerAudience");
23
23
  /**
24
24
  * @export
25
25
  * @enum {string}
@@ -59,6 +59,8 @@ var ListBroadcastsResponseBroadcastsInnerChannelEnum;
59
59
  * Check if a given object implements the ListBroadcastsResponseBroadcastsInner interface.
60
60
  */
61
61
  function instanceOfListBroadcastsResponseBroadcastsInner(value) {
62
+ if (!('audience' in value) || value['audience'] === undefined)
63
+ return false;
62
64
  if (!('broadcastId' in value) || value['broadcastId'] === undefined)
63
65
  return false;
64
66
  if (!('name' in value) || value['name'] === undefined)
@@ -69,8 +71,6 @@ function instanceOfListBroadcastsResponseBroadcastsInner(value) {
69
71
  return false;
70
72
  if (value['channel'] !== 'email')
71
73
  return false;
72
- if (!('audience' in value) || value['audience'] === undefined)
73
- return false;
74
74
  if (!('fromName' in value) || value['fromName'] === undefined)
75
75
  return false;
76
76
  if (!('fromAddress' in value) || value['fromAddress'] === undefined)
@@ -91,13 +91,13 @@ function ListBroadcastsResponseBroadcastsInnerFromJSONTyped(json, ignoreDiscrimi
91
91
  return json;
92
92
  }
93
93
  return {
94
+ audience: (0, ListBroadcastsResponseBroadcastsInnerAudience_1.ListBroadcastsResponseBroadcastsInnerAudienceFromJSON)(json['audience']),
94
95
  broadcastId: json['broadcastId'],
95
96
  name: json['name'],
96
97
  status: json['status'],
97
98
  pausedReason: json['pausedReason'] == null ? undefined : json['pausedReason'],
98
99
  type: json['type'] == null ? undefined : json['type'],
99
100
  channel: json['channel'],
100
- audience: (0, BroadcastResponseAudience_1.BroadcastResponseAudienceFromJSON)(json['audience']),
101
101
  fromName: json['fromName'],
102
102
  fromAddress: json['fromAddress'],
103
103
  replyToAddress: json['replyToAddress'] == null ? undefined : json['replyToAddress'],
@@ -116,13 +116,13 @@ function ListBroadcastsResponseBroadcastsInnerToJSONTyped(value, ignoreDiscrimin
116
116
  return value;
117
117
  }
118
118
  return {
119
+ audience: (0, ListBroadcastsResponseBroadcastsInnerAudience_1.ListBroadcastsResponseBroadcastsInnerAudienceToJSON)(value['audience']),
119
120
  broadcastId: value['broadcastId'],
120
121
  name: value['name'],
121
122
  status: value['status'],
122
123
  pausedReason: value['pausedReason'],
123
124
  type: value['type'],
124
125
  channel: value['channel'],
125
- audience: (0, BroadcastResponseAudience_1.BroadcastResponseAudienceToJSON)(value['audience']),
126
126
  fromName: value['fromName'],
127
127
  fromAddress: value['fromAddress'],
128
128
  replyToAddress: value['replyToAddress'],
@@ -0,0 +1,40 @@
1
+ /**
2
+ * Pingram
3
+ * Internal API for notification delivery and management
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Audience on a broadcast list row. Exactly one of `filter` (the live Mongo-style query) or `emailCount` (size of a raw email list). Addresses are omitted here; get, create, and update return `audience.emails`.
14
+ * @export
15
+ * @interface ListBroadcastsResponseBroadcastsInnerAudience
16
+ */
17
+ export interface ListBroadcastsResponseBroadcastsInnerAudience {
18
+ /**
19
+ *
20
+ * @type {{ [key: string]: any; }}
21
+ * @memberof ListBroadcastsResponseBroadcastsInnerAudience
22
+ */
23
+ filter?: {
24
+ [key: string]: any;
25
+ };
26
+ /**
27
+ * Number of addresses when the audience is a raw email list.
28
+ * @type {number}
29
+ * @memberof ListBroadcastsResponseBroadcastsInnerAudience
30
+ */
31
+ emailCount?: number;
32
+ }
33
+ /**
34
+ * Check if a given object implements the ListBroadcastsResponseBroadcastsInnerAudience interface.
35
+ */
36
+ export declare function instanceOfListBroadcastsResponseBroadcastsInnerAudience(value: object): value is ListBroadcastsResponseBroadcastsInnerAudience;
37
+ export declare function ListBroadcastsResponseBroadcastsInnerAudienceFromJSON(json: any): ListBroadcastsResponseBroadcastsInnerAudience;
38
+ export declare function ListBroadcastsResponseBroadcastsInnerAudienceFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListBroadcastsResponseBroadcastsInnerAudience;
39
+ export declare function ListBroadcastsResponseBroadcastsInnerAudienceToJSON(json: any): ListBroadcastsResponseBroadcastsInnerAudience;
40
+ export declare function ListBroadcastsResponseBroadcastsInnerAudienceToJSONTyped(value?: ListBroadcastsResponseBroadcastsInnerAudience | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,58 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Pingram
6
+ * Internal API for notification delivery and management
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfListBroadcastsResponseBroadcastsInnerAudience = instanceOfListBroadcastsResponseBroadcastsInnerAudience;
17
+ exports.ListBroadcastsResponseBroadcastsInnerAudienceFromJSON = ListBroadcastsResponseBroadcastsInnerAudienceFromJSON;
18
+ exports.ListBroadcastsResponseBroadcastsInnerAudienceFromJSONTyped = ListBroadcastsResponseBroadcastsInnerAudienceFromJSONTyped;
19
+ exports.ListBroadcastsResponseBroadcastsInnerAudienceToJSON = ListBroadcastsResponseBroadcastsInnerAudienceToJSON;
20
+ exports.ListBroadcastsResponseBroadcastsInnerAudienceToJSONTyped = ListBroadcastsResponseBroadcastsInnerAudienceToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the ListBroadcastsResponseBroadcastsInnerAudience interface.
23
+ */
24
+ function instanceOfListBroadcastsResponseBroadcastsInnerAudience(value) {
25
+ return true;
26
+ }
27
+ function ListBroadcastsResponseBroadcastsInnerAudienceFromJSON(json) {
28
+ return ListBroadcastsResponseBroadcastsInnerAudienceFromJSONTyped(json, false);
29
+ }
30
+ function ListBroadcastsResponseBroadcastsInnerAudienceFromJSONTyped(json, ignoreDiscriminator) {
31
+ if (json == null) {
32
+ return json;
33
+ }
34
+ const filter = json['filter'] == null ? undefined : json['filter'];
35
+ if (filter !== undefined) {
36
+ return { filter };
37
+ }
38
+ const legacyEmails = json['emails'];
39
+ return {
40
+ emailCount: json['emailCount'] == null
41
+ ? Array.isArray(legacyEmails)
42
+ ? legacyEmails.length
43
+ : undefined
44
+ : json['emailCount']
45
+ };
46
+ }
47
+ function ListBroadcastsResponseBroadcastsInnerAudienceToJSON(json) {
48
+ return ListBroadcastsResponseBroadcastsInnerAudienceToJSONTyped(json, false);
49
+ }
50
+ function ListBroadcastsResponseBroadcastsInnerAudienceToJSONTyped(value, ignoreDiscriminator = false) {
51
+ if (value == null) {
52
+ return value;
53
+ }
54
+ return {
55
+ filter: value['filter'],
56
+ emailCount: value['emailCount']
57
+ };
58
+ }
@@ -169,6 +169,7 @@ export * from './ListBroadcastRecipientsResponse';
169
169
  export * from './ListBroadcastRecipientsResponseRecipientsInner';
170
170
  export * from './ListBroadcastsResponse';
171
171
  export * from './ListBroadcastsResponseBroadcastsInner';
172
+ export * from './ListBroadcastsResponseBroadcastsInnerAudience';
172
173
  export * from './ListInvoicesResponse';
173
174
  export * from './ListInvoicesResponseInvoicesInner';
174
175
  export * from './ListLibraryResponse';
@@ -187,6 +187,7 @@ __exportStar(require("./ListBroadcastRecipientsResponse"), exports);
187
187
  __exportStar(require("./ListBroadcastRecipientsResponseRecipientsInner"), exports);
188
188
  __exportStar(require("./ListBroadcastsResponse"), exports);
189
189
  __exportStar(require("./ListBroadcastsResponseBroadcastsInner"), exports);
190
+ __exportStar(require("./ListBroadcastsResponseBroadcastsInnerAudience"), exports);
190
191
  __exportStar(require("./ListInvoicesResponse"), exports);
191
192
  __exportStar(require("./ListInvoicesResponseInvoicesInner"), exports);
192
193
  __exportStar(require("./ListLibraryResponse"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pingram",
3
- "version": "1.0.39-alpha.1641",
3
+ "version": "1.0.39-alpha.1642",
4
4
  "description": "Official Node.js SDK for Pingram - Send notifications via Email, SMS, Push, In-App, and more",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.js",