pingram 1.0.39 → 1.0.40

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3521645359a81dc82e84e9f12ae5d019dce125e556cb5661cd04eb924cc7bc9a
-  data.tar.gz: 12080816cec42686dd955540577e9ba52b07b4f82cab9fcbc3cca78cd3c8e8c0
+  metadata.gz: c7c189f4dbe0fee0a6ddf00f29993eab2e143d2774bf4e4ae01e8893f8bfddb0
+  data.tar.gz: dee219ada2ba149b315d48721fe0c1b6790695eaf9834fb4a14a0d3dc4d49117
 SHA512:
-  metadata.gz: d8a97c832a2bd1a1d643f4730b1928cea3282c08c061d9d9d39c860202112576fd42c9ef10797064759d857f8403fa74df7b4de40a5e7a91e7f891df684e7e22
-  data.tar.gz: 8abc49f3658f4c83b5d046a3429eb03dbe0ed36c4b302c01a9cdaf70fb9b3e226de7c193da3ca674f5e64e4db9667279340cfbbf13b389fb4f217b158e44f8b6
+  metadata.gz: da6ddc9a3ba80763a51fc6ac96e7fc5fba3f4cb31cb578f4fa3671e31964d30dc2b39b8c766fde6bf186053794bf9bd27b5e35bd5c94ccf2435816aa2d8833d3
+  data.tar.gz: e0951e381c394c431113e93d2f6cf92f6c22a750af10e260d618a615787b005b3ae5a7c10cda41bc8474bf1f6bcd9dedf88f63426de8cb49774e6153a265440c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pingram (1.0.39)
+    pingram (1.0.40)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -22,10 +22,10 @@ GEM
     logger (1.7.0)
     method_source (1.1.0)
     parallel (1.28.0)
-    parser (3.3.12.0)
+    parser (3.3.13.0)
       ast (~> 2.4.1)
       racc
