Class: Amocrm::Resources::Widgets

Inherits:
Object
  • Object
show all
Defined in:
lib/amocrm/resources/widgets.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Widgets

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

Parameters:



92
93
94
 
# File 'lib/amocrm/resources/widgets.rb', line 92

def initialize(client:)
  @client = client
end

Instance Method Details

#get_by_code(widget_code, request_options: {}) ⇒ Amocrm::Models::WidgetGetByCodeResponse::Widget, Amocrm::Models::WidgetGetByCodeResponse::Problem

Get widget info by code.

Parameters:

Returns:

See Also:



39
40
41
42
43
44
45
46
 
# File 'lib/amocrm/resources/widgets.rb', line 39

def get_by_code(widget_code, params = {})
  @client.request(
    method: :get,
    path: ["api/v4/widgets/%1$s", widget_code],
    model: Amocrm::Models::WidgetGetByCodeResponse,
    options: params[:request_options]
  )
end

#install(widget_code, body:, request_options: {}) ⇒ Amocrm::Models::WidgetInstallResponse::Widget, Amocrm::Models::WidgetInstallResponse::Problem

Install widget in account.

Parameters:

Returns:

See Also:



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/amocrm/resources/widgets.rb', line 59

def install(widget_code, params)
  parsed, options = Amocrm::WidgetInstallParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["api/v4/widgets/%1$s", widget_code],
    body: parsed[:body],
    model: Amocrm::Models::WidgetInstallResponse,
    options: options
  )
end

#list(limit: nil, page: nil, request_options: {}) ⇒ Amocrm::Models::WidgetListResponse::WidgetListResponse, Amocrm::Models::WidgetListResponse::Problem

Get widgets list.

Parameters:

Returns:

See Also:



17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/amocrm/resources/widgets.rb', line 17

def list(params = {})
  parsed, options = Amocrm::WidgetListParams.dump_request(params)
  query = Amocrm::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "api/v4/widgets",
    query: query,
    model: Amocrm::Models::WidgetListResponse,
    options: options
  )
end

#uninstall(widget_code, request_options: {}) ⇒ Amocrm::Models::WidgetUninstallResponse::EmptyResponse, Amocrm::Models::WidgetUninstallResponse::Problem

Uninstall widget from account.

Parameters:

Returns:

See Also:



80
81
82
83
84
85
86
87
 
# File 'lib/amocrm/resources/widgets.rb', line 80

def uninstall(widget_code, params = {})
  @client.request(
    method: :delete,
    path: ["api/v4/widgets/%1$s", widget_code],
    model: Amocrm::Models::WidgetUninstallResponse,
    options: params[:request_options]
  )
end