Exception: TiktokBusinessApi::Error

Inherits:
StandardError
  • Object
show all
Defined in:
lib/tiktok_business_api/errors.rb

Overview

Base error class for the TikTok Business API

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(message = nil, status_code = nil, body = nil, request = nil) ⇒ Error

Initialize a new error

Parameters:

  • message (String) (defaults to: nil) —

    Error message

  • status_code (Integer) (defaults to: nil) —

    HTTP status code

  • body (Hash) (defaults to: nil) —

    Response body

  • request (Hash) (defaults to: nil) —

    Request that caused the error



21
22
23
24
25
26
 
# File 'lib/tiktok_business_api/errors.rb', line 21

def initialize(message = nil, status_code = nil, body = nil, request = nil)
  @status_code = status_code
  @body = body
  @request = request
  super(message)
end

Instance Attribute Details

#body ⇒ Hash (readonly)

Returns Full response body.

Returns:

  • (Hash) —

    Full response body



10
11
12
 
# File 'lib/tiktok_business_api/errors.rb', line 10

def body
  @body
end

#request ⇒ Hash (readonly)

Returns Request that caused the error.

Returns:

  • (Hash) —

    Request that caused the error



13
14
15
 
# File 'lib/tiktok_business_api/errors.rb', line 13

def request
  @request
end

#status_code ⇒ Integer (readonly)

Returns HTTP status code.

Returns:

  • (Integer) —

    HTTP status code



7
8
9
 
# File 'lib/tiktok_business_api/errors.rb', line 7

def status_code
  @status_code
end