@gobodo/gobodo-api 0.1.215 → 0.1.217

package/dist/api/FieldsApi.d.ts

@@ -1,7 +1,7 @@
 /**
 * Fields service.
 * @module api/FieldsApi
-* @version 0.1.215
+* @version 0.1.217
 */
 export default class FieldsApi {
     /**
@@ -17,31 +17,25 @@ export default class FieldsApi {
      * Callback function to receive the result of the createActionTypeField operation.
      * @callback module:api/FieldsApi~createActionTypeFieldCallback
      * @param {String} error Error message, if any.
-     * @param {module:model/SkinField} data The data returned by the service call.
+     * @param {module:model/SkinFieldResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
      * Create a field for an action type
-     * Creates a new field for the specified action type
+     * Creates a new field for the specified action type. Choose the field behavior with type, then populate only the matching settings block such as textSettings, numberSettings, objectSettings, traversalSettings, or functionSettings.
      * @param {Number} id
-     * @param {module:model/SkinField} skinField Field data to create the new field from
+     * @param {module:model/SkinFieldInput} skinFieldInput Field definition to create. For traversal fields, traversalSettings uses the flattened TraversalProjectionInput shape.
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
-     * @param {Number} [cacheduration] The how long the cache entry should persist
-     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
-     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
-     * @param {module:model/String} [cachescope] The scope of storage of the cache item
-     * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
-     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation
      * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
      * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
      * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
      * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
      * @param {String} [transactionid] The id of the transaction this operation is being run in
      * @param {module:api/FieldsApi~createActionTypeFieldCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link module:model/SkinField}
+     * data is of type: {@link module:model/SkinFieldResponse}
      */
-    createActionTypeField(id: number, skinField: any, opts: any, callback: any): any;
+    createActionTypeField(id: number, skinFieldInput: any, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the createFieldInContainer operation.
      * @callback module:api/FieldsApi~createFieldInContainerCallback
@@ -57,12 +51,6 @@ export default class FieldsApi {
      * @param {module:model/SkinFieldInput} skinFieldInput Field data to create the new field from
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
-     * @param {Number} [cacheduration] The how long the cache entry should persist
-     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
-     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
-     * @param {module:model/String} [cachescope] The scope of storage of the cache item
-     * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
-     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation
      * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
      * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
      * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
@@ -85,12 +73,6 @@ export default class FieldsApi {
      * @param {Array.<module:model/SkinFieldInput>} skinFieldInput Field data to create the new fields from
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
-     * @param {Number} [cacheduration] The how long the cache entry should persist
-     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
-     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
-     * @param {module:model/String} [cachescope] The scope of storage of the cache item
-     * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
-     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation
      * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
      * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
      * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
@@ -104,60 +86,48 @@ export default class FieldsApi {
      * Callback function to receive the result of the createObjectTypeField operation.
      * @callback module:api/FieldsApi~createObjectTypeFieldCallback
      * @param {String} error Error message, if any.
-     * @param {module:model/SkinField} data The data returned by the service call.
+     * @param {module:model/SkinFieldResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
      * Create a field for an object type
-     * Creates a new field for the specified object type
+     * Creates a new field for the specified object type. Choose the field behavior with type, then populate only the matching settings block such as textSettings, numberSettings, objectSettings, traversalSettings, or functionSettings.
      * @param {Number} id
-     * @param {module:model/SkinField} skinField Field data to create the new field from
+     * @param {module:model/SkinFieldInput} skinFieldInput Field definition to create. For traversal fields, traversalSettings uses the flattened TraversalProjectionInput shape.
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
-     * @param {Number} [cacheduration] The how long the cache entry should persist
-     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
-     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
-     * @param {module:model/String} [cachescope] The scope of storage of the cache item
-     * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
-     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation
      * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
      * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
      * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
      * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
      * @param {String} [transactionid] The id of the transaction this operation is being run in
      * @param {module:api/FieldsApi~createObjectTypeFieldCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link module:model/SkinField}
+     * data is of type: {@link module:model/SkinFieldResponse}
      */
-    createObjectTypeField(id: number, skinField: any, opts: any, callback: any): any;
+    createObjectTypeField(id: number, skinFieldInput: any, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the createRelationshipTypeField operation.
      * @callback module:api/FieldsApi~createRelationshipTypeFieldCallback
      * @param {String} error Error message, if any.
-     * @param {module:model/SkinField} data The data returned by the service call.
+     * @param {module:model/SkinFieldResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
      * Create a field for a relationship type
-     * Creates a new field for the specified relationship type
+     * Creates a new field for the specified relationship type. Choose the field behavior with type, then populate only the matching settings block such as textSettings, numberSettings, objectSettings, traversalSettings, or functionSettings.
      * @param {Number} id
-     * @param {module:model/SkinField} skinField Field data to create the new field from
+     * @param {module:model/SkinFieldInput} skinFieldInput Field definition to create. For traversal fields, traversalSettings uses the flattened TraversalProjectionInput shape.
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
-     * @param {Number} [cacheduration] The how long the cache entry should persist
-     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
-     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
-     * @param {module:model/String} [cachescope] The scope of storage of the cache item
-     * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
-     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation
      * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
      * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
      * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
      * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
      * @param {String} [transactionid] The id of the transaction this operation is being run in
      * @param {module:api/FieldsApi~createRelationshipTypeFieldCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link module:model/SkinField}
+     * data is of type: {@link module:model/SkinFieldResponse}
      */
-    createRelationshipTypeField(id: number, skinField: any, opts: any, callback: any): any;
+    createRelationshipTypeField(id: number, skinFieldInput: any, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the deleteFieldById operation.
      * @callback module:api/FieldsApi~deleteFieldByIdCallback
@@ -171,12 +141,6 @@ export default class FieldsApi {
      * @param {Number} fieldid
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
-     * @param {Number} [cacheduration] The how long the cache entry should persist
-     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
-     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
-     * @param {module:model/String} [cachescope] The scope of storage of the cache item
-     * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
-     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation
      * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
      * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
      * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
@@ -199,12 +163,6 @@ export default class FieldsApi {
      * @param {String} name Exact field name
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
-     * @param {Number} [cacheduration] The how long the cache entry should persist
-     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
-     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
-     * @param {module:model/String} [cachescope] The scope of storage of the cache item
-     * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
-     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation
      * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
      * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
      * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
@@ -228,12 +186,6 @@ export default class FieldsApi {
      * @param {String} name Exact field name
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
-     * @param {Number} [cacheduration] The how long the cache entry should persist
-     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
-     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
-     * @param {module:model/String} [cachescope] The scope of storage of the cache item
-     * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
-     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation
      * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
      * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
      * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
@@ -256,12 +208,6 @@ export default class FieldsApi {
      * @param {Number} fieldid
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
-     * @param {Number} [cacheduration] The how long the cache entry should persist
-     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
-     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
-     * @param {module:model/String} [cachescope] The scope of storage of the cache item
-     * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
-     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation
      * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
      * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
      * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
@@ -285,12 +231,6 @@ export default class FieldsApi {
      * @param {String} name Exact field name
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
-     * @param {Number} [cacheduration] The how long the cache entry should persist
-     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
-     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
-     * @param {module:model/String} [cachescope] The scope of storage of the cache item
-     * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
-     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation
      * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
      * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
      * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
@@ -314,12 +254,6 @@ export default class FieldsApi {
      * @param {String} name Exact field name
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
-     * @param {Number} [cacheduration] The how long the cache entry should persist
-     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
-     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
-     * @param {module:model/String} [cachescope] The scope of storage of the cache item
-     * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
-     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation
      * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
      * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
      * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
@@ -343,12 +277,6 @@ export default class FieldsApi {
      * @param {String} name Exact field name
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
-     * @param {Number} [cacheduration] The how long the cache entry should persist
-     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
-     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
-     * @param {module:model/String} [cachescope] The scope of storage of the cache item
-     * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
-     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation
      * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
      * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
      * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
@@ -372,12 +300,6 @@ export default class FieldsApi {
      * @param {String} name Exact field name
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
-     * @param {Number} [cacheduration] The how long the cache entry should persist
-     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
-     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
-     * @param {module:model/String} [cachescope] The scope of storage of the cache item
-     * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
-     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation
      * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
      * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
      * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
@@ -401,12 +323,6 @@ export default class FieldsApi {
      * @param {module:model/SkinFieldInput} skinFieldInput Field data to create the new field from
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
-     * @param {Number} [cacheduration] The how long the cache entry should persist
-     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
-     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
-     * @param {module:model/String} [cachescope] The scope of storage of the cache item
-     * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
-     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation
      * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
      * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
      * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page