class NeverBounce::API::Request::JobsStart

Attributes

allow_manual_review[RW]

@return [Boolean]

job_id[RW]

@return [Integer]

run_sample[RW]

@return [Boolean]

Public Class Methods

http_method() click to toggle source

@return [Symbol]

# File lib/never_bounce/api/request/jobs_start.rb, line 18
def self.http_method
  :post
end
path() click to toggle source

@return [String]

# File lib/never_bounce/api/request/jobs_start.rb, line 23
def self.path
  "jobs/start"
end
response_klass() click to toggle source

@return [Response::JobsStart]

# File lib/never_bounce/api/request/jobs_start.rb, line 28
def self.response_klass
  Response::JobsStart
end

Public Instance Methods

mode_h() click to toggle source

Return a ready-to-merge mode attributes hash. @return [Hash]

# File lib/never_bounce/api/request/jobs_start.rb, line 34
def mode_h
  @mode_h ||= {}.tap do |_|
    unless (v = run_sample).nil?
      _[:run_sample] = v
    end

    unless (v = allow_manual_review).nil?
      _[:allow_manual_review] = v
    end
  end
end
to_h() click to toggle source

@return [Hash]

# File lib/never_bounce/api/request/jobs_start.rb, line 47
def to_h
  {
    job_id: require_attr(:job_id),
    key: require_attr(:api_key),
  }.merge(mode_h)
end