pepipost_gem 2.5.0 → 5.0.0

data/lib/pepipost/controllers/domain_controller.rb

@@ -0,0 +1,68 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # DomainController
+  class DomainController < BaseController
+    @instance = DomainController.new
+
+    class << self
+      attr_accessor :instance
+    end
+
+    def instance
+      self.class.instance
+    end
+
+    # This endpoint enables you to add a sending domain which is one of the
+    # pre-requisites for sending emails.
+    # @param [DomainStruct] body Required parameter: Add new domain
+    # @return Object response from the API call
+    def add_domain(body)
+      # Prepare query url.
+      _path_url = '/domain'
+      _query_builder = Configuration.base_uri.dup
+      _query_builder << _path_url
+      _query_url = APIHelper.clean_url _query_builder
+      # Prepare headers.
+      _headers = {
+        'content-type' => 'application/json; charset=utf-8'
+      }
+      # Prepare and execute HttpRequest.
+      _request = @http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      CustomHeaderAuth.apply(_request)
+      _context = execute_request(_request)
+      # Validate response against endpoint and global error codes.
+      if _context.response.status_code == 400
+        raise APIException.new(
+          'API Response',
+          _context
+        )
+      elsif _context.response.status_code == 401
+        raise APIException.new(
+          'API Response',
+          _context
+        )
+      elsif _context.response.status_code == 403
+        raise APIException.new(
+          'API Response',
+          _context
+        )
+      elsif _context.response.status_code == 405
+        raise APIException.new(
+          'Invalid input',
+          _context
+        )
+      end
+      validate_response(_context)
+      # Return appropriate response type.
+      _context.response.raw_body
+    end
+  end
+end

data/lib/pepipost/controllers/domain_delete_controller.rb

