pulp_npm_client 0.3.3 → 0.4.0

data/docs/RemotesNpmApi.md

@@ -16,7 +16,7 @@ All URIs are relative to *http://localhost:24817*
 
 ## create
 
-> <NpmNpmRemoteResponse> create(npm_npm_remote)
+> <NpmNpmRemoteResponse> create(npm_npm_remote, opts)
 
 Create a npm remote
 
@@ -36,10 +36,13 @@ end
 
 api_instance = PulpNpmClient::RemotesNpmApi.new
 npm_npm_remote = PulpNpmClient::NpmNpmRemote.new({name: 'name_example', url: 'url_example'}) # NpmNpmRemote | 
+opts = {
+  x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
+}
 
 begin
   # Create a npm remote
-  result = api_instance.create(npm_npm_remote)
+  result = api_instance.create(npm_npm_remote, opts)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Error when calling RemotesNpmApi->create: #{e}"
@@ -50,12 +53,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<NpmNpmRemoteResponse>, Integer, Hash)> create_with_http_info(npm_npm_remote)
+> <Array(<NpmNpmRemoteResponse>, Integer, Hash)> create_with_http_info(npm_npm_remote, opts)
 
 ```ruby
 begin
   # Create a npm remote
-  data, status_code, headers = api_instance.create_with_http_info(npm_npm_remote)
+  data, status_code, headers = api_instance.create_with_http_info(npm_npm_remote, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <NpmNpmRemoteResponse>
@@ -69,6 +72,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **npm_npm_remote** | [**NpmNpmRemote**](NpmNpmRemote.md) |  |  |
+| **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
 
 ### Return type
 
@@ -86,7 +90,7 @@ end
 
 ## delete
 
-> <AsyncOperationResponse> delete(npm_npm_remote_href)
+> <AsyncOperationResponse> delete(npm_npm_remote_href, opts)
 
 Delete a npm remote
 
@@ -106,10 +110,13 @@ end
 
 api_instance = PulpNpmClient::RemotesNpmApi.new
 npm_npm_remote_href = 'npm_npm_remote_href_example' # String | 
+opts = {
+  x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
+}
 
 begin
   # Delete a npm remote
-  result = api_instance.delete(npm_npm_remote_href)
+  result = api_instance.delete(npm_npm_remote_href, opts)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Error when calling RemotesNpmApi->delete: #{e}"
@@ -120,12 +127,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<AsyncOperationResponse>, Integer, Hash)> delete_with_http_info(npm_npm_remote_href)
+> <Array(<AsyncOperationResponse>, Integer, Hash)> delete_with_http_info(npm_npm_remote_href, opts)
 
 ```ruby
 begin
   # Delete a npm remote
