mailmock 1.1.1.pre.34026500447

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9da3cff83330b726409c09535c793fa74d67d20331b7c14aed7ae6dc487ce3eb
+  data.tar.gz: 81b774f98fb309819d689b44326d05be9976a9a98410bd0f7013d5e35ee19beb
+SHA512:
+  metadata.gz: 96b92a3956afa20381be75856dd151e3a842f9a02a8c5fa93f63d3ee3c08b1a424e780999ced4a4cdd42d48dbe1f4c418ab38156d231d030a6836564fa53efb5
+  data.tar.gz: d990c7c25dfb22efab40d5a2292a7e78be8e48aefeede4d138dbba1b72d65e2a44542a792e390b3c27e67ce19cfe4c759fd50d5d90089c8cf1f2260bd40cbd5b

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,111 @@
+# mailmock
+
+Mailmock - the Ruby gem for the Mailmock API
+
+Mailmock API
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 1.1.1.pre.34026500447
+- Generator version: 7.24.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build mailmock.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./mailmock-1.1.1.pre.34026500447.gem
+```
+
+(for development, run `gem install --dev ./mailmock-1.1.1.pre.34026500447.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'mailmock', '~> 1.1.1.pre.34026500447'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/descope/mailmock, then add the following in the Gemfile:
+
+    gem 'mailmock', :git => 'https://github.com/descope/mailmock.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'mailmock'
+
+api_instance = Mailmock::EmailApi.new
+email_create_request = Mailmock::EmailCreateRequest.new({user: 'user_example', provider: 'provider_example'}) # EmailCreateRequest | 
+
+begin
+  #Create a new mailbox
+  result = api_instance.email_create(email_create_request)
+  p result
+rescue Mailmock::ApiError => e
+  puts "Exception when calling EmailApi->email_create: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to */api/trpc*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*Mailmock::EmailApi* | [**email_create**](docs/EmailApi.md#email_create) | **PUT** /email | Create a new mailbox
+*Mailmock::EmailApi* | [**email_list**](docs/EmailApi.md#email_list) | **GET** /email | List mailbox(es)
+*Mailmock::EmailApi* | [**email_read**](docs/EmailApi.md#email_read) | **POST** /email | Fetch an email, optionally mark as read
+*Mailmock::SendApi* | [**send_aws**](docs/SendApi.md#send_aws) | **POST** /aws | 
+
+
+## Documentation for Models
+
+ - [Mailmock::EmailCreate200Response](docs/EmailCreate200Response.md)
+ - [Mailmock::EmailCreateRequest](docs/EmailCreateRequest.md)
+ - [Mailmock::EmailList200ResponseInner](docs/EmailList200ResponseInner.md)
+ - [Mailmock::EmailListDefaultResponse](docs/EmailListDefaultResponse.md)
+ - [Mailmock::EmailListDefaultResponseIssuesInner](docs/EmailListDefaultResponseIssuesInner.md)
+ - [Mailmock::EmailRead200Response](docs/EmailRead200Response.md)
+ - [Mailmock::EmailRead200ResponseHeadersInner](docs/EmailRead200ResponseHeadersInner.md)
+ - [Mailmock::EmailReadRequest](docs/EmailReadRequest.md)
+ - [Mailmock::SendAws200Response](docs/SendAws200Response.md)
+ - [Mailmock::SendAwsRequest](docs/SendAwsRequest.md)
+ - [Mailmock::SendAwsRequestMail](docs/SendAwsRequestMail.md)
+ - [Mailmock::SendAwsRequestMailCommonHeaders](docs/SendAwsRequestMailCommonHeaders.md)
+ - [Mailmock::SendAwsRequestReceipt](docs/SendAwsRequestReceipt.md)
+ - [Mailmock::SendAwsRequestReceiptAction](docs/SendAwsRequestReceiptAction.md)
+ - [Mailmock::SendAwsRequestReceiptSpamVerdict](docs/SendAwsRequestReceiptSpamVerdict.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### Authorization
+
+- **Type**: Bearer authentication
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/EmailApi.md

@@ -0,0 +1,202 @@
+# Mailmock::EmailApi
+
+All URIs are relative to */api/trpc*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**email_create**](EmailApi.md#email_create) | **PUT** /email | Create a new mailbox |
+| [**email_list**](EmailApi.md#email_list) | **GET** /email | List mailbox(es) |
+| [**email_read**](EmailApi.md#email_read) | **POST** /email | Fetch an email, optionally mark as read |
+
+
+## email_create
+
+> <EmailCreate200Response> email_create(email_create_request)
+
+Create a new mailbox
+
+### Examples
+
+```ruby
+require 'time'
+require 'mailmock'
+
+api_instance = Mailmock::EmailApi.new
+email_create_request = Mailmock::EmailCreateRequest.new({user: 'user_example', provider: 'provider_example'}) # EmailCreateRequest | 
+
+begin
+  # Create a new mailbox
+  result = api_instance.email_create(email_create_request)
+  p result
+rescue Mailmock::ApiError => e
+  puts "Error when calling EmailApi->email_create: #{e}"
+end
+```
+
+#### Using the email_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmailCreate200Response>, Integer, Hash)> email_create_with_http_info(email_create_request)
+
+```ruby
+begin
+  # Create a new mailbox
+  data, status_code, headers = api_instance.email_create_with_http_info(email_create_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmailCreate200Response>
+rescue Mailmock::ApiError => e
+  puts "Error when calling EmailApi->email_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email_create_request** | [**EmailCreateRequest**](EmailCreateRequest.md) |  |  |
+
+### Return type
+
+[**EmailCreate200Response**](EmailCreate200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## email_list
+
+> <Array<EmailList200ResponseInner>> email_list(opts)
+
+List mailbox(es)
+
+### Examples
+
+```ruby
+require 'time'
+require 'mailmock'
+
+api_instance = Mailmock::EmailApi.new
+opts = {
+  user: 'user_example', # String | 
+  mailbox: 'mailbox_example', # String | 
+  unread: 'true' # String | 
+}
+
+begin
+  # List mailbox(es)
+  result = api_instance.email_list(opts)
+  p result
+rescue Mailmock::ApiError => e
+  puts "Error when calling EmailApi->email_list: #{e}"
+end
+```
+
+#### Using the email_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<EmailList200ResponseInner>>, Integer, Hash)> email_list_with_http_info(opts)
+
+```ruby
+begin
+  # List mailbox(es)
+  data, status_code, headers = api_instance.email_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<EmailList200ResponseInner>>
+rescue Mailmock::ApiError => e
+  puts "Error when calling EmailApi->email_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user** | **String** |  | [optional] |
+| **mailbox** | **String** |  | [optional] |
+| **unread** | **String** |  | [optional] |
+
+### Return type
+
+[**Array&lt;EmailList200ResponseInner&gt;**](EmailList200ResponseInner.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## email_read
+
+> <EmailRead200Response> email_read(email_read_request)
+
+Fetch an email, optionally mark as read
+
+### Examples
+
+```ruby
+require 'time'
+require 'mailmock'
+
+api_instance = Mailmock::EmailApi.new
+email_read_request = Mailmock::EmailReadRequest.new({message_id: 'message_id_example'}) # EmailReadRequest | 
+
+begin
+  # Fetch an email, optionally mark as read
+  result = api_instance.email_read(email_read_request)
+  p result
+rescue Mailmock::ApiError => e
+  puts "Error when calling EmailApi->email_read: #{e}"
+end
+```
+
+#### Using the email_read_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmailRead200Response>, Integer, Hash)> email_read_with_http_info(email_read_request)
+
+```ruby
+begin
+  # Fetch an email, optionally mark as read
+  data, status_code, headers = api_instance.email_read_with_http_info(email_read_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmailRead200Response>
+rescue Mailmock::ApiError => e
+  puts "Error when calling EmailApi->email_read_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email_read_request** | [**EmailReadRequest**](EmailReadRequest.md) |  |  |
+
+### Return type
+
+[**EmailRead200Response**](EmailRead200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/EmailCreate200Response.md

@@ -0,0 +1,20 @@
+# Mailmock::EmailCreate200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mailbox** | **String** |  |  |
+| **email** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'mailmock'
+
+instance = Mailmock::EmailCreate200Response.new(
+  mailbox: null,
+  email: null
+)
+```
+

data/docs/EmailCreateRequest.md

@@ -0,0 +1,20 @@
+# Mailmock::EmailCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user** | **String** |  |  |
+| **provider** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'mailmock'
+
+instance = Mailmock::EmailCreateRequest.new(
+  user: null,
+  provider: null
+)
+```
+

data/docs/EmailList200ResponseInner.md

@@ -0,0 +1,26 @@
+# Mailmock::EmailList200ResponseInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user** | **String** |  |  |
+| **mailbox** | **String** |  |  |
+| **message_id** | **String** |  |  |
+| **received** | **Float** |  |  |
+| **unread** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'mailmock'
+
+instance = Mailmock::EmailList200ResponseInner.new(
+  user: null,
+  mailbox: null,
+  message_id: null,
+  received: null,
+  unread: null
+)
+```
+

data/docs/EmailListDefaultResponse.md

@@ -0,0 +1,22 @@
+# Mailmock::EmailListDefaultResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  |  |
+| **code** | **String** |  |  |
+| **issues** | [**Array<EmailListDefaultResponseIssuesInner>**](EmailListDefaultResponseIssuesInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mailmock'
+
+instance = Mailmock::EmailListDefaultResponse.new(
+  message: null,
+  code: null,
+  issues: null
+)
+```
+

data/docs/EmailListDefaultResponseIssuesInner.md

@@ -0,0 +1,18 @@
+# Mailmock::EmailListDefaultResponseIssuesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'mailmock'
+
+instance = Mailmock::EmailListDefaultResponseIssuesInner.new(
+  message: null
+)
+```
+

data/docs/EmailRead200Response.md

@@ -0,0 +1,36 @@
+# Mailmock::EmailRead200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **from** | **Array<String>** |  |  |
+| **to** | **Array<String>** |  |  |
+| **subject** | **String** |  |  |
+| **headers** | [**Array<EmailRead200ResponseHeadersInner>**](EmailRead200ResponseHeadersInner.md) |  |  |
+| **text** | **String** |  |  |
+| **html** | **String** |  | [optional] |
+| **timestamp** | **Time** |  |  |
+| **unread** | **Boolean** |  |  |
+| **ttl** | **Float** |  |  |
+| **error** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mailmock'
+
+instance = Mailmock::EmailRead200Response.new(
+  from: null,
+  to: null,
+  subject: null,
+  headers: null,
+  text: null,
+  html: null,
+  timestamp: null,
+  unread: null,
+  ttl: null,
+  error: null
+)
+```
+

data/docs/EmailRead200ResponseHeadersInner.md

@@ -0,0 +1,20 @@
+# Mailmock::EmailRead200ResponseHeadersInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **value** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'mailmock'
+
+instance = Mailmock::EmailRead200ResponseHeadersInner.new(
+  name: null,
+  value: null
+)
+```
+

data/docs/EmailReadRequest.md

@@ -0,0 +1,20 @@
+# Mailmock::EmailReadRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message_id** | **String** |  |  |
+| **mark_as_read** | **Boolean** |  | [optional][default to true] |
+
+## Example
+
+```ruby
+require 'mailmock'
+
+instance = Mailmock::EmailReadRequest.new(
+  message_id: null,
+  mark_as_read: null
+)
+```
+

data/docs/SendApi.md

@@ -0,0 +1,70 @@
+# Mailmock::SendApi
+
+All URIs are relative to */api/trpc*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**send_aws**](SendApi.md#send_aws) | **POST** /aws |  |
+
+
+## send_aws
+
+> <SendAws200Response> send_aws(send_aws_request)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'mailmock'
+
+api_instance = Mailmock::SendApi.new
+send_aws_request = Mailmock::SendAwsRequest.new({notification_type: 'notification_type_example', mail: Mailmock::SendAwsRequestMail.new({timestamp: Time.now, source: 'source_example', message_id: 'message_id_example', destination: ['destination_example'], headers_truncated: false, headers: [Mailmock::EmailRead200ResponseHeadersInner.new({name: 'name_example', value: 'value_example'})], common_headers: Mailmock::SendAwsRequestMailCommonHeaders.new({return_path: 'return_path_example', from: ['from_example'], date: 'date_example', to: ['to_example'], message_id: 'message_id_example', subject: 'subject_example'})}), receipt: Mailmock::SendAwsRequestReceipt.new({timestamp: Time.now, processing_time_millis: 3.56, recipients: ['recipients_example'], spam_verdict: Mailmock::SendAwsRequestReceiptSpamVerdict.new({status: 'status_example'}), virus_verdict: Mailmock::SendAwsRequestReceiptSpamVerdict.new({status: 'status_example'}), spf_verdict: , dkim_verdict: , dmarc_verdict: , action: Mailmock::SendAwsRequestReceiptAction.new({type: 'type_example', topic_arn: 'topic_arn_example', encoding: 'encoding_example'})}), content: 'content_example'}) # SendAwsRequest | 
+
+begin
+  
+  result = api_instance.send_aws(send_aws_request)
+  p result
+rescue Mailmock::ApiError => e
+  puts "Error when calling SendApi->send_aws: #{e}"
+end
+```
+
+#### Using the send_aws_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SendAws200Response>, Integer, Hash)> send_aws_with_http_info(send_aws_request)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.send_aws_with_http_info(send_aws_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SendAws200Response>
+rescue Mailmock::ApiError => e
+  puts "Error when calling SendApi->send_aws_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **send_aws_request** | [**SendAwsRequest**](SendAwsRequest.md) |  |  |
+
+### Return type
+
+[**SendAws200Response**](SendAws200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/SendAws200Response.md

@@ -0,0 +1,24 @@
+# Mailmock::SendAws200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user** | **String** |  |  |
+| **mailbox** | **String** |  |  |
+| **message_id** | **String** |  |  |
+| **ttl** | **Float** |  |  |
+
+## Example
+
+```ruby
+require 'mailmock'
+
+instance = Mailmock::SendAws200Response.new(
+  user: null,
+  mailbox: null,
+  message_id: null,
+  ttl: null
+)
+```
+

data/docs/SendAwsRequest.md

@@ -0,0 +1,24 @@
+# Mailmock::SendAwsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **notification_type** | **String** |  |  |
+| **mail** | [**SendAwsRequestMail**](SendAwsRequestMail.md) |  |  |
+| **receipt** | [**SendAwsRequestReceipt**](SendAwsRequestReceipt.md) |  |  |
+| **content** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'mailmock'
+
+instance = Mailmock::SendAwsRequest.new(
+  notification_type: null,
+  mail: null,
+  receipt: null,
+  content: null
+)
+```
+

data/docs/SendAwsRequestMail.md

@@ -0,0 +1,30 @@
+# Mailmock::SendAwsRequestMail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **timestamp** | **Time** |  |  |
+| **source** | **String** |  |  |
+| **message_id** | **String** |  |  |
+| **destination** | **Array<String>** |  |  |
+| **headers_truncated** | **Boolean** |  |  |
+| **headers** | [**Array<EmailRead200ResponseHeadersInner>**](EmailRead200ResponseHeadersInner.md) |  |  |
+| **common_headers** | [**SendAwsRequestMailCommonHeaders**](SendAwsRequestMailCommonHeaders.md) |  |  |
+
+## Example
+
+```ruby
+require 'mailmock'
+
+instance = Mailmock::SendAwsRequestMail.new(
+  timestamp: null,
+  source: null,
+  message_id: null,
+  destination: null,
+  headers_truncated: null,
+  headers: null,
+  common_headers: null
+)
+```
+