Class: SignwellSDK::Resources::V1::APIApplications

Inherits:
Object
  • Object
show all
Defined in:
lib/signwell_sdk/resources/v1/api_applications.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ APIApplications

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

Parameters:



53
54
55
 
# File 'lib/signwell_sdk/resources/v1/api_applications.rb', line 53

def initialize(client:)
  @client = client
end

Instance Method Details

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

Deletes an API Application from an account. Supply the unique Application ID from either the Create API Application response or the API Application edit page

Parameters:

Returns:

  • (nil)

See Also:



41
42
43
44
45
46
47
48
 
# File 'lib/signwell_sdk/resources/v1/api_applications.rb', line 41

def delete(id, params = {})
  @client.request(
    method: :delete,
    path: ["api/v1/api_applications/%1$s", id],
    model: NilClass,
    options: params[:request_options]
  )
end

#retrieve(id, request_options: {}) ⇒ nil

Gets the details of a specific API Application within an account. Supply the unique Application ID from either the Create API Application response or the API Application edit page.

Parameters:

Returns:

  • (nil)

See Also:



20
21
22
23
24
25
26
27
 
# File 'lib/signwell_sdk/resources/v1/api_applications.rb', line 20

def retrieve(id, params = {})
  @client.request(
    method: :get,
    path: ["api/v1/api_applications/%1$s", id],
    model: NilClass,
    options: params[:request_options]
  )
end