qubrics-sending 2.0.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 (46) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +57 -0
  3. data/LICENSE +21 -0
  4. data/README.md +112 -0
  5. data/lib/qubrics/sending/client.rb +71 -0
  6. data/lib/qubrics/sending/version.rb +7 -0
  7. data/lib/qubrics/sending.rb +12 -0
  8. data/lib/qubrics_sending_generated/api/attachments_api.rb +373 -0
  9. data/lib/qubrics_sending_generated/api/emails_api.rb +172 -0
  10. data/lib/qubrics_sending_generated/api/meta_api.rb +142 -0
  11. data/lib/qubrics_sending_generated/api_client.rb +447 -0
  12. data/lib/qubrics_sending_generated/api_error.rb +58 -0
  13. data/lib/qubrics_sending_generated/api_model_base.rb +95 -0
  14. data/lib/qubrics_sending_generated/configuration.rb +413 -0
  15. data/lib/qubrics_sending_generated/models/address.rb +215 -0
  16. data/lib/qubrics_sending_generated/models/attachment.rb +103 -0
  17. data/lib/qubrics_sending_generated/models/attachment_upload_data.rb +284 -0
  18. data/lib/qubrics_sending_generated/models/attachment_upload_intent_data.rb +337 -0
  19. data/lib/qubrics_sending_generated/models/attachment_upload_intent_request.rb +279 -0
  20. data/lib/qubrics_sending_generated/models/attachment_upload_intent_response.rb +223 -0
  21. data/lib/qubrics_sending_generated/models/attachment_upload_response.rb +223 -0
  22. data/lib/qubrics_sending_generated/models/batch_result_item.rb +256 -0
  23. data/lib/qubrics_sending_generated/models/batch_send_request.rb +185 -0
  24. data/lib/qubrics_sending_generated/models/batch_send_success_data.rb +192 -0
  25. data/lib/qubrics_sending_generated/models/batch_send_success_response.rb +223 -0
  26. data/lib/qubrics_sending_generated/models/batch_summary.rb +219 -0
  27. data/lib/qubrics_sending_generated/models/connection.rb +273 -0
  28. data/lib/qubrics_sending_generated/models/connection_credential.rb +226 -0
  29. data/lib/qubrics_sending_generated/models/connection_mailboxes_inner.rb +190 -0
  30. data/lib/qubrics_sending_generated/models/connection_response.rb +223 -0
  31. data/lib/qubrics_sending_generated/models/connection_team.rb +190 -0
  32. data/lib/qubrics_sending_generated/models/email_send_request.rb +474 -0
  33. data/lib/qubrics_sending_generated/models/email_send_request_delivery_group.rb +105 -0
  34. data/lib/qubrics_sending_generated/models/error_detail.rb +251 -0
  35. data/lib/qubrics_sending_generated/models/error_issue.rb +219 -0
  36. data/lib/qubrics_sending_generated/models/error_response.rb +216 -0
  37. data/lib/qubrics_sending_generated/models/inline_attachment.rb +274 -0
  38. data/lib/qubrics_sending_generated/models/meta.rb +165 -0
  39. data/lib/qubrics_sending_generated/models/recipient.rb +214 -0
  40. data/lib/qubrics_sending_generated/models/send_success_data.rb +227 -0
  41. data/lib/qubrics_sending_generated/models/send_success_response.rb +223 -0
  42. data/lib/qubrics_sending_generated/models/success_envelope.rb +190 -0
  43. data/lib/qubrics_sending_generated/models/uploaded_attachment_ref.rb +176 -0
  44. data/lib/qubrics_sending_generated/version.rb +15 -0
  45. data/lib/qubrics_sending_generated.rb +72 -0
  46. metadata +168 -0
