pepipost_gem 2.5.0 → 5.0.0

data/lib/pepipost/controllers/subaccounts_controller.rb

@@ -0,0 +1,68 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # SubaccountsController
+  class SubaccountsController < BaseController
+    @instance = SubaccountsController.new
+
+    class << self
+      attr_accessor :instance
+    end
+
+    def instance
+      self.class.instance
+    end
+
+    # Lets you enable or disable a subaccount
+    # @param [EnableOrDisableSubacoount] body Required parameter: enable or
+    # disable subaccount
+    # @return Object response from the API call
+    def update_subaccounts_patch(body)
+      # Prepare query url.
+      _path_url = '/subaccounts'
+      _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.patch(
+        _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/subaccounts_create_subaccount_controller.rb

@@ -0,0 +1,68 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # SubaccountsCreateSubaccountController
+  class SubaccountsCreateSubaccountController < BaseController
+    @instance = SubaccountsCreateSubaccountController.new
+
+    class << self
+      attr_accessor :instance
+    end
+
+    def instance
+      self.class.instance
+    end
+
+    # Subaccount is the same as any regular Pepipost account however the credits
+    # are managed by the master account.
+    # @param [CreateSubaccount] body Required parameter: create sub account
+    # @return Object response from the API call
+    def create_subaccounts_create_subaccount_post(body)
+      # Prepare query url.
+      _path_url = '/subaccounts/createSubaccount'
+      _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/subaccounts_delete_controller.rb

@@ -0,0 +1,67 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # SubaccountsDeleteController
+  class SubaccountsDeleteController < BaseController
+    @instance = SubaccountsDeleteController.new
+
+    class << self
+      attr_accessor :instance
+    end
+
+    def instance
+      self.class.instance
+    end
+
+    # Lets you delete a subaccount
+    # @param [DeleteSubacoount] body Required parameter: delete subaccount
+    # @return Object response from the API call
+    def delete_subaccounts_delete_delete(body)
+      # Prepare query url.
+      _path_url = '/subaccounts/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/subaccounts_get_sub_accounts_controller.rb

@@ -0,0 +1,71 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # SubaccountsGetSubAccountsController
+  class SubaccountsGetSubAccountsController < BaseController
+    @instance = SubaccountsGetSubAccountsController.new
+
+    class << self
+      attr_accessor :instance
+    end
+
+    def instance
+      self.class.instance
+    end
+
+    # Lets you fetch all the subaccounts created by you
+    # @param [String] limit Required parameter: Example:
+    # @param [String] offset Required parameter: Example:
+    # @return Object response from the API call
+    def get_subaccounts_get_sub_accounts_get(limit,
+                                             offset)
+      # Prepare query url.
+      _path_url = '/subaccounts/getSubAccounts'
+      _query_builder = Configuration.base_uri.dup
+      _query_builder << _path_url
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        {
+          'limit' => limit,
+          'offset' => offset
+        },
+        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/subaccounts_setsubaccountcredit_controller.rb

@@ -0,0 +1,68 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # SubaccountsSetsubaccountcreditController
+  class SubaccountsSetsubaccountcreditController < BaseController
+    @instance = SubaccountsSetsubaccountcreditController.new
+
+    class << self
+      attr_accessor :instance
+    end
+
+    def instance
+      self.class.instance
+    end
+
+    # Lets you add(or remove) credits to a subaccount
+    # @param [UpdateCredisOfSubaccount] body Required parameter: Update credit
+    # account
+    # @return Object response from the API call
+    def create_subaccounts_setsubaccountcredit_post(body)
+      # Prepare query url.
+      _path_url = '/subaccounts/setsubaccountcredit'
+      _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/subaccounts_update_subaccount_controller.rb

@@ -0,0 +1,67 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # SubaccountsUpdateSubaccountController
+  class SubaccountsUpdateSubaccountController < BaseController
+    @instance = SubaccountsUpdateSubaccountController.new
+
+    class << self
+      attr_accessor :instance
+    end
+
+    def instance
+      self.class.instance
+    end
+
+    # lets you update credentials and credit type of a subaccount.
+    # @param [UpdateSubaccount] body Required parameter: Update sub account
+    # @return Object response from the API call
+    def create_subaccounts_update_subaccount_post(body)
+      # Prepare query url.
+      _path_url = '/subaccounts/updateSubaccount'
+      _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/suppression_controller.rb

@@ -0,0 +1,121 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # SuppressionController
+  class SuppressionController < BaseController
+    @instance = SuppressionController.new
+
+    class << self
+      attr_accessor :instance
+    end
+
+    def instance
+      self.class.instance
+    end
+
+    # This API allows you to suppress an email address and block any future
+    # email delivery attempts on this email address.
+    # @param [AddEmailOrDomainToSuppressionList] body Required parameter: add
+    # email or domain to suppression list
+    # @return Object response from the API call
+    def add_domain_or_email_to_suppression_list(body)
+      # Prepare query url.
+      _path_url = '/suppression'
+      _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
+
+    # Use this API to remove an email address or a recipient domain from the
+    # suppression list. You can remove multiple email addresses and recipient
+    # domains together by passing them as values & separating them using commas
+    # as shown below.
+    # @param [RemoveEmailOrDomainToSuppressionList] body Required parameter:
+    # remove email or domain to suppression list
+    # @return Object response from the API call
+    def remove_domain_or_email_to_suppression_list(body)
+      # Prepare query url.
+      _path_url = '/suppression'
+      _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