@gobodo/gobodo-api-promise 0.1.182 → 0.1.183

package/dist/api/SchemaViewsApi.d.ts

@@ -0,0 +1,258 @@
+/**
+* SchemaViews service.
+* @module api/SchemaViewsApi
+* @version 0.1.183
+*/
+export default class SchemaViewsApi {
+    /**
+    * Constructs a new SchemaViewsApi.
+    * @alias module:api/SchemaViewsApi
+    * @class
+    * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+    * default to {@link module:ApiClient#instance} if unspecified.
+    */
+    constructor(apiClient?: any);
+    apiClient: any;
+    /**
+     * Create schema view
+     * Create a schema view. Body must include schemaId. Requires schema admin or graph admin/owner when graphId is set.
+     * @param {module:model/SchemaViewInput} schemaViewInput
+     * @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
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SchemaViewResponse} and HTTP response
+     */
+    createSchemaViewWithHttpInfo(schemaViewInput: any, opts: any): Promise<any>;
+    /**
+     * Create schema view
+     * Create a schema view. Body must include schemaId. Requires schema admin or graph admin/owner when graphId is set.
+     * @param {module:model/SchemaViewInput} schemaViewInput
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @param {Number} opts.cacheduration The how long the cache entry should persist
+     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} opts.cachekey The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} opts.cachescope The scope of storage of the cache item
+     * @param {Array.<String>} opts.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>} opts.invalidationkeys Cache keys that should be invalidated in this operation
+     * @param {Number} opts.zeusportalPostasApp The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} opts.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} opts.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} opts.zeusportalPostasSite The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} opts.transactionid The id of the transaction this operation is being run in
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SchemaViewResponse}
+     */
+    createSchemaView(schemaViewInput: any, opts?: { [key: string]: any;  [key: string]: any; 
+        authorization?: string;
+        cacheduration?: number;
+        cachegroup?: Array<string>;
+        cachekey?: Array<string>;
+        cachescope?: any;
+        cacheuser?: Array<string>;
+    }): Promise<any>;
+    /**
+     * Delete schema view
+     * Delete a schema view. Requires schema admin or graph admin/owner.
+     * @param {Number} id
+     * @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
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
+     */
+    deleteSchemaViewWithHttpInfo(id: number, opts: any): Promise<any>;
+    /**
+     * Delete schema view
+     * Delete a schema view. Requires schema admin or graph admin/owner.
+     * @param {Number} id
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @param {Number} opts.cacheduration The how long the cache entry should persist
+     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} opts.cachekey The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} opts.cachescope The scope of storage of the cache item
+     * @param {Array.<String>} opts.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>} opts.invalidationkeys Cache keys that should be invalidated in this operation
+     * @param {Number} opts.zeusportalPostasApp The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} opts.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} opts.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} opts.zeusportalPostasSite The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} opts.transactionid The id of the transaction this operation is being run in
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}
+     */
+    deleteSchemaView(id: number, opts?: { [key: string]: any;  [key: string]: any; 
+        authorization?: string;
+        cacheduration?: number;
+        cachegroup?: Array<string>;
+        cachekey?: Array<string>;
+        cachescope?: any;
+        cacheuser?: Array<string>;
+    }): Promise<any>;
+    /**
+     * Get schema view by id
+     * Get a schema view by id.
+     * @param {Number} id
+     * @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
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SchemaViewResponse} and HTTP response
+     */
+    getSchemaViewByIdWithHttpInfo(id: number, opts: any): Promise<any>;
+    /**
+     * Get schema view by id
+     * Get a schema view by id.
+     * @param {Number} id
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @param {Number} opts.cacheduration The how long the cache entry should persist
+     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} opts.cachekey The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} opts.cachescope The scope of storage of the cache item
+     * @param {Array.<String>} opts.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>} opts.invalidationkeys Cache keys that should be invalidated in this operation
+     * @param {Number} opts.zeusportalPostasApp The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} opts.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} opts.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} opts.zeusportalPostasSite The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} opts.transactionid The id of the transaction this operation is being run in
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SchemaViewResponse}
+     */
+    getSchemaViewById(id: number, opts?: { [key: string]: any;  [key: string]: any; 
+        authorization?: string;
+        cacheduration?: number;
+        cachegroup?: Array<string>;
+        cachekey?: Array<string>;
+        cachescope?: any;
+        cacheuser?: Array<string>;
+    }): Promise<any>;
+    /**
+     * List schema views
+     * List views for a schema, optionally filtered by graph and object type. Requires schema admin or graph admin/owner.
+     * @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 {Number} [schemaId]
+     * @param {Number} [graphId]
+     * @param {Number} [objectTypeId]
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<module:model/SchemaViewResponse>} and HTTP response
+     */
+    listSchemaViewsWithHttpInfo(opts: any): Promise<any>;
+    /**
+     * List schema views
+     * List views for a schema, optionally filtered by graph and object type. Requires schema admin or graph admin/owner.
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @param {Number} opts.cacheduration The how long the cache entry should persist
+     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} opts.cachekey The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} opts.cachescope The scope of storage of the cache item
+     * @param {Array.<String>} opts.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>} opts.invalidationkeys Cache keys that should be invalidated in this operation
+     * @param {Number} opts.zeusportalPostasApp The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} opts.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} opts.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} opts.zeusportalPostasSite The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} opts.transactionid The id of the transaction this operation is being run in
+     * @param {Number} opts.schemaId
+     * @param {Number} opts.graphId
+     * @param {Number} opts.objectTypeId
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/SchemaViewResponse>}
+     */
+    listSchemaViews(opts?: { [key: string]: any;  [key: string]: any; 
+        authorization?: string;
+        cacheduration?: number;
+        cachegroup?: Array<string>;
+        cachekey?: Array<string>;
+        cachescope?: any;
+        cacheuser?: Array<string>;
+    }): Promise<any>;
+    /**
+     * Update schema view
+     * Update a schema view. Requires schema admin or graph admin/owner.
+     * @param {Number} id
+     * @param {module:model/SchemaViewInput} schemaViewInput
+     * @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
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SchemaViewResponse} and HTTP response
+     */
+    updateSchemaViewWithHttpInfo(id: number, schemaViewInput: any, opts: any): Promise<any>;
+    /**
+     * Update schema view
+     * Update a schema view. Requires schema admin or graph admin/owner.
+     * @param {Number} id
+     * @param {module:model/SchemaViewInput} schemaViewInput
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @param {Number} opts.cacheduration The how long the cache entry should persist
+     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} opts.cachekey The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} opts.cachescope The scope of storage of the cache item
+     * @param {Array.<String>} opts.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>} opts.invalidationkeys Cache keys that should be invalidated in this operation
+     * @param {Number} opts.zeusportalPostasApp The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} opts.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} opts.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} opts.zeusportalPostasSite The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} opts.transactionid The id of the transaction this operation is being run in
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SchemaViewResponse}
+     */
+    updateSchemaView(id: number, schemaViewInput: any, opts?: { [key: string]: any;  [key: string]: any; 
+        authorization?: string;
+        cacheduration?: number;
+        cachegroup?: Array<string>;
+        cachekey?: Array<string>;
+        cachescope?: any;
+        cacheuser?: Array<string>;
+    }): Promise<any>;
+}
+//# sourceMappingURL=SchemaViewsApi.d.ts.map

package/dist/api/SchemaViewsApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaViewsApi.d.ts","sourceRoot":"","sources":["../../src/api/SchemaViewsApi.js"],"names":[],"mappings":"AAmBA;;;;EAIE;AACF;IAEI;;;;;;MAME;IACF,wBAHU,GAAgB,EAKzB;IADG,eAAgD;IAKpD;;;;;;;;;;;;;;;;;;OAkBG;IACH,8CAhBW,GAA4B,2BAsDtC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,kCAhBW,GAA4B,QAEpC;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;KACtB,gBAaF;IAGD;;;;;;;;;;;;;;;;;;OAkBG;IACH,kEAuCC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,mCAdG;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;KACtB,gBAaF;IAGD;;;;;;;;;;;;;;;;;;OAkBG;IACH,mEAuCC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,oCAdG;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;KACtB,gBAaF;IAGD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,qDAqCC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,sBAjBG;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;KACtB,gBAgBF;IAGD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,0DAhBW,GAA4B,2BA2DtC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,8CAhBW,GAA4B,QAEpC;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;KACtB,gBAaF;CAGJ"}