@@ -0,0 +1,67 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # DomainDeleteController
+  class DomainDeleteController < BaseController
+    @instance = DomainDeleteController.new
+
+    class << self
+      attr_accessor :instance
+    end
+
+    def instance
+      self.class.instance
+    end
+
+    # This endpoint allows you to delete a domain from your Pepipost account.
+    # @param [DeleteDomain] body Required parameter: delete domain
+    # @return Object response from the API call
+    def delete_domain(body)
+      # Prepare query url.
+      _path_url = '/domain/delete'
+      _query_builder = Configuration.base_uri.dup
+      _query_builder << _path_url
+      _query_url = APIHelper.clean_url _query_builder
+      # Prepare headers.
+      _headers = {
+        'content-type' => 'application/json; charset=utf-8'
+      }
+      # Prepare and execute HttpRequest.
+      _request = @http_client.delete(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      CustomHeaderAuth.apply(_request)
+      _context = execute_request(_request)
+      # Validate response against endpoint and global error codes.
+      if _context.response.status_code == 400
+        raise APIException.new(
+          'API Response',
+          _context
+        )
+      elsif _context.response.status_code == 401
+        raise APIException.new(
+          'API Response',
+          _context
+        )
+      elsif _context.response.status_code == 403
+        raise APIException.new(
+          'API Response',
+          _context
+        )
+      elsif _context.response.status_code == 405
+        raise APIException.new(
+          'Invalid input',
+          _context
+        )
+      end
+      validate_response(_context)
+      # Return appropriate response type.
+      _context.response.raw_body
+    end
+  end
+end

data/lib/pepipost/controllers/events_controller.rb

@@ -0,0 +1,104 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # EventsController
+  class EventsController < BaseController
+    @instance = EventsController.new
+
+    class << self
+      attr_accessor :instance
+    end
+
+    def instance
+      self.class.instance
+    end
+
+    # Lets you to retrieve the email transaction logs.
+    # @param [Date] startdate Required parameter: The starting date of the
+    # statistics to retrieve. Must follow format YYYY-MM-DD.
+    # @param [EventsEnum] events Optional parameter: Filter based on different
+    # email events. If not passed, all events will be fetched. Multiple comma
+    # separated events are allowed
+    # @param [SortEnum] sort Optional parameter: Sort based on email sent time
+    # @param [Date] enddate Optional parameter: The end date of the statistics
+    # to retrieve. Defaults to today. Must follow format YYYY-MM-DD
+    # @param [Integer] offset Optional parameter: The point in the list to begin
+    # retrieving results.
+    # @param [Integer] limit Optional parameter: The number of results to
+    # return.
+    # @param [String] subject Optional parameter: Filter logs based on subject
+    # @param [String] xapiheader Optional parameter: Filter logs based on
+    # recipient's email
+    # @param [String] fromaddress Optional parameter: Filter logs based on
+    # fromaddress
+    # @param [String] email Optional parameter: Filter logs based on recipient's
+    # email
+    # @return Object response from the API call
+    def get_events_get(startdate,
+                       events = nil,
+                       sort = nil,
+                       enddate = nil,
+                       offset = 0,
+                       limit = 10,
+                       subject = nil,
+                       xapiheader = nil,
+                       fromaddress = nil,
+                       email = nil)
+      # Prepare query url.
+      _path_url = '/events'
+      _query_builder = Configuration.base_uri.dup
+      _query_builder << _path_url
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        {
+          'startdate' => startdate,
+          'events' => events,
+          'sort' => sort,
+          'enddate' => enddate,
+          'offset' => offset,
+          'limit' => limit,
+          'subject' => subject,
+          'xapiheader' => xapiheader,
+          'fromaddress' => fromaddress,
+          'email' => email
+        },
+        array_serialization: Configuration.array_serialization
+      )
+      _query_url = APIHelper.clean_url _query_builder
+      # Prepare and execute HttpRequest.
+      _request = @http_client.get(
+        _query_url
+      )
+      CustomHeaderAuth.apply(_request)
+      _context = execute_request(_request)
+      # Validate response against endpoint and global error codes.
+      if _context.response.status_code == 400
+        raise APIException.new(
+          'API Response',
+          _context
+        )
+      elsif _context.response.status_code == 401
+        raise APIException.new(
+          'API Response',
+          _context
+        )
+      elsif _context.response.status_code == 403
+        raise APIException.new(
+          'API Response',
+          _context
+        )
+      elsif _context.response.status_code == 405
+        raise APIException.new(
+          'Invalid input',
+          _context
+        )
+      end
+      validate_response(_context)
+      # Return appropriate response type.
+      _context.response.raw_body
+    end
+  end
+end

data/lib/pepipost/controllers/mail_send_controller.rb

@@ -0,0 +1,54 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # MailSendController
+  class MailSendController < BaseController
+    @instance = MailSendController.new
+
+    class << self
+      attr_accessor :instance
+    end
+
+    def instance
+      self.class.instance
+    end
+
+    # The endpoint send is used to generate the request to pepipost server for
+    # sending an email to recipients.
+    # @param [Send] body Required parameter: New mail request will be
+    # generated
+    # @return Object response from the API call
+    def create_generatethemailsendrequest(body)
+      # Prepare query url.
+      _path_url = '/mail/send'
+      _query_builder = Configuration.base_uri.dup
+      _query_builder << _path_url
+      _query_url = APIHelper.clean_url _query_builder
+      # Prepare headers.
+      _headers = {
+        'content-type' => 'application/json; charset=utf-8'
+      }
+      # Prepare and execute HttpRequest.
+      _request = @http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      CustomHeaderAuth.apply(_request)
+      _context = execute_request(_request)
+      # Validate response against endpoint and global error codes.
+      if _context.response.status_code == 405
+        raise APIException.new(
+          'Invalid input',
+          _context
+        )
+      end
+      validate_response(_context)
+      # Return appropriate response type.
+      _context.response.raw_body
+    end
+  end
+end

data/lib/pepipost/controllers/setrecurringcreditddetails_controller.rb

