pingram 1.0.39-alpha.1655 → 1.0.39-alpha.1657

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.
@@ -23,7 +23,7 @@ export interface CreateAccountOperationRequest {
23
23
  export interface AccountsApiInterface {
24
24
  /**
25
25
  *
26
- * @summary Create an additional account for the authenticated user
26
+ * @summary Create one additional Pingram account (a separate workspace) for the signed-in user. The caller must already belong to an account. Requires a user session or personal access token; an account API key cannot call this. Does not create a login, and does not change, delete, or grant access to existing accounts. Omit plan and nothing is charged. The new account is ready for billing to be added later, and it cannot send until then. Setting plan charges immediately. It starts a paid subscription on the payment method already saved on sourceBillingAccountId, an account the caller must own. Optional memberEmails adds people who already share an account with the caller and invites everyone else.
27
27
  * @param {CreateAccountRequest} createAccountRequest
28
28
  * @param {*} [options] Override http request option.
29
29
  * @throws {RequiredError}
@@ -31,7 +31,7 @@ export interface AccountsApiInterface {
31
31
  */
32
32
  createAccountRaw(requestParameters: CreateAccountOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateAccountResponse>>;
33
33
  /**
34
- * Create an additional account for the authenticated user
34
+ * Create one additional Pingram account (a separate workspace) for the signed-in user. The caller must already belong to an account. Requires a user session or personal access token; an account API key cannot call this. Does not create a login, and does not change, delete, or grant access to existing accounts. Omit plan and nothing is charged. The new account is ready for billing to be added later, and it cannot send until then. Setting plan charges immediately. It starts a paid subscription on the payment method already saved on sourceBillingAccountId, an account the caller must own. Optional memberEmails adds people who already share an account with the caller and invites everyone else.
35
35
  */
36
36
  createAccount(createAccountRequest: CreateAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateAccountResponse>;
37
37
  /**
@@ -52,11 +52,11 @@ export interface AccountsApiInterface {
52
52
  */
53
53
  export declare class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface {
54
54
  /**
55
- * Create an additional account for the authenticated user
55
+ * Create one additional Pingram account (a separate workspace) for the signed-in user. The caller must already belong to an account. Requires a user session or personal access token; an account API key cannot call this. Does not create a login, and does not change, delete, or grant access to existing accounts. Omit plan and nothing is charged. The new account is ready for billing to be added later, and it cannot send until then. Setting plan charges immediately. It starts a paid subscription on the payment method already saved on sourceBillingAccountId, an account the caller must own. Optional memberEmails adds people who already share an account with the caller and invites everyone else.
56
56
  */
57
57
  createAccountRaw(requestParameters: CreateAccountOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateAccountResponse>>;
58
58
  /**
59
- * Create an additional account for the authenticated user
59
+ * Create one additional Pingram account (a separate workspace) for the signed-in user. The caller must already belong to an account. Requires a user session or personal access token; an account API key cannot call this. Does not create a login, and does not change, delete, or grant access to existing accounts. Omit plan and nothing is charged. The new account is ready for billing to be added later, and it cannot send until then. Setting plan charges immediately. It starts a paid subscription on the payment method already saved on sourceBillingAccountId, an account the caller must own. Optional memberEmails adds people who already share an account with the caller and invites everyone else.
60
60
  */
61
61
  createAccount(createAccountRequest: CreateAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateAccountResponse>;
62
62
  /**
@@ -54,7 +54,7 @@ const index_1 = require("../models/index");
54
54
  */
55
55
  class AccountsApi extends runtime.BaseAPI {
56
56
  /**
57
- * Create an additional account for the authenticated user
57
+ * Create one additional Pingram account (a separate workspace) for the signed-in user. The caller must already belong to an account. Requires a user session or personal access token; an account API key cannot call this. Does not create a login, and does not change, delete, or grant access to existing accounts. Omit plan and nothing is charged. The new account is ready for billing to be added later, and it cannot send until then. Setting plan charges immediately. It starts a paid subscription on the payment method already saved on sourceBillingAccountId, an account the caller must own. Optional memberEmails adds people who already share an account with the caller and invites everyone else.
58
58
  */
59
59
  async createAccountRaw(requestParameters, initOverrides) {
60
60
  if (requestParameters['createAccountRequest'] == null) {
@@ -102,7 +102,7 @@ class AccountsApi extends runtime.BaseAPI {
102
102
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateAccountResponseFromJSON)(jsonValue));
103
103
  }
104
104
  /**
105
- * Create an additional account for the authenticated user
105
+ * Create one additional Pingram account (a separate workspace) for the signed-in user. The caller must already belong to an account. Requires a user session or personal access token; an account API key cannot call this. Does not create a login, and does not change, delete, or grant access to existing accounts. Omit plan and nothing is charged. The new account is ready for billing to be added later, and it cannot send until then. Setting plan charges immediately. It starts a paid subscription on the payment method already saved on sourceBillingAccountId, an account the caller must own. Optional memberEmails adds people who already share an account with the caller and invites everyone else.
106
106
  */
107
107
  async createAccount(createAccountRequest, initOverrides) {
108
108
  const response = await this.createAccountRaw({ createAccountRequest: createAccountRequest }, initOverrides);
@@ -67,7 +67,7 @@ export interface AddressesApiInterface {
67
67
  listAddresses(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountAddressesResponse>;
68
68
  /**
69
69
  *
70
- * @summary Update an inbox prefix or display name.
70
+ * @summary Update one inbox on this account. A new prefix deletes the old address, so mail to the previous address stops, and that address is not kept. displayName only relabels a custom inbox and does not change where mail is delivered. Does not create an inbox or change its domain.
71
71
  * @param {UpdateAddressRequest} updateAddressRequest
72
72
  * @param {*} [options] Override http request option.
73
73
  * @throws {RequiredError}
@@ -75,7 +75,7 @@ export interface AddressesApiInterface {
75
75
  */
76
76
  updateAddressRaw(requestParameters: UpdateAddressOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AddressResponse>>;
77
77
  /**
78
- * Update an inbox prefix or display name.
78
+ * Update one inbox on this account. A new prefix deletes the old address, so mail to the previous address stops, and that address is not kept. displayName only relabels a custom inbox and does not change where mail is delivered. Does not create an inbox or change its domain.
79
79
  */
80
80
  updateAddress(updateAddressRequest: UpdateAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AddressResponse>;
81
81
  }
@@ -108,11 +108,11 @@ export declare class AddressesApi extends runtime.BaseAPI implements AddressesAp
108
108
  */
109
109
  listAddresses(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountAddressesResponse>;
110
110
  /**
111
- * Update an inbox prefix or display name.
111
+ * Update one inbox on this account. A new prefix deletes the old address, so mail to the previous address stops, and that address is not kept. displayName only relabels a custom inbox and does not change where mail is delivered. Does not create an inbox or change its domain.
112
112
  */
113
113
  updateAddressRaw(requestParameters: UpdateAddressOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AddressResponse>>;
114
114
  /**
115
- * Update an inbox prefix or display name.
115
+ * Update one inbox on this account. A new prefix deletes the old address, so mail to the previous address stops, and that address is not kept. displayName only relabels a custom inbox and does not change where mail is delivered. Does not create an inbox or change its domain.
116
116
  */
117
117
  updateAddress(updateAddressRequest: UpdateAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AddressResponse>;
118
118
  }
@@ -213,7 +213,7 @@ class AddressesApi extends runtime.BaseAPI {
213
213
  return await response.value();
214
214
  }
215
215
  /**
216
- * Update an inbox prefix or display name.
216
+ * Update one inbox on this account. A new prefix deletes the old address, so mail to the previous address stops, and that address is not kept. displayName only relabels a custom inbox and does not change where mail is delivered. Does not create an inbox or change its domain.
217
217
  */
218
218
  async updateAddressRaw(requestParameters, initOverrides) {
219
219
  if (requestParameters['updateAddressRequest'] == null) {
@@ -261,7 +261,7 @@ class AddressesApi extends runtime.BaseAPI {
261
261
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AddressResponseFromJSON)(jsonValue));
262
262
  }
263
263
  /**
264
- * Update an inbox prefix or display name.
264
+ * Update one inbox on this account. A new prefix deletes the old address, so mail to the previous address stops, and that address is not kept. displayName only relabels a custom inbox and does not change where mail is delivered. Does not create an inbox or change its domain.
265
265
  */
266
266
  async updateAddress(updateAddressRequest, initOverrides) {
267
267
  const response = await this.updateAddressRaw({ updateAddressRequest: updateAddressRequest }, initOverrides);
@@ -94,7 +94,7 @@ export interface BroadcastsApiInterface {
94
94
  archive(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
95
95
  /**
96
96
  *
97
- * @summary Cancel an email broadcast. Scheduled broadcasts revert to draft and drop their schedule. Sending or paused broadcasts become canceled; remaining pending recipients are skipped.
97
+ * @summary Cancel an email broadcast. Scheduled broadcasts revert to draft and drop their schedule (they can be scheduled again). Sending or paused broadcasts become canceled; recipients already processed stay as they are, and remaining pending recipients are skipped and will not be sent. That skip cannot be undone.
98
98
  * @param {string} broadcastId Broadcast ID
99
99
  * @param {*} [options] Override http request option.
100
100
  * @throws {RequiredError}
@@ -102,7 +102,7 @@ export interface BroadcastsApiInterface {
102
102
  */
103
103
  cancelRaw(requestParameters: CancelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
104
104
  /**
105
- * Cancel an email broadcast. Scheduled broadcasts revert to draft and drop their schedule. Sending or paused broadcasts become canceled; remaining pending recipients are skipped.
105
+ * Cancel an email broadcast. Scheduled broadcasts revert to draft and drop their schedule (they can be scheduled again). Sending or paused broadcasts become canceled; recipients already processed stay as they are, and remaining pending recipients are skipped and will not be sent. That skip cannot be undone.
106
106
  */
107
107
  cancel(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
108
108
  /**
@@ -242,7 +242,7 @@ export interface BroadcastsApiInterface {
242
242
  unarchive(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
243
243
  /**
244
244
  *
245
- * @summary Update a draft email broadcast (name, type, audience, sender, subject, html). html is the send-ready body. Send an empty replyToAddress to clear Reply-To. internalTemplate can be updated only when the broadcast was created with it; it cannot be added to an html-only broadcast or removed. Only drafts can be edited; scheduled or active broadcasts are locked.
245
+ * @summary Update a draft email broadcast. Fields you send replace the stored values (name, type, audience, sender, subject, html) and the previous values are not kept; omitted fields stay. html is the send-ready body. Send an empty replyToAddress to clear Reply-To. internalTemplate can be updated only when the broadcast was created with it; it cannot be added to an html-only broadcast or removed. Only drafts can be edited; scheduled or active broadcasts are locked. This does not send the broadcast.
246
246
  * @param {string} broadcastId Broadcast ID
247
247
  * @param {UpdateBroadcastRequest} updateBroadcastRequest
248
248
  * @param {*} [options] Override http request option.
@@ -251,7 +251,7 @@ export interface BroadcastsApiInterface {
251
251
  */
252
252
  updateRaw(requestParameters: UpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
253
253
  /**
254
- * Update a draft email broadcast (name, type, audience, sender, subject, html). html is the send-ready body. Send an empty replyToAddress to clear Reply-To. internalTemplate can be updated only when the broadcast was created with it; it cannot be added to an html-only broadcast or removed. Only drafts can be edited; scheduled or active broadcasts are locked.
254
+ * Update a draft email broadcast. Fields you send replace the stored values (name, type, audience, sender, subject, html) and the previous values are not kept; omitted fields stay. html is the send-ready body. Send an empty replyToAddress to clear Reply-To. internalTemplate can be updated only when the broadcast was created with it; it cannot be added to an html-only broadcast or removed. Only drafts can be edited; scheduled or active broadcasts are locked. This does not send the broadcast.
255
255
  */
256
256
  update(broadcastId: string, updateBroadcastRequest: UpdateBroadcastRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
257
257
  }
@@ -276,11 +276,11 @@ export declare class BroadcastsApi extends runtime.BaseAPI implements Broadcasts
276
276
  */
277
277
  archive(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
278
278
  /**
279
- * Cancel an email broadcast. Scheduled broadcasts revert to draft and drop their schedule. Sending or paused broadcasts become canceled; remaining pending recipients are skipped.
279
+ * Cancel an email broadcast. Scheduled broadcasts revert to draft and drop their schedule (they can be scheduled again). Sending or paused broadcasts become canceled; recipients already processed stay as they are, and remaining pending recipients are skipped and will not be sent. That skip cannot be undone.
280
280
  */
281
281
  cancelRaw(requestParameters: CancelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
282
282
  /**
283
- * Cancel an email broadcast. Scheduled broadcasts revert to draft and drop their schedule. Sending or paused broadcasts become canceled; remaining pending recipients are skipped.
283
+ * Cancel an email broadcast. Scheduled broadcasts revert to draft and drop their schedule (they can be scheduled again). Sending or paused broadcasts become canceled; recipients already processed stay as they are, and remaining pending recipients are skipped and will not be sent. That skip cannot be undone.
284
284
  */
285
285
  cancel(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
286
286
  /**
@@ -364,11 +364,11 @@ export declare class BroadcastsApi extends runtime.BaseAPI implements Broadcasts
364
364
  */
365
365
  unarchive(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
366
366
  /**
367
- * Update a draft email broadcast (name, type, audience, sender, subject, html). html is the send-ready body. Send an empty replyToAddress to clear Reply-To. internalTemplate can be updated only when the broadcast was created with it; it cannot be added to an html-only broadcast or removed. Only drafts can be edited; scheduled or active broadcasts are locked.
367
+ * Update a draft email broadcast. Fields you send replace the stored values (name, type, audience, sender, subject, html) and the previous values are not kept; omitted fields stay. html is the send-ready body. Send an empty replyToAddress to clear Reply-To. internalTemplate can be updated only when the broadcast was created with it; it cannot be added to an html-only broadcast or removed. Only drafts can be edited; scheduled or active broadcasts are locked. This does not send the broadcast.
368
368
  */
369
369
  updateRaw(requestParameters: UpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
370
370
  /**
371
- * Update a draft email broadcast (name, type, audience, sender, subject, html). html is the send-ready body. Send an empty replyToAddress to clear Reply-To. internalTemplate can be updated only when the broadcast was created with it; it cannot be added to an html-only broadcast or removed. Only drafts can be edited; scheduled or active broadcasts are locked.
371
+ * Update a draft email broadcast. Fields you send replace the stored values (name, type, audience, sender, subject, html) and the previous values are not kept; omitted fields stay. html is the send-ready body. Send an empty replyToAddress to clear Reply-To. internalTemplate can be updated only when the broadcast was created with it; it cannot be added to an html-only broadcast or removed. Only drafts can be edited; scheduled or active broadcasts are locked. This does not send the broadcast.
372
372
  */
373
373
  update(broadcastId: string, updateBroadcastRequest: UpdateBroadcastRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
374
374
  }
@@ -162,7 +162,7 @@ class BroadcastsApi extends runtime.BaseAPI {
162
162
  return await response.value();
163
163
  }
164
164
  /**
165
- * Cancel an email broadcast. Scheduled broadcasts revert to draft and drop their schedule. Sending or paused broadcasts become canceled; remaining pending recipients are skipped.
165
+ * Cancel an email broadcast. Scheduled broadcasts revert to draft and drop their schedule (they can be scheduled again). Sending or paused broadcasts become canceled; recipients already processed stay as they are, and remaining pending recipients are skipped and will not be sent. That skip cannot be undone.
166
166
  */
167
167
  async cancelRaw(requestParameters, initOverrides) {
168
168
  if (requestParameters['broadcastId'] == null) {
@@ -209,7 +209,7 @@ class BroadcastsApi extends runtime.BaseAPI {
209
209
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.BroadcastResponseFromJSON)(jsonValue));
210
210
  }
211
211
  /**
212
- * Cancel an email broadcast. Scheduled broadcasts revert to draft and drop their schedule. Sending or paused broadcasts become canceled; remaining pending recipients are skipped.
212
+ * Cancel an email broadcast. Scheduled broadcasts revert to draft and drop their schedule (they can be scheduled again). Sending or paused broadcasts become canceled; recipients already processed stay as they are, and remaining pending recipients are skipped and will not be sent. That skip cannot be undone.
213
213
  */
214
214
  async cancel(broadcastId, initOverrides) {
215
215
  const response = await this.cancelRaw({ broadcastId: broadcastId }, initOverrides);
@@ -781,7 +781,7 @@ class BroadcastsApi extends runtime.BaseAPI {
781
781
  return await response.value();
782
782
  }
783
783
  /**
784
- * Update a draft email broadcast (name, type, audience, sender, subject, html). html is the send-ready body. Send an empty replyToAddress to clear Reply-To. internalTemplate can be updated only when the broadcast was created with it; it cannot be added to an html-only broadcast or removed. Only drafts can be edited; scheduled or active broadcasts are locked.
784
+ * Update a draft email broadcast. Fields you send replace the stored values (name, type, audience, sender, subject, html) and the previous values are not kept; omitted fields stay. html is the send-ready body. Send an empty replyToAddress to clear Reply-To. internalTemplate can be updated only when the broadcast was created with it; it cannot be added to an html-only broadcast or removed. Only drafts can be edited; scheduled or active broadcasts are locked. This does not send the broadcast.
785
785
  */
786
786
  async updateRaw(requestParameters, initOverrides) {
787
787
  if (requestParameters['broadcastId'] == null) {
@@ -833,7 +833,7 @@ class BroadcastsApi extends runtime.BaseAPI {
833
833
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.BroadcastResponseFromJSON)(jsonValue));
834
834
  }
835
835
  /**
836
- * Update a draft email broadcast (name, type, audience, sender, subject, html). html is the send-ready body. Send an empty replyToAddress to clear Reply-To. internalTemplate can be updated only when the broadcast was created with it; it cannot be added to an html-only broadcast or removed. Only drafts can be edited; scheduled or active broadcasts are locked.
836
+ * Update a draft email broadcast. Fields you send replace the stored values (name, type, audience, sender, subject, html) and the previous values are not kept; omitted fields stay. html is the send-ready body. Send an empty replyToAddress to clear Reply-To. internalTemplate can be updated only when the broadcast was created with it; it cannot be added to an html-only broadcast or removed. Only drafts can be edited; scheduled or active broadcasts are locked. This does not send the broadcast.
837
837
  */
838
838
  async update(broadcastId, updateBroadcastRequest, initOverrides) {
839
839
  const response = await this.updateRaw({
@@ -29,7 +29,7 @@ export interface StartDomainVerificationRequest {
29
29
  export interface DomainsApiInterface {
30
30
  /**
31
31
  *
32
- * @summary Add and start verification for a new sender domain. Pass the domain only (not a full email address).
32
+ * @summary Start verification for a domain you already own so Pingram can use it for email. Pass a bare domain (example.com) or subdomain (mail.example.com). This does not purchase, transfer, renew, or control the domain, does not edit DNS, and does not disable sending or receiving on other platforms. It saves the domain on this Pingram account and returns DNS records for you to publish. Required DKIM lets Pingram send email from addresses on this domain once verification completes. Optional inbound MX, once you publish it, routes that domain\'s inbound email to Pingram. This call only begins verification. Publish the records, then start verification in the dashboard or with the start-verification API. Adding a domain that is already on the account returns the existing records.
33
33
  * @param {PostSendersRequestBody} postSendersRequestBody
34
34
  * @param {*} [options] Override http request option.
35
35
  * @throws {RequiredError}
@@ -37,7 +37,7 @@ export interface DomainsApiInterface {
37
37
  */
38
38
  addDomainRaw(requestParameters: AddDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetSendersResponseInner>>>;
39
39
  /**
40
- * Add and start verification for a new sender domain. Pass the domain only (not a full email address).
40
+ * Start verification for a domain you already own so Pingram can use it for email. Pass a bare domain (example.com) or subdomain (mail.example.com). This does not purchase, transfer, renew, or control the domain, does not edit DNS, and does not disable sending or receiving on other platforms. It saves the domain on this Pingram account and returns DNS records for you to publish. Required DKIM lets Pingram send email from addresses on this domain once verification completes. Optional inbound MX, once you publish it, routes that domain\'s inbound email to Pingram. This call only begins verification. Publish the records, then start verification in the dashboard or with the start-verification API. Adding a domain that is already on the account returns the existing records.
41
41
  */
42
42
  addDomain(postSendersRequestBody: PostSendersRequestBody, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetSendersResponseInner>>;
43
43
  /**
@@ -55,14 +55,14 @@ export interface DomainsApiInterface {
55
55
  deleteDomain(sender: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessResponse>;
56
56
  /**
57
57
  *
58
- * @summary List sender domains configured for the account (for outbound email).
58
+ * @summary List domains already added to this Pingram account for email. Each entry includes verification status and the DNS records Pingram expects you to publish. Does not search a registrar, purchase or transfer a domain, change DNS, or include domains that have not been added to this account.
59
59
  * @param {*} [options] Override http request option.
60
60
  * @throws {RequiredError}
61
61
  * @memberof DomainsApiInterface
62
62
  */
63
63
  listDomainsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetSendersResponseInner>>>;
64
64
  /**
65
- * List sender domains configured for the account (for outbound email).
65
+ * List domains already added to this Pingram account for email. Each entry includes verification status and the DNS records Pingram expects you to publish. Does not search a registrar, purchase or transfer a domain, change DNS, or include domains that have not been added to this account.
66
66
  */
67
67
  listDomains(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetSendersResponseInner>>;
68
68
  /**
@@ -84,11 +84,11 @@ export interface DomainsApiInterface {
84
84
  */
85
85
  export declare class DomainsApi extends runtime.BaseAPI implements DomainsApiInterface {
86
86
  /**
87
- * Add and start verification for a new sender domain. Pass the domain only (not a full email address).
87
+ * Start verification for a domain you already own so Pingram can use it for email. Pass a bare domain (example.com) or subdomain (mail.example.com). This does not purchase, transfer, renew, or control the domain, does not edit DNS, and does not disable sending or receiving on other platforms. It saves the domain on this Pingram account and returns DNS records for you to publish. Required DKIM lets Pingram send email from addresses on this domain once verification completes. Optional inbound MX, once you publish it, routes that domain\'s inbound email to Pingram. This call only begins verification. Publish the records, then start verification in the dashboard or with the start-verification API. Adding a domain that is already on the account returns the existing records.
88
88
  */
89
89
  addDomainRaw(requestParameters: AddDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetSendersResponseInner>>>;
90
90
  /**
91
- * Add and start verification for a new sender domain. Pass the domain only (not a full email address).
91
+ * Start verification for a domain you already own so Pingram can use it for email. Pass a bare domain (example.com) or subdomain (mail.example.com). This does not purchase, transfer, renew, or control the domain, does not edit DNS, and does not disable sending or receiving on other platforms. It saves the domain on this Pingram account and returns DNS records for you to publish. Required DKIM lets Pingram send email from addresses on this domain once verification completes. Optional inbound MX, once you publish it, routes that domain\'s inbound email to Pingram. This call only begins verification. Publish the records, then start verification in the dashboard or with the start-verification API. Adding a domain that is already on the account returns the existing records.
92
92
  */
93
93
  addDomain(postSendersRequestBody: PostSendersRequestBody, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetSendersResponseInner>>;
94
94
  /**
@@ -100,11 +100,11 @@ export declare class DomainsApi extends runtime.BaseAPI implements DomainsApiInt
100
100
  */
101
101
  deleteDomain(sender: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessResponse>;
102
102
  /**
103
- * List sender domains configured for the account (for outbound email).
103
+ * List domains already added to this Pingram account for email. Each entry includes verification status and the DNS records Pingram expects you to publish. Does not search a registrar, purchase or transfer a domain, change DNS, or include domains that have not been added to this account.
104
104
  */
105
105
  listDomainsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetSendersResponseInner>>>;
106
106
  /**
107
- * List sender domains configured for the account (for outbound email).
107
+ * List domains already added to this Pingram account for email. Each entry includes verification status and the DNS records Pingram expects you to publish. Does not search a registrar, purchase or transfer a domain, change DNS, or include domains that have not been added to this account.
108
108
  */
109
109
  listDomains(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetSendersResponseInner>>;
110
110
  /**
@@ -54,7 +54,7 @@ const index_1 = require("../models/index");
54
54
  */
55
55
  class DomainsApi extends runtime.BaseAPI {
56
56
  /**
57
- * Add and start verification for a new sender domain. Pass the domain only (not a full email address).
57
+ * Start verification for a domain you already own so Pingram can use it for email. Pass a bare domain (example.com) or subdomain (mail.example.com). This does not purchase, transfer, renew, or control the domain, does not edit DNS, and does not disable sending or receiving on other platforms. It saves the domain on this Pingram account and returns DNS records for you to publish. Required DKIM lets Pingram send email from addresses on this domain once verification completes. Optional inbound MX, once you publish it, routes that domain\'s inbound email to Pingram. This call only begins verification. Publish the records, then start verification in the dashboard or with the start-verification API. Adding a domain that is already on the account returns the existing records.
58
58
  */
59
59
  async addDomainRaw(requestParameters, initOverrides) {
60
60
  if (requestParameters['postSendersRequestBody'] == null) {
@@ -102,7 +102,7 @@ class DomainsApi extends runtime.BaseAPI {
102
102
  return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.GetSendersResponseInnerFromJSON));
103
103
  }
104
104
  /**
105
- * Add and start verification for a new sender domain. Pass the domain only (not a full email address).
105
+ * Start verification for a domain you already own so Pingram can use it for email. Pass a bare domain (example.com) or subdomain (mail.example.com). This does not purchase, transfer, renew, or control the domain, does not edit DNS, and does not disable sending or receiving on other platforms. It saves the domain on this Pingram account and returns DNS records for you to publish. Required DKIM lets Pingram send email from addresses on this domain once verification completes. Optional inbound MX, once you publish it, routes that domain\'s inbound email to Pingram. This call only begins verification. Publish the records, then start verification in the dashboard or with the start-verification API. Adding a domain that is already on the account returns the existing records.
106
106
  */
107
107
  async addDomain(postSendersRequestBody, initOverrides) {
108
108
  const response = await this.addDomainRaw({ postSendersRequestBody: postSendersRequestBody }, initOverrides);
@@ -163,7 +163,7 @@ class DomainsApi extends runtime.BaseAPI {
163
163
  return await response.value();
164
164
  }
165
165
  /**
166
- * List sender domains configured for the account (for outbound email).
166
+ * List domains already added to this Pingram account for email. Each entry includes verification status and the DNS records Pingram expects you to publish. Does not search a registrar, purchase or transfer a domain, change DNS, or include domains that have not been added to this account.
167
167
  */
168
168
  async listDomainsRaw(initOverrides) {
169
169
  const queryParameters = {};
@@ -206,7 +206,7 @@ class DomainsApi extends runtime.BaseAPI {
206
206
  return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.GetSendersResponseInnerFromJSON));
207
207
  }
208
208
  /**
209
- * List sender domains configured for the account (for outbound email).
209
+ * List domains already added to this Pingram account for email. Each entry includes verification status and the DNS records Pingram expects you to publish. Does not search a registrar, purchase or transfer a domain, change DNS, or include domains that have not been added to this account.
210
210
  */
211
211
  async listDomains(initOverrides) {
212
212
  const response = await this.listDomainsRaw(initOverrides);
@@ -66,7 +66,7 @@ export interface RegistrationsApiInterface {
66
66
  getUs10dlcCampaign(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TenDlcCampaignRegistration>;
67
67
  /**
68
68
  *
69
- * @summary Update an existing 10DLC brand registration. Business fields are editable before carrier submission; workflow status is managed by Pingram.
69
+ * @summary Overwrite business fields on this account\'s existing US 10DLC brand registration (legal name, address, tax ID, website, compliance contact, and related identity). Fields you omit stay; values you send replace what was stored and are not kept as history. Does not create a registration, submit it to carriers, change brandStatus, or delete it. Workflow status stays under Pingram\'s control.
70
70
  * @param {TenDlcBrandUpdateRequest} tenDlcBrandUpdateRequest
71
71
  * @param {*} [options] Override http request option.
72
72
  * @throws {RequiredError}
@@ -74,12 +74,12 @@ export interface RegistrationsApiInterface {
74
74
  */
75
75
  updateUs10dlcBrandRaw(requestParameters: UpdateUs10dlcBrandRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TenDlcBrandRegistration>>;
76
76
  /**
77
- * Update an existing 10DLC brand registration. Business fields are editable before carrier submission; workflow status is managed by Pingram.
77
+ * Overwrite business fields on this account\'s existing US 10DLC brand registration (legal name, address, tax ID, website, compliance contact, and related identity). Fields you omit stay; values you send replace what was stored and are not kept as history. Does not create a registration, submit it to carriers, change brandStatus, or delete it. Workflow status stays under Pingram\'s control.
78
78
  */
79
79
  updateUs10dlcBrand(tenDlcBrandUpdateRequest: TenDlcBrandUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TenDlcBrandRegistration>;
80
80
  /**
81
81
  *
82
- * @summary Update an existing 10DLC campaign registration. Campaign fields are editable before carrier submission; workflow status is managed by Pingram.
82
+ * @summary Overwrite campaign fields on this account\'s existing US 10DLC campaign (description, samples, opt-in and opt-out text, use case, and related settings). Fields you send replace the stored values and the previous text is not kept; omitted fields stay. Editing is refused once the campaign is in_progress or approved. Does not submit the campaign to carriers, change campaignStatus, or delete it.
83
83
  * @param {TenDlcCampaignUpdateRequest} tenDlcCampaignUpdateRequest
84
84
  * @param {*} [options] Override http request option.
85
85
  * @throws {RequiredError}
@@ -87,7 +87,7 @@ export interface RegistrationsApiInterface {
87
87
  */
88
88
  updateUs10dlcCampaignRaw(requestParameters: UpdateUs10dlcCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TenDlcCampaignRegistration>>;
89
89
  /**
90
- * Update an existing 10DLC campaign registration. Campaign fields are editable before carrier submission; workflow status is managed by Pingram.
90
+ * Overwrite campaign fields on this account\'s existing US 10DLC campaign (description, samples, opt-in and opt-out text, use case, and related settings). Fields you send replace the stored values and the previous text is not kept; omitted fields stay. Editing is refused once the campaign is in_progress or approved. Does not submit the campaign to carriers, change campaignStatus, or delete it.
91
91
  */
92
92
  updateUs10dlcCampaign(tenDlcCampaignUpdateRequest: TenDlcCampaignUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TenDlcCampaignRegistration>;
93
93
  }
@@ -120,19 +120,19 @@ export declare class RegistrationsApi extends runtime.BaseAPI implements Registr
120
120
  */
121
121
  getUs10dlcCampaign(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TenDlcCampaignRegistration>;
122
122
  /**
123
- * Update an existing 10DLC brand registration. Business fields are editable before carrier submission; workflow status is managed by Pingram.
123
+ * Overwrite business fields on this account\'s existing US 10DLC brand registration (legal name, address, tax ID, website, compliance contact, and related identity). Fields you omit stay; values you send replace what was stored and are not kept as history. Does not create a registration, submit it to carriers, change brandStatus, or delete it. Workflow status stays under Pingram\'s control.
124
124
  */
125
125
  updateUs10dlcBrandRaw(requestParameters: UpdateUs10dlcBrandRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TenDlcBrandRegistration>>;
126
126
  /**
127
- * Update an existing 10DLC brand registration. Business fields are editable before carrier submission; workflow status is managed by Pingram.
127
+ * Overwrite business fields on this account\'s existing US 10DLC brand registration (legal name, address, tax ID, website, compliance contact, and related identity). Fields you omit stay; values you send replace what was stored and are not kept as history. Does not create a registration, submit it to carriers, change brandStatus, or delete it. Workflow status stays under Pingram\'s control.
128
128
  */
129
129
  updateUs10dlcBrand(tenDlcBrandUpdateRequest: TenDlcBrandUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TenDlcBrandRegistration>;
130
130
  /**
131
- * Update an existing 10DLC campaign registration. Campaign fields are editable before carrier submission; workflow status is managed by Pingram.
131
+ * Overwrite campaign fields on this account\'s existing US 10DLC campaign (description, samples, opt-in and opt-out text, use case, and related settings). Fields you send replace the stored values and the previous text is not kept; omitted fields stay. Editing is refused once the campaign is in_progress or approved. Does not submit the campaign to carriers, change campaignStatus, or delete it.
132
132
  */
133
133
  updateUs10dlcCampaignRaw(requestParameters: UpdateUs10dlcCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TenDlcCampaignRegistration>>;
134
134
  /**
135
- * Update an existing 10DLC campaign registration. Campaign fields are editable before carrier submission; workflow status is managed by Pingram.
135
+ * Overwrite campaign fields on this account\'s existing US 10DLC campaign (description, samples, opt-in and opt-out text, use case, and related settings). Fields you send replace the stored values and the previous text is not kept; omitted fields stay. Editing is refused once the campaign is in_progress or approved. Does not submit the campaign to carriers, change campaignStatus, or delete it.
136
136
  */
137
137
  updateUs10dlcCampaign(tenDlcCampaignUpdateRequest: TenDlcCampaignUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TenDlcCampaignRegistration>;
138
138
  }
@@ -209,7 +209,7 @@ class RegistrationsApi extends runtime.BaseAPI {
209
209
  return await response.value();
210
210
  }
211
211
  /**
212
- * Update an existing 10DLC brand registration. Business fields are editable before carrier submission; workflow status is managed by Pingram.
212
+ * Overwrite business fields on this account\'s existing US 10DLC brand registration (legal name, address, tax ID, website, compliance contact, and related identity). Fields you omit stay; values you send replace what was stored and are not kept as history. Does not create a registration, submit it to carriers, change brandStatus, or delete it. Workflow status stays under Pingram\'s control.
213
213
  */
214
214
  async updateUs10dlcBrandRaw(requestParameters, initOverrides) {
215
215
  if (requestParameters['tenDlcBrandUpdateRequest'] == null) {
@@ -257,14 +257,14 @@ class RegistrationsApi extends runtime.BaseAPI {
257
257
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.TenDlcBrandRegistrationFromJSON)(jsonValue));
258
258
  }
259
259
  /**
260
- * Update an existing 10DLC brand registration. Business fields are editable before carrier submission; workflow status is managed by Pingram.
260
+ * Overwrite business fields on this account\'s existing US 10DLC brand registration (legal name, address, tax ID, website, compliance contact, and related identity). Fields you omit stay; values you send replace what was stored and are not kept as history. Does not create a registration, submit it to carriers, change brandStatus, or delete it. Workflow status stays under Pingram\'s control.
261
261
  */
262
262
  async updateUs10dlcBrand(tenDlcBrandUpdateRequest, initOverrides) {
263
263
  const response = await this.updateUs10dlcBrandRaw({ tenDlcBrandUpdateRequest: tenDlcBrandUpdateRequest }, initOverrides);
264
264
  return await response.value();
265
265
  }
266
266
  /**
267
- * Update an existing 10DLC campaign registration. Campaign fields are editable before carrier submission; workflow status is managed by Pingram.
267
+ * Overwrite campaign fields on this account\'s existing US 10DLC campaign (description, samples, opt-in and opt-out text, use case, and related settings). Fields you send replace the stored values and the previous text is not kept; omitted fields stay. Editing is refused once the campaign is in_progress or approved. Does not submit the campaign to carriers, change campaignStatus, or delete it.
268
268
  */
269
269
  async updateUs10dlcCampaignRaw(requestParameters, initOverrides) {
270
270
  if (requestParameters['tenDlcCampaignUpdateRequest'] == null) {
@@ -312,7 +312,7 @@ class RegistrationsApi extends runtime.BaseAPI {
312
312
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.TenDlcCampaignRegistrationFromJSON)(jsonValue));
313
313
  }
314
314
  /**
315
- * Update an existing 10DLC campaign registration. Campaign fields are editable before carrier submission; workflow status is managed by Pingram.
315
+ * Overwrite campaign fields on this account\'s existing US 10DLC campaign (description, samples, opt-in and opt-out text, use case, and related settings). Fields you send replace the stored values and the previous text is not kept; omitted fields stay. Editing is refused once the campaign is in_progress or approved. Does not submit the campaign to carriers, change campaignStatus, or delete it.
316
316
  */
317
317
  async updateUs10dlcCampaign(tenDlcCampaignUpdateRequest, initOverrides) {
318
318
  const response = await this.updateUs10dlcCampaignRaw({ tenDlcCampaignUpdateRequest: tenDlcCampaignUpdateRequest }, initOverrides);
@@ -30,7 +30,7 @@ export interface UpdateWebhookRequest {
30
30
  export interface WebhooksApiInterface {
31
31
  /**
32
32
  *
33
- * @summary Create a webhook endpoint. Pingram POSTs signed JSON to the URL when one of the subscribed events happens. The response includes id and a signing secret starting with pingram_whsecret_. Save it and verify the X-Pingram-Signature header. Updates keep this secret. At most 10 endpoints per account. The URL must be a public HTTPS URL and should return 2xx.
33
+ * @summary Create a webhook endpoint on a server outside Pingram. Pingram later POSTs signed JSON to that URL when one of the subscribed events happens. This call only saves the endpoint; it does not send a webhook and does not modify the destination server. The response includes id and a signing secret starting with pingram_whsecret_. Save it and verify the X-Pingram-Signature header. Updates keep this secret. At most 10 endpoints per account. The URL must be a public HTTPS URL and should return 2xx.
34
34
  * @param {WebhookEndpointUpsertRequest} webhookEndpointUpsertRequest
35
35
  * @param {*} [options] Override http request option.
36
36
  * @throws {RequiredError}
@@ -38,7 +38,7 @@ export interface WebhooksApiInterface {
38
38
  */
39
39
  createWebhookRaw(requestParameters: CreateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookEndpoint>>;
40
40
  /**
41
- * Create a webhook endpoint. Pingram POSTs signed JSON to the URL when one of the subscribed events happens. The response includes id and a signing secret starting with pingram_whsecret_. Save it and verify the X-Pingram-Signature header. Updates keep this secret. At most 10 endpoints per account. The URL must be a public HTTPS URL and should return 2xx.
41
+ * Create a webhook endpoint on a server outside Pingram. Pingram later POSTs signed JSON to that URL when one of the subscribed events happens. This call only saves the endpoint; it does not send a webhook and does not modify the destination server. The response includes id and a signing secret starting with pingram_whsecret_. Save it and verify the X-Pingram-Signature header. Updates keep this secret. At most 10 endpoints per account. The URL must be a public HTTPS URL and should return 2xx.
42
42
  */
43
43
  createWebhook(webhookEndpointUpsertRequest: WebhookEndpointUpsertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookEndpoint>;
44
44
  /**
@@ -68,7 +68,7 @@ export interface WebhooksApiInterface {
68
68
  listWebhooks(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookEndpointsResponse>;
69
69
  /**
70
70
  *
71
- * @summary Replace one webhook endpoint\'s URL and its full event subscription. endpointId comes from list or create. The signing secret stays the same. events is the complete set; omitting an event unsubscribes it. The URL must be a public HTTPS URL.
71
+ * @summary Replace one webhook endpoint\'s URL and its full event subscription. The URL is a server outside Pingram. endpointId comes from list or create. The signing secret stays the same. events is the complete set; omitting an event unsubscribes it, and the previous URL stops receiving events. The previous URL and event list are not kept. The URL must be a public HTTPS URL.
72
72
  * @param {string} endpointId Id of the webhook endpoint, from list or create.
73
73
  * @param {WebhookEndpointUpsertRequest} webhookEndpointUpsertRequest
74
74
  * @param {*} [options] Override http request option.
@@ -77,7 +77,7 @@ export interface WebhooksApiInterface {
77
77
  */
78
78
  updateWebhookRaw(requestParameters: UpdateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookEndpoint>>;
79
79
  /**
80
- * Replace one webhook endpoint\'s URL and its full event subscription. endpointId comes from list or create. The signing secret stays the same. events is the complete set; omitting an event unsubscribes it. The URL must be a public HTTPS URL.
80
+ * Replace one webhook endpoint\'s URL and its full event subscription. The URL is a server outside Pingram. endpointId comes from list or create. The signing secret stays the same. events is the complete set; omitting an event unsubscribes it, and the previous URL stops receiving events. The previous URL and event list are not kept. The URL must be a public HTTPS URL.
81
81
  */
82
82
  updateWebhook(endpointId: string, webhookEndpointUpsertRequest: WebhookEndpointUpsertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookEndpoint>;
83
83
  }
@@ -86,11 +86,11 @@ export interface WebhooksApiInterface {
86
86
  */
87
87
  export declare class WebhooksApi extends runtime.BaseAPI implements WebhooksApiInterface {
88
88
  /**
89
- * Create a webhook endpoint. Pingram POSTs signed JSON to the URL when one of the subscribed events happens. The response includes id and a signing secret starting with pingram_whsecret_. Save it and verify the X-Pingram-Signature header. Updates keep this secret. At most 10 endpoints per account. The URL must be a public HTTPS URL and should return 2xx.
89
+ * Create a webhook endpoint on a server outside Pingram. Pingram later POSTs signed JSON to that URL when one of the subscribed events happens. This call only saves the endpoint; it does not send a webhook and does not modify the destination server. The response includes id and a signing secret starting with pingram_whsecret_. Save it and verify the X-Pingram-Signature header. Updates keep this secret. At most 10 endpoints per account. The URL must be a public HTTPS URL and should return 2xx.
90
90
  */
91
91
  createWebhookRaw(requestParameters: CreateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookEndpoint>>;
92
92
  /**
93
- * Create a webhook endpoint. Pingram POSTs signed JSON to the URL when one of the subscribed events happens. The response includes id and a signing secret starting with pingram_whsecret_. Save it and verify the X-Pingram-Signature header. Updates keep this secret. At most 10 endpoints per account. The URL must be a public HTTPS URL and should return 2xx.
93
+ * Create a webhook endpoint on a server outside Pingram. Pingram later POSTs signed JSON to that URL when one of the subscribed events happens. This call only saves the endpoint; it does not send a webhook and does not modify the destination server. The response includes id and a signing secret starting with pingram_whsecret_. Save it and verify the X-Pingram-Signature header. Updates keep this secret. At most 10 endpoints per account. The URL must be a public HTTPS URL and should return 2xx.
94
94
  */
95
95
  createWebhook(webhookEndpointUpsertRequest: WebhookEndpointUpsertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookEndpoint>;
96
96
  /**
@@ -110,11 +110,11 @@ export declare class WebhooksApi extends runtime.BaseAPI implements WebhooksApiI
110
110
  */
111
111
  listWebhooks(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookEndpointsResponse>;
112
112
  /**
113
- * Replace one webhook endpoint\'s URL and its full event subscription. endpointId comes from list or create. The signing secret stays the same. events is the complete set; omitting an event unsubscribes it. The URL must be a public HTTPS URL.
113
+ * Replace one webhook endpoint\'s URL and its full event subscription. The URL is a server outside Pingram. endpointId comes from list or create. The signing secret stays the same. events is the complete set; omitting an event unsubscribes it, and the previous URL stops receiving events. The previous URL and event list are not kept. The URL must be a public HTTPS URL.
114
114
  */
115
115
  updateWebhookRaw(requestParameters: UpdateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookEndpoint>>;
116
116
  /**
117
- * Replace one webhook endpoint\'s URL and its full event subscription. endpointId comes from list or create. The signing secret stays the same. events is the complete set; omitting an event unsubscribes it. The URL must be a public HTTPS URL.
117
+ * Replace one webhook endpoint\'s URL and its full event subscription. The URL is a server outside Pingram. endpointId comes from list or create. The signing secret stays the same. events is the complete set; omitting an event unsubscribes it, and the previous URL stops receiving events. The previous URL and event list are not kept. The URL must be a public HTTPS URL.
118
118
  */
119
119
  updateWebhook(endpointId: string, webhookEndpointUpsertRequest: WebhookEndpointUpsertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookEndpoint>;
120
120
  }
@@ -54,7 +54,7 @@ const index_1 = require("../models/index");
54
54
  */
55
55
  class WebhooksApi extends runtime.BaseAPI {
56
56
  /**
57
- * Create a webhook endpoint. Pingram POSTs signed JSON to the URL when one of the subscribed events happens. The response includes id and a signing secret starting with pingram_whsecret_. Save it and verify the X-Pingram-Signature header. Updates keep this secret. At most 10 endpoints per account. The URL must be a public HTTPS URL and should return 2xx.
57
+ * Create a webhook endpoint on a server outside Pingram. Pingram later POSTs signed JSON to that URL when one of the subscribed events happens. This call only saves the endpoint; it does not send a webhook and does not modify the destination server. The response includes id and a signing secret starting with pingram_whsecret_. Save it and verify the X-Pingram-Signature header. Updates keep this secret. At most 10 endpoints per account. The URL must be a public HTTPS URL and should return 2xx.
58
58
  */
59
59
  async createWebhookRaw(requestParameters, initOverrides) {
60
60
  if (requestParameters['webhookEndpointUpsertRequest'] == null) {
@@ -102,7 +102,7 @@ class WebhooksApi extends runtime.BaseAPI {
102
102
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WebhookEndpointFromJSON)(jsonValue));
103
103
  }
104
104
  /**
105
- * Create a webhook endpoint. Pingram POSTs signed JSON to the URL when one of the subscribed events happens. The response includes id and a signing secret starting with pingram_whsecret_. Save it and verify the X-Pingram-Signature header. Updates keep this secret. At most 10 endpoints per account. The URL must be a public HTTPS URL and should return 2xx.
105
+ * Create a webhook endpoint on a server outside Pingram. Pingram later POSTs signed JSON to that URL when one of the subscribed events happens. This call only saves the endpoint; it does not send a webhook and does not modify the destination server. The response includes id and a signing secret starting with pingram_whsecret_. Save it and verify the X-Pingram-Signature header. Updates keep this secret. At most 10 endpoints per account. The URL must be a public HTTPS URL and should return 2xx.
106
106
  */
107
107
  async createWebhook(webhookEndpointUpsertRequest, initOverrides) {
108
108
  const response = await this.createWebhookRaw({ webhookEndpointUpsertRequest: webhookEndpointUpsertRequest }, initOverrides);
@@ -212,7 +212,7 @@ class WebhooksApi extends runtime.BaseAPI {
212
212
  return await response.value();
213
213
  }
214
214
  /**
215
- * Replace one webhook endpoint\'s URL and its full event subscription. endpointId comes from list or create. The signing secret stays the same. events is the complete set; omitting an event unsubscribes it. The URL must be a public HTTPS URL.
215
+ * Replace one webhook endpoint\'s URL and its full event subscription. The URL is a server outside Pingram. endpointId comes from list or create. The signing secret stays the same. events is the complete set; omitting an event unsubscribes it, and the previous URL stops receiving events. The previous URL and event list are not kept. The URL must be a public HTTPS URL.
216
216
  */
217
217
  async updateWebhookRaw(requestParameters, initOverrides) {
218
218
  if (requestParameters['endpointId'] == null) {
@@ -264,7 +264,7 @@ class WebhooksApi extends runtime.BaseAPI {
264
264
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WebhookEndpointFromJSON)(jsonValue));
265
265
  }
266
266
  /**
267
- * Replace one webhook endpoint\'s URL and its full event subscription. endpointId comes from list or create. The signing secret stays the same. events is the complete set; omitting an event unsubscribes it. The URL must be a public HTTPS URL.
267
+ * Replace one webhook endpoint\'s URL and its full event subscription. The URL is a server outside Pingram. endpointId comes from list or create. The signing secret stays the same. events is the complete set; omitting an event unsubscribes it, and the previous URL stops receiving events. The previous URL and event list are not kept. The URL must be a public HTTPS URL.
268
268
  */
269
269
  async updateWebhook(endpointId, webhookEndpointUpsertRequest, initOverrides) {
270
270
  const response = await this.updateWebhookRaw({
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pingram",
3
- "version": "1.0.39-alpha.1655",
3
+ "version": "1.0.39-alpha.1657",
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",