pingram 1.0.33 → 1.0.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40cafa3ce26c9605c65945ea74595afba080c5f42b7c2b36d53239af28b1f787
-  data.tar.gz: '0293e3b14abf37454a19a01b8bf4b99a81954d1ce25de5d74c2069a1051f5de2'
+  metadata.gz: 16e5866cf88c570d5219281eac2aa300e150afd378c6e7fe224340ee2f795807
+  data.tar.gz: ff9aac6a50b3b824c504f088b735fed9d322ba8678dfde2a6eaffcba1482ad32
 SHA512:
-  metadata.gz: a8ec073c59824edddeeb8513cc19aed931decce493f68977dcde7a6e76d2b2e86830dad019cece0968c3d41f0b53cc2ed43f575b63a36f6c90ec99027ed4575d
-  data.tar.gz: 20c29536635b87114a1fd455fee66ecb1338b6c92fa2d5dedd9bd89cb0117afbc626be124cbd43db4acf45960edabb72d80f303567066ecc506b380f67d818de
+  metadata.gz: 2a42cfe7d24d7e446f0d7ce850399146ec36f17d40560c875079acb473914553bf237f36211a3de62c08b52d162964355a1cb31d593ae74379238151bc2d9248
+  data.tar.gz: ad4256a9220959dc81ad049a30b1207f8f3ca22e2b380dea9cf2a41a9918d22df0e075581987dadc3e7ae6cf31c04e49f1a070ddd97b2c5de5e9a3d2091b910f

data/Gemfile.lock

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

data/lib/pingram/api/account_api.rb

@@ -250,20 +250,22 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Get historical usage for the authenticated account over a date range.
+    # Get historical usage for the authenticated account over a date range, summed by UTC calendar month or billing cycle from daily counts.
     # @param start_date [String] Start date (YYYY-MM-DD) for the range
     # @param end_date [String] End date (YYYY-MM-DD) for the range
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :group_by calendar (UTC months, default) or billing (account billing cycles)
     # @return [GetUsageHistoryResponse]
     def account_get_usage_history(start_date, end_date, opts = {})
       data, _status_code, _headers = account_get_usage_history_with_http_info(start_date, end_date, opts)
       data
     end
 
-    # Get historical usage for the authenticated account over a date range.
+    # Get historical usage for the authenticated account over a date range, summed by UTC calendar month or billing cycle from daily counts.
     # @param start_date [String] Start date (YYYY-MM-DD) for the range
     # @param end_date [String] End date (YYYY-MM-DD) for the range
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :group_by calendar (UTC months, default) or billing (account billing cycles)
     # @return [Array<(GetUsageHistoryResponse, Integer, Hash)>] GetUsageHistoryResponse data, response status code and response headers
     def account_get_usage_history_with_http_info(start_date, end_date, opts = {})
       if @api_client.config.debugging
@@ -284,6 +286,7 @@ module Pingram
       query_params = opts[:query_params] || {}
       query_params[:'startDate'] = start_date
       query_params[:'endDate'] = end_date
