15.17.41 - add-ruby-docs

Author: mailslurp-sdk-bot

.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

.openapi-generator/VERSION

@@ -0,0 +1 @@
+4.3.1

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2024 MailSlurp Email API (Provided by Pettman OÜ, Estonia)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,158 @@
+# MailSlurp GraphQL Email API
+
+MailSlurp has a powerful free GraphQL email API that lets you fetch and read emails with GraphQL in React, Apollo, iOS, Android or server to server. You can create disposable test email accounts on demand or permanent custom domains. Send and receive emails and attachments from any client that uses GraphQL.
+
+If you are unfamiliar with GraphQL don't worry -  MailSlurp has a traditional [REST API](https://docs.mailslurp.com/api/) and [compiled SDK Clients](https://www.mailslurp.com/developers/) in many languages.
+
+## Quick links 
+- API server root is [https://graph.mailslurp.com/](https://graph.mailslurp.com/)
+- See the Github for [graphql schema definitions](https://github.com/mailslurp/mailslurp-client-graphql/blob/master/mailslurp/)
+- Go to the [MailSlurp GraphQL Playground](https://graphql.mailslurp.com) to explore yourself
+- Read the [graphQL getting started guide](https://www.mailslurp.com/guides/graphql-email-api/) for more help
+
+## Getting started
+MailSlurp's API is free but requires an API_KEY. [Obtain an API_KEY](https://app.mailslurp.com) at app.mailslurp.com first. **Include you api key in an `x-api-key` header** to authenticate you requests.
+
+### HTTP requests
+You can query the GraphQL api using any client. Here is an example using Curl in a terminal:
+
+```bash
+curl -lX POST https://graphql.mailslurp.com -H 'x-api-key:YOUR_API_KEY' -H "Content-Type: application/json" -d '{ "query": "{ inboxes { totalElements } }"}'
+```
+
+For simpler usage please see the Javascript examples.
+
+### Javascript usage
+Add the `graphql-request` library to your node project. 
+
+```bash
+npm install --save graphql-request
+```
+
+Create a client using the `https://graphql.mailslurp.com` root endpoint and pass your api key as a header. 
+
+```javascript
+import {GraphQLClient} from "graphql-request";
+
+export function getClient(apiKey) {
+  if (!apiKey) {
+    throw "Please set missing API_KEY"
+  }
+  // create a new graphql-request client using the MailSlurp graphql endpoint
+  // and passing a headers map including your MailSlurp API Key using "x-api-key" header
+  return new GraphQLClient('https://graphql.mailslurp.com', {
+    headers: {
+      'x-api-key': apiKey,
+    },
+  });
+}
+```
+
+## Create email inbox
+Using the client function we created above we can create a new email address using the `createInbox` mutation.
+
+Note: the examples that follow use the AVA test framework to demonstrate usage - you can use any frameworks you wish with GraphQL.
+
+```javascript
+import test from 'ava';
+import {gql} from "graphql-request";
+import {getClient} from "./index.mjs";
+
+const apiKey = process.env.API_KEY;
+
+test('can create inbox', async t => {
+    const {createInbox} = await getClient(apiKey).request(gql`
+        mutation {
+            createInbox {
+                id
+                emailAddress
+            }
+        }
+    `);
+    t.is(!!createInbox.id, true);
+    t.is(createInbox.emailAddress.indexOf('@mailslurp') > -1, true);
+});
+```
+
+## Send email in GraphQL
+
+Use the `sendEmail` mutation to send a real email from your inbox.
+
+```javascript
+test('can send an email', async t => {
+    // create an inbox
+    const {createInbox} = await getClient(apiKey).request(gql`
+        mutation {
+            createInbox {
+                id
+                emailAddress
+            }
+        }
+    `);
+    // send an email using mutation
+    const {sendEmail} = await getClient(apiKey).request(gql`
+        mutation {
+            sendEmail(fromInboxId: "${createInbox.id}", to: ["${createInbox.emailAddress}"], subject: "Test subject") {
+                from
+                to
+                subject
+            }
+        }
+    `);
+    t.is(sendEmail.from, createInbox.emailAddress)
+    t.is(sendEmail.subject, "Test subject")
+    t.is(sendEmail.to.indexOf(createInbox.emailAddress) > -1, true)
+});
+```
+
+## Receive and read email using GraphQL
+You can query emails that you know already exist using the `email` and `emails` queries. To block until an expected email either arrives or is found in an inbox use the `waitForX` queries:
+
+```javascript
+test('can send an email and receive the contents', async t => {
+    // create an inbox
+    const {createInbox} = await getClient(apiKey).request(gql`
+        mutation {
+            createInbox {
+                id
+                emailAddress
+            }
+        }
+    `);
+    // send an email using mutation
+    const {sendEmail} = await getClient(apiKey).request(gql`
+        mutation {
+            sendEmail(fromInboxId: "${createInbox.id}", to: ["${createInbox.emailAddress}"], subject: "Test subject", body: "Hello") {
+                from
+                to
+                subject
+            }
+        }
+    `);
+
+    // wait for the email to arrive
+    const {waitForLatestEmail} = await getClient(apiKey).request(gql`
+        query {
+            waitForLatestEmail(inboxId: "${createInbox.id}", timeout: 60000, unreadOnly: true) {
+                id
+                from
+                to
+                subject
+                body
+            }
+        }
+    `);
+    t.is(waitForLatestEmail.body.indexOf("Hello") > -1 , true)
+    t.is(waitForLatestEmail.subject.indexOf(sendEmail.subject) > -1 , true)
+    t.is(waitForLatestEmail.from.indexOf(sendEmail.from) > -1 , true)
+
+    // delete the email afterwards
+       const {deleteEmail} = await getClient(apiKey).request(gql`
+        mutation {
+            deleteEmail(emailId: "${waitForLatestEmail.id}")
+        }
+    `);
+    t.is(deleteEmail === "deleted", true)
+
+});
+```

SECURITY.md

@@ -0,0 +1,4 @@
+# Security
+
+This client calls the MailSlurp API endpoints. Connections should be made over secure HTTPS using your secure API Token. Do not share or commit the token if you can avoid doing so.
+To report security issues or talk with MailSlurp support please email [[email protected]](mailto:[email protected]).

SUPPORT.md

@@ -0,0 +1,4 @@
+# Support
+
+To report issues or talk with MailSlurp support please email [[email protected]](mailto:[email protected]).
+Alternatively you can visit our [support portal](https://www.mailslurp.com/support/) or open a ticket in the corresponding [Github repository](https://www.github.com/mailslurp).

docs/README.md

@@ -0,0 +1,5 @@
+# MailSlurp GraphQL Schemas
+
+Generated graphql schema for MailSlurp [email API](https://www.mailslurp.com/guides/graphql-email-api/).
+
+See [models and api documentation](https://github.com/mailslurp/mailslurp-client-graphql/blob/master/mailslurp/) for schema definitions.

mailslurp/api/alias_controller_api.graphql

@@ -0,0 +1,104 @@
+# MailSlurp API
+# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more.  ## Resources  - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository
+# The version of the OpenAPI document: 6.5.2
+# Contact: [email protected]
+# Generated by OpenAPI Generator: https://openapi-generator.tech
+#
+
+# package mailslurp
+
+# alias_controller_api
+
+type mutation {
+  # Create an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active.
+  # Email aliases use a MailSlurp randomly generated email address (or a custom domain inbox that you provide) to mask or proxy a real email address. Emails sent to the alias address will be forwarded to the hidden email address it was created for. If you want to send a reply use the threadId attached
+  # @param CreateAliasOptions createAliasOptions 
+  # @return [AliasDto]
+  CreateAlias(createAliasOptions: CreateAliasOptions): AliasDto
+
+  # Delete an email alias
+  # @param ID! aliasId 
+  # @return [null]
+  DeleteAlias(aliasId: ID!): null
+
+  # Reply to an email
+  # Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails `to`, `cc`, and `bcc`.
+  # @param ID! aliasId ID of the alias that email belongs to
+  # @param ID! emailId ID of the email that should be replied to
+  # @param ReplyToAliasEmailOptions replyToAliasEmailOptions 
+  # @return [SentEmailDto]
+  ReplyToAliasEmail(aliasId: ID!, emailId: ID!, replyToAliasEmailOptions: ReplyToAliasEmailOptions): SentEmailDto
+
+  # Send an email from an alias inbox
+  # Send an email from an alias. Replies to the email will be forwarded to the alias masked email address
+  # @param ID! aliasId 
+  # @param SendEmailOptions sendEmailOptions 
+  # @return [SentEmailDto]
+  SendAliasEmail(aliasId: ID!, sendEmailOptions: SendEmailOptions): SentEmailDto
+
+  # Update an email alias
+  # @param ID! aliasId 
+  # @param UpdateAliasOptions updateAliasOptions 
+  # @return [AliasDto]
+  UpdateAlias(aliasId: ID!, updateAliasOptions: UpdateAliasOptions): AliasDto
+
+}
+
+type query {
+  # Get an email alias
+  # Get an email alias by ID
+  # @param ID! aliasId 
+  # @return [AliasDto]
+  GetAlias(aliasId: ID!): AliasDto
+
+  # Get emails for an alias
+  # Get paginated emails for an alias by ID
+  # @param ID! aliasId 
+  # @param Int! page Optional page index alias email list pagination
+  # @param Int! size Optional page size alias email list pagination
+  # @param String! sort Optional createdAt sort direction ASC or DESC
+  # @param String! since Optional filter by sent after given date time
+  # @param String! before Optional filter by sent before given date time
+  # @return [PageEmailProjection]
+  GetAliasEmails(aliasId: ID!, page: Int!, size: Int!, sort: String!, since: String!, before: String!): PageEmailProjection
+
+  # Get threads created for an alias
+  # Returns threads created for an email alias in paginated form
+  # @param ID! aliasId 
+  # @param Int! page Optional page index in thread list pagination
+  # @param Int! size Optional page size in thread list pagination
+  # @param String! sort Optional createdAt sort direction ASC or DESC
+  # @param String! since Optional filter by sent after given date time
+  # @param String! before Optional filter by sent before given date time
+  # @return [PageThreadProjection]
+  GetAliasThreads(aliasId: ID!, page: Int!, size: Int!, sort: String!, since: String!, before: String!): PageThreadProjection
+
+  # Get all email aliases you have created
+  # Get all email aliases in paginated form
+  # @param String! search Optional search term
+  # @param Int! page Optional page index in alias list pagination
+  # @param Int! size Optional page size in alias list pagination
+  # @param String! sort Optional createdAt sort direction ASC or DESC
+  # @param String! since Filter by created at after the given timestamp
+  # @param String! before Filter by created at before the given timestamp
+  # @return [PageAlias]
+  GetAliases(search: String!, page: Int!, size: Int!, sort: String!, since: String!, before: String!): PageAlias
+
+  # Get a thread
+  # Return a thread associated with an alias
+  # @param ID! threadId 
+  # @return [ThreadProjection]
+  GetThread(threadId: ID!): ThreadProjection
+
+  # Get all threads
+  # Returns threads created for all aliases in paginated form
+  # @param Int! page Optional page index in thread list pagination
+  # @param Int! size Optional page size in thread list pagination
+  # @param String! sort Optional createdAt sort direction ASC or DESC
+  # @param String! since Optional filter by sent after given date time
+  # @param String! before Optional filter by sent before given date time
+  # @return [PageThreadProjection]
+  GetThreadsPaginated(page: Int!, size: Int!, sort: String!, since: String!, before: String!): PageThreadProjection
+
+}
+

mailslurp/api/attachment_controller_api.graphql

@@ -0,0 +1,84 @@
+# MailSlurp API
+# MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more.  ## Resources  - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository
+# The version of the OpenAPI document: 6.5.2
+# Contact: [email protected]
+# Generated by OpenAPI Generator: https://openapi-generator.tech
+#
+
+# package mailslurp
+
+# attachment_controller_api
+
+type mutation {
+  # Delete all attachments
+  # @return [null]
+  DeleteAllAttachments(): null
+
+  # Delete an attachment
+  # @param String! attachmentId ID of attachment
+  # @return [null]
+  DeleteAttachment(attachmentId: String!): null
+
+  # Upload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment.
+  # @param UploadAttachmentOptions uploadAttachmentOptions 
+  # @return [[String!]]
+  UploadAttachment(uploadAttachmentOptions: UploadAttachmentOptions): [String!]
+
+  # Upload an attachment for sending using file byte stream input octet stream. Returns an array whose first element is the ID of the uploaded attachment.
+  # @param String! contentType 
+  # @param String! contentType2 Optional contentType for file. For instance `application/pdf`
+  # @param String! contentId Optional content ID (CID) to save upload with
+  # @param String! filename Optional filename to save upload with
+  # @param String! filename2 
+  # @return [[String!]]
+  UploadAttachmentBytes(contentType: String!, contentType2: String!, contentId: String!, filename: String!, filename2: String!): [String!]
+
+  # Upload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment.
+  # @param String! contentId Optional content ID of attachment
+  # @param String! contentType Optional content type of attachment
+  # @param String! filename Optional name of file
+  # @param String! xFilename Optional content type header of attachment
+  # @param InlineObject inlineObject 
+  # @return [[String!]]
+  UploadMultipartForm(contentId: String!, contentType: String!, filename: String!, xFilename: String!, inlineObject: InlineObject): [String!]
+
+}
+
+type query {
+  # Get email attachment as base64 encoded string as alternative to binary responses. To read the content decode the Base64 encoded contents.
+  # Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses.
+  # @param String! attachmentId ID of attachment
+  # @return [DownloadAttachmentDto]
+  DownloadAttachmentAsBase64Encoded(attachmentId: String!): DownloadAttachmentDto
+
+  # Download attachments. Get email attachment bytes. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints.
+  # Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.
+  # @param String! attachmentId ID of attachment
+  # @return [String!]
+  DownloadAttachmentAsBytes(attachmentId: String!): String!
+
+  # Get an attachment entity
+  # @param String! attachmentId ID of attachment
+  # @return [AttachmentEntity]
+  GetAttachment(attachmentId: String!): AttachmentEntity
+
+  # Get email attachment metadata information
+  # Returns the metadata for an attachment. It is saved separately to the content of the attachment. Contains properties `name` and `content-type` and `content-length` in bytes for a given attachment.
+  # @param String! attachmentId ID of attachment
+  # @return [AttachmentMetaData]
+  GetAttachmentInfo(attachmentId: String!): AttachmentMetaData
+
+  # Get email attachments
+  # Get all attachments in paginated response. Each entity contains meta data for the attachment such as `name` and `content-type`. Use the `attachmentId` and the download endpoints to get the file contents.
+  # @param Int! page Optional page index for list pagination
+  # @param Int! size Optional page size for list pagination
+  # @param String! sort Optional createdAt sort direction ASC or DESC
+  # @param String! fileNameFilter Optional file name and content type search filter
+  # @param String! since Filter by created at after the given timestamp
+  # @param String! before Filter by created at before the given timestamp
+  # @param ID! inboxId Optional inboxId to filter attachments by
+  # @return [PageAttachmentEntity]
+  GetAttachments(page: Int!, size: Int!, sort: String!, fileNameFilter: String!, since: String!, before: String!, inboxId: ID!): PageAttachmentEntity
+
+}
+