sendmux-sdk 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +13 -0
  3. data/LICENSE +21 -0
  4. data/README.md +100 -0
  5. data/lib/sendmux/sdk/version.rb +1 -1
  6. metadata +43 -18
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 56ceb1fe731c5830065a1f4f5be8ebbb1b1f6294e5fdd66a52eb68de5687c8c7
4
- data.tar.gz: e0363ea6c3ea42e4da5c8939fcede74f588c97b9bfff23424c6bae4655433524
3
+ metadata.gz: 946626bb643de0dc8928f34d244b36238c753a03c23cfecd9df1dbc1dcf3bf64
4
+ data.tar.gz: cc71e459613e3e051b3be9ca84e4a0093560e40ae9c7599b19daf87b96b764ae
5
5
  SHA512:
6
- metadata.gz: 45d182e92203c61fc48ad324544e24d06ef9c6713c659df56438f75faad57c908aad2ed3d86b778bf3a7e7c6805fd70a4e3c27e1d9d7511c05d97ce48c865437
7
- data.tar.gz: bfbdeed8c387684eb1830f2183c9e45922c8cab7f9c88ab8af4758fa14face0dd1a81b193bb4246432170505b6f9ebc8b9d26de31f3321576e59e39a41160501
6
+ metadata.gz: b2a7c15d4764c8ee03527894905ee189df1c319de9d66fc2ac38c987051719c5297b640e5d4d78c975d7ad8e19003b6ddc20dce70632d57111f8059303d67df5
7
+ data.tar.gz: 49240f8784116d5ff261abba03eab3d6b43bc1d096b5f77a1288b14864e7f4d4d6196c7b8c4eed87ebe8028a572caa4dfb2e84843219d117201c5d070018c6ff
data/CHANGELOG.md CHANGED
@@ -1,5 +1,18 @@
1
1
  # Changelog
2
2
 
