Class: Amocrm::Resources::WebsiteButtons

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ WebsiteButtons

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

Parameters:



120
121
122
 
# File 'lib/amocrm/resources/website_buttons.rb', line 120

def initialize(client:)
  @client = client
end

Instance Method Details

#connect_online_chat(source_id, request_options: {}) ⇒ Amocrm::Models::WebsiteButtonConnectOnlineChatResponse::EmptyResponse, Amocrm::Models::WebsiteButtonConnectOnlineChatResponse::Problem

Connect online chat to CRM Plugin.

Parameters:

Returns:

See Also:



85
86
87
88
89
90
91
92
 
# File 'lib/amocrm/resources/website_buttons.rb', line 85

def connect_online_chat(source_id, params = {})
  @client.request(
    method: :post,
    path: ["api/v4/website_buttons/%1$s/online_chat", source_id],
    model: Amocrm::Models::WebsiteButtonConnectOnlineChatResponse,
    options: params[:request_options]
  )
end

#create(pipeline_id:, is_used_in_app: nil, trusted_websites: nil, request_options: {}) ⇒ Amocrm::Models::WebsiteButtonCreateResponse::WebsiteButtonCreateResponse, Amocrm::Models::WebsiteButtonCreateResponse::Problem

Create CRM Plugin.

Parameters:

  • pipeline_id (Integer)
  • is_used_in_app (Boolean)
  • trusted_websites (Array<String>)
  • request_options (Amocrm::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



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

def create(params)
  parsed, options = Amocrm::WebsiteButtonCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "api/v4/website_buttons",
    body: parsed,
    model: Amocrm::Models::WebsiteButtonCreateResponse,
    options: options
  )
end

#get_by_source_id(source_id, with: nil, request_options: {}) ⇒ Amocrm::Models::WebsiteButtonGetBySourceIDResponse::WebsiteButton, Amocrm::Models::WebsiteButtonGetBySourceIDResponse::Problem

Get CRM Plugin by source id.

Parameters:

Returns:

See Also:



105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/amocrm/resources/website_buttons.rb', line 105

def get_by_source_id(source_id, params = {})
  parsed, options = Amocrm::WebsiteButtonGetBySourceIDParams.dump_request(params)
  query = Amocrm::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["api/v4/website_buttons/%1$s", source_id],
    query: query,
    model: Amocrm::Models::WebsiteButtonGetBySourceIDResponse,
    options: options
  )
end

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

Get CRM Plugin list.

Parameters:

  • limit (Integer)
  • page (Integer)
  • with (String)
  • request_options (Amocrm::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/amocrm/resources/website_buttons.rb', line 63

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

#update(source_id, trusted_websites:, request_options: {}) ⇒ Amocrm::Models::WebsiteButtonUpdateResponse::WebsiteButton, Amocrm::Models::WebsiteButtonUpdateResponse::Problem

Update CRM Plugin trusted domains.

Parameters:

Returns:

See Also:



40
41
42
43
44
45
46
47
48
49
 
# File 'lib/amocrm/resources/website_buttons.rb', line 40

def update(source_id, params)
  parsed, options = Amocrm::WebsiteButtonUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["api/v4/website_buttons/%1$s", source_id],
    body: parsed,
    model: Amocrm::Models::WebsiteButtonUpdateResponse,
    options: options
  )
end