Class: Falcon::DeliverySettings

Inherits:
Object
  • Object
show all
Defined in:
lib/crimson-falcon/api/delivery_settings.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DeliverySettings

Returns a new instance of DeliverySettings.



35
36
37
 
# File 'lib/crimson-falcon/api/delivery_settings.rb', line 35

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



33
34
35
 
# File 'lib/crimson-falcon/api/delivery_settings.rb', line 33

def api_client
  @api_client
end

Instance Method Details

#get_delivery_settings(opts = {}) ⇒ ModelsDeliverySettingsEntityResponse

Get Delivery Settings

Parameters:

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

    the optional parameters

Returns:



41
42
43
44
 
# File 'lib/crimson-falcon/api/delivery_settings.rb', line 41

def get_delivery_settings(opts = {})
  data, _status_code, _headers = get_delivery_settings_with_http_info(opts)
  data
end

#get_delivery_settings_with_http_info(opts = {}) ⇒ Array<(ModelsDeliverySettingsEntityResponse, Integer, Hash)>

Get Delivery Settings

Parameters:

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

    the optional parameters

Returns:



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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/crimson-falcon/api/delivery_settings.rb', line 49

def get_delivery_settings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeliverySettings.get_delivery_settings ...'
  end
  # resource path
  local_var_path = '/delivery-settings/entities/delivery-settings/v1'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ModelsDeliverySettingsEntityResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"DeliverySettings.get_delivery_settings",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DeliverySettings#get_delivery_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_delivery_settings(body, opts = {}) ⇒ ModelsDeliverySettingsEntityResponse

Create Delivery Settings

Parameters:

Returns:



97
98
99
100
 
# File 'lib/crimson-falcon/api/delivery_settings.rb', line 97

def post_delivery_settings(body, opts = {})
  data, _status_code, _headers = post_delivery_settings_with_http_info(body, opts)
  data
end

#post_delivery_settings_with_http_info(body, opts = {}) ⇒ Array<(ModelsDeliverySettingsEntityResponse, Integer, Hash)>

Create Delivery Settings

Parameters:

Returns:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/crimson-falcon/api/delivery_settings.rb', line 106

def post_delivery_settings_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeliverySettings.post_delivery_settings ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling DeliverySettings.post_delivery_settings"
  end
  # resource path
  local_var_path = '/delivery-settings/entities/delivery-settings/v1'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'ModelsDeliverySettingsEntityResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"DeliverySettings.post_delivery_settings",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DeliverySettings#post_delivery_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end