norbelys 0.1.0

data/docs/MessageAttachmentInput.md

@@ -0,0 +1,22 @@
+# Norbelys::MessageAttachmentInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **content_type** | **String** | MIME type; defaults to application/octet-stream. | [optional] |
+| **filename** | **String** | File name shown to the recipient. |  |
+| **content** | **String** | Base64-encoded file content. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::MessageAttachmentInput.new(
+  content_type: null,
+  filename: null,
+  content: null
+)
+```
+

data/docs/MessageAttachmentList.md

@@ -0,0 +1,22 @@
+# Norbelys::MessageAttachmentList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<MessageAttachment>**](MessageAttachment.md) | The attachment metadata. |  |
+| **has_more** | **Boolean** | Always false — attachments are returned in full. |  |
+| **object** | **Object** |  |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::MessageAttachmentList.new(
+  data: null,
+  has_more: null,
+  object: null
+)
+```
+

data/docs/MessageCreateParams.md

@@ -0,0 +1,44 @@
+# Norbelys::MessageCreateParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | **Hash<String, Object>** | Template variables merged over the person's fields at render time. | [optional] |
+| **from** | **String** | Who the message is sent from — a sender id, or any email address on a sending domain you've set up (a sender identity is created automatically on first use). |  |
+| **to** | **String** | Recipient email address. |  |
+| **to_name** | **String** | Recipient display name. | [optional] |
+| **sequence** | **String** | Id of a program to enroll the person into instead of sending now; the program then controls send timing. Required for a cold-email sender (those send on a paced schedule, not immediately). |  |
+| **attachments** | [**Array<MessageAttachmentInput>**](MessageAttachmentInput.md) | Files to attach (Base64-encoded). Up to 5 files, 7 MB decoded total. | [optional] |
+| **html** | **String** | Inline HTML body. | [optional] |
+| **subject** | **String** | Subject line for an inline send. | [optional] |
+| **text** | **String** | Inline plain-text body. | [optional] |
+| **track_clicks** | **Boolean** | Rewrite links to track clicks. | [optional] |
+| **track_opens** | **Boolean** | Track opens for this message. | [optional] |
+| **variant_id** | **String** | Id of a stored step variant to render as the template instead of inline content. | [optional] |
+| **in_reply_to** | **String** | Id of an inbound message to reply to; threads this send to that conversation. |  |
+| **test** | **Object** |  |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::MessageCreateParams.new(
+  data: null,
+  from: null,
+  to: null,
+  to_name: null,
+  sequence: null,
+  attachments: null,
+  html: null,
+  subject: null,
+  text: null,
+  track_clicks: null,
+  track_opens: null,
+  variant_id: null,
+  in_reply_to: null,
+  test: null
+)
+```
+

data/docs/MessageEnrollParams.md

@@ -0,0 +1,26 @@
+# Norbelys::MessageEnrollParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | **Hash<String, Object>** | Template variables merged over the person's fields at render time. | [optional] |
+| **from** | **String** | Who the message is sent from — a sender id, or any email address on a sending domain you've set up (a sender identity is created automatically on first use). |  |
+| **to** | **String** | Recipient email address. |  |
+| **to_name** | **String** | Recipient display name. | [optional] |
+| **sequence** | **String** | Id of a program to enroll the person into instead of sending now; the program then controls send timing. Required for a cold-email sender (those send on a paced schedule, not immediately). |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::MessageEnrollParams.new(
+  data: null,
+  from: null,
+  to: null,
+  to_name: null,
+  sequence: null
+)
+```
+

data/docs/MessageList.md

@@ -0,0 +1,26 @@
+# Norbelys::MessageList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<Message>**](Message.md) | The page of results, newest first. |  |
+| **has_more** | **Boolean** | Whether another page exists beyond this one. |  |
+| **next_cursor** | **String** |  |  |
+| **object** | **Object** |  | [optional] |
+| **total** | **Integer** | Count across both directions matching the filters. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::MessageList.new(
+  data: null,
+  has_more: null,
+  next_cursor: null,
+  object: null,
+  total: null
+)
+```
+

data/docs/MessageReplyParams.md

@@ -0,0 +1,40 @@
+# Norbelys::MessageReplyParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | **Hash<String, Object>** | Template variables merged over the person's fields at render time. | [optional] |
+| **from** | **String** | Who the message is sent from — a sender id, or any email address on a sending domain you've set up (a sender identity is created automatically on first use). |  |
+| **to** | **String** | Recipient email address. |  |
+| **to_name** | **String** | Recipient display name. | [optional] |
+| **attachments** | [**Array<MessageAttachmentInput>**](MessageAttachmentInput.md) | Files to attach (Base64-encoded). Up to 5 files, 7 MB decoded total. | [optional] |
+| **html** | **String** | Inline HTML body. | [optional] |
+| **subject** | **String** | Subject line for an inline send. | [optional] |
+| **text** | **String** | Inline plain-text body. | [optional] |
+| **track_clicks** | **Boolean** | Rewrite links to track clicks. | [optional] |
+| **track_opens** | **Boolean** | Track opens for this message. | [optional] |
+| **variant_id** | **String** | Id of a stored step variant to render as the template instead of inline content. | [optional] |
+| **in_reply_to** | **String** | Id of an inbound message to reply to; threads this send to that conversation. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::MessageReplyParams.new(
+  data: null,
+  from: null,
+  to: null,
+  to_name: null,
+  attachments: null,
+  html: null,
+  subject: null,
+  text: null,
+  track_clicks: null,
+  track_opens: null,
+  variant_id: null,
+  in_reply_to: null
+)
+```
+

