Class: Beanie::AddressBlockApi

Inherits:
Object
  • Object
show all
Defined in:
lib/beanie/api/address_block_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AddressBlockApi

Returns a new instance of AddressBlockApi.



19
20
21
 
# File 'lib/beanie/api/address_block_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/beanie/api/address_block_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_address_block(address_blocks, opts = {}) ⇒ AddressBlock

Creates a new address block in the system

Parameters:

  • address_blocks —

    Address block to add to the system

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/beanie/api/address_block_api.rb', line 26

def add_address_block(address_blocks, opts = {})
  data, _status_code, _headers = add_address_block_with_http_info(address_blocks, opts)
  data
end

#add_address_block_with_http_info(address_blocks, opts = {}) ⇒ Array<(AddressBlock, Fixnum, Hash)>

Creates a new address block in the system

Parameters:

  • address_blocks —

    Address block to add to the system

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AddressBlock, Fixnum, Hash)>) —

    AddressBlock data, response status code and response headers



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/beanie/api/address_block_api.rb', line 35

def add_address_block_with_http_info(address_blocks, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AddressBlockApi.add_address_block ...'
  end
  # verify the required parameter 'address_blocks' is set
  if @api_client.config.client_side_validation && address_blocks.nil?
    fail ArgumentError, "Missing the required parameter 'address_blocks' when calling AddressBlockApi.add_address_block"
  end
  # resource path
  local_var_path = '/address_blocks'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(address_blocks)
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AddressBlock')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AddressBlockApi#add_address_block\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#find_address_block_by_id(id, opts = {}) ⇒ AddressBlock

Find Address block by ID Returns a single address block if the user has access

Parameters:

  • id —

    ID of address block to fetch

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



79
80
81
82
 
# File 'lib/beanie/api/address_block_api.rb', line 79

def find_address_block_by_id(id, opts = {})
  data, _status_code, _headers = find_address_block_by_id_with_http_info(id, opts)
  data
end

#find_address_block_by_id_with_http_info(id, opts = {}) ⇒ Array<(AddressBlock, Fixnum, Hash)>

Find Address block by ID Returns a single address block if the user has access

Parameters:

  • id —

    ID of address block to fetch

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AddressBlock, Fixnum, Hash)>) —

    AddressBlock data, response status code and response headers



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/beanie/api/address_block_api.rb', line 89

def find_address_block_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AddressBlockApi.find_address_block_by_id ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AddressBlockApi.find_address_block_by_id"
  end
  # resource path
  local_var_path = '/address_blocks/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AddressBlock')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AddressBlockApi#find_address_block_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#find_address_blocks(opts = {}) ⇒ Array<AddressBlock>

All address block Returns all address block from the system that the user has access to

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :tags (Array<String>) —

    tags to filter by

  • :limit (Integer) —

    Maximum number of results to return

Returns:



134
135
136
137
 
# File 'lib/beanie/api/address_block_api.rb', line 134

def find_address_blocks(opts = {})
  data, _status_code, _headers = find_address_blocks_with_http_info(opts)
  data
end

#find_address_blocks_with_http_info(opts = {}) ⇒ Array<(Array<AddressBlock>, Fixnum, Hash)>

All address block Returns all address block from the system that the user has access to

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :tags (Array<String>) —

    tags to filter by

  • :limit (Integer) —

    Maximum number of results to return

Returns:

  • (Array<(Array<AddressBlock>, Fixnum, Hash)>) —

    Array<AddressBlock> data, response status code and response headers



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/beanie/api/address_block_api.rb', line 145

def find_address_blocks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AddressBlockApi.find_address_blocks ...'
  end
  # resource path
  local_var_path = '/address_blocks'

  # query parameters
  query_params = {}
  query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<AddressBlock>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AddressBlockApi#find_address_blocks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end