Class: Dodopayments::Resources::Entitlements::Files

Inherits:
Object
  • Object
show all
Defined in:
lib/dodopayments/resources/entitlements/files.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Files

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

Parameters:



57
58
59
 
# File 'lib/dodopayments/resources/entitlements/files.rb', line 57

def initialize(client:)
  @client = client
end

Instance Method Details

#delete(file_id, id:, request_options: {}) ⇒ nil

Detach a previously-attached file from a ‘digital_files` entitlement.

Parameters:

  • file_id (String) —

    Identifier of the attached file

  • id (String) —

    Entitlement Id

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

Returns:

  • (nil)

See Also:



20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/dodopayments/resources/entitlements/files.rb', line 20

def delete(file_id, params)
  parsed, options = Dodopayments::Entitlements::FileDeleteParams.dump_request(params)
  id =
    parsed.delete(:id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["entitlements/%1$s/files/%2$s", id, file_id],
    model: NilClass,
    options: options
  )
end

#upload(id, request_options: {}) ⇒ Dodopayments::Models::Entitlements::FileUploadResponse

Attach a file to a ‘digital_files` entitlement. Per-file size cap: 500 MiB.

Parameters:

Returns:

See Also:



45
46
47
48
49
50
51
52
 
# File 'lib/dodopayments/resources/entitlements/files.rb', line 45

def upload(id, params = {})
  @client.request(
    method: :post,
    path: ["entitlements/%1$s/files", id],
    model: Dodopayments::Models::Entitlements::FileUploadResponse,
    options: params[:request_options]
  )
end