data/docs/MessageSource.md

@@ -0,0 +1,36 @@
+# Norbelys::MessageSource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **attachments** | [**Array<MessageSourceAttachment>**](MessageSourceAttachment.md) | Attached files (metadata only; raw content omitted). | [optional] |
+| **bcc** | [**Array<MessageAddress>**](MessageAddress.md) | Blind-carbon-copy recipients, as sent. | [optional] |
+| **cc** | [**Array<MessageAddress>**](MessageAddress.md) | Carbon-copy recipients, as sent. | [optional] |
+| **from** | [**MessageAddress**](MessageAddress.md) | The From identity as sent. |  |
+| **headers** | **Hash<String, String>** | Extra headers attached at send time. | [optional] |
+| **html** | **String** | The final HTML body, tracking applied. |  |
+| **reply_to** | **String** | The Reply-To header, if set. | [optional] |
+| **subject** | **String** | The final personalized subject. |  |
+| **text** | **String** | The final plain-text body. |  |
+| **to** | [**MessageAddress**](MessageAddress.md) | The recipient as sent. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::MessageSource.new(
+  attachments: null,
+  bcc: null,
+  cc: null,
+  from: null,
+  headers: null,
+  html: null,
+  reply_to: null,
+  subject: null,
+  text: null,
+  to: null
+)
+```
+

data/docs/MessageSourceAttachment.md

@@ -0,0 +1,22 @@
+# Norbelys::MessageSourceAttachment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **content_id** | **String** | Inline-image Content-ID (for `cid:` references), if any. | [optional] |
+| **content_type** | **String** | MIME type. | [optional] |
+| **filename** | **String** | File name. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::MessageSourceAttachment.new(
+  content_id: null,
+  content_type: null,
+  filename: null
+)
+```
+

data/docs/MessageTestParams.md

@@ -0,0 +1,40 @@
+# Norbelys::MessageTestParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | **Hash<String, Object>** | Template variables merged over the person's fields at render time. | [optional] |
+| **from** | **String** | Who the message is sent from — a sender id, or any email address on a sending domain you've set up (a sender identity is created automatically on first use). |  |
+| **to** | **String** | Recipient email address. |  |
+| **to_name** | **String** | Recipient display name. | [optional] |
+| **attachments** | [**Array<MessageAttachmentInput>**](MessageAttachmentInput.md) | Files to attach (Base64-encoded). Up to 5 files, 7 MB decoded total. | [optional] |
+| **html** | **String** | Inline HTML body. | [optional] |
+| **subject** | **String** | Subject line for an inline send. | [optional] |
+| **text** | **String** | Inline plain-text body. | [optional] |
+| **track_clicks** | **Boolean** | Rewrite links to track clicks. | [optional] |
+| **track_opens** | **Boolean** | Track opens for this message. | [optional] |
+| **variant_id** | **String** | Id of a stored step variant to render as the template instead of inline content. | [optional] |
+| **test** | **Object** |  |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::MessageTestParams.new(
+  data: null,
+  from: null,
+  to: null,
+  to_name: null,
+  attachments: null,
+  html: null,
+  subject: null,
+  text: null,
+  track_clicks: null,
+  track_opens: null,
+  variant_id: null,
+  test: null
+)
+```
+

data/docs/MessageUpdateParams.md

@@ -0,0 +1,22 @@
+# Norbelys::MessageUpdateParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **assignee_id** | **String** |  | [optional] |
+| **classification** | **String** | Re-classify the reply's intent: interested, out_of_office, not_interested, auto_reply, bounce, complaint, unsubscribe, uncategorized. | [optional] |
+| **is_read** | **Boolean** | Mark read or unread. | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::MessageUpdateParams.new(
+  assignee_id: null,
+  classification: null,
+  is_read: null
+)
+```
+