pingram 1.0.24-alpha.1385 → 1.0.24-alpha.1386

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.
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { DeleteEmailSuppressionsResponse, SendEmailApiResponse, SendEmailRequest } from '../models/index';
13
+ import type { MessageResponse, SendEmailApiResponse, SendEmailRequest } from '../models/index';
14
14
  export interface DeleteSuppressionsRequest {
15
15
  reason: string;
16
16
  }
@@ -26,17 +26,17 @@ export interface SendRequest {
26
26
  export interface EmailApiInterface {
27
27
  /**
28
28
  *
29
- * @summary Remove all email suppressions of the given reason for users in the environment
29
+ * @summary Start removing all email suppressions of the given reason (`retryable` or `bounces`) for users in the environment. Returns immediately after the job is queued — suppressions are not yet cleared when this response is received. Large removals are processed in the background in batches.
30
30
  * @param {string} reason Suppression reason to clear (retryable | bounces)
31
31
  * @param {*} [options] Override http request option.
32
32
  * @throws {RequiredError}
33
33
  * @memberof EmailApiInterface
34
34
  */
35
- deleteSuppressionsRaw(requestParameters: DeleteSuppressionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteEmailSuppressionsResponse>>;
35
+ deleteSuppressionsRaw(requestParameters: DeleteSuppressionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MessageResponse>>;
36
36
  /**
37
- * Remove all email suppressions of the given reason for users in the environment
37
+ * Start removing all email suppressions of the given reason (`retryable` or `bounces`) for users in the environment. Returns immediately after the job is queued — suppressions are not yet cleared when this response is received. Large removals are processed in the background in batches.
38
38
  */
39
- deleteSuppressions(reason: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteEmailSuppressionsResponse>;
39
+ deleteSuppressions(reason: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MessageResponse>;
40
40
  /**
41
41
  *
42
42
  * @summary Send an email. Requires `type`, `to`, `subject`, and `html`. Optional: `fromAddress`, `fromName`, `schedule`, attachments. The fromAddress must be a verified domain; otherwise our built-in address will be used which is fine for testing purposes.
@@ -56,13 +56,13 @@ export interface EmailApiInterface {
56
56
  */
57
57
  export declare class EmailApi extends runtime.BaseAPI implements EmailApiInterface {
58
58
  /**
59
- * Remove all email suppressions of the given reason for users in the environment
59
+ * Start removing all email suppressions of the given reason (`retryable` or `bounces`) for users in the environment. Returns immediately after the job is queued — suppressions are not yet cleared when this response is received. Large removals are processed in the background in batches.
60
60
  */
61
- deleteSuppressionsRaw(requestParameters: DeleteSuppressionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteEmailSuppressionsResponse>>;
61
+ deleteSuppressionsRaw(requestParameters: DeleteSuppressionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MessageResponse>>;
62
62
  /**
63
- * Remove all email suppressions of the given reason for users in the environment
63
+ * Start removing all email suppressions of the given reason (`retryable` or `bounces`) for users in the environment. Returns immediately after the job is queued — suppressions are not yet cleared when this response is received. Large removals are processed in the background in batches.
64
64
  */
65
- deleteSuppressions(reason: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteEmailSuppressionsResponse>;
65
+ deleteSuppressions(reason: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MessageResponse>;
66
66
  /**
67
67
  * Send an email. Requires `type`, `to`, `subject`, and `html`. Optional: `fromAddress`, `fromName`, `schedule`, attachments. The fromAddress must be a verified domain; otherwise our built-in address will be used which is fine for testing purposes.
68
68
  */
@@ -54,7 +54,7 @@ const index_1 = require("../models/index");
54
54
  */
55
55
  class EmailApi extends runtime.BaseAPI {
56
56
  /**
57
- * Remove all email suppressions of the given reason for users in the environment
57
+ * Start removing all email suppressions of the given reason (`retryable` or `bounces`) for users in the environment. Returns immediately after the job is queued — suppressions are not yet cleared when this response is received. Large removals are processed in the background in batches.
58
58
  */
59
59
  async deleteSuppressionsRaw(requestParameters, initOverrides) {
60
60
  if (requestParameters['reason'] == null) {
@@ -98,10 +98,10 @@ class EmailApi extends runtime.BaseAPI {
98
98
  headers: headerParameters,
99
99
  query: queryParameters
100
100
  }, initOverrides);
101
- return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.DeleteEmailSuppressionsResponseFromJSON)(jsonValue));
101
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.MessageResponseFromJSON)(jsonValue));
102
102
  }
103
103
  /**
104
- * Remove all email suppressions of the given reason for users in the environment
104
+ * Start removing all email suppressions of the given reason (`retryable` or `bounces`) for users in the environment. Returns immediately after the job is queued — suppressions are not yet cleared when this response is received. Large removals are processed in the background in batches.
105
105
  */
106
106
  async deleteSuppressions(reason, initOverrides) {
107
107
  const response = await this.deleteSuppressionsRaw({ reason: reason }, initOverrides);
@@ -41,7 +41,6 @@ export * from './CreateVoiceAgentRequest';
41
41
  export * from './CreateVoiceAgentResponse';
42
42
  export * from './Custom';
43
43
  export * from './DeleteAccountRequest';
44
- export * from './DeleteEmailSuppressionsResponse';
45
44
  export * from './DeleteKeyResponse';
46
45
  export * from './DeleteUserResponse';
47
46
  export * from './DeleteVoiceAgentResponse';
@@ -59,7 +59,6 @@ __exportStar(require("./CreateVoiceAgentRequest"), exports);
59
59
  __exportStar(require("./CreateVoiceAgentResponse"), exports);
60
60
  __exportStar(require("./Custom"), exports);
61
61
  __exportStar(require("./DeleteAccountRequest"), exports);
62
- __exportStar(require("./DeleteEmailSuppressionsResponse"), exports);
63
62
  __exportStar(require("./DeleteKeyResponse"), exports);
64
63
  __exportStar(require("./DeleteUserResponse"), exports);
65
64
  __exportStar(require("./DeleteVoiceAgentResponse"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pingram",
3
- "version": "1.0.24-alpha.1385",
3
+ "version": "1.0.24-alpha.1386",
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",
@@ -1,38 +0,0 @@
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
- *
14
- * @export
15
- * @interface DeleteEmailSuppressionsResponse
16
- */
17
- export interface DeleteEmailSuppressionsResponse {
18
- /**
19
- * Number of users whose email suppression was removed.
20
- * @type {number}
21
- * @memberof DeleteEmailSuppressionsResponse
22
- */
23
- removed: number;
24
- /**
25
- * Number of suppressed users that did not match the requested reason.
26
- * @type {number}
27
- * @memberof DeleteEmailSuppressionsResponse
28
- */
29
- skipped: number;
30
- }
31
- /**
32
- * Check if a given object implements the DeleteEmailSuppressionsResponse interface.
33
- */
34
- export declare function instanceOfDeleteEmailSuppressionsResponse(value: object): value is DeleteEmailSuppressionsResponse;
35
- export declare function DeleteEmailSuppressionsResponseFromJSON(json: any): DeleteEmailSuppressionsResponse;
36
- export declare function DeleteEmailSuppressionsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeleteEmailSuppressionsResponse;
37
- export declare function DeleteEmailSuppressionsResponseToJSON(json: any): DeleteEmailSuppressionsResponse;
38
- export declare function DeleteEmailSuppressionsResponseToJSONTyped(value?: DeleteEmailSuppressionsResponse | null, ignoreDiscriminator?: boolean): any;
@@ -1,54 +0,0 @@
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.instanceOfDeleteEmailSuppressionsResponse = instanceOfDeleteEmailSuppressionsResponse;
17
- exports.DeleteEmailSuppressionsResponseFromJSON = DeleteEmailSuppressionsResponseFromJSON;
18
- exports.DeleteEmailSuppressionsResponseFromJSONTyped = DeleteEmailSuppressionsResponseFromJSONTyped;
19
- exports.DeleteEmailSuppressionsResponseToJSON = DeleteEmailSuppressionsResponseToJSON;
20
- exports.DeleteEmailSuppressionsResponseToJSONTyped = DeleteEmailSuppressionsResponseToJSONTyped;
21
- /**
22
- * Check if a given object implements the DeleteEmailSuppressionsResponse interface.
23
- */
24
- function instanceOfDeleteEmailSuppressionsResponse(value) {
25
- if (!('removed' in value) || value['removed'] === undefined)
26
- return false;
27
- if (!('skipped' in value) || value['skipped'] === undefined)
28
- return false;
29
- return true;
30
- }
31
- function DeleteEmailSuppressionsResponseFromJSON(json) {
32
- return DeleteEmailSuppressionsResponseFromJSONTyped(json, false);
33
- }
34
- function DeleteEmailSuppressionsResponseFromJSONTyped(json, ignoreDiscriminator) {
35
- if (json == null) {
36
- return json;
37
- }
38
- return {
39
- removed: json['removed'],
40
- skipped: json['skipped']
41
- };
42
- }
43
- function DeleteEmailSuppressionsResponseToJSON(json) {
44
- return DeleteEmailSuppressionsResponseToJSONTyped(json, false);
45
- }
46
- function DeleteEmailSuppressionsResponseToJSONTyped(value, ignoreDiscriminator = false) {
47
- if (value == null) {
48
- return value;
49
- }
50
- return {
51
- removed: value['removed'],
52
- skipped: value['skipped']
53
- };
54
- }