mailslurp_client 12.2.0 → 12.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a427bb5e49835296ad621a84d617d327449fe99c38aa75413dd030973b5fb5d
-  data.tar.gz: 7c7d311d0f3cce375656e224c7e1bffc0a196ae654a08b6ef34994cc995471f3
+  metadata.gz: cedf655ad57b8f3a567ec5ee89707998e4ccec13a907595b45eec3380615b16a
+  data.tar.gz: 976d2acfbe552d9f7ece214e3cfc62531a298c8545b7d527fbf6c34854b5a4a7
 SHA512:
-  metadata.gz: 2ce2d37cd2a1fdcf6c1eb971269e8ba0e192cb11e352e9c7fcccc0524d61dfc5dac6e9a29118408e9024046b88b07c24672b3ace6c81223ab321f8495cb68836
-  data.tar.gz: acd8e736eedf69e94eb3d1323fa7fd32a187a9846db01bc3c3cc7418e9dd5468af2a13cca58f0160ea55a4752980d0a9fa461ba77a14a9c5755a4df9b0bea5db
+  metadata.gz: 7b82024c9486047471bd4b217ff3ecbef303bc1b023b4de4f2d6b7909446112acbe461307f257c860c57bf956c2f2c6c3b59635538d0ba5d2774b015432f2701
+  data.tar.gz: 52dd65dec093e4fce0902bb3b0172476e4e844f7fb1f6e43bae8f447a8c62cea3b0a5f7f2fcacf8f9768bcdfcc714921ec377f76655e1f2eb2103bfb9d1b14b5

data/lib/mailslurp_client/api/inbox_controller_api.rb

@@ -648,6 +648,7 @@ module MailSlurpClient
     # @param inbox_id [String] inboxId
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Optional page index in inbox sent email list pagination (default to 0)
+    # @option opts [String] :search_filter Optional sent email search
     # @option opts [Integer] :size Optional page size in inbox sent email list pagination (default to 20)
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
     # @return [PageSentEmailProjection]
@@ -661,6 +662,7 @@ module MailSlurpClient
     # @param inbox_id [String] inboxId
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Optional page index in inbox sent email list pagination
+    # @option opts [String] :search_filter Optional sent email search
     # @option opts [Integer] :size Optional page size in inbox sent email list pagination
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
     # @return [Array<(PageSentEmailProjection, Integer, Hash)>] PageSentEmailProjection data, response status code and response headers
@@ -682,6 +684,7 @@ module MailSlurpClient
       # query parameters
       query_params = opts[:query_params] || {}
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
       query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
       query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
 
@@ -844,6 +847,7 @@ module MailSlurpClient
     # List organization inboxes in paginated form. These are inboxes created with `allowTeamAccess` flag enabled. Organization inboxes are `readOnly` for non-admin users. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Optional page index in inbox list pagination (default to 0)
+    # @option opts [String] :search_filter Optional search filter
     # @option opts [Integer] :size Optional page size in inbox list pagination (default to 20)
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
     # @return [PageOrganizationInboxProjection]
@@ -856,6 +860,7 @@ module MailSlurpClient
     # List organization inboxes in paginated form. These are inboxes created with &#x60;allowTeamAccess&#x60; flag enabled. Organization inboxes are &#x60;readOnly&#x60; for non-admin users. The results are available on the &#x60;content&#x60; property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Optional page index in inbox list pagination
+    # @option opts [String] :search_filter Optional search filter
     # @option opts [Integer] :size Optional page size in inbox list pagination
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
     # @return [Array<(PageOrganizationInboxProjection, Integer, Hash)>] PageOrganizationInboxProjection data, response status code and response headers
@@ -873,6 +878,7 @@ module MailSlurpClient
       # query parameters
       query_params = opts[:query_params] || {}
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
       query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
       query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
 

data/lib/mailslurp_client/api/missed_email_controller_api.rb

@@ -22,6 +22,7 @@ module MailSlurpClient
     # Get all MissedEmails in paginated format
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Optional page index in inbox list pagination (default to 0)
+    # @option opts [String] :search_filter Optional search filter
     # @option opts [Integer] :size Optional page size in inbox list pagination (default to 20)
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
     # @return [PageMissedEmailProjection]
@@ -33,6 +34,7 @@ module MailSlurpClient
     # Get all MissedEmails in paginated format
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Optional page index in inbox list pagination
+    # @option opts [String] :search_filter Optional search filter
     # @option opts [Integer] :size Optional page size in inbox list pagination
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
     # @return [Array<(PageMissedEmailProjection, Integer, Hash)>] PageMissedEmailProjection data, response status code and response headers
