Class: Onlyfans::Resources::Media::Vault::Lists

Inherits:
Object
  • Object
show all
Defined in:
lib/onlyfans/resources/media/vault/lists.rb,
lib/onlyfans/resources/media/vault/lists/media.rb

Defined Under Namespace

Classes: Media

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Lists

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 Lists.

Parameters:



148
149
150
151
 
# File 'lib/onlyfans/resources/media/vault/lists.rb', line 148

def initialize(client:)
  @client = client
  @media = Onlyfans::Resources::Media::Vault::Lists::Media.new(client: client)
end

Instance Attribute Details

#media ⇒ Onlyfans::Resources::Media::Vault::Lists::Media (readonly)

Returns:



9
10
11
 
# File 'lib/onlyfans/resources/media/vault/lists.rb', line 9

def media
  @media
end

Instance Method Details

#create(account, name:, request_options: {}) ⇒ Onlyfans::Models::Media::Vault::ListCreateResponse

Create a new Vault list.

Parameters:

  • account (String) —

    The Account ID

  • name (String) —

    The name of your new list

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

Returns:

See Also:



24
25
26
27
28
29
30
31
32
33
 
# File 'lib/onlyfans/resources/media/vault/lists.rb', line 24

def create(, params)
  parsed, options = Onlyfans::Media::Vault::ListCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["api/%1$s/media/vault/lists", ],
    body: parsed,
    model: Onlyfans::Models::Media::Vault::ListCreateResponse,
    options: options
  )
end

#delete(list_id, account:, request_options: {}) ⇒ Onlyfans::Models::Media::Vault::ListDeleteResponse

Delete a Vault list.

Parameters:

  • list_id (String) —

    The ID of the list

  • account (String) —

    The Account ID

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

Returns:

See Also:



131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/onlyfans/resources/media/vault/lists.rb', line 131

def delete(list_id, params)
  parsed, options = Onlyfans::Media::Vault::ListDeleteParams.dump_request(params)
   =
    parsed.delete(:account) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["api/%1$s/media/vault/lists/%2$s", , list_id],
    model: Onlyfans::Models::Media::Vault::ListDeleteResponse,
    options: options
  )
end

#list(account, limit: nil, offset: nil, query: nil, request_options: {}) ⇒ Onlyfans::Models::Media::Vault::ListListResponse

List your Vault lists (categories).

Parameters:

  • account (String) —

    The Account ID

  • limit (Integer) —

    Number of media to return per page. Default: ‘24`

  • offset (Integer) —

    The offset used for pagination. Default ‘0`

  • query (String) —

    Optionally, find a list by its name.

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

Returns:

See Also:



106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/onlyfans/resources/media/vault/lists.rb', line 106

def list(, params = {})
  parsed, options = Onlyfans::Media::Vault::ListListParams.dump_request(params)
  query = Onlyfans::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["api/%1$s/media/vault/lists", ],
    query: query,
    model: Onlyfans::Models::Media::Vault::ListListResponse,
    options: options
  )
end

#retrieve(list_id, account:, request_options: {}) ⇒ Onlyfans::Models::Media::Vault::ListRetrieveResponse

Show a Vault list.

Parameters:

  • list_id (String) —

    The ID of the list

  • account (String) —

    The Account ID

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

Returns:

See Also:



48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/onlyfans/resources/media/vault/lists.rb', line 48

def retrieve(list_id, params)
  parsed, options = Onlyfans::Media::Vault::ListRetrieveParams.dump_request(params)
   =
    parsed.delete(:account) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["api/%1$s/media/vault/lists/%2$s", , list_id],
    model: Onlyfans::Models::Media::Vault::ListRetrieveResponse,
    options: options
  )
end

#update(list_id, account:, request_options: {}) ⇒ Onlyfans::Models::Media::Vault::ListUpdateResponse

Rename a Vault list.

Parameters:

  • list_id (String) —

    The ID of the list

  • account (String) —

    The Account ID

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

Returns:

See Also:



75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/onlyfans/resources/media/vault/lists.rb', line 75

def update(list_id, params)
  parsed, options = Onlyfans::Media::Vault::ListUpdateParams.dump_request(params)
   =
    parsed.delete(:account) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :put,
    path: ["api/%1$s/media/vault/lists/%2$s", , list_id],
    model: Onlyfans::Models::Media::Vault::ListUpdateResponse,
    options: options
  )
end