sendpost_ruby_sdk 1.0.0 → 1.0.1

data/sendpost.yaml

@@ -79,6 +79,163 @@ paths:
           description: Request body is not in proper format
         '500':
           description: Internal Server Error
+  /subaccount/suppression/:
+    get:
+      tags:
+      - suppression
+      description: Get all suppressions
+      operationId: GetSuppressions
+      parameters:
+        - in: header
+          name: X-SubAccount-ApiKey
+          description: Sub-Account API Key
+          required: true
+          schema:
+            type: string
+        - in: query
+          name: offset
+          description: offset
+          schema:
+            type: integer
+            format: int64
+        - in: query
+          name: limit
+          description: limit
+          schema:
+            type: integer
+            format: int64
+        - in: query
+          name: search
+          description: search
+          schema:
+            type: string
+        - in: query
+          name: from
+          description: from date
+          schema:
+            type: string
+        - in: query
+          name: to
+          description: to date
+          schema:
+            type: string
+      responses:
+        '200':
+          description: '"Suppressions retrieved successfully"'
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Suppression'
+        '401':
+          description: Not Authorized
+        '500':
+          description: Internal Server Error
+    post:
+      tags:
+      - suppression
+      description: Add Email Addresses To Suppression List
+      operationId: CreateSuppressions
+      parameters:
+        - in: header
+          name: X-SubAccount-ApiKey
+          description: Sub-Account API Key
+          required: true
+          schema:
+            type: string
+      requestBody:
+        description: "Suppression content"
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/RSuppression'
+      responses:
+        '200':
+          description: '"Suppressions created successfully"'
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Suppression'
+        '401':
+          description: Not Authorized
+        '406':
+          description: Suppression list is empty
+        '422':
+          description: Request body is not in proper format
+        '500':
+          description: Internal Server Error
+    delete:
+      tags:
+      - suppression
+      description: Delete specific emails which are in suppression list
+      operationId: DeleteSuppression
+      parameters:
+        - in: header
+          name: X-SubAccount-ApiKey
+          description: Sub-Account API Key
+          required: true
+          schema:
+              type: string
+      requestBody:
+        description: "Suppression content"
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/RDSuppression'
+      responses:
+        '200':
+          description: '"Emails in suppression list have been deleted successfully"'
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/DeleteResponse'
+        '401':
+          description: Not Authorized
+        '406':
+          description: suppression list is empty
+        '422':
+          description: Request body is not in proper format
+        '500':
+          description: Internal Server Error
+  /subaccount/suppression/count:
+    get:
+      tags:
+      - suppression
+      description: Count Total Suppressions
+      operationId: Count
+      parameters:
+        - in: header
+          name: X-SubAccount-ApiKey
+          description: Sub-Account API Key
+          required: true
+          schema:
+            type: string
+        - in: query
+          name: from
+          description: from date
+          schema:
+            type: string
+        - in: query
+          name: to
+          description: to date
+          schema:
+            type: string
+      responses:
+        '200':
+          description: '"Total count of Suppressions for a specific sub-account"'
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CountStat'
+        '401':
+          description: Not Authorized
+        '500':
+          description: Internal Server Error
 components:
   schemas:
     EmailMessage:
@@ -374,8 +531,8 @@ components:
       type: object
       properties:
         errorCode:
-            type: integer
-            example: 500
+          type: integer
+          example: 500
         message:
           type: string
           example: "ok"
@@ -421,6 +578,73 @@ components:
           type: string
         Patch:
           type: string