-  data, status_code, headers = api_instance.delete_with_http_info(npm_npm_remote_href)
+  data, status_code, headers = api_instance.delete_with_http_info(npm_npm_remote_href, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <AsyncOperationResponse>
@@ -139,6 +146,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **npm_npm_remote_href** | **String** |  |  |
+| **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
 
 ### Return type
 
@@ -176,6 +184,7 @@ end
 
 api_instance = PulpNpmClient::RemotesNpmApi.new
 opts = {
+  x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
   limit: 56, # Integer | Number of results to return per page.
   name: 'name_example', # String | Filter results where name matches value
   name__contains: 'name__contains_example', # String | Filter results where name contains value
@@ -235,6 +244,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
 | **limit** | **Integer** | Number of results to return per page. | [optional] |
 | **name** | **String** | Filter results where name matches value | [optional] |
 | **name__contains** | **String** | Filter results where name contains value | [optional] |
@@ -278,7 +288,7 @@ end
 
 ## partial_update
 
-> <AsyncOperationResponse> partial_update(npm_npm_remote_href, patchednpm_npm_remote)
+> <AsyncOperationResponse> partial_update(npm_npm_remote_href, patchednpm_npm_remote, opts)
 
 Update a npm remote
 
@@ -299,10 +309,13 @@ end
 api_instance = PulpNpmClient::RemotesNpmApi.new
 npm_npm_remote_href = 'npm_npm_remote_href_example' # String | 
 patchednpm_npm_remote = PulpNpmClient::PatchednpmNpmRemote.new # PatchednpmNpmRemote | 
+opts = {
+  x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
+}
 
 begin
   # Update a npm remote
-  result = api_instance.partial_update(npm_npm_remote_href, patchednpm_npm_remote)
+  result = api_instance.partial_update(npm_npm_remote_href, patchednpm_npm_remote, opts)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Error when calling RemotesNpmApi->partial_update: #{e}"
@@ -313,12 +326,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<AsyncOperationResponse>, Integer, Hash)> partial_update_with_http_info(npm_npm_remote_href, patchednpm_npm_remote)
+> <Array(<AsyncOperationResponse>, Integer, Hash)> partial_update_with_http_info(npm_npm_remote_href, patchednpm_npm_remote, opts)
 
 ```ruby
 begin
   # Update a npm remote
-  data, status_code, headers = api_instance.partial_update_with_http_info(npm_npm_remote_href, patchednpm_npm_remote)
+  data, status_code, headers = api_instance.partial_update_with_http_info(npm_npm_remote_href, patchednpm_npm_remote, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <AsyncOperationResponse>
@@ -333,6 +346,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **npm_npm_remote_href** | **String** |  |  |
 | **patchednpm_npm_remote** | [**PatchednpmNpmRemote**](PatchednpmNpmRemote.md) |  |  |
+| **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
 
 ### Return type
 
@@ -371,6 +385,7 @@ end
 api_instance = PulpNpmClient::RemotesNpmApi.new
 npm_npm_remote_href = 'npm_npm_remote_href_example' # String | 
 opts = {
+  x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
   fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
   exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
 }
@@ -407,6 +422,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **npm_npm_remote_href** | **String** |  |  |
+| **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
 | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
 | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
 
@@ -426,7 +442,7 @@ end
 
 ## set_label
 
-> <SetLabelResponse> set_label(npm_npm_remote_href, set_label)
+> <SetLabelResponse> set_label(npm_npm_remote_href, set_label, opts)
 
 Set a label
 
@@ -447,10 +463,13 @@ end
 api_instance = PulpNpmClient::RemotesNpmApi.new
 npm_npm_remote_href = 'npm_npm_remote_href_example' # String | 
 set_label = PulpNpmClient::SetLabel.new({key: 'key_example', value: 'value_example'}) # SetLabel | 
+opts = {
+  x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
+}
 
 begin
   # Set a label
-  result = api_instance.set_label(npm_npm_remote_href, set_label)
+  result = api_instance.set_label(npm_npm_remote_href, set_label, opts)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Error when calling RemotesNpmApi->set_label: #{e}"
@@ -461,12 +480,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<SetLabelResponse>, Integer, Hash)> set_label_with_http_info(npm_npm_remote_href, set_label)
+> <Array(<SetLabelResponse>, Integer, Hash)> set_label_with_http_info(npm_npm_remote_href, set_label, opts)
 
 ```ruby
 begin
   # Set a label
-  data, status_code, headers = api_instance.set_label_with_http_info(npm_npm_remote_href, set_label)
+  data, status_code, headers = api_instance.set_label_with_http_info(npm_npm_remote_href, set_label, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <SetLabelResponse>
@@ -481,6 +500,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **npm_npm_remote_href** | **String** |  |  |
 | **set_label** | [**SetLabel**](SetLabel.md) |  |  |
+| **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
 
 ### Return type
 
@@ -498,7 +518,7 @@ end
 
 ## unset_label
 
-> <UnsetLabelResponse> unset_label(npm_npm_remote_href, unset_label)
+> <UnsetLabelResponse> unset_label(npm_npm_remote_href, unset_label, opts)
 
 Unset a label
 
@@ -519,10 +539,13 @@ end
 api_instance = PulpNpmClient::RemotesNpmApi.new
 npm_npm_remote_href = 'npm_npm_remote_href_example' # String | 
 unset_label = PulpNpmClient::UnsetLabel.new({key: 'key_example'}) # UnsetLabel | 
+opts = {
+  x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
+}
 
 begin
   # Unset a label
-  result = api_instance.unset_label(npm_npm_remote_href, unset_label)
+  result = api_instance.unset_label(npm_npm_remote_href, unset_label, opts)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Error when calling RemotesNpmApi->unset_label: #{e}"
@@ -533,12 +556,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<UnsetLabelResponse>, Integer, Hash)> unset_label_with_http_info(npm_npm_remote_href, unset_label)
+> <Array(<UnsetLabelResponse>, Integer, Hash)> unset_label_with_http_info(npm_npm_remote_href, unset_label, opts)
 
 ```ruby
 begin
   # Unset a label
-  data, status_code, headers = api_instance.unset_label_with_http_info(npm_npm_remote_href, unset_label)
+  data, status_code, headers = api_instance.unset_label_with_http_info(npm_npm_remote_href, unset_label, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <UnsetLabelResponse>
@@ -553,6 +576,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **npm_npm_remote_href** | **String** |  |  |
 | **unset_label** | [**UnsetLabel**](UnsetLabel.md) |  |  |
+| **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
 
 ### Return type
 
@@ -570,7 +594,7 @@ end
 
 ## update
 
-> <AsyncOperationResponse> update(npm_npm_remote_href, npm_npm_remote)
+> <AsyncOperationResponse> update(npm_npm_remote_href, npm_npm_remote, opts)
 
 Update a npm remote
 
@@ -591,10 +615,13 @@ end
 api_instance = PulpNpmClient::RemotesNpmApi.new
 npm_npm_remote_href = 'npm_npm_remote_href_example' # String | 
 npm_npm_remote = PulpNpmClient::NpmNpmRemote.new({name: 'name_example', url: 'url_example'}) # NpmNpmRemote | 
+opts = {
+  x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
+}
 
 begin
   # Update a npm remote
-  result = api_instance.update(npm_npm_remote_href, npm_npm_remote)
+  result = api_instance.update(npm_npm_remote_href, npm_npm_remote, opts)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Error when calling RemotesNpmApi->update: #{e}"
@@ -605,12 +632,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<AsyncOperationResponse>, Integer, Hash)> update_with_http_info(npm_npm_remote_href, npm_npm_remote)
+> <Array(<AsyncOperationResponse>, Integer, Hash)> update_with_http_info(npm_npm_remote_href, npm_npm_remote, opts)
 
 ```ruby
 begin
   # Update a npm remote
-  data, status_code, headers = api_instance.update_with_http_info(npm_npm_remote_href, npm_npm_remote)
+  data, status_code, headers = api_instance.update_with_http_info(npm_npm_remote_href, npm_npm_remote, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <AsyncOperationResponse>
@@ -625,6 +652,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **npm_npm_remote_href** | **String** |  |  |
 | **npm_npm_remote** | [**NpmNpmRemote**](NpmNpmRemote.md) |  |  |
+| **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
 
 ### Return type