Class: SignwellSDK::Resources::V1

Inherits:
Object
  • Object
show all
Defined in:
lib/signwell_sdk/resources/v1.rb,
lib/signwell_sdk/resources/v1/hooks.rb,
lib/signwell_sdk/resources/v1/documents.rb,
lib/signwell_sdk/resources/v1/bulk_sends.rb,
lib/signwell_sdk/resources/v1/api_applications.rb,
lib/signwell_sdk/resources/v1/document_templates.rb

Defined Under Namespace

Classes: APIApplications, BulkSends, DocumentTemplates, Documents, Hooks

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ V1

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

Parameters:



37
38
39
40
41
42
43
44
 
# File 'lib/signwell_sdk/resources/v1.rb', line 37

def initialize(client:)
  @client = client
  @documents = SignwellSDK::Resources::V1::Documents.new(client: client)
  @document_templates = SignwellSDK::Resources::V1::DocumentTemplates.new(client: client)
  @api_applications = SignwellSDK::Resources::V1::APIApplications.new(client: client)
  @hooks = SignwellSDK::Resources::V1::Hooks.new(client: client)
  @bulk_sends = SignwellSDK::Resources::V1::BulkSends.new(client: client)
end

Instance Attribute Details

#api_applications ⇒ SignwellSDK::Resources::V1::APIApplications (readonly)

Returns:



13
14
15
 
# File 'lib/signwell_sdk/resources/v1.rb', line 13

def api_applications
  @api_applications
end

#bulk_sends ⇒ SignwellSDK::Resources::V1::BulkSends (readonly)

Returns:



19
20
21
 
# File 'lib/signwell_sdk/resources/v1.rb', line 19

def bulk_sends
  @bulk_sends
end

#document_templates ⇒ SignwellSDK::Resources::V1::DocumentTemplates (readonly)

Returns:



10
11
12
 
# File 'lib/signwell_sdk/resources/v1.rb', line 10

def document_templates
  @document_templates
end

#documents ⇒ SignwellSDK::Resources::V1::Documents (readonly)

Returns:



7
8
9
 
# File 'lib/signwell_sdk/resources/v1.rb', line 7

def documents
  @documents
end

#hooks ⇒ SignwellSDK::Resources::V1::Hooks (readonly)

Returns:



16
17
18
 
# File 'lib/signwell_sdk/resources/v1.rb', line 16

def hooks
  @hooks
end

Instance Method Details

#me(request_options: {}) ⇒ nil

Retrieves the account information associated with the API key being used.

Parameters:

Returns:

  • (nil)

See Also:



30
31
32
 
# File 'lib/signwell_sdk/resources/v1.rb', line 30

def me(params = {})
  @client.request(method: :get, path: "api/v1/me", model: NilClass, options: params[:request_options])
end