+      query_params[:'groupBy'] = opts[:'group_by'] if !opts[:'group_by'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/pingram/api/user_api.rb

@@ -74,122 +74,6 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Get in-app notifications for a user
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :before Timestamp or ISO date to fetch notifications before
-    # @option opts [Float] :count Number of notifications to return (default 10)
-    # @return [GetInappNotificationsResponse]
-    def user_get_in_app_notifications(opts = {})
-      data, _status_code, _headers = user_get_in_app_notifications_with_http_info(opts)
-      data
-    end
-
-    # Get in-app notifications for a user
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :before Timestamp or ISO date to fetch notifications before
-    # @option opts [Float] :count Number of notifications to return (default 10)
-    # @return [Array<(GetInappNotificationsResponse, Integer, Hash)>] GetInappNotificationsResponse data, response status code and response headers
-    def user_get_in_app_notifications_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: UserApi.user_get_in_app_notifications ...'
-      end
-      # resource path
-      local_var_path = '/user/inapp'
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
-      query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
-
-      # 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] || 'GetInappNotificationsResponse'
-
-      # 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 => :"UserApi.user_get_in_app_notifications",
-        :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(:GET, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: UserApi#user_get_in_app_notifications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Get the count of unread in-app notifications for a user
-    # @param [Hash] opts the optional parameters
-    # @return [InappUnreadCountResponse]
-    def user_get_in_app_unread_count(opts = {})
-      data, _status_code, _headers = user_get_in_app_unread_count_with_http_info(opts)
-      data
-    end
-
-    # Get the count of unread in-app notifications for a user
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(InappUnreadCountResponse, Integer, Hash)>] InappUnreadCountResponse data, response status code and response headers
-    def user_get_in_app_unread_count_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: UserApi.user_get_in_app_unread_count ...'
-      end
-      # resource path
-      local_var_path = '/user/inapp/unread'
-
-      # 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] || 'InappUnreadCountResponse'
-
-      # 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 => :"UserApi.user_get_in_app_unread_count",
-        :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(:GET, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: UserApi#user_get_in_app_unread_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Get a user by ID. All users exist implicitly, returns basic user object if not found in DB.
     # @param user_id [String] User ID
     # @param [Hash] opts the optional parameters
@@ -322,137 +206,5 @@ module Pingram
       end
       return data, status_code, headers
     end
-
-    # Mark in-app web notifications as seen/read for a user
-    # @param in_app_notification_unread_clear_request [InAppNotificationUnreadClearRequest] 
-    # @param [Hash] opts the optional parameters
-    # @return [SuccessResponse]
-    def user_mark_in_app_notifications_as_seen(in_app_notification_unread_clear_request, opts = {})
-      data, _status_code, _headers = user_mark_in_app_notifications_as_seen_with_http_info(in_app_notification_unread_clear_request, opts)
-      data
-    end
-
-    # Mark in-app web notifications as seen/read for a user
-    # @param in_app_notification_unread_clear_request [InAppNotificationUnreadClearRequest] 
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(SuccessResponse, Integer, Hash)>] SuccessResponse data, response status code and response headers
-    def user_mark_in_app_notifications_as_seen_with_http_info(in_app_notification_unread_clear_request, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: UserApi.user_mark_in_app_notifications_as_seen ...'
-      end
-      # verify the required parameter 'in_app_notification_unread_clear_request' is set
-      if @api_client.config.client_side_validation && in_app_notification_unread_clear_request.nil?
-        fail ArgumentError, "Missing the required parameter 'in_app_notification_unread_clear_request' when calling UserApi.user_mark_in_app_notifications_as_seen"
-      end
-      # resource path
-      local_var_path = '/user/inapp/unread'
-
-      # 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']
-      # HTTP header 'Content-Type'
-      content_type = @api_client.select_header_content_type(['application/json'])
-      if !content_type.nil?
-          header_params['Content-Type'] = content_type
-      end
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(in_app_notification_unread_clear_request)
-
-      # 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 => :"UserApi.user_mark_in_app_notifications_as_seen",
-        :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(:PATCH, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: UserApi#user_mark_in_app_notifications_as_seen\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Update in-app web notification status (opened, archived, clicked, etc.)
-    # @param in_app_notification_patch_request [InAppNotificationPatchRequest] 
-    # @param [Hash] opts the optional parameters
-    # @return [SuccessResponse]
-    def user_update_in_app_notification_status(in_app_notification_patch_request, opts = {})
-      data, _status_code, _headers = user_update_in_app_notification_status_with_http_info(in_app_notification_patch_request, opts)
-      data
-    end
-
-    # Update in-app web notification status (opened, archived, clicked, etc.)
-    # @param in_app_notification_patch_request [InAppNotificationPatchRequest] 
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(SuccessResponse, Integer, Hash)>] SuccessResponse data, response status code and response headers
-    def user_update_in_app_notification_status_with_http_info(in_app_notification_patch_request, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: UserApi.user_update_in_app_notification_status ...'
-      end
-      # verify the required parameter 'in_app_notification_patch_request' is set
-      if @api_client.config.client_side_validation && in_app_notification_patch_request.nil?
-        fail ArgumentError, "Missing the required parameter 'in_app_notification_patch_request' when calling UserApi.user_update_in_app_notification_status"
-      end
-      # resource path
-      local_var_path = '/user/inapp'
-
-      # 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']
-      # HTTP header 'Content-Type'
-      content_type = @api_client.select_header_content_type(['application/json'])
-      if !content_type.nil?
-          header_params['Content-Type'] = content_type
-      end
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(in_app_notification_patch_request)
-
-      # 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 => :"UserApi.user_update_in_app_notification_status",
-        :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(:PATCH, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: UserApi#user_update_in_app_notification_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
   end
 end

data/lib/pingram/api/webhooks_api.rb

@@ -19,7 +19,7 @@ module Pingram
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Create a webhook.
+    # 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 http or https and should return 2xx.
     # @param webhook_endpoint_upsert_request [WebhookEndpointUpsertRequest] 
     # @param [Hash] opts the optional parameters
     # @return [WebhookEndpoint]
@@ -28,7 +28,7 @@ module Pingram
       data
     end
 
-    # Create a webhook.
+    # 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 http or https and should return 2xx.
     # @param webhook_endpoint_upsert_request [WebhookEndpointUpsertRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(WebhookEndpoint, Integer, Hash)>] WebhookEndpoint data, response status code and response headers
@@ -85,8 +85,8 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Delete a webhook.
-    # @param endpoint_id [String] Webhook endpoint id
+    # Delete one webhook endpoint by id from list or create. That URL stops receiving its events. Other endpoints on the account are left as they are.
+    # @param endpoint_id [String] Id of the webhook endpoint, from list or create.
     # @param [Hash] opts the optional parameters
     # @return [nil]
     def webhooks_delete_webhook(endpoint_id, opts = {})
@@ -94,8 +94,8 @@ module Pingram
       nil
     end
 
-    # Delete a webhook.
-    # @param endpoint_id [String] Webhook endpoint id
+    # Delete one webhook endpoint by id from list or create. That URL stops receiving its events. Other endpoints on the account are left as they are.
+    # @param endpoint_id [String] Id of the webhook endpoint, from list or create.
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def webhooks_delete_webhook_with_http_info(endpoint_id, opts = {})
@@ -146,7 +146,7 @@ module Pingram
       return data, status_code, headers
     end
 
-    # List webhooks for the current account.
+    # List webhook endpoints on the current account, including each id, URL, subscribed events, and signing secret. Use the id with update or delete.
     # @param [Hash] opts the optional parameters
     # @return [WebhookEndpointsResponse]
     def webhooks_list_webhooks(opts = {})
@@ -154,7 +154,7 @@ module Pingram
       data
     end
 
-    # List webhooks for the current account.
+    # List webhook endpoints on the current account, including each id, URL, subscribed events, and signing secret. Use the id with update or delete.
     # @param [Hash] opts the optional parameters
     # @return [Array<(WebhookEndpointsResponse, Integer, Hash)>] WebhookEndpointsResponse data, response status code and response headers
     def webhooks_list_webhooks_with_http_info(opts = {})
@@ -201,8 +201,8 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Update a webhook. The signing secret is preserved.
-    # @param endpoint_id [String] Webhook endpoint id
+    # 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 http or https.
+    # @param endpoint_id [String] Id of the webhook endpoint, from list or create.
     # @param webhook_endpoint_upsert_request [WebhookEndpointUpsertRequest] 
     # @param [Hash] opts the optional parameters
     # @return [WebhookEndpoint]
@@ -211,8 +211,8 @@ module Pingram
       data
     end
 
-    # Update a webhook. The signing secret is preserved.
-    # @param endpoint_id [String] Webhook endpoint id
+    # Replace one webhook endpoint&#39;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 http or https.
+    # @param endpoint_id [String] Id of the webhook endpoint, from list or create.
     # @param webhook_endpoint_upsert_request [WebhookEndpointUpsertRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(WebhookEndpoint, Integer, Hash)>] WebhookEndpoint data, response status code and response headers

data/lib/pingram/api_client.rb

@@ -32,7 +32,7 @@ module Pingram
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "pingram-ruby/1.0.33"
+      @user_agent = "pingram-ruby/1.0.35"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/pingram/models/create_account_request_plan.rb

@@ -125,7 +125,7 @@ module Pingram
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @tier.nil?
-      tier_validator = EnumAttributeValidator.new('String', ["budget_20", "budget_50", "budget_100", "budget_250", "budget_500", "budget_1000", "budget_2000", "budget_5000"])
+      tier_validator = EnumAttributeValidator.new('String', ["budget_20", "budget_50", "budget_100", "budget_250", "budget_500", "budget_1000"])
       return false unless tier_validator.valid?(@tier)
       return false if @source_billing_account_id.nil?
       true
@@ -134,7 +134,7 @@ module Pingram
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] tier Object to be assigned
     def tier=(tier)
-      validator = EnumAttributeValidator.new('String', ["budget_20", "budget_50", "budget_100", "budget_250", "budget_500", "budget_1000", "budget_2000", "budget_5000"])
+      validator = EnumAttributeValidator.new('String', ["budget_20", "budget_50", "budget_100", "budget_250", "budget_500", "budget_1000"])
       unless validator.valid?(tier)
         fail ArgumentError, "invalid value for \"tier\", must be one of #{validator.allowable_values}."
       end

data/lib/pingram/models/get_usage_history_query.rb

@@ -22,11 +22,15 @@ module Pingram
     # End date (YYYY-MM-DD) for the range
     attr_accessor :end_date
 
+    # calendar = UTC calendar months (YYYY-MM). billing = account billing cycles (YYYY-MM-DD period start). Defaults to calendar.
+    attr_accessor :group_by
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'start_date' => :'startDate',
-        :'end_date' => :'endDate'
+        :'end_date' => :'endDate',
+        :'group_by' => :'groupBy'
       }
     end
 
@@ -44,7 +48,8 @@ module Pingram
     def self.openapi_types
       {
         :'start_date' => :'String',
-        :'end_date' => :'String'
+        :'end_date' => :'String',
+        :'group_by' => :'String'
       }
     end
 
@@ -81,6 +86,10 @@ module Pingram
       else
         self.end_date = nil
       end
+
+      if attributes.key?(:'group_by')
+        self.group_by = attributes[:'group_by']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -134,7 +143,8 @@ module Pingram
       return true if self.equal?(o)
       self.class == o.class &&
           start_date == o.start_date &&
-          end_date == o.end_date
+          end_date == o.end_date &&
+          group_by == o.group_by
     end
 
     # @see the `==` method
@@ -146,7 +156,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [start_date, end_date].hash
+      [start_date, end_date, group_by].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/get_usage_history_response.rb

@@ -16,7 +16,7 @@ require 'time'
 module Pingram
   # Response for GET /account/usage/history
   class GetUsageHistoryResponse < ApiModelBase
-    # Array of usage items, one per month in the requested range
+    # Array of usage items, one per calendar month or billing cycle in the range
     attr_accessor :items
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/pingram/models/get_usage_history_response_items_inner.rb

@@ -16,7 +16,7 @@ require 'time'
 module Pingram
   # Single usage item in historical response
   class GetUsageHistoryResponseItemsInner < ApiModelBase
-    # Year-month (YYYY-MM) for this usage period
+    # YYYY-MM for calendar months, or YYYY-MM-DD billing-period start.
     attr_accessor :year_month
 
     attr_accessor :counts