Class: Ittybit::TasksClient

Inherits:
Object
  • Object
show all
Defined in:
lib/ittybit/tasks/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Ittybit::TasksClient

Parameters:



17
18
19
 
# File 'lib/ittybit/tasks/client.rb', line 17

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Ittybit::RequestClient (readonly)

Returns:



13
14
15
 
# File 'lib/ittybit/tasks/client.rb', line 13

def request_client
  @request_client
end

Instance Method Details

#create(request: nil, request_options: nil) ⇒ Ittybit::Tasks::TasksCreateResponse

Creates a new task item. See [Tasks](/docs/tasks) for detailed coverage of all

available props and values.

Examples:

api = Ittybit::Client.new(
  base_url: "https://api.example.com",
  environment: Ittybit::Environment::DEFAULT,
  api_key: "YOUR_AUTH_TOKEN"
)
api.tasks.create(request: {"file_id":"file_abcdefgh1234","kind":"image","width":320,"format":"png","ref":"thumbnail"})

Parameters:

Returns:



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/ittybit/tasks/client.rb', line 71

def create(request: nil, request_options: nil)
  response = @request_client.conn.post do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
    req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
    req.headers = {
      **(req.headers || {}),
      **@request_client.get_headers,
      **(request_options&.additional_headers || {}),
      "Accept-Version": "2025-08-20"
    }.compact
    unless request_options.nil? || request_options&.additional_query_parameters.nil?
      req.params = { **(request_options&.additional_query_parameters || {}) }.compact
    end
    req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
    req.url "#{@request_client.get_url(request_options: request_options)}/tasks"
  end
  Ittybit::Tasks::TasksCreateResponse.from_json(json_object: response.body)
end

#get(id:, request_options: nil) ⇒ Ittybit::Tasks::TasksGetResponse

Retrieves the task object for a task with the given ID.

Examples:

api = Ittybit::Client.new(
  base_url: "https://api.example.com",
  environment: Ittybit::Environment::DEFAULT,
  api_key: "YOUR_AUTH_TOKEN"
)
api.tasks.get(id: "task_abcdefgh1234")

Parameters:

Returns:



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/ittybit/tasks/client.rb', line 103

def get(id:, request_options: nil)
  response = @request_client.conn.get do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
    req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
    req.headers = {
      **(req.headers || {}),
      **@request_client.get_headers,
      **(request_options&.additional_headers || {}),
      "Accept-Version": "2025-08-20"
    }.compact
    unless request_options.nil? || request_options&.additional_query_parameters.nil?
      req.params = { **(request_options&.additional_query_parameters || {}) }.compact
    end
    unless request_options.nil? || request_options&.additional_body_parameters.nil?
      req.body = { **(request_options&.additional_body_parameters || {}) }.compact
    end
    req.url "#{@request_client.get_url(request_options: request_options)}/tasks/#{id}"
  end
  Ittybit::Tasks::TasksGetResponse.from_json(json_object: response.body)
end

#list(page: nil, limit: nil, request_options: nil) ⇒ Array<Ittybit::Tasks::TasksListResponseItem>

Retrieves a paginated list of all tasks for the current project.

Examples:

api = Ittybit::Client.new(
  base_url: "https://api.example.com",
  environment: Ittybit::Environment::DEFAULT,
  api_key: "YOUR_AUTH_TOKEN"
)
api.tasks.list

Parameters:

  • page (Integer) (defaults to: nil)
  • limit (Integer) (defaults to: nil)
  • request_options (Ittybit::RequestOptions) (defaults to: nil)

Returns:



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/ittybit/tasks/client.rb', line 34

def list(page: nil, limit: nil, request_options: nil)
  response = @request_client.conn.get do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
    req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
    req.headers = {
      **(req.headers || {}),
      **@request_client.get_headers,
      **(request_options&.additional_headers || {}),
      "Accept-Version": "2025-08-20"
    }.compact
    req.params = { **(request_options&.additional_query_parameters || {}), "page": page, "limit": limit }.compact
    unless request_options.nil? || request_options&.additional_body_parameters.nil?
      req.body = { **(request_options&.additional_body_parameters || {}) }.compact
    end
    req.url "#{@request_client.get_url(request_options: request_options)}/tasks"
  end
  parsed_json = JSON.parse(response.body)
  parsed_json&.map do |item|
    item = item.to_json
    Ittybit::Tasks::TasksListResponseItem.from_json(json_object: item)
  end
end