pingram 1.0.14 → 1.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b0da74b04be34652ce4772d960f635a00fd4de9282f579a2b4f2b5fff340e22
-  data.tar.gz: a830cb772656fc43455340ef6f7bc447c3a4ad8ecb096ffd6ceded61aa2e8dce
+  metadata.gz: 5508d55a6a48f3ffdf596af86d422c9e83f8f42f841e3a78d7673d25323b660c
+  data.tar.gz: 9b5aa76add40c0202018c39b9040ca69dba5ca15df7ecbe19006515ce64423e9
 SHA512:
-  metadata.gz: 91ee7f634122374ab81a9cea5187eef7ca4ee3b207f9fc1b5f1eb993cf16049bd39a8b429d932be7e99a5bc4ffac9247324987e8bb03702016981c9591aaf24d
-  data.tar.gz: a0cbcb303e77a518f768df2fa83f4f96c81a423db53e5ac41bc0b1221911be75f3b0b31f04a6a48e28d4c32f40ed33e2609c693f9e230d7342fbc3f4d8e0a3e5
+  metadata.gz: e76b1b8fe23fd399556ae4593834b5bf68e8ff0b76f9a10ff43dd45f5003234324f98f1cd8e57faea8f033a84a7a2441b9356ff2e4ab6d9063917db7bcce50aa
+  data.tar.gz: ddc1499030dd37f0a934c841180c8065bbc19996333b897323190f25bfe1797df972810b557647d8e1e4eef18f3f26726450528030a2eb2bef6001c05c171605

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pingram (1.0.14)
+    pingram (1.0.16)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/lib/pingram/api/addresses_api.rb

@@ -19,7 +19,7 @@ module Pingram
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Create a new email address for inbound/outbound purposes. Each account can have one builtin address and many custom addresses. Custom addresses must belong to configured domains.
+    # Create a new email inbox. Omit `domain` for a built-in `@mail.pingram.io` address; set `domain` and `displayName` for a custom address on a verified domain.
     # @param create_address_request [CreateAddressRequest] 
     # @param [Hash] opts the optional parameters
     # @return [AddressResponse]
@@ -28,7 +28,7 @@ module Pingram
       data
     end
 
-    # Create a new email address for inbound/outbound purposes. Each account can have one builtin address and many custom addresses. Custom addresses must belong to configured domains.
+    # Create a new email inbox. Omit `domain` for a built-in `@mail.pingram.io` address; set `domain` and `displayName` for a custom address on a verified domain.
     # @param create_address_request [CreateAddressRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(AddressResponse, Integer, Hash)>] AddressResponse data, response status code and response headers
