Class: Amocrm::Resources::CustomersMode

Inherits:

Object

• Object
• Amocrm::Resources::CustomersMode

Defined in:

lib/amocrm/resources/customers_mode.rb

Instance Method Summary

• #initialize(client:) ⇒ CustomersMode constructor private

  A new instance of CustomersMode.

• #set_mode(is_enabled:, mode:, request_options: {}) ⇒ Amocrm::Models::CustomersModeSetModeResponse::CustomerModeResponse, Amocrm::Models::CustomersModeSetModeResponse::Problem

  Enable or switch customers mode.

Constructor Details

#initialize(client:) ⇒ CustomersMode

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

Parameters:

• client (Amocrm::Client)

# File 'lib/amocrm/resources/customers_mode.rb', line 31

def initialize(client:)
  @client = client
end

Instance Method Details

#set_mode(is_enabled:, mode:, request_options: {}) ⇒ Amocrm::Models::CustomersModeSetModeResponse::CustomerModeResponse, Amocrm::Models::CustomersModeSetModeResponse::Problem

Enable or switch customers mode.

Parameters:

• is_enabled (Boolean)
• mode (Symbol, Amocrm::Models::CustomersModeSetModeParams::Mode)
• request_options (Amocrm::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Amocrm::Models::CustomersModeSetModeResponse::CustomerModeResponse, Amocrm::Models::CustomersModeSetModeResponse::Problem)

See Also:

• Models::CustomersModeSetModeParams

# File 'lib/amocrm/resources/customers_mode.rb', line 17

def set_mode(params)
  parsed, options = Amocrm::CustomersModeSetModeParams.dump_request(params)
  @client.request(
    method: :patch,
    path: "api/v4/customers/mode",
    body: parsed,
    model: Amocrm::Models::CustomersModeSetModeResponse,
    options: options
  )
end