def update_params_for_auth(self, headers, querys, auth_settings): """Updates header and query params based on authentication setting. :param headers: Header parameters dict to be updated. :param querys: Query parameters tuple list to be updated. :param auth_settings: Authentication setting identifiers list. """ if not auth_settings: return for auth in auth_settings: auth_setting = self.configuration.auth_settings().get(auth) if auth_setting: if auth_setting['in'] == 'cookie': headers['Cookie'] = auth_setting['value'] elif auth_setting['in'] == 'header': headers[auth_setting['key']] = auth_setting['value'] elif auth_setting['in'] == 'query': querys.append((auth_setting['key'], auth_setting['value'])) else: raise ApiValueError( 'Authentication token must be in `query` or `header`')
def get_environments_with_http_info(self, program_id, x_gw_ims_org_id, authorization, x_api_key, **kwargs): # noqa: E501 """List Environments # noqa: E501 Lists all environments in an program # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_environments_with_http_info(program_id, x_gw_ims_org_id, authorization, x_api_key, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str program_id: Identifier of the program (required) :param str x_gw_ims_org_id: IMS organization ID that the request is being made under. (required) :param str authorization: Bearer [token] - An access token for the technical account created through integration with Adobe IO (required) :param str x_api_key: IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io (required) :param str type: Type of the environment :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EnvironmentList, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'program_id', 'x_gw_ims_org_id', 'authorization', 'x_api_key', 'type' ] all_params.extend([ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ]) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError("Got an unexpected keyword argument '%s'" " to method get_environments" % key) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'program_id' is set if self.api_client.client_side_validation and ( 'program_id' not in local_var_params or # noqa: E501 local_var_params['program_id'] is None): # noqa: E501 raise ApiValueError( "Missing the required parameter `program_id` when calling `get_environments`" ) # noqa: E501 # verify the required parameter 'x_gw_ims_org_id' is set if self.api_client.client_side_validation and ( 'x_gw_ims_org_id' not in local_var_params or # noqa: E501 local_var_params['x_gw_ims_org_id'] is None): # noqa: E501 raise ApiValueError( "Missing the required parameter `x_gw_ims_org_id` when calling `get_environments`" ) # noqa: E501 # verify the required parameter 'authorization' is set if self.api_client.client_side_validation and ( 'authorization' not in local_var_params or # noqa: E501 local_var_params['authorization'] is None): # noqa: E501 raise ApiValueError( "Missing the required parameter `authorization` when calling `get_environments`" ) # noqa: E501 # verify the required parameter 'x_api_key' is set if self.api_client.client_side_validation and ( 'x_api_key' not in local_var_params or # noqa: E501 local_var_params['x_api_key'] is None): # noqa: E501 raise ApiValueError( "Missing the required parameter `x_api_key` when calling `get_environments`" ) # noqa: E501 collection_formats = {} path_params = {} if 'program_id' in local_var_params: path_params['programId'] = local_var_params[ 'program_id'] # noqa: E501 query_params = [] if 'type' in local_var_params and local_var_params[ 'type'] is not None: # noqa: E501 query_params.append( ('type', local_var_params['type'])) # noqa: E501 header_params = {} if 'x_gw_ims_org_id' in local_var_params: header_params['x-gw-ims-org-id'] = local_var_params[ 'x_gw_ims_org_id'] # noqa: E501 if 'authorization' in local_var_params: header_params['Authorization'] = local_var_params[ 'authorization'] # noqa: E501 if 'x_api_key' in local_var_params: header_params['x-api-key'] = local_var_params[ 'x_api_key'] # noqa: E501 form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/api/program/{programId}/environments', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EnvironmentList', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get( '_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
def request(self, method, url, query_params=None, headers=None, body=None, post_params=None, _preload_content=True, _request_timeout=None): """Perform requests. :param method: http request method :param url: http request url :param query_params: query parameters in the url :param headers: http request headers :param body: request json body, for `application/json` :param post_params: request post parameters, `application/x-www-form-urlencoded` and `multipart/form-data` :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. """ method = method.upper() assert method in [ 'GET', 'HEAD', 'DELETE', 'POST', 'PUT', 'PATCH', 'OPTIONS' ] if post_params and body: raise ApiValueError( "body parameter cannot be used with post_params parameter.") post_params = post_params or {} headers = headers or {} timeout = None if _request_timeout: if isinstance(_request_timeout, (int, ) if six.PY3 else (int, long)): # noqa: E501,F821 timeout = urllib3.Timeout(total=_request_timeout) elif (isinstance(_request_timeout, tuple) and len(_request_timeout) == 2): timeout = urllib3.Timeout(connect=_request_timeout[0], read=_request_timeout[1]) if 'Content-Type' not in headers: headers['Content-Type'] = 'application/json' try: # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE` if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']: if query_params: url += '?' + urlencode(query_params) if re.search('json', headers['Content-Type'], re.IGNORECASE): request_body = None if body is not None: request_body = json.dumps(body) r = self.pool_manager.request( method, url, body=request_body, preload_content=_preload_content, timeout=timeout, headers=headers) elif headers[ 'Content-Type'] == 'application/x-www-form-urlencoded': # noqa: E501 r = self.pool_manager.request( method, url, fields=post_params, encode_multipart=False, preload_content=_preload_content, timeout=timeout, headers=headers) elif headers['Content-Type'] == 'multipart/form-data': # must del headers['Content-Type'], or the correct # Content-Type which generated by urllib3 will be # overwritten. del headers['Content-Type'] r = self.pool_manager.request( method, url, fields=post_params, encode_multipart=True, preload_content=_preload_content, timeout=timeout, headers=headers) # Pass a `string` parameter directly in the body to support # other content types than Json when `body` argument is # provided in serialized form elif isinstance(body, str) or isinstance(body, bytes): request_body = body r = self.pool_manager.request( method, url, body=request_body, preload_content=_preload_content, timeout=timeout, headers=headers) else: # Cannot generate the request from given parameters msg = """Cannot prepare a request message for provided arguments. Please check that your arguments match declared content type.""" raise ApiException(status=0, reason=msg) # For `GET`, `HEAD` else: r = self.pool_manager.request(method, url, fields=query_params, preload_content=_preload_content, timeout=timeout, headers=headers) except urllib3.exceptions.SSLError as e: msg = "{0}\n{1}".format(type(e).__name__, str(e)) raise ApiException(status=0, reason=msg) if _preload_content: r = RESTResponse(r) # In the python 3, the response.data is bytes. # we need to decode it to string. if six.PY3: r.data = r.data.decode('utf8') # log response body logger.debug("response body: %s", r.data) if not 200 <= r.status <= 299: raise ApiException(http_resp=r) return r
def request(self, method, url, query_params=None, headers=None, post_params=None, body=None, _preload_content=True, _request_timeout=None): """Makes the HTTP request using RESTClient.""" if method == "GET": return self.rest_client.GET(url, query_params=query_params, _preload_content=_preload_content, _request_timeout=_request_timeout, headers=headers) elif method == "HEAD": return self.rest_client.HEAD(url, query_params=query_params, _preload_content=_preload_content, _request_timeout=_request_timeout, headers=headers) elif method == "OPTIONS": return self.rest_client.OPTIONS(url, query_params=query_params, headers=headers, _preload_content=_preload_content, _request_timeout=_request_timeout) elif method == "POST": return self.rest_client.POST(url, query_params=query_params, headers=headers, post_params=post_params, _preload_content=_preload_content, _request_timeout=_request_timeout, body=body) elif method == "PUT": return self.rest_client.PUT(url, query_params=query_params, headers=headers, post_params=post_params, _preload_content=_preload_content, _request_timeout=_request_timeout, body=body) elif method == "PATCH": return self.rest_client.PATCH(url, query_params=query_params, headers=headers, post_params=post_params, _preload_content=_preload_content, _request_timeout=_request_timeout, body=body) elif method == "DELETE": return self.rest_client.DELETE(url, query_params=query_params, headers=headers, _preload_content=_preload_content, _request_timeout=_request_timeout, body=body) else: raise ApiValueError("http method must be `GET`, `HEAD`, `OPTIONS`," " `POST`, `PATCH`, `PUT` or `DELETE`.")
def patch_environment_variables_with_http_info( self, program_id, environment_id, x_gw_ims_org_id, authorization, x_api_key, content_type, body, **kwargs): # noqa: E501 """Patch User Environment Variables # noqa: E501 Modify multiple environment variables (Cloud Service only). To delete a variable, include it with an empty value. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.patch_environment_variables_with_http_info(program_id, environment_id, x_gw_ims_org_id, authorization, x_api_key, content_type, body, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str program_id: Identifier of the program (required) :param str environment_id: Identifier of the environment (required) :param str x_gw_ims_org_id: IMS organization ID that the request is being made under. (required) :param str authorization: Bearer [token] - An access token for the technical account created through integration with Adobe IO (required) :param str x_api_key: IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io (required) :param str content_type: Must always be application/json (required) :param list[Variable] body: The list of variables to add, modify, or remove. It is not necessary to send variables here which are not changing. (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(VariableList, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'program_id', 'environment_id', 'x_gw_ims_org_id', 'authorization', 'x_api_key', 'content_type', 'body' ] all_params.extend([ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ]) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError("Got an unexpected keyword argument '%s'" " to method patch_environment_variables" % key) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'program_id' is set if self.api_client.client_side_validation and ( 'program_id' not in local_var_params or # noqa: E501 local_var_params['program_id'] is None): # noqa: E501 raise ApiValueError( "Missing the required parameter `program_id` when calling `patch_environment_variables`" ) # noqa: E501 # verify the required parameter 'environment_id' is set if self.api_client.client_side_validation and ( 'environment_id' not in local_var_params or # noqa: E501 local_var_params['environment_id'] is None): # noqa: E501 raise ApiValueError( "Missing the required parameter `environment_id` when calling `patch_environment_variables`" ) # noqa: E501 # verify the required parameter 'x_gw_ims_org_id' is set if self.api_client.client_side_validation and ( 'x_gw_ims_org_id' not in local_var_params or # noqa: E501 local_var_params['x_gw_ims_org_id'] is None): # noqa: E501 raise ApiValueError( "Missing the required parameter `x_gw_ims_org_id` when calling `patch_environment_variables`" ) # noqa: E501 # verify the required parameter 'authorization' is set if self.api_client.client_side_validation and ( 'authorization' not in local_var_params or # noqa: E501 local_var_params['authorization'] is None): # noqa: E501 raise ApiValueError( "Missing the required parameter `authorization` when calling `patch_environment_variables`" ) # noqa: E501 # verify the required parameter 'x_api_key' is set if self.api_client.client_side_validation and ( 'x_api_key' not in local_var_params or # noqa: E501 local_var_params['x_api_key'] is None): # noqa: E501 raise ApiValueError( "Missing the required parameter `x_api_key` when calling `patch_environment_variables`" ) # noqa: E501 # verify the required parameter 'content_type' is set if self.api_client.client_side_validation and ( 'content_type' not in local_var_params or # noqa: E501 local_var_params['content_type'] is None): # noqa: E501 raise ApiValueError( "Missing the required parameter `content_type` when calling `patch_environment_variables`" ) # noqa: E501 # verify the required parameter 'body' is set if self.api_client.client_side_validation and ( 'body' not in local_var_params or # noqa: E501 local_var_params['body'] is None): # noqa: E501 raise ApiValueError( "Missing the required parameter `body` when calling `patch_environment_variables`" ) # noqa: E501 collection_formats = {} path_params = {} if 'program_id' in local_var_params: path_params['programId'] = local_var_params[ 'program_id'] # noqa: E501 if 'environment_id' in local_var_params: path_params['environmentId'] = local_var_params[ 'environment_id'] # noqa: E501 query_params = [] header_params = {} if 'x_gw_ims_org_id' in local_var_params: header_params['x-gw-ims-org-id'] = local_var_params[ 'x_gw_ims_org_id'] # noqa: E501 if 'authorization' in local_var_params: header_params['Authorization'] = local_var_params[ 'authorization'] # noqa: E501 if 'x_api_key' in local_var_params: header_params['x-api-key'] = local_var_params[ 'x_api_key'] # noqa: E501 if 'content_type' in local_var_params: header_params['Content-Type'] = local_var_params[ 'content_type'] # noqa: E501 form_params = [] local_var_files = {} body_params = None if 'body' in local_var_params: body_params = local_var_params['body'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params[ 'Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/api/program/{programId}/environment/{environmentId}/variables', 'PATCH', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='VariableList', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get( '_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)