+    Suppression:
+      title: Suppression
+      type: object
+      properties:
+        created:
+          type: integer
+          format: int64
+        email:
+          type: string
+        id:
+          type: integer
+          format: int64
+        reason:
+          type: integer
+          format: int64
+        smtp_error:
+          type: string
+    RSuppression:
+      title: RSuppression
+      type: object
+      properties:
+        hardBounce:
+          type: array
+          items:
+            $ref: '#/components/schemas/SuppressionEmail'
+        manual:
+          type: array
+          items:
+            $ref: '#/components/schemas/SuppressionEmail'
+        spamComplaint:
+          type: array
+          items:
+            $ref: '#/components/schemas/SuppressionEmail'
+        unsubscribe:
+          type: array
+          items:
+            $ref: '#/components/schemas/SuppressionEmail'
+    SuppressionEmail:
+      title: SuppressionEmail
+      type: object
+      properties:
+        email:
+          type: string
+    RDSuppression:
+      title: RDSuppression
+      type: object
+      properties:
+        suppressions:
+          type: array
+          items:
+            $ref: '#/components/schemas/SuppressionEmail'
+    DeleteResponse:
+      title: DeleteResponse
+      type: object
+      properties:
+        id:
+          type: integer
+          format: int64
+        message:
+          type: string
+    CountStat:
+      title: CountStat
+      type: object
+      properties:
+        count:
+          type: integer
+          format: int64
     City:
       title: City
       type: object

data/sendpost_ruby_sdk.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Sendpost"]
   s.email       = ["dev@sendpost.io"]
-  s.homepage    = "https://sendpost.io/"
+  s.homepage    = "https://github.com/sendpost/sendpost_ruby_sdk"
   s.summary     = "SendPost Ruby API"
   s.description = "Email API and SMTP relay to not just send and measure email sending, but also alert and optimise. We provide you with tools, expertise and support needed to reliably deliver emails to your customers inboxes on time, every time."
   s.license     = "Unlicense"

data/spec/api/suppression_api_spec.rb

@@ -0,0 +1,88 @@
+=begin
+#SendPost API
+
+#Email API and SMTP relay to not just send and measure email sending, but also alert and optimise. We provide you with tools, expertise and support needed to reliably deliver emails to your customers inboxes on time, every time.
+
+The version of the OpenAPI document: 1.0.0
+Contact: hello@sendpost.io
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.6.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Sendpost::SuppressionApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'SuppressionApi' do
+  before do
+    # run before each test
+    @api_instance = Sendpost::SuppressionApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SuppressionApi' do
+    it 'should create an instance of SuppressionApi' do
+      expect(@api_instance).to be_instance_of(Sendpost::SuppressionApi)
+    end
+  end
+
+  # unit tests for count
+  # Count Total Suppressions
+  # @param x_sub_account_api_key Sub-Account API Key
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :from from date
+  # @option opts [String] :to to date
+  # @return [CountStat]
+  describe 'count test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for create_suppressions
+  # Add Email Addresses To Suppression List
+  # @param x_sub_account_api_key Sub-Account API Key
+  # @param [Hash] opts the optional parameters
+  # @option opts [RSuppression] :r_suppression Suppression content
+  # @return [Array<Suppression>]
+  describe 'create_suppressions test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for delete_suppression
+  # Delete specific emails which are in suppression list
+  # @param x_sub_account_api_key Sub-Account API Key
+  # @param [Hash] opts the optional parameters
+  # @option opts [RDSuppression] :rd_suppression Suppression content
+  # @return [Array<DeleteResponse>]
+  describe 'delete_suppression test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_suppressions
+  # Get all suppressions
+  # @param x_sub_account_api_key Sub-Account API Key
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :offset offset
+  # @option opts [Integer] :limit limit
+  # @option opts [String] :search search
+  # @option opts [String] :from from date
+  # @option opts [String] :to to date
+  # @return [Array<Suppression>]
+  describe 'get_suppressions test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/count_stat_spec.rb

@@ -0,0 +1,34 @@
+=begin
+#SendPost API
+
+#Email API and SMTP relay to not just send and measure email sending, but also alert and optimise. We provide you with tools, expertise and support needed to reliably deliver emails to your customers inboxes on time, every time.
+
+The version of the OpenAPI document: 1.0.0
+Contact: hello@sendpost.io
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.6.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Sendpost::CountStat
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe Sendpost::CountStat do
+  let(:instance) { Sendpost::CountStat.new }
+
+  describe 'test an instance of CountStat' do
+    it 'should create an instance of CountStat' do
+      expect(instance).to be_instance_of(Sendpost::CountStat)
+    end
+  end
+  describe 'test attribute "count"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/delete_response_spec.rb

