Class: Amocrm::Models::CompanyListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Amocrm::Models::CompanyListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/amocrm/models/company_list_params.rb,
sig/amocrm/models/company_list_params.rbs

Overview

See Also:

• Amocrm::Resources::Companies#list

Defined Under Namespace

Modules: Query

Instance Attribute Summary

• #filter ⇒ Object^?

  Filtering parameters.

• #limit ⇒ Integer^?

  Pagination limit.

• #order ⇒ Object^?

  Sorting, e.g.

• #page ⇒ Integer^?

  Pagination page.

• #query ⇒ String, ...

  Search by query string or id.

• #with ⇒ String^?

  Expand related entities; comma-separated values.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(filter: nil, limit: nil, order: nil, page: nil, query: nil, with: nil, request_options: {}) ⇒ Object constructor
• #to_hash ⇒ {

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(filter: nil, limit: nil, order: nil, page: nil, query: nil, with: nil, request_options: {}) ⇒ Object

Parameters:

• filter (Object) (defaults to: nil) —

  Filtering parameters

• limit (Integer) (defaults to: nil) —

  Pagination limit

• order (Object) (defaults to: nil) —

  Sorting, e.g. order=asc

• page (Integer) (defaults to: nil) —

  Pagination page

• query (String, Integer) (defaults to: nil) —

  Search by query string or id

• with (String) (defaults to: nil) —

  Expand related entities; comma-separated values

• request_options (Amocrm::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/amocrm/models/company_list_params.rb', line 46

Instance Attribute Details

#filter ⇒ Object^?

Filtering parameters

Parameters:

• (top)

Returns:

• (Object, nil)

# File 'lib/amocrm/models/company_list_params.rb', line 14

optional :filter, Amocrm::Internal::Type::Unknown

#limit ⇒ Integer^?

Pagination limit

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/amocrm/models/company_list_params.rb', line 20

optional :limit, Integer

#order ⇒ Object^?

Sorting, e.g. order=asc

Parameters:

• (top)

Returns:

• (Object, nil)

# File 'lib/amocrm/models/company_list_params.rb', line 26

optional :order, Amocrm::Internal::Type::Unknown

#page ⇒ Integer^?

Pagination page

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/amocrm/models/company_list_params.rb', line 32

optional :page, Integer

#query ⇒ String, ...

Search by query string or id

Returns:

• (String, Integer, nil)

# File 'lib/amocrm/models/company_list_params.rb', line 38

optional :query, union: -> { Amocrm::CompanyListParams::Query }

#with ⇒ String^?

Expand related entities; comma-separated values

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/amocrm/models/company_list_params.rb', line 44

optional :with, String

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/amocrm/models/company_list_params.rbs', line 54

def to_hash: -> {