-    pry (0.16.0)
+    pry (0.16.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
       reline (>= 0.6.0)

data/lib/pingram/api/accounts_api.rb

@@ -19,7 +19,7 @@ module Pingram
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Create an additional account for the authenticated user
+    # 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.
     # @param create_account_request [CreateAccountRequest] 
     # @param [Hash] opts the optional parameters
     # @return [CreateAccountResponse]
@@ -28,7 +28,7 @@ module Pingram
       data
     end
 
-    # Create an additional account for the authenticated user
+    # 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.
     # @param create_account_request [CreateAccountRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(CreateAccountResponse, Integer, Hash)>] CreateAccountResponse data, response status code and response headers

data/lib/pingram/api/addresses_api.rb

@@ -201,7 +201,7 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Update an inbox prefix or display name.
+    # 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.
     # @param update_address_request [UpdateAddressRequest] 
     # @param [Hash] opts the optional parameters
     # @return [AddressResponse]
@@ -210,7 +210,7 @@ module Pingram
       data
     end
 
-    # Update an inbox prefix or display name.
+    # 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.
     # @param update_address_request [UpdateAddressRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(AddressResponse, Integer, Hash)>] AddressResponse data, response status code and response headers

data/lib/pingram/api/broadcasts_api.rb

@@ -80,7 +80,7 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Cancel an email broadcast. Scheduled broadcasts revert to draft and drop their schedule. Sending or paused broadcasts become canceled; remaining pending recipients are skipped.
+    # 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.
     # @param broadcast_id [String] Broadcast ID
     # @param [Hash] opts the optional parameters
     # @return [BroadcastResponse]
@@ -89,7 +89,7 @@ module Pingram
       data
     end
 
-    # Cancel an email broadcast. Scheduled broadcasts revert to draft and drop their schedule. Sending or paused broadcasts become canceled; remaining pending recipients are skipped.
+    # 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.
     # @param broadcast_id [String] Broadcast ID
     # @param [Hash] opts the optional parameters
     # @return [Array<(BroadcastResponse, Integer, Hash)>] BroadcastResponse data, response status code and response headers
@@ -141,7 +141,7 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Create a draft email broadcast. html is the send-ready body. Optional internalTemplate is visual-editor source; if set it must be paired with html and cannot be added later. Set audience to either a Mongo-style user filter (sync users via Users API first; for large lists) or a raw email list (max 10,000). Include name, from fields, subject, and HTML. Notification type is optional on create and required before send or schedule; it is created automatically if missing.
+    # Create a draft email broadcast. html is the send-ready body. Optional internalTemplate is visual-editor source; if set it must be paired with html. A later update can add it to a draft by sending it with html. Set audience to either a Mongo-style user filter (sync users via Users API first; for large lists) or a raw email list (max 10,000). Include name, from fields, subject, and HTML. Notification type is optional on create and required before send or schedule; it is created automatically if missing.
     # @param create_broadcast_request [CreateBroadcastRequest] 
     # @param [Hash] opts the optional parameters
     # @return [BroadcastResponse]
@@ -150,7 +150,7 @@ module Pingram
       data
     end
 
-    # Create a draft email broadcast. html is the send-ready body. Optional internalTemplate is visual-editor source; if set it must be paired with html and cannot be added later. Set audience to either a Mongo-style user filter (sync users via Users API first; for large lists) or a raw email list (max 10,000). Include name, from fields, subject, and HTML. Notification type is optional on create and required before send or schedule; it is created automatically if missing.
+    # Create a draft email broadcast. html is the send-ready body. Optional internalTemplate is visual-editor source; if set it must be paired with html. A later update can add it to a draft by sending it with html. Set audience to either a Mongo-style user filter (sync users via Users API first; for large lists) or a raw email list (max 10,000). Include name, from fields, subject, and HTML. Notification type is optional on create and required before send or schedule; it is created automatically if missing.
     # @param create_broadcast_request [CreateBroadcastRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(BroadcastResponse, Integer, Hash)>] BroadcastResponse data, response status code and response headers
@@ -390,7 +390,7 @@ module Pingram
       return data, status_code, headers
     end
 
-    # 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.
+    # 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.
     # @param [Hash] opts the optional parameters
     # @option opts [Float] :limit Max broadcasts to return (default 50)
     # @option opts [String] :next_token Pagination token
@@ -400,7 +400,7 @@ module Pingram
       data
     end
 
-    # 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.
+    # 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.
     # @param [Hash] opts the optional parameters
     # @option opts [Float] :limit Max broadcasts to return (default 50)
     # @option opts [String] :next_token Pagination token
@@ -643,7 +643,7 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Schedule a draft email broadcast for a future ISO datetime (sendAt). Requires a non-empty subject. fromAddress must be the platform default sender or a domain verified for this account (Settings → Domain Verification). The platform default sender is for testing only (at most 10 recipients, heavily throttled). Cancels any existing schedule when the broadcast is returned to draft via cancel.
+    # Schedule a draft email broadcast for a future ISO datetime (sendAt). Requires a non-empty subject. Cancels any existing schedule when the broadcast is returned to draft via cancel.
     # @param broadcast_id [String] Broadcast ID
     # @param schedule_broadcast_request [ScheduleBroadcastRequest] 
     # @param [Hash] opts the optional parameters
@@ -653,7 +653,7 @@ module Pingram
       data
     end
 
-    # Schedule a draft email broadcast for a future ISO datetime (sendAt). Requires a non-empty subject. fromAddress must be the platform default sender or a domain verified for this account (Settings → Domain Verification). The platform default sender is for testing only (at most 10 recipients, heavily throttled). Cancels any existing schedule when the broadcast is returned to draft via cancel.
+    # Schedule a draft email broadcast for a future ISO datetime (sendAt). Requires a non-empty subject. Cancels any existing schedule when the broadcast is returned to draft via cancel.
     # @param broadcast_id [String] Broadcast ID
     # @param schedule_broadcast_request [ScheduleBroadcastRequest] 
     # @param [Hash] opts the optional parameters
@@ -715,7 +715,7 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Send a draft email broadcast immediately. Requires a non-empty subject. fromAddress must be the platform default sender or a domain verified for this account (Settings → Domain Verification). The platform default sender is for testing only (at most 10 recipients, heavily throttled). Transitions status to sending and starts delivery.
+    # Send a draft email broadcast immediately. Requires a non-empty subject. Transitions status to sending and starts delivery.
     # @param broadcast_id [String] Broadcast ID
     # @param [Hash] opts the optional parameters
     # @return [BroadcastResponse]
@@ -724,7 +724,7 @@ module Pingram
       data
     end
 
-    # Send a draft email broadcast immediately. Requires a non-empty subject. fromAddress must be the platform default sender or a domain verified for this account (Settings → Domain Verification). The platform default sender is for testing only (at most 10 recipients, heavily throttled). Transitions status to sending and starts delivery.
+    # Send a draft email broadcast immediately. Requires a non-empty subject. Transitions status to sending and starts delivery.
     # @param broadcast_id [String] Broadcast ID
     # @param [Hash] opts the optional parameters
     # @return [Array<(BroadcastResponse, Integer, Hash)>] BroadcastResponse data, response status code and response headers
@@ -837,7 +837,7 @@ module Pingram
       return data, status_code, headers
     end
 
-    # 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.
+    # 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 is visual-editor source: send it with html to add it to an html-only draft or to update it. It cannot be removed. Only drafts can be edited; scheduled or active broadcasts are locked. This does not send the broadcast.
     # @param broadcast_id [String] Broadcast ID
     # @param update_broadcast_request [UpdateBroadcastRequest] 
     # @param [Hash] opts the optional parameters
@@ -847,7 +847,7 @@ module Pingram
       data
     end
 
-    # 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.
+    # 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 is visual-editor source: send it with html to add it to an html-only draft or to update it. It cannot be removed. Only drafts can be edited; scheduled or active broadcasts are locked. This does not send the broadcast.
     # @param broadcast_id [String] Broadcast ID
     # @param update_broadcast_request [UpdateBroadcastRequest] 
     # @param [Hash] opts the optional parameters

data/lib/pingram/api/domains_api.rb

@@ -19,7 +19,7 @@ module Pingram
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Add and start verification for a new sender domain. Pass the domain only (not a full email address).
+    # 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.
     # @param post_senders_request_body [PostSendersRequestBody] 
     # @param [Hash] opts the optional parameters
     # @return [Array<GetSendersResponseInner>]
@@ -28,7 +28,7 @@ module Pingram
       data
     end
 
-    # Add and start verification for a new sender domain. Pass the domain only (not a full email address).
+    # 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&#39;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.
     # @param post_senders_request_body [PostSendersRequestBody] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<GetSendersResponseInner>, Integer, Hash)>] Array<GetSendersResponseInner> data, response status code and response headers
@@ -146,7 +146,7 @@ module Pingram
       return data, status_code, headers
     end
 
-    # List sender domains configured for the account (for outbound email).
+    # 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.
     # @param [Hash] opts the optional parameters
     # @return [Array<GetSendersResponseInner>]
     def domains_list_domains(opts = {})
@@ -154,7 +154,7 @@ module Pingram
       data
     end
 
-    # List sender domains configured for the account (for outbound email).
+    # 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.
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<GetSendersResponseInner>, Integer, Hash)>] Array<GetSendersResponseInner> data, response status code and response headers
     def domains_list_domains_with_http_info(opts = {})