@@ -85,7 +85,68 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Lists all email addresses the account has configured to send and receive emails. Custom addresses must belong to configured domains.
+    # Delete a custom inbound address. Builtin addresses cannot be deleted.
+    # @param full_address [String] Full address to delete (e.g. hello@example.com)
+    # @param [Hash] opts the optional parameters
+    # @return [SuccessResponse]
+    def addresses_delete_address(full_address, opts = {})
+      data, _status_code, _headers = addresses_delete_address_with_http_info(full_address, opts)
+      data
+    end
+
+    # Delete a custom inbound address. Builtin addresses cannot be deleted.
+    # @param full_address [String] Full address to delete (e.g. hello@example.com)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SuccessResponse, Integer, Hash)>] SuccessResponse data, response status code and response headers
+    def addresses_delete_address_with_http_info(full_address, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AddressesApi.addresses_delete_address ...'
+      end
+      # verify the required parameter 'full_address' is set
+      if @api_client.config.client_side_validation && full_address.nil?
+        fail ArgumentError, "Missing the required parameter 'full_address' when calling AddressesApi.addresses_delete_address"
+      end
+      # resource path
+      local_var_path = '/addresses/{fullAddress}'.sub('{' + 'fullAddress' + '}', CGI.escape(full_address.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SuccessResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"AddressesApi.addresses_delete_address",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AddressesApi#addresses_delete_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List email inboxes (addresses) configured for receiving. Custom addresses must use a verified domain.
     # @param [Hash] opts the optional parameters
     # @return [AccountAddressesResponse]
     def addresses_list_addresses(opts = {})
@@ -93,7 +154,7 @@ module Pingram
       data
     end
 
-    # Lists all email addresses the account has configured to send and receive emails. Custom addresses must belong to configured domains.
+    # List email inboxes (addresses) configured for receiving. Custom addresses must use a verified domain.
     # @param [Hash] opts the optional parameters
     # @return [Array<(AccountAddressesResponse, Integer, Hash)>] AccountAddressesResponse data, response status code and response headers
     def addresses_list_addresses_with_http_info(opts = {})
@@ -140,7 +201,7 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Update an existing address
+    # Update an inbox prefix or display name.
     # @param update_address_request [UpdateAddressRequest] 
     # @param [Hash] opts the optional parameters
     # @return [AddressResponse]
@@ -149,7 +210,7 @@ module Pingram
       data
     end
 
-    # Update an existing address
+    # Update an inbox prefix or display name.
     # @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/default_api.rb

@@ -19,7 +19,7 @@ module Pingram
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Send a notification
+    # Send a notification (email, SMS, etc.) to one user. Requires a notification `type` which categorizes this messages for future reporting, and channel-specific payloads such as `email` or `sms`. Recipient is specified with the `to` parameter. Returns a `trackingId` for error or delivery lookup through our Logs.
     # @param sender_post_body [SenderPostBody] 
     # @param [Hash] opts the optional parameters
     # @return [SenderPostResponse]
@@ -28,7 +28,7 @@ module Pingram
       data
     end
 
-    # Send a notification
+    # Send a notification (email, SMS, etc.) to one user. Requires a notification `type` which categorizes this messages for future reporting, and channel-specific payloads such as `email` or `sms`. Recipient is specified with the `to` parameter. Returns a `trackingId` for error or delivery lookup through our Logs.
     # @param sender_post_body [SenderPostBody] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(SenderPostResponse, Integer, Hash)>] SenderPostResponse data, response status code and response headers

data/lib/pingram/api/domains_api.rb

@@ -19,7 +19,7 @@ module Pingram
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Request to verify a new sender domain
+    # Add and start verification for a new sender domain. Pass the domain only (not a full email address).
     # @param post_senders_request_body [PostSendersRequestBody] 
     # @param [Hash] opts the optional parameters
     # @return [Array<GetSendersResponseInner>]
@@ -28,7 +28,7 @@ module Pingram
       data
     end
 
-    # Request to verify a new sender domain
+    # Add and start verification for a new sender domain. Pass the domain only (not a full email address).
     # @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
@@ -85,8 +85,8 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Delete a sender domain or email address
-    # @param sender [String] Sender domain or email address (URL encoded)
+    # Remove a sender domain from the account.
+    # @param sender [String] Sender domain (URL encoded)
     # @param [Hash] opts the optional parameters
     # @return [SuccessResponse]
     def domains_delete_domain(sender, opts = {})
@@ -94,8 +94,8 @@ module Pingram
       data
     end
 
-    # Delete a sender domain or email address
-    # @param sender [String] Sender domain or email address (URL encoded)
+    # Remove a sender domain from the account.
+    # @param sender [String] Sender domain (URL encoded)
     # @param [Hash] opts the optional parameters
     # @return [Array<(SuccessResponse, Integer, Hash)>] SuccessResponse data, response status code and response headers
     def domains_delete_domain_with_http_info(sender, opts = {})
@@ -146,7 +146,7 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Get all sender domains configured for the account
+    # List sender domains configured for the account (for outbound email).
     # @param [Hash] opts the optional parameters
     # @return [Array<GetSendersResponseInner>]
     def domains_list_domains(opts = {})
@@ -154,7 +154,7 @@ module Pingram
       data
     end
 
-    # Get all sender domains configured for the account
+    # List sender domains configured for the account (for outbound email).
     # @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 = {})
@@ -200,5 +200,66 @@ module Pingram
       end
       return data, status_code, headers
     end
+
+    # Start SES domain verification (DNS readiness is checked client-side via checkDomainDns)
+    # @param sender [String] Sender domain (URL encoded)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<GetSendersResponseInner>]
+    def domains_start_domain_verification(sender, opts = {})
+      data, _status_code, _headers = domains_start_domain_verification_with_http_info(sender, opts)
+      data
+    end
+
+    # Start SES domain verification (DNS readiness is checked client-side via checkDomainDns)
+    # @param sender [String] Sender domain (URL encoded)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<GetSendersResponseInner>, Integer, Hash)>] Array<GetSendersResponseInner> data, response status code and response headers
+    def domains_start_domain_verification_with_http_info(sender, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DomainsApi.domains_start_domain_verification ...'
+      end
+      # verify the required parameter 'sender' is set
+      if @api_client.config.client_side_validation && sender.nil?
+        fail ArgumentError, "Missing the required parameter 'sender' when calling DomainsApi.domains_start_domain_verification"
+      end
+      # resource path
+      local_var_path = '/domains/{sender}/start-verification'.sub('{' + 'sender' + '}', CGI.escape(sender.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<GetSendersResponseInner>'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"DomainsApi.domains_start_domain_verification",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DomainsApi#domains_start_domain_verification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/pingram/api/email_api.rb

@@ -19,7 +19,7 @@ module Pingram
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Send an email notification directly without templates
+    # 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.
     # @param send_email_request [SendEmailRequest] 
     # @param [Hash] opts the optional parameters
     # @return [SendEmailApiResponse]
@@ -28,7 +28,7 @@ module Pingram
       data
     end
 
-    # Send an email notification directly without templates
+    # 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.
     # @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/logs_api.rb

@@ -74,7 +74,7 @@ module Pingram
       return data, status_code, headers
     end
 
-    # List logs for the authenticated account
+    # List recent notification logs for the authenticated account, newest first.
     # @param [Hash] opts the optional parameters
     # @option opts [Float] :limit Maximum number of logs to return (default
     # @option opts [String] :cursor Pagination cursor for next page
@@ -84,7 +84,7 @@ module Pingram
       data
     end
 
-    # List logs for the authenticated account
+    # List recent notification logs for the authenticated account, newest first.
     # @param [Hash] opts the optional parameters
     # @option opts [Float] :limit Maximum number of logs to return (default
     # @option opts [String] :cursor Pagination cursor for next page
@@ -135,7 +135,7 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Get logs by tracking IDs (comma-separated, max 25 IDs)
+    # Get logs by tracking IDs (comma-separated, max 25 IDs). Use after sending email or SMS to look up delivery status.
     # @param tracking_ids [String] Comma-separated tracking IDs (URL encoded)
     # @param [Hash] opts the optional parameters
     # @return [LogsGetResponse]
@@ -144,7 +144,7 @@ module Pingram
       data
     end
 
-    # Get logs by tracking IDs (comma-separated, max 25 IDs)
+    # Get logs by tracking IDs (comma-separated, max 25 IDs). Use after sending email or SMS to look up delivery status.
     # @param tracking_ids [String] Comma-separated tracking IDs (URL encoded)
     # @param [Hash] opts the optional parameters
     # @return [Array<(LogsGetResponse, Integer, Hash)>] LogsGetResponse data, response status code and response headers
@@ -196,8 +196,8 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Get results from a query ID
-    # @param query_id [String] Query ID
+    # Get results from a log query started with Start Log Query. Poll until status is Complete.
+    # @param query_id [String] Query ID returned by Start Log Query
     # @param [Hash] opts the optional parameters
     # @return [LogsQueryResultResponse]
     def logs_get_logs_query_result(query_id, opts = {})
@@ -205,8 +205,8 @@ module Pingram
       data
     end
 
-    # Get results from a query ID
-    # @param query_id [String] Query ID
+    # Get results from a log query started with Start Log Query. Poll until status is Complete.
+    # @param query_id [String] Query ID returned by Start Log Query
     # @param [Hash] opts the optional parameters
     # @return [Array<(LogsQueryResultResponse, Integer, Hash)>] LogsQueryResultResponse data, response status code and response headers
     def logs_get_logs_query_result_with_http_info(query_id, opts = {})
@@ -257,7 +257,7 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Start a log query and return query ID for asynchronous log searching
+    # Start an asynchronous log search over a date range. Returns a `queryId`; poll with Get Log Query Results until status is Complete.
     # @param log_query_post_body [LogQueryPostBody] 
     # @param [Hash] opts the optional parameters
     # @return [LogsQueryResponse]
@@ -266,7 +266,7 @@ module Pingram
       data
     end
 
-    # Start a log query and return query ID for asynchronous log searching
+    # Start an asynchronous log search over a date range. Returns a &#x60;queryId&#x60;; poll with Get Log Query Results until status is Complete.
     # @param log_query_post_body [LogQueryPostBody] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(LogsQueryResponse, Integer, Hash)>] LogsQueryResponse data, response status code and response headers

data/lib/pingram/api/numbers_api.rb

@@ -19,7 +19,7 @@ module Pingram
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # List active phone numbers registered for the account
+    # List active phone numbers registered for the account.
     # @param [Hash] opts the optional parameters
     # @return [ListPhoneNumbersResponse]
     def numbers_list(opts = {})
@@ -27,7 +27,7 @@ module Pingram
       data
     end
 
-    # List active phone numbers registered for the account
+    # List active phone numbers registered for the account.
     # @param [Hash] opts the optional parameters
     # @return [Array<(ListPhoneNumbersResponse, Integer, Hash)>] ListPhoneNumbersResponse data, response status code and response headers
     def numbers_list_with_http_info(opts = {})
@@ -129,7 +129,7 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Purchase a phone number for the authenticated account, or reactivate a released number owned by the account (preserves original createdAt).
+    # Purchase a phone number for the authenticated account, or reactivate a released number owned by the account (preserves original createdAt). Pass `phoneNumber` in E.164 format (e.g. +15551234567).
     # @param order_phone_number_request [OrderPhoneNumberRequest] 
     # @param [Hash] opts the optional parameters
     # @return [OrderPhoneNumberResponse]
@@ -138,7 +138,7 @@ module Pingram
       data
     end
 
-    # Purchase a phone number for the authenticated account, or reactivate a released number owned by the account (preserves original createdAt).
+    # Purchase a phone number for the authenticated account, or reactivate a released number owned by the account (preserves original createdAt). Pass &#x60;phoneNumber&#x60; in E.164 format (e.g. +15551234567).
     # @param order_phone_number_request [OrderPhoneNumberRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(OrderPhoneNumberResponse, Integer, Hash)>] OrderPhoneNumberResponse data, response status code and response headers
@@ -256,7 +256,7 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Search for available phone numbers
+    # Search for available phone numbers to purchase. Requires `countryCode` (e.g. US, CA). Use before ordering a number.
     # @param country_code [String] ISO 3166-1 alpha-2 country code (e.g., US, CA)
     # @param [Hash] opts the optional parameters
     # @option opts [String] :features Comma-separated
@@ -268,7 +268,7 @@ module Pingram
       data
     end
 
-    # Search for available phone numbers
+    # Search for available phone numbers to purchase. Requires &#x60;countryCode&#x60; (e.g. US, CA). Use before ordering a number.
     # @param country_code [String] ISO 3166-1 alpha-2 country code (e.g., US, CA)
     # @param [Hash] opts the optional parameters
     # @option opts [String] :features Comma-separated