@@ -0,0 +1,40 @@
+=begin
+#SendPost API
+
+#Email API and SMTP relay to not just send and measure email sending, but also alert and optimise. We provide you with tools, expertise and support needed to reliably deliver emails to your customers inboxes on time, every time.
+
+The version of the OpenAPI document: 1.0.0
+Contact: hello@sendpost.io
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.6.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Sendpost::DeleteResponse
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe Sendpost::DeleteResponse do
+  let(:instance) { Sendpost::DeleteResponse.new }
+
+  describe 'test an instance of DeleteResponse' do
+    it 'should create an instance of DeleteResponse' do
+      expect(instance).to be_instance_of(Sendpost::DeleteResponse)
+    end
+  end
+  describe 'test attribute "id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "message"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/r_suppression_spec.rb

@@ -0,0 +1,52 @@
+=begin
+#SendPost API
+
+#Email API and SMTP relay to not just send and measure email sending, but also alert and optimise. We provide you with tools, expertise and support needed to reliably deliver emails to your customers inboxes on time, every time.
+
+The version of the OpenAPI document: 1.0.0
+Contact: hello@sendpost.io
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.6.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Sendpost::RSuppression
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe Sendpost::RSuppression do
+  let(:instance) { Sendpost::RSuppression.new }
+
+  describe 'test an instance of RSuppression' do
+    it 'should create an instance of RSuppression' do
+      expect(instance).to be_instance_of(Sendpost::RSuppression)
+    end
+  end
+  describe 'test attribute "hard_bounce"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "manual"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "spam_complaint"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "unsubscribe"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/rd_suppression_spec.rb

@@ -0,0 +1,34 @@
+=begin
+#SendPost API
+
+#Email API and SMTP relay to not just send and measure email sending, but also alert and optimise. We provide you with tools, expertise and support needed to reliably deliver emails to your customers inboxes on time, every time.
+
+The version of the OpenAPI document: 1.0.0
+Contact: hello@sendpost.io
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.6.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Sendpost::RDSuppression
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe Sendpost::RDSuppression do
+  let(:instance) { Sendpost::RDSuppression.new }
+
+  describe 'test an instance of RDSuppression' do
+    it 'should create an instance of RDSuppression' do
+      expect(instance).to be_instance_of(Sendpost::RDSuppression)
+    end
+  end
+  describe 'test attribute "suppressions"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/suppression_email_spec.rb

@@ -0,0 +1,34 @@
+=begin
+#SendPost API
+
+#Email API and SMTP relay to not just send and measure email sending, but also alert and optimise. We provide you with tools, expertise and support needed to reliably deliver emails to your customers inboxes on time, every time.
+
+The version of the OpenAPI document: 1.0.0
+Contact: hello@sendpost.io
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.6.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Sendpost::SuppressionEmail
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe Sendpost::SuppressionEmail do
+  let(:instance) { Sendpost::SuppressionEmail.new }
+
+  describe 'test an instance of SuppressionEmail' do
+    it 'should create an instance of SuppressionEmail' do
+      expect(instance).to be_instance_of(Sendpost::SuppressionEmail)
+    end
+  end
+  describe 'test attribute "email"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/suppression_spec.rb

@@ -0,0 +1,58 @@
+=begin
+#SendPost API
+
+#Email API and SMTP relay to not just send and measure email sending, but also alert and optimise. We provide you with tools, expertise and support needed to reliably deliver emails to your customers inboxes on time, every time.
+
+The version of the OpenAPI document: 1.0.0
+Contact: hello@sendpost.io
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.6.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Sendpost::Suppression
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe Sendpost::Suppression do
+  let(:instance) { Sendpost::Suppression.new }
+
+  describe 'test an instance of Suppression' do
+    it 'should create an instance of Suppression' do
+      expect(instance).to be_instance_of(Sendpost::Suppression)
+    end
+  end
+  describe 'test attribute "created"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "email"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "reason"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "smtp_error"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end