data/lib/pingram/api/email_api.rb

@@ -80,7 +80,7 @@ module Pingram
       return data, status_code, headers
     end
 
-    # 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.
+    # Send an email. Requires `type`, `to`, `subject`, and `html`. Optional: `fromAddress`, `fromName`, `schedule`, attachments. To reach people outside your account, use an address on a verified domain. The shared Pingram address can only email the account itself and always sends as noreply.
     # @param send_email_request [SendEmailRequest] 
     # @param [Hash] opts the optional parameters
     # @return [SendEmailApiResponse]
@@ -89,7 +89,7 @@ module Pingram
       data
     end
 
-    # 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.
+    # Send an email. Requires `type`, `to`, `subject`, and `html`. Optional: `fromAddress`, `fromName`, `schedule`, attachments. To reach people outside your account, use an address on a verified domain. The shared Pingram address can only email the account itself and always sends as noreply.
     # @param send_email_request [SendEmailRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(SendEmailApiResponse, Integer, Hash)>] SendEmailApiResponse data, response status code and response headers

data/lib/pingram/api/registrations_api.rb

@@ -195,7 +195,7 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Update an existing 10DLC brand registration. Business fields are editable before carrier submission; workflow status is managed by Pingram.
+    # 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.
     # @param ten_dlc_brand_update_request [TenDlcBrandUpdateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [TenDlcBrandRegistration]
@@ -204,7 +204,7 @@ module Pingram
       data
     end
 
-    # Update an existing 10DLC brand registration. Business fields are editable before carrier submission; workflow status is managed by Pingram.
+    # 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.
     # @param ten_dlc_brand_update_request [TenDlcBrandUpdateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(TenDlcBrandRegistration, Integer, Hash)>] TenDlcBrandRegistration data, response status code and response headers
@@ -261,7 +261,7 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Update an existing 10DLC campaign registration. Campaign fields are editable before carrier submission; workflow status is managed by Pingram.
+    # 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.
     # @param ten_dlc_campaign_update_request [TenDlcCampaignUpdateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [TenDlcCampaignRegistration]
@@ -270,7 +270,7 @@ module Pingram
       data
     end
 
-    # Update an existing 10DLC campaign registration. Campaign fields are editable before carrier submission; workflow status is managed by Pingram.
+    # Overwrite campaign fields on this account&#39;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.
     # @param ten_dlc_campaign_update_request [TenDlcCampaignUpdateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(TenDlcCampaignRegistration, Integer, Hash)>] TenDlcCampaignRegistration data, response status code and response headers