Class: SubskribeDevClient::EntityApi

Inherits:
Object
  • Object
show all
Defined in:
lib/subskribe_dev/api/entity_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EntityApi

Returns a new instance of EntityApi.



19
20
21
 
# File 'lib/subskribe_dev/api/entity_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/subskribe_dev/api/entity_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#upload_logo(entity_id, opts = {}) ⇒ nil

Update entity logo Updates the logo used in external facing communication such as order forms and invoices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :file (File)

Returns:

  • (nil) 


28
29
30
31
 
# File 'lib/subskribe_dev/api/entity_api.rb', line 28

def (entity_id, opts = {})
  upload_logo_with_http_info(entity_id, opts)
  nil
end

#upload_logo_with_http_info(entity_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update entity logo Updates the logo used in external facing communication such as order forms and invoices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :file (File)

Returns:

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

    nil, response status code and response headers



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
74
75
76
77
 
# File 'lib/subskribe_dev/api/entity_api.rb', line 39

def upload_logo_with_http_info(entity_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntityApi.upload_logo ...'
  end
  # verify the required parameter 'entity_id' is set
  if @api_client.config.client_side_validation && entity_id.nil?
    fail ArgumentError, "Missing the required parameter 'entity_id' when calling EntityApi.upload_logo"
  end
  # resource path
  local_var_path = '/entities/logo/{entityId}'.sub('{' + 'entityId' + '}', entity_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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?

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