@@ -50,6 +52,7 @@ module MailSlurpClient
       # query parameters
       query_params = opts[:query_params] || {}
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
       query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
       query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
 

data/lib/mailslurp_client/api/sent_emails_controller_api.rb

@@ -83,6 +83,7 @@ module MailSlurpClient
     # @param [Hash] opts the optional parameters
     # @option opts [String] :inbox_id Optional inboxId to filter sender of sent emails by
     # @option opts [Integer] :page Optional page index in inbox sent email list pagination (default to 0)
+    # @option opts [String] :search_filter Optional search filter
     # @option opts [Integer] :size Optional page size in inbox sent email list pagination (default to 20)
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
     # @return [PageSentEmailProjection]
@@ -95,6 +96,7 @@ module MailSlurpClient
     # @param [Hash] opts the optional parameters
     # @option opts [String] :inbox_id Optional inboxId to filter sender of sent emails by
     # @option opts [Integer] :page Optional page index in inbox sent email list pagination
+    # @option opts [String] :search_filter Optional search filter
     # @option opts [Integer] :size Optional page size in inbox sent email list pagination
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
     # @return [Array<(PageSentEmailProjection, Integer, Hash)>] PageSentEmailProjection data, response status code and response headers
@@ -113,6 +115,7 @@ module MailSlurpClient
       query_params = opts[:query_params] || {}
       query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
       query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
       query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
 
@@ -153,6 +156,7 @@ module MailSlurpClient
     # @param [Hash] opts the optional parameters
     # @option opts [String] :inbox_id Optional inboxId to filter sender of sent emails by
     # @option opts [Integer] :page Optional page index in inbox sent email list pagination (default to 0)
+    # @option opts [String] :search_filter Optional search filter
     # @option opts [Integer] :size Optional page size in inbox sent email list pagination (default to 20)
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
     # @return [PageSentEmailProjection]
@@ -165,6 +169,7 @@ module MailSlurpClient
     # @param [Hash] opts the optional parameters
     # @option opts [String] :inbox_id Optional inboxId to filter sender of sent emails by
     # @option opts [Integer] :page Optional page index in inbox sent email list pagination
+    # @option opts [String] :search_filter Optional search filter
     # @option opts [Integer] :size Optional page size in inbox sent email list pagination
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
     # @return [Array<(PageSentEmailProjection, Integer, Hash)>] PageSentEmailProjection data, response status code and response headers
@@ -183,6 +188,7 @@ module MailSlurpClient
       query_params = opts[:query_params] || {}
       query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
       query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
       query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
 

data/lib/mailslurp_client/api/webhook_controller_api.rb

@@ -156,6 +156,7 @@ module MailSlurpClient
     # Get results for all webhooks
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Optional page index in list pagination (default to 0)
+    # @option opts [String] :search_filter Optional search filter
     # @option opts [Integer] :size Optional page size in list pagination (default to 20)
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
     # @return [PageWebhookResult]
@@ -167,6 +168,7 @@ module MailSlurpClient
     # Get results for all webhooks
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Optional page index in list pagination
+    # @option opts [String] :search_filter Optional search filter
     # @option opts [Integer] :size Optional page size in list pagination
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
     # @return [Array<(PageWebhookResult, Integer, Hash)>] PageWebhookResult data, response status code and response headers
@@ -184,6 +186,7 @@ module MailSlurpClient
       # query parameters
       query_params = opts[:query_params] || {}
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
       query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
       query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
 
@@ -224,6 +227,7 @@ module MailSlurpClient
     # List webhooks in paginated form. Allows for page index, page size, and sort direction.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Optional page index in list pagination (default to 0)
+    # @option opts [String] :search_filter Optional search filter
     # @option opts [Integer] :size Optional page size in list pagination (default to 20)
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
     # @return [PageWebhookProjection]
@@ -236,6 +240,7 @@ module MailSlurpClient
     # List webhooks in paginated form. Allows for page index, page size, and sort direction.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Optional page index in list pagination
+    # @option opts [String] :search_filter Optional search filter
     # @option opts [Integer] :size Optional page size in list pagination
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
     # @return [Array<(PageWebhookProjection, Integer, Hash)>] PageWebhookProjection data, response status code and response headers
@@ -253,6 +258,7 @@ module MailSlurpClient
       # query parameters
       query_params = opts[:query_params] || {}
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
       query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
       query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
 
