Class: Orb::Resources::Items

Inherits:
Object
  • Object
show all
Defined in:
lib/orb/resources/items.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Items

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Items.

Parameters:



128
129
130
 
# File 'lib/orb/resources/items.rb', line 128

def initialize(client:)
  @client = client
end

Instance Method Details

#archive(item_id, request_options: {}) ⇒ Orb::Models::Item

Archive item

Parameters:

Returns:

See Also:



97
98
99
100
101
102
103
104
 
# File 'lib/orb/resources/items.rb', line 97

def archive(item_id, params = {})
  @client.request(
    method: :post,
    path: ["items/%1$s/archive", item_id],
    model: Orb::Item,
    options: params[:request_options]
  )
end

#create(name: , metadata: nil, request_options: {}) ⇒ Orb::Models::Item

Some parameter documentations has been truncated, see Models::ItemCreateParams for more details.

This endpoint is used to create an [Item](/core-concepts#item).

Parameters:

  • name (String) —

    The name of the item.

  • metadata (Hash{Symbol=>String, nil}, nil) —

    User-specified key/value pairs for the resource. Individual keys can be removed

  • request_options (Orb::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



22
23
24
25
 
# File 'lib/orb/resources/items.rb', line 22

def create(params)
  parsed, options = Orb::ItemCreateParams.dump_request(params)
  @client.request(method: :post, path: "items", body: parsed, model: Orb::Item, options: options)
end

#fetch(item_id, request_options: {}) ⇒ Orb::Models::Item

This endpoint returns an item identified by its item_id.

Parameters:

Returns:

See Also:



116
117
118
119
120
121
122
123
 
# File 'lib/orb/resources/items.rb', line 116

def fetch(item_id, params = {})
  @client.request(
    method: :get,
    path: ["items/%1$s", item_id],
    model: Orb::Item,
    options: params[:request_options]
  )
end

#list(cursor: nil, limit: nil, request_options: {}) ⇒ Orb::Internal::Page<Orb::Models::Item>

Some parameter documentations has been truncated, see Models::ItemListParams for more details.

This endpoint returns a list of all Items, ordered in descending order by creation time.

Parameters:

  • cursor (String, nil) —

    Cursor for pagination. This can be populated by the ‘next_cursor` value returned

  • limit (Integer) —

    The number of items to fetch. Defaults to 20.

  • request_options (Orb::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/orb/resources/items.rb', line 75

def list(params = {})
  parsed, options = Orb::ItemListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "items",
    query: parsed,
    page: Orb::Internal::Page,
    model: Orb::Item,
    options: options
  )
end

#update(item_id, external_connections: nil, metadata: nil, name: nil, request_options: {}) ⇒ Orb::Models::Item

Some parameter documentations has been truncated, see Models::ItemUpdateParams for more details.

This endpoint can be used to update properties on the Item.

Parameters:

Returns:

See Also:



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/orb/resources/items.rb', line 47

def update(item_id, params = {})
  parsed, options = Orb::ItemUpdateParams.dump_request(params)
  @client.request(
    method: :put,
    path: ["items/%1$s", item_id],
    body: parsed,
    model: Orb::Item,
    options: options
  )
end