3
+ ## [1.1.0](https://github.com/Sendmux/sendmux-sdk/compare/ruby-sdk/v1.0.0...ruby-sdk/v1.1.0) (2026-07-01)
4
+
5
+
6
+ ### Features
7
+
8
+ * allow owner-approved agent tokens for sending ([9d1cb7d](https://github.com/Sendmux/sendmux-sdk/commit/9d1cb7df3df5aef1f59a4990dc087178ba3a7b21))
9
+
10
+
11
+ ### Bug Fixes
12
+
13
+ * **ruby-release:** require current component versions ([0e609e7](https://github.com/Sendmux/sendmux-sdk/commit/0e609e72630e05c29f93121dbac23946d0be7fe3))
14
+ * **ruby-release:** require current component versions ([6c4a97f](https://github.com/Sendmux/sendmux-sdk/commit/6c4a97f544aecde91e91e9649ddc9c824081eeb4))
15
+
3
16
  ## 1.0.0 (2026-06-02)
4
17
 
5
18
 
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Sendmux
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md CHANGED
@@ -1,3 +1,103 @@
1
1
  # sendmux-sdk
2
2
 
3
+ [![Gem Version](https://badge.fury.io/rb/sendmux-sdk.svg)](https://rubygems.org/gems/sendmux-sdk)
4
+ [![CI](https://github.com/Sendmux/sendmux-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/Sendmux/sendmux-sdk/actions/workflows/ci.yml)
5
+ [![Licence: MIT](https://img.shields.io/badge/licence-MIT-blue.svg)](https://github.com/Sendmux/sendmux-sdk/blob/main/LICENSE)
6
+
3
7
  Umbrella Ruby SDK package for Sendmux.
8
+
9
+ ## Documentation
10
+
11
+ - Ruby SDK guide: https://sendmux.ai/docs/sdks/ruby
12
+ - Source: https://github.com/Sendmux/sendmux-sdk/tree/main/packages/ruby/sdk
13
+ - Changelog: https://github.com/Sendmux/sendmux-sdk/blob/main/packages/ruby/sdk/CHANGELOG.md
14
+
15
+ ## Requirements
16
+
17
+ - Ruby 3.1 or newer.
18
+ - A send-capable `smx_mbx_` key or owner-approved Sending-resource `smx_agent_` token for sending clients.
19
+ - A mailbox-scoped key beginning with `smx_mbx_` or scoped token beginning with `smx_agent_` for mailbox clients.
20
+ - A root key beginning with `smx_root_` for management clients.
21
+
22
+ ## Installation
23
+
24
+ ```sh
25
+ gem install sendmux-sdk
26
+ ```
27
+
28
+ Or add it to your Gemfile:
29
+
30
+ ```ruby
31
+ gem "sendmux-sdk", "~> 1.0"
32
+ ```
33
+
34
+ ## Usage
35
+
36
+ Use the umbrella gem when you want all Ruby SDK surfaces in one install.
37
+
38
+ ```ruby
39
+ require "sendmux/sdk"
40
+
41
+ sending = Sendmux::SDK.sending(
42
+ api_key: ENV.fetch("SENDMUX_MAILBOX_KEY")
43
+ )
44
+
45
+ mailbox = Sendmux::SDK.mailbox(
46
+ api_key: ENV.fetch("SENDMUX_MAILBOX_KEY")
47
+ )
48
+
49
+ management = Sendmux::SDK.management(
50
+ api_key: ENV.fetch("SENDMUX_ROOT_KEY")
51
+ )
52
+
53
+ puts sending.emails.class
54
+ puts mailbox.mailbox_api.class
55
+ puts management.mailboxes.class
56
+ ```
57
+
58
+ `Sendmux::Sdk` is available as an alias for `Sendmux::SDK`.
59
+
60
+ ### Surface clients
61
+
62
+ The umbrella package installs and re-exports:
63
+
64
+ - `sendmux-core`
65
+ - `sendmux-sending`
66
+ - `sendmux-mailbox`
67
+ - `sendmux-management`
68
+
69
+ The helper methods return the same clients exposed by the surface gems:
70
+
71
+ - `Sendmux::SDK.sending(...)` returns `Sendmux::Sending::Client`.
72
+ - `Sendmux::SDK.mailbox(...)` returns `Sendmux::Mailbox::Client`.
73
+ - `Sendmux::SDK.management(...)` returns `Sendmux::Management::Client`.
74
+
75
+ ### Retries, pagination, and errors
76
+
77
+ Pass `Sendmux::Core::RetryOptions` through any umbrella helper. Use `Sendmux::Core.each_cursor` and `Sendmux::Core::Headers` with the generated operation methods exactly as you would with the surface gems.
78
+
79
+ ```ruby
80
+ retry_options = Sendmux::Core::RetryOptions.new(max_attempts: 4)
81
+
82
+ management = Sendmux::SDK.management(
83
+ api_key: ENV.fetch("SENDMUX_ROOT_KEY"),
84
+ retry_options: retry_options
85
+ )
86
+
87
+ pager = Sendmux::Core.each_cursor(lambda do |opts|
88
+ management.mailboxes.management_list_mailboxes(opts.merge(limit: 50))
89
+ end)
90
+
91
+ pager.each { |mailbox| puts mailbox.id }
92
+ ```
93
+
94
+ Generated API errors are mapped to `Sendmux::Core::ApiError`.
95
+
96
+ ## Support
97
+
98
+ - Documentation: https://sendmux.ai/docs
99
+ - Contact: contact@sendmux.ai
100
+
101
+ ## Licence
102
+
103
+ MIT licence. See https://github.com/Sendmux/sendmux-sdk/blob/main/LICENSE.
data/lib/sendmux/sdk/version.rb CHANGED
@@ -2,6 +2,6 @@
2
2
 
3
3
  module Sendmux
4
4
  module SDK
5
- VERSION = '1.0.0'
5
+ VERSION = '1.1.0'
6
6
  end
7
7
  end
metadata CHANGED
@@ -1,70 +1,94 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: sendmux-sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Sendmux
8
8
  bindir: bin
9
9
  cert_chain: []
10
- date: 2026-06-02 00:00:00.000000000 Z
10
+ date: 2026-07-01 00:00:00.000000000 Z
11
11
  dependencies:
12
12
  - !ruby/object:Gem::Dependency
13
13
  name: sendmux-core
14
14
  requirement: !ruby/object:Gem::Requirement
15
15
  requirements:
16
- - - "~>"
16
+ - - ">="
17
17
  - !ruby/object:Gem::Version
18
- version: '1.0'
18
+ version: 1.1.0
19
+ - - "<"
20
+ - !ruby/object:Gem::Version
21
+ version: '2.0'
19
22
  type: :runtime
20
23
  prerelease: false
21
24
  version_requirements: !ruby/object:Gem::Requirement
22
25
  requirements:
23
- - - "~>"
26
+ - - ">="
27
+ - !ruby/object:Gem::Version
28
+ version: 1.1.0
29
+ - - "<"
24
30
  - !ruby/object:Gem::Version
25
- version: '1.0'
31
+ version: '2.0'
26
32
  - !ruby/object:Gem::Dependency
27
33
  name: sendmux-mailbox
28
34
  requirement: !ruby/object:Gem::Requirement
29
35
  requirements:
30
- - - "~>"
36
+ - - ">="
31
37
  - !ruby/object:Gem::Version
32
- version: '1.0'
38
+ version: 1.0.0
39
+ - - "<"
40
+ - !ruby/object:Gem::Version
41
+ version: '2.0'
33
42
  type: :runtime
34
43
  prerelease: false
35
44
  version_requirements: !ruby/object:Gem::Requirement
36
45
  requirements:
37
- - - "~>"
46
+ - - ">="
47
+ - !ruby/object:Gem::Version
48
+ version: 1.0.0
49
+ - - "<"
38
50
  - !ruby/object:Gem::Version
39
- version: '1.0'
51
+ version: '2.0'
40
52
  - !ruby/object:Gem::Dependency
41
53
  name: sendmux-management
42
54
  requirement: !ruby/object:Gem::Requirement
43
55
  requirements:
44
- - - "~>"
56
+ - - ">="
45
57
  - !ruby/object:Gem::Version
46
- version: '1.0'
58
+ version: 1.0.0
59
+ - - "<"
60
+ - !ruby/object:Gem::Version
61
+ version: '2.0'
47
62
  type: :runtime
48
63
  prerelease: false
49
64
  version_requirements: !ruby/object:Gem::Requirement
50
65
  requirements:
51
- - - "~>"
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: 1.0.0
69
+ - - "<"
52
70
  - !ruby/object:Gem::Version
53
- version: '1.0'
71
+ version: '2.0'
54
72
  - !ruby/object:Gem::Dependency
55
73
  name: sendmux-sending
56
74
  requirement: !ruby/object:Gem::Requirement
57
75
  requirements:
58
- - - "~>"
76
+ - - ">="
59
77
  - !ruby/object:Gem::Version
60
- version: '1.0'
78
+ version: 1.1.0
79
+ - - "<"
80
+ - !ruby/object:Gem::Version
81
+ version: '2.0'
61
82
  type: :runtime
62
83
  prerelease: false
63
84
  version_requirements: !ruby/object:Gem::Requirement
64
85
  requirements:
65
- - - "~>"
86
+ - - ">="
87
+ - !ruby/object:Gem::Version
88
+ version: 1.1.0
89
+ - - "<"
66
90
  - !ruby/object:Gem::Version
67
- version: '1.0'
91
+ version: '2.0'
68
92
  email:
69
93
  - contact@sendmux.ai
70
94
  executables: []
@@ -72,6 +96,7 @@ extensions: []
72
96
  extra_rdoc_files: []
73
97
  files:
74
98
  - CHANGELOG.md
99
+ - LICENSE
75
100
  - README.md
76
101
  - lib/sendmux/sdk.rb
77
102
  - lib/sendmux/sdk/version.rb