@@ -0,0 +1,176 @@
1
+ =begin
2
+ #Qubrics Sending API
3
+
4
+ #Send emails programmatically via the Qubrics email infrastructure. Every response carries an `X-Request-Id` header; errors include a `retryable` flag. 429 and 503 responses include `Retry-After`. Mutating endpoints accept an `Idempotency-Key` header for safe retries.
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.22.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module Qubrics::Sending::Generated
17
+ class UploadedAttachmentRef < ApiModelBase
18
+ # Temporary uploaded attachment ID returned by POST /emails/attachments.
19
+ attr_accessor :attachment_id
20
+
21
+ # Attribute mapping from ruby-style variable name to JSON key.
22
+ def self.attribute_map
23
+ {
24
+ :'attachment_id' => :'attachment_id'
25
+ }
26
+ end
27
+
28
+ # Returns attribute mapping this model knows about
29
+ def self.acceptable_attribute_map
30
+ attribute_map
31
+ end
32
+
33
+ # Returns all the JSON keys this model knows about
34
+ def self.acceptable_attributes
35
+ acceptable_attribute_map.values
36
+ end
37
+
38
+ # Attribute type mapping.
39
+ def self.openapi_types
40
+ {
41
+ :'attachment_id' => :'String'
42
+ }
43
+ end
44
+
45
+ # List of attributes with nullable: true
46
+ def self.openapi_nullable
47
+ Set.new([
48
+ ])
49
+ end
50
+
51
+ # Initializes the object
52
+ # @param [Hash] attributes Model attributes in the form of hash
53
+ def initialize(attributes = {})
54
+ if (!attributes.is_a?(Hash))
55
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Qubrics::Sending::Generated::UploadedAttachmentRef` initialize method"
56
+ end
57
+
58
+ # check to see if the attribute exists and convert string to symbol for hash key
59
+ acceptable_attribute_map = self.class.acceptable_attribute_map
60
+ attributes = attributes.each_with_object({}) { |(k, v), h|
61
+ if (!acceptable_attribute_map.key?(k.to_sym))
62
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Qubrics::Sending::Generated::UploadedAttachmentRef`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
63
+ end
64
+ h[k.to_sym] = v
65
+ }
66
+
67
+ if attributes.key?(:'attachment_id')
68
+ self.attachment_id = attributes[:'attachment_id']
69
+ else
70
+ self.attachment_id = nil
71
+ end
72
+ end
73
+
74
+ # Show invalid properties with the reasons. Usually used together with valid?
75
+ # @return Array for valid properties with the reasons
76
+ def list_invalid_properties
77
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
78
+ invalid_properties = Array.new
79
+ if @attachment_id.nil?
80
+ invalid_properties.push('invalid value for "attachment_id", attachment_id cannot be nil.')
81
+ end
82
+
83
+ pattern = Regexp.new(/^att_[a-z0-9]{24}$/)
84
+ if @attachment_id !~ pattern
85
+ invalid_properties.push("invalid value for \"attachment_id\", must conform to the pattern #{pattern}.")
86
+ end
87
+
88
+ invalid_properties
89
+ end
90
+
91
+ # Check to see if the all the properties in the model are valid
92
+ # @return true if the model is valid
93
+ def valid?
94
+ warn '[DEPRECATED] the `valid?` method is obsolete'
95
+ return false if @attachment_id.nil?
96
+ return false if @attachment_id !~ Regexp.new(/^att_[a-z0-9]{24}$/)
97
+ true
98
+ end
99
+
100
+ # Custom attribute writer method with validation
101
+ # @param [Object] attachment_id Value to be assigned
102
+ def attachment_id=(attachment_id)
103
+ if attachment_id.nil?
104
+ fail ArgumentError, 'attachment_id cannot be nil'
105
+ end
106
+
107
+ pattern = Regexp.new(/^att_[a-z0-9]{24}$/)
108
+ if attachment_id !~ pattern
109
+ fail ArgumentError, "invalid value for \"attachment_id\", must conform to the pattern #{pattern}."
110
+ end
111
+
112
+ @attachment_id = attachment_id
113
+ end
114
+
115
+ # Checks equality by comparing each attribute.
116
+ # @param [Object] Object to be compared
117
+ def ==(o)
118
+ return true if self.equal?(o)
119
+ self.class == o.class &&
120
+ attachment_id == o.attachment_id
121
+ end
122
+
123
+ # @see the `==` method
124
+ # @param [Object] Object to be compared
125
+ def eql?(o)
126
+ self == o
127
+ end
128
+
129
+ # Calculates hash code according to all attributes.
130
+ # @return [Integer] Hash code
131
+ def hash
132
+ [attachment_id].hash
133
+ end
134
+
135
+ # Builds the object from hash
136
+ # @param [Hash] attributes Model attributes in the form of hash
137
+ # @return [Object] Returns the model itself
138
+ def self.build_from_hash(attributes)
139
+ return nil unless attributes.is_a?(Hash)
140
+ attributes = attributes.transform_keys(&:to_sym)
141
+ transformed_hash = {}
142
+ openapi_types.each_pair do |key, type|
143
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
144
+ transformed_hash["#{key}"] = nil
145
+ elsif type =~ /\AArray<(.*)>/i
146
+ # check to ensure the input is an array given that the attribute
147
+ # is documented as an array but the input is not
148
+ if attributes[attribute_map[key]].is_a?(Array)
149
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
150
+ end
151
+ elsif !attributes[attribute_map[key]].nil?
152
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
153
+ end
154
+ end
155
+ new(transformed_hash)
156
+ end
157
+
158
+ # Returns the object in the form of hash
159
+ # @return [Hash] Returns the object in the form of hash
160
+ def to_hash
161
+ hash = {}
162
+ self.class.attribute_map.each_pair do |attr, param|
163
+ value = self.send(attr)
164
+ if value.nil?
165
+ is_nullable = self.class.openapi_nullable.include?(attr)
166
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
167
+ end
168
+
169
+ hash[param] = _to_hash(value)
170
+ end
171
+ hash
172
+ end
173
+
174
+ end
175
+
176
+ end
@@ -0,0 +1,15 @@
1
+ =begin
2
+ #Qubrics Sending API
3
+
4
+ #Send emails programmatically via the Qubrics email infrastructure. Every response carries an `X-Request-Id` header; errors include a `retryable` flag. 429 and 503 responses include `Retry-After`. Mutating endpoints accept an `Idempotency-Key` header for safe retries.
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.22.0
10
+
11
+ =end
12
+
13
+ module Qubrics::Sending::Generated
14
+ VERSION = '1.0.0'
15
+ end
@@ -0,0 +1,72 @@
1
+ =begin
2
+ #Qubrics Sending API
3
+
4
+ #Send emails programmatically via the Qubrics email infrastructure. Every response carries an `X-Request-Id` header; errors include a `retryable` flag. 429 and 503 responses include `Retry-After`. Mutating endpoints accept an `Idempotency-Key` header for safe retries.
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.22.0
10
+
11
+ =end
12
+
13
+ # Common files
14
+ require 'qubrics_sending_generated/api_client'
15
+ require 'qubrics_sending_generated/api_error'
16
+ require 'qubrics_sending_generated/api_model_base'
17
+ require 'qubrics_sending_generated/version'
18
+ require 'qubrics_sending_generated/configuration'
19
+
20
+ # Models
21
+ require 'qubrics_sending_generated/models/address'
22
+ require 'qubrics_sending_generated/models/attachment'
23
+ require 'qubrics_sending_generated/models/attachment_upload_data'
24
+ require 'qubrics_sending_generated/models/attachment_upload_intent_data'
25
+ require 'qubrics_sending_generated/models/attachment_upload_intent_request'
26
+ require 'qubrics_sending_generated/models/attachment_upload_intent_response'
27
+ require 'qubrics_sending_generated/models/attachment_upload_response'
28
+ require 'qubrics_sending_generated/models/batch_result_item'
29
+ require 'qubrics_sending_generated/models/batch_send_request'
30
+ require 'qubrics_sending_generated/models/batch_send_success_data'
31
+ require 'qubrics_sending_generated/models/batch_send_success_response'
32
+ require 'qubrics_sending_generated/models/batch_summary'
33
+ require 'qubrics_sending_generated/models/connection'
34
+ require 'qubrics_sending_generated/models/connection_credential'
35
+ require 'qubrics_sending_generated/models/connection_mailboxes_inner'
36
+ require 'qubrics_sending_generated/models/connection_response'
37
+ require 'qubrics_sending_generated/models/connection_team'
38
+ require 'qubrics_sending_generated/models/email_send_request'
39
+ require 'qubrics_sending_generated/models/email_send_request_delivery_group'
40
+ require 'qubrics_sending_generated/models/error_detail'
41
+ require 'qubrics_sending_generated/models/error_issue'
42
+ require 'qubrics_sending_generated/models/error_response'
43
+ require 'qubrics_sending_generated/models/inline_attachment'
44
+ require 'qubrics_sending_generated/models/meta'
45
+ require 'qubrics_sending_generated/models/recipient'
46
+ require 'qubrics_sending_generated/models/send_success_data'
47
+ require 'qubrics_sending_generated/models/send_success_response'
48
+ require 'qubrics_sending_generated/models/success_envelope'
49
+ require 'qubrics_sending_generated/models/uploaded_attachment_ref'
50
+
51
+ # APIs
52
+ require 'qubrics_sending_generated/api/attachments_api'
53
+ require 'qubrics_sending_generated/api/emails_api'
54
+ require 'qubrics_sending_generated/api/meta_api'
55
+
56
+ module Qubrics::Sending::Generated
57
+ class << self
58
+ # Customize default settings for the SDK using block.
59
+ # Qubrics::Sending::Generated.configure do |config|
60
+ # config.username = "xxx"
61
+ # config.password = "xxx"
62
+ # end
63
+ # If no block given, return the default Configuration object.
64
+ def configure
65
+ if block_given?
66
+ yield(Configuration.default)
67
+ else
68
+ Configuration.default
69
+ end
70
+ end
71
+ end
72
+ end
metadata ADDED
@@ -0,0 +1,168 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: qubrics-sending
3
+ version: !ruby/object:Gem::Version
4
+ version: 2.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Qubrics
8
+ bindir: bin
9
+ cert_chain: []
10
+ date: 2026-11-19 00:00:00.000000000 Z
11
+ dependencies:
12
+ - !ruby/object:Gem::Dependency
13
+ name: faraday
14
+ requirement: !ruby/object:Gem::Requirement
15
+ requirements:
16
+ - - "~>"
17
+ - !ruby/object:Gem::Version
18
+ version: '2.0'
19
+ type: :runtime
20
+ prerelease: false
21
+ version_requirements: !ruby/object:Gem::Requirement
22
+ requirements:
23
+ - - "~>"
24
+ - !ruby/object:Gem::Version
25
+ version: '2.0'
26
+ - !ruby/object:Gem::Dependency
27
+ name: faraday-multipart
28
+ requirement: !ruby/object:Gem::Requirement
29
+ requirements:
30
+ - - "~>"
31
+ - !ruby/object:Gem::Version
32
+ version: '1.0'
33
+ type: :runtime
34
+ prerelease: false
35
+ version_requirements: !ruby/object:Gem::Requirement
36
+ requirements:
37
+ - - "~>"
38
+ - !ruby/object:Gem::Version
39
+ version: '1.0'
40
+ - !ruby/object:Gem::Dependency
41
+ name: faraday-retry
42
+ requirement: !ruby/object:Gem::Requirement
43
+ requirements:
44
+ - - ">="
45
+ - !ruby/object:Gem::Version
46
+ version: '2.4'
47
+ - - "<"
48
+ - !ruby/object:Gem::Version
49
+ version: '3.0'
50
+ type: :runtime
51
+ prerelease: false
52
+ version_requirements: !ruby/object:Gem::Requirement
53
+ requirements:
54
+ - - ">="
55
+ - !ruby/object:Gem::Version
56
+ version: '2.4'
57
+ - - "<"
58
+ - !ruby/object:Gem::Version
59
+ version: '3.0'
60
+ - !ruby/object:Gem::Dependency
61
+ name: marcel
62
+ requirement: !ruby/object:Gem::Requirement
63
+ requirements:
64
+ - - "~>"
65
+ - !ruby/object:Gem::Version
66
+ version: '1.0'
67
+ type: :runtime
68
+ prerelease: false
69
+ version_requirements: !ruby/object:Gem::Requirement
70
+ requirements:
71
+ - - "~>"
72
+ - !ruby/object:Gem::Version
73
+ version: '1.0'
74
+ - !ruby/object:Gem::Dependency
75
+ name: qubrics-core
76
+ requirement: !ruby/object:Gem::Requirement
77
+ requirements:
78
+ - - ">="
79
+ - !ruby/object:Gem::Version
80
+ version: 2.0.0
81
+ - - "<"
82
+ - !ruby/object:Gem::Version
83
+ version: '3.0'
84
+ type: :runtime
85
+ prerelease: false
86
+ version_requirements: !ruby/object:Gem::Requirement
87
+ requirements:
88
+ - - ">="
89
+ - !ruby/object:Gem::Version
90
+ version: 2.0.0
91
+ - - "<"
92
+ - !ruby/object:Gem::Version
93
+ version: '3.0'
94
+ email:
95
+ - contact@qubrics.com
96
+ executables: []
97
+ extensions: []
98
+ extra_rdoc_files: []
99
+ files:
100
+ - CHANGELOG.md
101
+ - LICENSE
102
+ - README.md
103
+ - lib/qubrics/sending.rb
104
+ - lib/qubrics/sending/client.rb
105
+ - lib/qubrics/sending/version.rb
106
+ - lib/qubrics_sending_generated.rb
107
+ - lib/qubrics_sending_generated/api/attachments_api.rb
108
+ - lib/qubrics_sending_generated/api/emails_api.rb
109
+ - lib/qubrics_sending_generated/api/meta_api.rb
110
+ - lib/qubrics_sending_generated/api_client.rb
111
+ - lib/qubrics_sending_generated/api_error.rb
112
+ - lib/qubrics_sending_generated/api_model_base.rb
113
+ - lib/qubrics_sending_generated/configuration.rb
114
+ - lib/qubrics_sending_generated/models/address.rb
115
+ - lib/qubrics_sending_generated/models/attachment.rb
116
+ - lib/qubrics_sending_generated/models/attachment_upload_data.rb
117
+ - lib/qubrics_sending_generated/models/attachment_upload_intent_data.rb
118
+ - lib/qubrics_sending_generated/models/attachment_upload_intent_request.rb
119
+ - lib/qubrics_sending_generated/models/attachment_upload_intent_response.rb
120
+ - lib/qubrics_sending_generated/models/attachment_upload_response.rb
121
+ - lib/qubrics_sending_generated/models/batch_result_item.rb
122
+ - lib/qubrics_sending_generated/models/batch_send_request.rb
123
+ - lib/qubrics_sending_generated/models/batch_send_success_data.rb
124
+ - lib/qubrics_sending_generated/models/batch_send_success_response.rb
125
+ - lib/qubrics_sending_generated/models/batch_summary.rb
126
+ - lib/qubrics_sending_generated/models/connection.rb
127
+ - lib/qubrics_sending_generated/models/connection_credential.rb
128
+ - lib/qubrics_sending_generated/models/connection_mailboxes_inner.rb
129
+ - lib/qubrics_sending_generated/models/connection_response.rb
130
+ - lib/qubrics_sending_generated/models/connection_team.rb
131
+ - lib/qubrics_sending_generated/models/email_send_request.rb
132
+ - lib/qubrics_sending_generated/models/email_send_request_delivery_group.rb
133
+ - lib/qubrics_sending_generated/models/error_detail.rb
134
+ - lib/qubrics_sending_generated/models/error_issue.rb
135
+ - lib/qubrics_sending_generated/models/error_response.rb
136
+ - lib/qubrics_sending_generated/models/inline_attachment.rb
137
+ - lib/qubrics_sending_generated/models/meta.rb
138
+ - lib/qubrics_sending_generated/models/recipient.rb
139
+ - lib/qubrics_sending_generated/models/send_success_data.rb
140
+ - lib/qubrics_sending_generated/models/send_success_response.rb
141
+ - lib/qubrics_sending_generated/models/success_envelope.rb
142
+ - lib/qubrics_sending_generated/models/uploaded_attachment_ref.rb
143
+ - lib/qubrics_sending_generated/version.rb
144
+ homepage: https://github.com/qubrics/qubrics-sdk
145
+ licenses:
146
+ - MIT
147
+ metadata:
148
+ homepage_uri: https://github.com/qubrics/qubrics-sdk
149
+ source_code_uri: https://github.com/qubrics/qubrics-sdk/tree/main/packages/ruby/sending
150
+ changelog_uri: https://github.com/qubrics/qubrics-sdk/blob/main/packages/ruby/sending/CHANGELOG.md
151
+ rdoc_options: []
152
+ require_paths:
153
+ - lib
154
+ required_ruby_version: !ruby/object:Gem::Requirement
155
+ requirements:
156
+ - - ">="
157
+ - !ruby/object:Gem::Version
158
+ version: '3.1'
159
+ required_rubygems_version: !ruby/object:Gem::Requirement
160
+ requirements:
161
+ - - ">="
162
+ - !ruby/object:Gem::Version
163
+ version: '0'
164
+ requirements: []
165
+ rubygems_version: 3.6.2
166
+ specification_version: 4
167
+ summary: Ruby SDK for the Qubrics Sending API.
168
+ test_files: []