# Cyclos411Api.ImagesApi All URIs are relative to *https://138.197.145.149:8080/cyclos/eCloudAtm/api* Method | HTTP request | Description ------------- | ------------- | ------------- [**deleteImage**](ImagesApi.md#deleteImage) | **DELETE** /images/{idOrKey} | Removes an image by id or key [**getAdImagesListData**](ImagesApi.md#getAdImagesListData) | **GET** /marketplace/{ad}/images/list-data | Returns the images of an advertisement, plus additional permissions and data [**getImageContent**](ImagesApi.md#getImageContent) | **GET** /images/content/{idOrKey} | Returns an image content by id or key [**getImageContentById**](ImagesApi.md#getImageContentById) | **GET** /images/{id}/content | (deprecated) Returns an image content by id [**getImageContentDeprecated**](ImagesApi.md#getImageContentDeprecated) | **GET** /images/{kind}/{file} | Returns an image content [**getUserImagesListData**](ImagesApi.md#getUserImagesListData) | **GET** /{user}/images/list-data | Returns either `profile` or `custom` images for a given user, plus additional permissions and data [**listAdImages**](ImagesApi.md#listAdImages) | **GET** /marketplace/{ad}/images | Lists the images of an advertisement [**listTempImages**](ImagesApi.md#listTempImages) | **GET** /images/temp | Lists temporary images related to the currently authenticated user or guest [**listUserImages**](ImagesApi.md#listUserImages) | **GET** /{user}/images | Lists either `profile` or `custom` images for a given user [**reorderAdImages**](ImagesApi.md#reorderAdImages) | **PUT** /marketplace/{ad}/images/order | Changes the order of the images of an advertisement [**reorderProfileImages**](ImagesApi.md#reorderProfileImages) | **PUT** /{user}/images/order | Changes the order of a user's profile images [**uploadAdImage**](ImagesApi.md#uploadAdImage) | **POST** /marketplace/{ad}/images | Adds a new image for the given advertisement. [**uploadContactInfoImage**](ImagesApi.md#uploadContactInfoImage) | **POST** /contact-infos/{id}/image | Uploads a new image for the given additional contact information. [**uploadContactInfoImageDeprecated**](ImagesApi.md#uploadContactInfoImageDeprecated) | **POST** /contactInfos/{id}/image | This operation is deprecated, use `POST /contact-infos/{id}/image` instead. [**uploadTempImage**](ImagesApi.md#uploadTempImage) | **POST** /images/temp | Adds a new temporary image for the currently authenticated user or guest. [**uploadUserImage**](ImagesApi.md#uploadUserImage) | **POST** /{user}/images | Adds a new image for the given user. The image kind is either `profile` or `custom`. [**viewImage**](ImagesApi.md#viewImage) | **GET** /images/{idOrKey} | Returns an image details by id or key # **deleteImage** > deleteImage(idOrKey) Removes an image by id or key Removes the image with the given internal id or key. Any image kind can be removed using this operation, but the authenticated user needs the appropriate permission to do so. ### Example ```javascript var Cyclos411Api = require('cyclos_411_api'); var apiInstance = new Cyclos411Api.ImagesApi(); var idOrKey = "idOrKey_example"; // String | The image id or file name var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; apiInstance.deleteImage(idOrKey, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **idOrKey** | **String**| The image id or file name | ### Return type null (empty response body) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **getAdImagesListData** > ImagesListData getAdImagesListData(ad, opts) Returns the images of an advertisement, plus additional permissions and data Returns the images of an advertisement. Additional data, such as the maximum images and whether the images can be managed by the authenticated user are also returned. ### Example ```javascript var Cyclos411Api = require('cyclos_411_api'); var defaultClient = Cyclos411Api.ApiClient.instance; // Configure API key authorization: accessClient var accessClient = defaultClient.authentications['accessClient']; accessClient.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //accessClient.apiKeyPrefix = 'Token'; // Configure HTTP basic authorization: basic var basic = defaultClient.authentications['basic']; basic.username = 'YOUR USERNAME'; basic.password = 'YOUR PASSWORD'; // Configure API key authorization: session var session = defaultClient.authentications['session']; session.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //session.apiKeyPrefix = 'Token'; var apiInstance = new Cyclos411Api.ImagesApi(); var ad = "ad_example"; // String | Can be either the advertisement internal identifier or, in case of webshop advertisements, can be the product number (if the owner is the logged user) or a string in the form `productNumber@user`, with the user identifier as well. var opts = { 'fields': ["fields_example"] // [String] | Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`). }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.getAdImagesListData(ad, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ad** | **String**| Can be either the advertisement internal identifier or, in case of webshop advertisements, can be the product number (if the owner is the logged user) or a string in the form `productNumber@user`, with the user identifier as well. | **fields** | [**[String]**](String.md)| Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`). | [optional] ### Return type [**ImagesListData**](ImagesListData.md) ### Authorization [accessClient](../README.md#accessClient), [basic](../README.md#basic), [session](../README.md#session) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **getImageContent** > File getImageContent(idOrKey, opts) Returns an image content by id or key Returns the content of an image, given the image identifier or key. When neither `width` nor `height` are specified, returns the original content. The original ratio is always maintained. When only of one of the dimensions is specified, it is used as maximum, and the other is calculated. When both are informed, the maximum size with the original ratio that fits both dimensions is used. ### Example ```javascript var Cyclos411Api = require('cyclos_411_api'); var apiInstance = new Cyclos411Api.ImagesApi(); var idOrKey = "idOrKey_example"; // String | The image id or file name var opts = { 'width': 56, // Number | The requested image width 'height': 56 // Number | The requested file height }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.getImageContent(idOrKey, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **idOrKey** | **String**| The image id or file name | **width** | **Number**| The requested image width | [optional] **height** | **Number**| The requested file height | [optional] ### Return type **File** ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json, image/jpeg, image/gif, image/png # **getImageContentById** > File getImageContentById(id, opts) (deprecated) Returns an image content by id Returns the content of an image, given the image id. When neither `width` nor `height` are specified, returns the original content. The original ratio is always maintained. When only of one of the dimensions is specified, it is used as maximum, and the other is calculated. When both are informed, the maximum size with the original ratio that fits both dimensions is used. ### Example ```javascript var Cyclos411Api = require('cyclos_411_api'); var apiInstance = new Cyclos411Api.ImagesApi(); var id = "id_example"; // String | The object identification var opts = { 'width': 56, // Number | The requested image width 'height': 56 // Number | The requested file height }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.getImageContentById(id, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| The object identification | **width** | **Number**| The requested image width | [optional] **height** | **Number**| The requested file height | [optional] ### Return type **File** ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json, image/jpeg, image/gif, image/png # **getImageContentDeprecated** > File getImageContentDeprecated(kind, file, opts) Returns an image content (deprecated) Returns the content of an image, given the image kind and key. When neither `width` nor `height` are specified, returns the original content. The original ratio is always maintained. When only of one of the dimensions is specified, it is used as maximum, and the other is calculated. When both are informed, the maximum size with the original ratio that fits both dimensions is used. ### Example ```javascript var Cyclos411Api = require('cyclos_411_api'); var apiInstance = new Cyclos411Api.ImagesApi(); var kind = "kind_example"; // String | Determines the kind of an image Possible values are: * contactInfo: An image of an additional contact information * customFieldValue: An image used as custom field value * marketplace: Advertisement images are associated with an advertisement, be it simple or for web shop. * marketplaceCategory: An image of an advertisement (simple or webshop) * profile: User profile images are those associated with the user profile. The first profile image is used to depict the user on search results. * systemCustom: System custom images are additional images an administrator that can be used on rich text contents. * temp: A temporary image which can upload for later associating with an entity being registered (for example, user or advertisement). * userCustom: User custom images are additional images that can be used on rich text contents. * voucherType: An image of a voucher type var file = "file_example"; // String | The file name. This is not the original uploaded file name, but a generated one. var opts = { 'width': 56, // Number | The requested image width 'height': 56 // Number | The requested file height }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.getImageContentDeprecated(kind, file, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **kind** | **String**| Determines the kind of an image Possible values are: * contactInfo: An image of an additional contact information * customFieldValue: An image used as custom field value * marketplace: Advertisement images are associated with an advertisement, be it simple or for web shop. * marketplaceCategory: An image of an advertisement (simple or webshop) * profile: User profile images are those associated with the user profile. The first profile image is used to depict the user on search results. * systemCustom: System custom images are additional images an administrator that can be used on rich text contents. * temp: A temporary image which can upload for later associating with an entity being registered (for example, user or advertisement). * userCustom: User custom images are additional images that can be used on rich text contents. * voucherType: An image of a voucher type | **file** | **String**| The file name. This is not the original uploaded file name, but a generated one. | **width** | **Number**| The requested image width | [optional] **height** | **Number**| The requested file height | [optional] ### Return type **File** ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json, image/jpeg, image/gif, image/png # **getUserImagesListData** > ImagesListData getUserImagesListData(user, opts) Returns either `profile` or `custom` images for a given user, plus additional permissions and data Returns either `profile` or `custom` images for the given user. For `profile`, the user must be visible by the authenticated user. For `custom`, the authenticated user must either be the owner or a manager (administrator or broker). Custom images are used in rich text content, not images for custom fields. Additional data, such as the maximum images and whether the images can be managed by the authenticated user are also returned. ### Example ```javascript var Cyclos411Api = require('cyclos_411_api'); var defaultClient = Cyclos411Api.ApiClient.instance; // Configure API key authorization: accessClient var accessClient = defaultClient.authentications['accessClient']; accessClient.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //accessClient.apiKeyPrefix = 'Token'; // Configure HTTP basic authorization: basic var basic = defaultClient.authentications['basic']; basic.username = 'YOUR USERNAME'; basic.password = 'YOUR PASSWORD'; // Configure API key authorization: session var session = defaultClient.authentications['session']; session.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //session.apiKeyPrefix = 'Token'; var apiInstance = new Cyclos411Api.ImagesApi(); var user = "user_example"; // String | Can be one of: * a user identification value, such as id, username, e-mail, phone, etc. Id is always allowed, others depend on Cyclos configuration. Note that a valid numeric value is always considered as id. For example, when using another identification method that can be numeric only, prefix the value with a single quote (like in Excel spreadsheets), for example, `'1234567890`; * `self` for the currently authenticated user. var opts = { 'fields': ["fields_example"], // [String] | Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`). 'kind': "kind_example" // String | The kind of images to be returned. The default value is `profile` Possible values are: * custom: User custom images are additional images that can be used on rich text contents. * profile: User profile images are those associated with the user profile. The first profile image is used to depict the user on search results. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.getUserImagesListData(user, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user** | **String**| Can be one of: * a user identification value, such as id, username, e-mail, phone, etc. Id is always allowed, others depend on Cyclos configuration. Note that a valid numeric value is always considered as id. For example, when using another identification method that can be numeric only, prefix the value with a single quote (like in Excel spreadsheets), for example, `'1234567890`; * `self` for the currently authenticated user. | **fields** | [**[String]**](String.md)| Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`). | [optional] **kind** | **String**| The kind of images to be returned. The default value is `profile` Possible values are: * custom: User custom images are additional images that can be used on rich text contents. * profile: User profile images are those associated with the user profile. The first profile image is used to depict the user on search results. | [optional] ### Return type [**ImagesListData**](ImagesListData.md) ### Authorization [accessClient](../README.md#accessClient), [basic](../README.md#basic), [session](../README.md#session) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **listAdImages** > [Image] listAdImages(ad, opts) Lists the images of an advertisement Returns the images of an advertisement. ### Example ```javascript var Cyclos411Api = require('cyclos_411_api'); var defaultClient = Cyclos411Api.ApiClient.instance; // Configure API key authorization: accessClient var accessClient = defaultClient.authentications['accessClient']; accessClient.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //accessClient.apiKeyPrefix = 'Token'; // Configure HTTP basic authorization: basic var basic = defaultClient.authentications['basic']; basic.username = 'YOUR USERNAME'; basic.password = 'YOUR PASSWORD'; // Configure API key authorization: session var session = defaultClient.authentications['session']; session.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //session.apiKeyPrefix = 'Token'; var apiInstance = new Cyclos411Api.ImagesApi(); var ad = "ad_example"; // String | Can be either the advertisement internal identifier or, in case of webshop advertisements, can be the product number (if the owner is the logged user) or a string in the form `productNumber@user`, with the user identifier as well. var opts = { 'fields': ["fields_example"] // [String] | Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`). }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.listAdImages(ad, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ad** | **String**| Can be either the advertisement internal identifier or, in case of webshop advertisements, can be the product number (if the owner is the logged user) or a string in the form `productNumber@user`, with the user identifier as well. | **fields** | [**[String]**](String.md)| Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`). | [optional] ### Return type [**[Image]**](Image.md) ### Authorization [accessClient](../README.md#accessClient), [basic](../README.md#basic), [session](../README.md#session) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **listTempImages** > [Image] listTempImages(opts) Lists temporary images related to the currently authenticated user or guest Returns all uploaded temporary images by the current user, or guest key. If the current request is as guest and no guest key is given, the IP address is used to match images. Using a key is recommended, because clients that move between WiFi and mobile connection or if the client is in a network with multiple outbound IP addresses, images won't be correctly matched without a key. ### Example ```javascript var Cyclos411Api = require('cyclos_411_api'); var apiInstance = new Cyclos411Api.ImagesApi(); var opts = { 'fields': ["fields_example"], // [String] | Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`). 'target': "target_example", // String | The possible targets for a temporary image Possible values are: * advertisement: The image will be used for an advertisement of a specific user * contactInfo: The image will be used for an additional contact information of a specific user * customValue: The image will be used for a value of a specific custom field * userProfile: The image will be used as a profile image for an existing user * userRegistration: The image will be used as a profile image for a newly registered user 'guestKey': "guestKey_example", // String | This parameter is only taken into account if the current request is running as guest. It is the key passed by the client when uploading images. If no key is given, images are matched by remote address. 'user': "user_example", // String | If the target is `userProfile` or `advertisement`, must be either the id or an identification method of the target user (or advertisement owner). 'customField': "customField_example", // String | If the temp image will be used as the value of a custom field of type image then the corresponding custom field must be given (id or internal name). Otherwise this paremeter will be ignored. 'customFieldKind': "customFieldKind_example" // String | If a custom field is given then its kind must be given too to allow find it. Possible values are: * contact: Contact fields. * contactInfo: Additional contact information fields. * custom_operation: Custom operation fields. * document: Document fields. * marketplace: Advertisements field. * record: Record fields. * transaction: Transaction fields. * user: User profile fields. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.listTempImages(opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **fields** | [**[String]**](String.md)| Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`). | [optional] **target** | **String**| The possible targets for a temporary image Possible values are: * advertisement: The image will be used for an advertisement of a specific user * contactInfo: The image will be used for an additional contact information of a specific user * customValue: The image will be used for a value of a specific custom field * userProfile: The image will be used as a profile image for an existing user * userRegistration: The image will be used as a profile image for a newly registered user | [optional] **guestKey** | **String**| This parameter is only taken into account if the current request is running as guest. It is the key passed by the client when uploading images. If no key is given, images are matched by remote address. | [optional] **user** | **String**| If the target is `userProfile` or `advertisement`, must be either the id or an identification method of the target user (or advertisement owner). | [optional] **customField** | **String**| If the temp image will be used as the value of a custom field of type image then the corresponding custom field must be given (id or internal name). Otherwise this paremeter will be ignored. | [optional] **customFieldKind** | **String**| If a custom field is given then its kind must be given too to allow find it. Possible values are: * contact: Contact fields. * contactInfo: Additional contact information fields. * custom_operation: Custom operation fields. * document: Document fields. * marketplace: Advertisements field. * record: Record fields. * transaction: Transaction fields. * user: User profile fields. | [optional] ### Return type [**[Image]**](Image.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **listUserImages** > [Image] listUserImages(user, opts) Lists either `profile` or `custom` images for a given user Returns either `profile` or `custom` images for the given user. For `profile`, the user must be visible by the authenticated user. Custom images are used in rich text content, not images for custom fields. For `custom`, the authenticated user must either be the owner or a manager (administrator or broker). ### Example ```javascript var Cyclos411Api = require('cyclos_411_api'); var defaultClient = Cyclos411Api.ApiClient.instance; // Configure API key authorization: accessClient var accessClient = defaultClient.authentications['accessClient']; accessClient.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //accessClient.apiKeyPrefix = 'Token'; // Configure HTTP basic authorization: basic var basic = defaultClient.authentications['basic']; basic.username = 'YOUR USERNAME'; basic.password = 'YOUR PASSWORD'; // Configure API key authorization: session var session = defaultClient.authentications['session']; session.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //session.apiKeyPrefix = 'Token'; var apiInstance = new Cyclos411Api.ImagesApi(); var user = "user_example"; // String | Can be one of: * a user identification value, such as id, username, e-mail, phone, etc. Id is always allowed, others depend on Cyclos configuration. Note that a valid numeric value is always considered as id. For example, when using another identification method that can be numeric only, prefix the value with a single quote (like in Excel spreadsheets), for example, `'1234567890`; * `self` for the currently authenticated user. var opts = { 'fields': ["fields_example"], // [String] | Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`). 'kind': "kind_example" // String | The kind of images to be returned. The default value is `profile` Possible values are: * custom: User custom images are additional images that can be used on rich text contents. * profile: User profile images are those associated with the user profile. The first profile image is used to depict the user on search results. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.listUserImages(user, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user** | **String**| Can be one of: * a user identification value, such as id, username, e-mail, phone, etc. Id is always allowed, others depend on Cyclos configuration. Note that a valid numeric value is always considered as id. For example, when using another identification method that can be numeric only, prefix the value with a single quote (like in Excel spreadsheets), for example, `'1234567890`; * `self` for the currently authenticated user. | **fields** | [**[String]**](String.md)| Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`). | [optional] **kind** | **String**| The kind of images to be returned. The default value is `profile` Possible values are: * custom: User custom images are additional images that can be used on rich text contents. * profile: User profile images are those associated with the user profile. The first profile image is used to depict the user on search results. | [optional] ### Return type [**[Image]**](Image.md) ### Authorization [accessClient](../README.md#accessClient), [basic](../README.md#basic), [session](../README.md#session) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **reorderAdImages** > reorderAdImages(ad, ids) Changes the order of the images of an advertisement The new order is defined by the list of ids, so that images appear in the same order as the ids. ### Example ```javascript var Cyclos411Api = require('cyclos_411_api'); var defaultClient = Cyclos411Api.ApiClient.instance; // Configure API key authorization: accessClient var accessClient = defaultClient.authentications['accessClient']; accessClient.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //accessClient.apiKeyPrefix = 'Token'; // Configure HTTP basic authorization: basic var basic = defaultClient.authentications['basic']; basic.username = 'YOUR USERNAME'; basic.password = 'YOUR PASSWORD'; // Configure API key authorization: session var session = defaultClient.authentications['session']; session.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //session.apiKeyPrefix = 'Token'; var apiInstance = new Cyclos411Api.ImagesApi(); var ad = "ad_example"; // String | Can be either the advertisement internal identifier or, in case of webshop advertisements, can be the product number (if the owner is the logged user) or a string in the form `productNumber@user`, with the user identifier as well. var ids = ["ids_example"]; // [String] | The array of ids (comma-separated) reflecting the desired order var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; apiInstance.reorderAdImages(ad, ids, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ad** | **String**| Can be either the advertisement internal identifier or, in case of webshop advertisements, can be the product number (if the owner is the logged user) or a string in the form `productNumber@user`, with the user identifier as well. | **ids** | [**[String]**](String.md)| The array of ids (comma-separated) reflecting the desired order | ### Return type null (empty response body) ### Authorization [accessClient](../README.md#accessClient), [basic](../README.md#basic), [session](../README.md#session) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **reorderProfileImages** > reorderProfileImages(user, ids) Changes the order of a user's profile images The new order is defined by the list of ids, so that images appear in the same order as the ids. ### Example ```javascript var Cyclos411Api = require('cyclos_411_api'); var defaultClient = Cyclos411Api.ApiClient.instance; // Configure API key authorization: accessClient var accessClient = defaultClient.authentications['accessClient']; accessClient.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //accessClient.apiKeyPrefix = 'Token'; // Configure HTTP basic authorization: basic var basic = defaultClient.authentications['basic']; basic.username = 'YOUR USERNAME'; basic.password = 'YOUR PASSWORD'; // Configure API key authorization: session var session = defaultClient.authentications['session']; session.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //session.apiKeyPrefix = 'Token'; var apiInstance = new Cyclos411Api.ImagesApi(); var user = "user_example"; // String | Can be one of: * a user identification value, such as id, username, e-mail, phone, etc. Id is always allowed, others depend on Cyclos configuration. Note that a valid numeric value is always considered as id. For example, when using another identification method that can be numeric only, prefix the value with a single quote (like in Excel spreadsheets), for example, `'1234567890`; * `self` for the currently authenticated user. var ids = ["ids_example"]; // [String] | The array of ids (comma-separated) reflecting the desired order var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; apiInstance.reorderProfileImages(user, ids, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user** | **String**| Can be one of: * a user identification value, such as id, username, e-mail, phone, etc. Id is always allowed, others depend on Cyclos configuration. Note that a valid numeric value is always considered as id. For example, when using another identification method that can be numeric only, prefix the value with a single quote (like in Excel spreadsheets), for example, `'1234567890`; * `self` for the currently authenticated user. | **ids** | [**[String]**](String.md)| The array of ids (comma-separated) reflecting the desired order | ### Return type null (empty response body) ### Authorization [accessClient](../README.md#accessClient), [basic](../README.md#basic), [session](../README.md#session) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **uploadAdImage** > 'String' uploadAdImage(ad, image, opts) Adds a new image for the given advertisement. Uploads a new image for the given advertisement. ### Example ```javascript var Cyclos411Api = require('cyclos_411_api'); var defaultClient = Cyclos411Api.ApiClient.instance; // Configure API key authorization: accessClient var accessClient = defaultClient.authentications['accessClient']; accessClient.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //accessClient.apiKeyPrefix = 'Token'; // Configure HTTP basic authorization: basic var basic = defaultClient.authentications['basic']; basic.username = 'YOUR USERNAME'; basic.password = 'YOUR PASSWORD'; // Configure API key authorization: session var session = defaultClient.authentications['session']; session.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //session.apiKeyPrefix = 'Token'; var apiInstance = new Cyclos411Api.ImagesApi(); var ad = "ad_example"; // String | Can be either the advertisement internal identifier or, in case of webshop advertisements, can be the product number (if the owner is the logged user) or a string in the form `productNumber@user`, with the user identifier as well. var image = "/path/to/file.txt"; // File | The image being uploaded var opts = { 'name': "name_example" // String | The name for the new image. If not informed will fall back to the original file name in the form data }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.uploadAdImage(ad, image, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ad** | **String**| Can be either the advertisement internal identifier or, in case of webshop advertisements, can be the product number (if the owner is the logged user) or a string in the form `productNumber@user`, with the user identifier as well. | **image** | **File**| The image being uploaded | **name** | **String**| The name for the new image. If not informed will fall back to the original file name in the form data | [optional] ### Return type **'String'** ### Authorization [accessClient](../README.md#accessClient), [basic](../README.md#basic), [session](../README.md#session) ### HTTP request headers - **Content-Type**: multipart/form-data - **Accept**: application/json, text/plain # **uploadContactInfoImage** > 'String' uploadContactInfoImage(id, image, opts) Uploads a new image for the given additional contact information. Saves the given image for the additional contact information. If the given additional contact information already has an image, the old one is removed, and the current image is saved in its place. ### Example ```javascript var Cyclos411Api = require('cyclos_411_api'); var defaultClient = Cyclos411Api.ApiClient.instance; // Configure API key authorization: accessClient var accessClient = defaultClient.authentications['accessClient']; accessClient.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //accessClient.apiKeyPrefix = 'Token'; // Configure HTTP basic authorization: basic var basic = defaultClient.authentications['basic']; basic.username = 'YOUR USERNAME'; basic.password = 'YOUR PASSWORD'; // Configure API key authorization: session var session = defaultClient.authentications['session']; session.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //session.apiKeyPrefix = 'Token'; var apiInstance = new Cyclos411Api.ImagesApi(); var id = "id_example"; // String | The object identification var image = "/path/to/file.txt"; // File | The image being uploaded var opts = { 'name': "name_example" // String | The name for the new image. If not informed will fall back to the original file name in the form data }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.uploadContactInfoImage(id, image, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| The object identification | **image** | **File**| The image being uploaded | **name** | **String**| The name for the new image. If not informed will fall back to the original file name in the form data | [optional] ### Return type **'String'** ### Authorization [accessClient](../README.md#accessClient), [basic](../README.md#basic), [session](../README.md#session) ### HTTP request headers - **Content-Type**: multipart/form-data - **Accept**: application/json, text/plain # **uploadContactInfoImageDeprecated** > 'String' uploadContactInfoImageDeprecated(id, image, opts) This operation is deprecated, use `POST /contact-infos/{id}/image` instead. Saves the given image for the additional contact information. If the given additional contact information already has an image, the old one is removed, and the current image is saved in its place. ### Example ```javascript var Cyclos411Api = require('cyclos_411_api'); var defaultClient = Cyclos411Api.ApiClient.instance; // Configure API key authorization: accessClient var accessClient = defaultClient.authentications['accessClient']; accessClient.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //accessClient.apiKeyPrefix = 'Token'; // Configure HTTP basic authorization: basic var basic = defaultClient.authentications['basic']; basic.username = 'YOUR USERNAME'; basic.password = 'YOUR PASSWORD'; // Configure API key authorization: session var session = defaultClient.authentications['session']; session.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //session.apiKeyPrefix = 'Token'; var apiInstance = new Cyclos411Api.ImagesApi(); var id = "id_example"; // String | The object identification var image = "/path/to/file.txt"; // File | The image being uploaded var opts = { 'name': "name_example" // String | The name for the new image. If not informed will fall back to the original file name in the form data }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.uploadContactInfoImageDeprecated(id, image, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| The object identification | **image** | **File**| The image being uploaded | **name** | **String**| The name for the new image. If not informed will fall back to the original file name in the form data | [optional] ### Return type **'String'** ### Authorization [accessClient](../README.md#accessClient), [basic](../README.md#basic), [session](../README.md#session) ### HTTP request headers - **Content-Type**: multipart/form-data - **Accept**: application/json, text/plain # **uploadTempImage** > 'String' uploadTempImage(image, opts) Adds a new temporary image for the currently authenticated user or guest. Uploads a new temporary image. A temporary image should be given a target, which can be: - `userRegistration`: The image will be used as a profile image for a newly registered user; - `userProfile`: The image will be used as a profile image for an existing user; - `advertisement`: The image will be used for an advertisement of a specific user; - `customValue`: The image will be used for a value of a specific custom field. Temporary images won't be immediately associated to the next registered model, but its `id`, which is returned by this operation, must be explicitly passed in, either as the `images` field (for profile or advertisement images) or in the `customValues` field of the model that has custom values (multiple ids can be passed-in as pipe-separated). Images as guest can only be uploaded if on the destination group products the image profile field is allowed at registrations. Users may upload images if they can register new users or create advertisements. ### Example ```javascript var Cyclos411Api = require('cyclos_411_api'); var apiInstance = new Cyclos411Api.ImagesApi(); var image = "/path/to/file.txt"; // File | The image being uploaded var opts = { 'name': "name_example", // String | The name for the new image. If not informed will fall back to the original file name in the form data 'target': "target_example", // String | The possible targets for a temporary image Possible values are: * advertisement: The image will be used for an advertisement of a specific user * contactInfo: The image will be used for an additional contact information of a specific user * customValue: The image will be used for a value of a specific custom field * userProfile: The image will be used as a profile image for an existing user * userRegistration: The image will be used as a profile image for a newly registered user 'guestKey': "guestKey_example", // String | This parameter is only taken into account if the current request is running as guest. It should be a reasonably unique key (for example, an UUID, device identifier or a reasonably large random string) which uniquely identifies the uploaded image as belonging to this \"session\". If no key is given, images uploaded as guest are matched by IP address. Using a key is recommended, because clients that move between WiFi and mobile connection or if the client is in a network with multiple outbound IP addresses, images won't be correctly matched without a key. 'user': "user_example", // String | If the target is `userProfile` or `advertisement`, must be either the id or an identification method of the target user (or advertisement owner). 'customField': "customField_example", // String | If the temp image will be used as the value of a custom field of type image then the corresponding custom field must be given (id or internal name). Otherwise this paremeter will be ignored. 'customFieldKind': "customFieldKind_example" // String | If a custom field is given then its kind must be given too to allow find it. Possible values are: * contact: Contact fields. * contactInfo: Additional contact information fields. * custom_operation: Custom operation fields. * document: Document fields. * marketplace: Advertisements field. * record: Record fields. * transaction: Transaction fields. * user: User profile fields. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.uploadTempImage(image, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **image** | **File**| The image being uploaded | **name** | **String**| The name for the new image. If not informed will fall back to the original file name in the form data | [optional] **target** | **String**| The possible targets for a temporary image Possible values are: * advertisement: The image will be used for an advertisement of a specific user * contactInfo: The image will be used for an additional contact information of a specific user * customValue: The image will be used for a value of a specific custom field * userProfile: The image will be used as a profile image for an existing user * userRegistration: The image will be used as a profile image for a newly registered user | [optional] **guestKey** | **String**| This parameter is only taken into account if the current request is running as guest. It should be a reasonably unique key (for example, an UUID, device identifier or a reasonably large random string) which uniquely identifies the uploaded image as belonging to this \"session\". If no key is given, images uploaded as guest are matched by IP address. Using a key is recommended, because clients that move between WiFi and mobile connection or if the client is in a network with multiple outbound IP addresses, images won't be correctly matched without a key. | [optional] **user** | **String**| If the target is `userProfile` or `advertisement`, must be either the id or an identification method of the target user (or advertisement owner). | [optional] **customField** | **String**| If the temp image will be used as the value of a custom field of type image then the corresponding custom field must be given (id or internal name). Otherwise this paremeter will be ignored. | [optional] **customFieldKind** | **String**| If a custom field is given then its kind must be given too to allow find it. Possible values are: * contact: Contact fields. * contactInfo: Additional contact information fields. * custom_operation: Custom operation fields. * document: Document fields. * marketplace: Advertisements field. * record: Record fields. * transaction: Transaction fields. * user: User profile fields. | [optional] ### Return type **'String'** ### Authorization No authorization required ### HTTP request headers - **Content-Type**: multipart/form-data - **Accept**: application/json, text/plain # **uploadUserImage** > 'String' uploadUserImage(user, image, opts) Adds a new image for the given user. The image kind is either `profile` or `custom`. Uploads a new image, either `profile` (by default) or `custom`, for the given user. Custom images are used in rich text content, not images for custom fields. For uploading images for custom field values, see the documentation for the operation at `POST /images/temp`. ### Example ```javascript var Cyclos411Api = require('cyclos_411_api'); var defaultClient = Cyclos411Api.ApiClient.instance; // Configure API key authorization: accessClient var accessClient = defaultClient.authentications['accessClient']; accessClient.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //accessClient.apiKeyPrefix = 'Token'; // Configure HTTP basic authorization: basic var basic = defaultClient.authentications['basic']; basic.username = 'YOUR USERNAME'; basic.password = 'YOUR PASSWORD'; // Configure API key authorization: session var session = defaultClient.authentications['session']; session.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //session.apiKeyPrefix = 'Token'; var apiInstance = new Cyclos411Api.ImagesApi(); var user = "user_example"; // String | Can be one of: * a user identification value, such as id, username, e-mail, phone, etc. Id is always allowed, others depend on Cyclos configuration. Note that a valid numeric value is always considered as id. For example, when using another identification method that can be numeric only, prefix the value with a single quote (like in Excel spreadsheets), for example, `'1234567890`; * `self` for the currently authenticated user. var image = "/path/to/file.txt"; // File | The image being uploaded var opts = { 'kind': "kind_example", // String | The kind of images to be returned. The default value is `profile` Possible values are: * custom: User custom images are additional images that can be used on rich text contents. * profile: User profile images are those associated with the user profile. The first profile image is used to depict the user on search results. 'name': "name_example" // String | The name for the new image. If not informed will fall back to the original file name in the form data }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.uploadUserImage(user, image, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user** | **String**| Can be one of: * a user identification value, such as id, username, e-mail, phone, etc. Id is always allowed, others depend on Cyclos configuration. Note that a valid numeric value is always considered as id. For example, when using another identification method that can be numeric only, prefix the value with a single quote (like in Excel spreadsheets), for example, `'1234567890`; * `self` for the currently authenticated user. | **image** | **File**| The image being uploaded | **kind** | **String**| The kind of images to be returned. The default value is `profile` Possible values are: * custom: User custom images are additional images that can be used on rich text contents. * profile: User profile images are those associated with the user profile. The first profile image is used to depict the user on search results. | [optional] **name** | **String**| The name for the new image. If not informed will fall back to the original file name in the form data | [optional] ### Return type **'String'** ### Authorization [accessClient](../README.md#accessClient), [basic](../README.md#basic), [session](../README.md#session) ### HTTP request headers - **Content-Type**: multipart/form-data - **Accept**: application/json, text/plain # **viewImage** > ImageView viewImage(idOrKey, opts) Returns an image details by id or key Returns metadata about an image given its identifier or key ### Example ```javascript var Cyclos411Api = require('cyclos_411_api'); var apiInstance = new Cyclos411Api.ImagesApi(); var idOrKey = "idOrKey_example"; // String | The image id or file name var opts = { 'fields': ["fields_example"] // [String] | Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`). }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.viewImage(idOrKey, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **idOrKey** | **String**| The image id or file name | **fields** | [**[String]**](String.md)| Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`). | [optional] ### Return type [**ImageView**](ImageView.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json