@@ -289,6 +295,82 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Get paginated webhooks for an Inbox
+    # @param inbox_id [String] inboxId
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Optional page index in list pagination (default to 0)
+    # @option opts [String] :search_filter Optional search filter
+    # @option opts [Integer] :size Optional page size in list pagination (default to 20)
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
+    # @return [PageWebhookProjection]
+    def get_inbox_webhooks_paginated(inbox_id, opts = {})
+      data, _status_code, _headers = get_inbox_webhooks_paginated_with_http_info(inbox_id, opts)
+      data
+    end
+
+    # Get paginated webhooks for an Inbox
+    # @param inbox_id [String] inboxId
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Optional page index in list pagination
+    # @option opts [String] :search_filter Optional search filter
+    # @option opts [Integer] :size Optional page size in list pagination
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
+    # @return [Array<(PageWebhookProjection, Integer, Hash)>] PageWebhookProjection data, response status code and response headers
+    def get_inbox_webhooks_paginated_with_http_info(inbox_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookControllerApi.get_inbox_webhooks_paginated ...'
+      end
+      # verify the required parameter 'inbox_id' is set
+      if @api_client.config.client_side_validation && inbox_id.nil?
+        fail ArgumentError, "Missing the required parameter 'inbox_id' when calling WebhookControllerApi.get_inbox_webhooks_paginated"
+      end
+      allowable_values = ["ASC", "DESC"]
+      if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
+        fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/inboxes/{inboxId}/webhooks/paginated'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
+      query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'PageWebhookProjection' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['API_KEY']
+
+      new_options = opts.merge(
+        :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: WebhookControllerApi#get_inbox_webhooks_paginated\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get test webhook payload example. Response content depends on eventName passed. Uses `EMAIL_RECEIVED` as default.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :event_name eventName
@@ -636,6 +718,7 @@ module MailSlurpClient
     # @param webhook_id [String] ID of webhook to get results for
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Optional page index in list pagination (default to 0)
+    # @option opts [String] :search_filter Optional search filter
     # @option opts [Integer] :size Optional page size in list pagination (default to 20)
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
     # @return [PageWebhookResult]
@@ -648,6 +731,7 @@ module MailSlurpClient
     # @param webhook_id [String] ID of webhook to get results for
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Optional page index in list pagination
+    # @option opts [String] :search_filter Optional search filter
     # @option opts [Integer] :size Optional page size in list pagination
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
     # @return [Array<(PageWebhookResult, Integer, Hash)>] PageWebhookResult data, response status code and response headers
@@ -669,6 +753,7 @@ module MailSlurpClient
       # query parameters
       query_params = opts[:query_params] || {}
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
       query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
       query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
 

data/lib/mailslurp_client/models/page_webhook_projection.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
-  # Paginated webhook entity. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.
   class PageWebhookProjection
     attr_accessor :content
 

data/lib/mailslurp_client/models/webhook_new_attachment_payload.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
-  # NEW_ATTACHMENT webhook payload
+  # NEW_ATTACHMENT webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is received by the inbox that your webhook is attached to that contains an attachment. You can use the attachmentId to download the attachment.
   class WebhookNewAttachmentPayload
     # ID of attachment. Use the `AttachmentController` to
     attr_accessor :attachment_id

data/lib/mailslurp_client/models/webhook_new_contact_payload.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
-  # NEW_CONTACT webhook payload
+  # NEW_CONTACT webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is received by the inbox that your webhook is attached to that contains a recipient that has not been saved as a contact.
   class WebhookNewContactPayload
     attr_accessor :company
 

data/lib/mailslurp_client/models/webhook_new_email_payload.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
-  # NEW_EMAIL webhook payload
+  # NEW_EMAIL webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is received by the inbox that your webhook is attached to. Use the email ID to fetch the full email body or attachments.
   class WebhookNewEmailPayload
     # List of attachment meta data objects if attachments present
     attr_accessor :attachment_meta_datas

data/lib/mailslurp_client/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.3.1
 =end
 
 module MailSlurpClient
-  VERSION = '12.2.0'
+  VERSION = '12.3.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailslurp_client
 version: !ruby/object:Gem::Version
-  version: 12.2.0
+  version: 12.3.2
 platform: ruby
 authors:
 - mailslurp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-18 00:00:00.000000000 Z
+date: 2021-06-22 00:00:00.000000000 Z
 dependencies: []
 description: Create emails addresses in Ruby then send and receive real emails and
   attachments. See https://www.mailslurp.com/docs/ruby/ for full Ruby documentation.