pingram 1.0.31 → 1.0.33

data/lib/pingram/api/library_api.rb

@@ -0,0 +1,161 @@
+=begin
+#Pingram
+
+#Internal API for notification delivery and management
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'cgi'
+
+module Pingram
+  class LibraryApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create an upload slot in the account library. PUT the file to the returned uploadUrl with the same Content-Type, then use the returned url in emails and the editor.
+    # @param use_case [String] Library use-case
+    # @param create_library_request [CreateLibraryRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateLibraryResponse]
+    def library_create(use_case, create_library_request, opts = {})
+      data, _status_code, _headers = library_create_with_http_info(use_case, create_library_request, opts)
+      data
+    end
+
+    # Create an upload slot in the account library. PUT the file to the returned uploadUrl with the same Content-Type, then use the returned url in emails and the editor.
+    # @param use_case [String] Library use-case
+    # @param create_library_request [CreateLibraryRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateLibraryResponse, Integer, Hash)>] CreateLibraryResponse data, response status code and response headers
+    def library_create_with_http_info(use_case, create_library_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LibraryApi.library_create ...'
+      end
+      # verify the required parameter 'use_case' is set
+      if @api_client.config.client_side_validation && use_case.nil?
+        fail ArgumentError, "Missing the required parameter 'use_case' when calling LibraryApi.library_create"
+      end
+      # verify the required parameter 'create_library_request' is set
+      if @api_client.config.client_side_validation && create_library_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_library_request' when calling LibraryApi.library_create"
+      end
+      # resource path
+      local_var_path = '/library/{useCase}'.sub('{' + 'useCase' + '}', CGI.escape(use_case.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']
+      # 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(create_library_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateLibraryResponse'
+
+      # 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 => :"LibraryApi.library_create",
+        :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: LibraryApi#library_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List files in the account library for a use-case, newest first. Paginate with limit (default 50, max 100) and nextToken.
+    # @param use_case [String] Library use-case
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :limit Max items to return (default 50)
+    # @option opts [String] :next_token Pagination token
+    # @return [ListLibraryResponse]
+    def library_list(use_case, opts = {})
+      data, _status_code, _headers = library_list_with_http_info(use_case, opts)
+      data
+    end
+
+    # List files in the account library for a use-case, newest first. Paginate with limit (default 50, max 100) and nextToken.
+    # @param use_case [String] Library use-case
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :limit Max items to return (default 50)
+    # @option opts [String] :next_token Pagination token
+    # @return [Array<(ListLibraryResponse, Integer, Hash)>] ListLibraryResponse data, response status code and response headers
+    def library_list_with_http_info(use_case, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LibraryApi.library_list ...'
+      end
+      # verify the required parameter 'use_case' is set
+      if @api_client.config.client_side_validation && use_case.nil?
+        fail ArgumentError, "Missing the required parameter 'use_case' when calling LibraryApi.library_list"
+      end
+      # resource path
+      local_var_path = '/library/{useCase}'.sub('{' + 'useCase' + '}', CGI.escape(use_case.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'nextToken'] = opts[:'next_token'] if !opts[:'next_token'].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] || 'ListLibraryResponse'
+
+      # 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 => :"LibraryApi.library_list",
+        :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: LibraryApi#library_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/pingram/api/sub_notifications_api.rb

@@ -0,0 +1,167 @@
+=begin
+#Pingram
+
+#Internal API for notification delivery and management
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'cgi'
+
+module Pingram
+  class SubNotificationsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # This endpoint is no longer maintained and should not be used.
+    # @param notification_id [String] The notification ID
+    # @param sub_notification_id [String] The sub-notification ID
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def sub_notifications_delete_sub_notification(notification_id, sub_notification_id, opts = {})
+      sub_notifications_delete_sub_notification_with_http_info(notification_id, sub_notification_id, opts)
+      nil
+    end
+
+    # This endpoint is no longer maintained and should not be used.
+    # @param notification_id [String] The notification ID
+    # @param sub_notification_id [String] The sub-notification ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def sub_notifications_delete_sub_notification_with_http_info(notification_id, sub_notification_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SubNotificationsApi.sub_notifications_delete_sub_notification ...'
+      end
+      # verify the required parameter 'notification_id' is set
+      if @api_client.config.client_side_validation && notification_id.nil?
+        fail ArgumentError, "Missing the required parameter 'notification_id' when calling SubNotificationsApi.sub_notifications_delete_sub_notification"
+      end
+      # verify the required parameter 'sub_notification_id' is set
+      if @api_client.config.client_side_validation && sub_notification_id.nil?
+        fail ArgumentError, "Missing the required parameter 'sub_notification_id' when calling SubNotificationsApi.sub_notifications_delete_sub_notification"
+      end
+      # resource path
+      local_var_path = '/notifications/{notificationId}/subNotifications/{subNotificationId}'.sub('{' + 'notificationId' + '}', CGI.escape(notification_id.to_s)).sub('{' + 'subNotificationId' + '}', CGI.escape(sub_notification_id.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]
+
+      # 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 => :"SubNotificationsApi.sub_notifications_delete_sub_notification",
+        :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: SubNotificationsApi#sub_notifications_delete_sub_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # This endpoint is no longer maintained and should not be used.
+    # @param notification_id [String] The notification ID
+    # @param sub_notification_id [String] The sub-notification ID
+    # @param sub_notification_put_request [SubNotificationPUTRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [SubNotification]
+    def sub_notifications_put_sub_notification(notification_id, sub_notification_id, sub_notification_put_request, opts = {})
+      data, _status_code, _headers = sub_notifications_put_sub_notification_with_http_info(notification_id, sub_notification_id, sub_notification_put_request, opts)
+      data
+    end
+
+    # This endpoint is no longer maintained and should not be used.
+    # @param notification_id [String] The notification ID
+    # @param sub_notification_id [String] The sub-notification ID
+    # @param sub_notification_put_request [SubNotificationPUTRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SubNotification, Integer, Hash)>] SubNotification data, response status code and response headers
+    def sub_notifications_put_sub_notification_with_http_info(notification_id, sub_notification_id, sub_notification_put_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SubNotificationsApi.sub_notifications_put_sub_notification ...'
+      end
+      # verify the required parameter 'notification_id' is set
+      if @api_client.config.client_side_validation && notification_id.nil?
+        fail ArgumentError, "Missing the required parameter 'notification_id' when calling SubNotificationsApi.sub_notifications_put_sub_notification"
+      end
+      # verify the required parameter 'sub_notification_id' is set
+      if @api_client.config.client_side_validation && sub_notification_id.nil?
+        fail ArgumentError, "Missing the required parameter 'sub_notification_id' when calling SubNotificationsApi.sub_notifications_put_sub_notification"
+      end
+      # verify the required parameter 'sub_notification_put_request' is set
+      if @api_client.config.client_side_validation && sub_notification_put_request.nil?
+        fail ArgumentError, "Missing the required parameter 'sub_notification_put_request' when calling SubNotificationsApi.sub_notifications_put_sub_notification"
+      end
+      # resource path
+      local_var_path = '/notifications/{notificationId}/subNotifications/{subNotificationId}'.sub('{' + 'notificationId' + '}', CGI.escape(notification_id.to_s)).sub('{' + 'subNotificationId' + '}', CGI.escape(sub_notification_id.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']
+      # 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(sub_notification_put_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SubNotification'
+
+      # 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 => :"SubNotificationsApi.sub_notifications_put_sub_notification",
+        :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(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SubNotificationsApi#sub_notifications_put_sub_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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.31"
+      @user_agent = "pingram-ruby/1.0.33"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/pingram/client_wrapper.rb

@@ -14,6 +14,8 @@ require_relative 'api/accounts_api'
 
 require_relative 'api/addresses_api'
 
+require_relative 'api/broadcasts_api'
+
 require_relative 'api/components_api'
 
 require_relative 'api/default_api'
@@ -32,6 +34,8 @@ require_relative 'api/insights_api'
 
 require_relative 'api/keys_api'
 
+require_relative 'api/library_api'
+
 require_relative 'api/logs_api'
 
 require_relative 'api/members_api'
@@ -46,6 +50,8 @@ require_relative 'api/sender_api'
 
 require_relative 'api/sms_api'
 
+require_relative 'api/sub_notifications_api'
+
 require_relative 'api/templates_api'
 
 require_relative 'api/types_api'
@@ -92,6 +98,8 @@ module Pingram
 
       @addresses = Pingram::AddressesApi.new(@api_client)
 
+      @broadcasts = Pingram::BroadcastsApi.new(@api_client)
+
       @components = Pingram::ComponentsApi.new(@api_client)
 
       @default_api = Pingram::DefaultApi.new(@api_client)
@@ -110,6 +118,8 @@ module Pingram
 
       @keys = Pingram::KeysApi.new(@api_client)
 
+      @library = Pingram::LibraryApi.new(@api_client)
+
       @logs = Pingram::LogsApi.new(@api_client)
 
       @members = Pingram::MembersApi.new(@api_client)
@@ -124,6 +134,8 @@ module Pingram
 
       @sms = Pingram::SmsApi.new(@api_client)
 
+      @sub_notifications = Pingram::SubNotificationsApi.new(@api_client)
+
       @templates = Pingram::TemplatesApi.new(@api_client)
 
       @types = Pingram::TypesApi.new(@api_client)
@@ -157,6 +169,12 @@ module Pingram
     end
 
 
+    # @return [Pingram::BroadcastsApi]
+    def broadcasts
+      @broadcasts
+    end
+
+
     # @return [Pingram::ComponentsApi]
     def components
       @components
@@ -211,6 +229,12 @@ module Pingram
     end
 
 
+    # @return [Pingram::LibraryApi]
+    def library
+      @library
+    end
+
+
     # @return [Pingram::LogsApi]
     def logs
       @logs
@@ -253,6 +277,12 @@ module Pingram
     end
 
 
+    # @return [Pingram::SubNotificationsApi]
+    def sub_notifications
+      @sub_notifications
+    end
+
+
     # @return [Pingram::TemplatesApi]
     def templates
       @templates