@@ -0,0 +1,68 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # SetrecurringcreditddetailsController
+  class SetrecurringcreditddetailsController < BaseController
+    @instance = SetrecurringcreditddetailsController.new
+
+    class << self
+      attr_accessor :instance
+    end
+
+    def instance
+      self.class.instance
+    end
+
+    # Lets you configure a recurring credit allocation to a subaccount
+    # @param [UpdateRecurringCredisOfSubaccount] body Required parameter: Update
+    # recurring credit account
+    # @return Object response from the API call
+    def create_setrecurringcreditddetails_post(body)
+      # Prepare query url.
+      _path_url = '/setrecurringcreditddetails'
+      _query_builder = Configuration.base_uri.dup
+      _query_builder << _path_url
+      _query_url = APIHelper.clean_url _query_builder
+      # Prepare headers.
+      _headers = {
+        'content-type' => 'application/json; charset=utf-8'
+      }
+      # Prepare and execute HttpRequest.
+      _request = @http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      CustomHeaderAuth.apply(_request)
+      _context = execute_request(_request)
+      # Validate response against endpoint and global error codes.
+      if _context.response.status_code == 400
+        raise APIException.new(
+          'API Response',
+          _context
+        )
+      elsif _context.response.status_code == 401
+        raise APIException.new(
+          'API Response',
+          _context
+        )
+      elsif _context.response.status_code == 403
+        raise APIException.new(
+          'API Response',
+          _context
+        )
+      elsif _context.response.status_code == 405
+        raise APIException.new(
+          'Invalid input',
+          _context
+        )
+      end
+      validate_response(_context)
+      # Return appropriate response type.
+      _context.response.raw_body
+    end
+  end
+end

data/lib/pepipost/controllers/stats_controller.rb

@@ -0,0 +1,82 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # StatsController
+  class StatsController < BaseController
+    @instance = StatsController.new
+
+    class << self
+      attr_accessor :instance
+    end
+
+    def instance
+      self.class.instance
+    end
+
+    # Lets you fetch all the subaccounts created by you
+    # @param [Date] startdate Required parameter: The starting date of the
+    # statistics to retrieve. Must follow format YYYY-MM-DD.
+    # @param [Date] enddate Optional parameter: The end date of the statistics
+    # to retrieve. Defaults to today. Must follow format YYYY-MM-DD.
+    # @param [AggregatedByEnum] aggregated_by Optional parameter: Example:
+    # @param [Integer] offset Optional parameter: Example:1
+    # @param [Integer] limit Optional parameter: Example:100
+    # @return Object response from the API call
+    def get_stats_get(startdate,
+                      enddate = nil,
+                      aggregated_by = nil,
+                      offset = 1,
+                      limit = 100)
+      # Prepare query url.
+      _path_url = '/stats'
+      _query_builder = Configuration.base_uri.dup
+      _query_builder << _path_url
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        {
+          'startdate' => startdate,
+          'enddate' => enddate,
+          'aggregated_by' => aggregated_by,
+          'offset' => offset,
+          'limit' => limit
+        },
+        array_serialization: Configuration.array_serialization
+      )
+      _query_url = APIHelper.clean_url _query_builder
+      # Prepare and execute HttpRequest.
+      _request = @http_client.get(
+        _query_url
+      )
+      CustomHeaderAuth.apply(_request)
+      _context = execute_request(_request)
+      # Validate response against endpoint and global error codes.
+      if _context.response.status_code == 400
+        raise APIException.new(
+          'API Response',
+          _context
+        )
+      elsif _context.response.status_code == 401
+        raise APIException.new(
+          'API Response',
+          _context
+        )
+      elsif _context.response.status_code == 403
+        raise APIException.new(
+          'API Response',
+          _context
+        )
+      elsif _context.response.status_code == 405
+        raise APIException.new(
+          'Invalid input',
+          _context
+        )
+      end
+      validate_response(_context)
+      # Return appropriate response type.
+      _context.response.raw_body
+    end
+  end
+end