@gobodo/gobodo-api-promise 0.1.8-9.1

package/dist/api/PhoneNumbersApi.d.ts

@@ -0,0 +1,255 @@
+/**
+* PhoneNumbers service.
+* @module api/PhoneNumbersApi
+* @version 0.1.89
+*/
+export default class PhoneNumbersApi {
+    /**
+    * Constructs a new PhoneNumbersApi.
+    * @alias module:api/PhoneNumbersApi
+    * @class
+    * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+    * default to {@link module:ApiClient#instance} if unspecified.
+    */
+    constructor(apiClient?: any);
+    apiClient: any;
+    /**
+     * Creates a phone number for a page
+     * Creates a phone number for a page
+     * @param {Number} pageId
+     * @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 {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} [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/PhoneNumber} and HTTP response
+     */
+    createPhoneNumberForPageWithHttpInfo(pageId: number, opts: any): Promise<any>;
+    /**
+     * Creates a phone number for a page
+     * Creates a phone number for a page
+     * @param {Number} pageId
+     * @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 {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.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/PhoneNumber}
+     */
+    createPhoneNumberForPage(pageId: number, opts?: { [key: string]: any;  [key: string]: any; 
+        authorization: string;
+        cacheduration: number;
+        cachegroup: Array<string>;
+        cachekey: Array<string>;
+        cachescope: any;
+        cacheuser: Array<string>;
+        zeusportalPostasApp: number;
+        zeusportalPostas: number;
+        zeusportalPostasSite: number;
+        transactionid: string;
+    }): Promise<any>;
+    /**
+     * Creates a phone number for a user
+     * Creates a phone number for a user
+     * @param {Number} userId
+     * @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 {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} [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/PhoneNumber} and HTTP response
+     */
+    createPhoneNumberForUserWithHttpInfo(userId: number, opts: any): Promise<any>;
+    /**
+     * Creates a phone number for a user
+     * Creates a phone number for a user
+     * @param {Number} userId
+     * @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 {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.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/PhoneNumber}
+     */
+    createPhoneNumberForUser(userId: number, opts?: { [key: string]: any;  [key: string]: any; 
+        authorization: string;
+        cacheduration: number;
+        cachegroup: Array<string>;
+        cachekey: Array<string>;
+        cachescope: any;
+        cacheuser: Array<string>;
+        zeusportalPostasApp: number;
+        zeusportalPostas: number;
+        zeusportalPostasSite: number;
+        transactionid: string;
+    }): Promise<any>;
+    /**
+     * Returns a phone number by id
+     * Returns a phone number by it's 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 {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} [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} [body]
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
+     */
+    getPhoneNumberWithHttpInfo(opts: any): Promise<any>;
+    /**
+     * Returns a phone number by id
+     * Returns a phone number by it's 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 {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.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.body
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}
+     */
+    getPhoneNumber(opts?: { [key: string]: any;  [key: string]: any; 
+        authorization: string;
+        cacheduration: number;
+        cachegroup: Array<string>;
+        cachekey: Array<string>;
+        cachescope: any;
+        cacheuser: Array<string>;
+        zeusportalPostasApp: number;
+        zeusportalPostas: number;
+        zeusportalPostasSite: number;
+        transactionid: string;
+        body: number;
+    }): Promise<any>;
+    /**
+     * Returns all email addresses for a given page
+     * Returns all email addresses for a given page
+     * @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 {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} [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} [body]
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<module:model/PhoneNumber>} and HTTP response
+     */
+    getPhoneNumbersByPageWithHttpInfo(opts: any): Promise<any>;
+    /**
+     * Returns all email addresses for a given page
+     * Returns all email addresses for a given page
+     * @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 {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.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.body
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/PhoneNumber>}
+     */
+    getPhoneNumbersByPage(opts?: { [key: string]: any;  [key: string]: any; 
+        authorization: string;
+        cacheduration: number;
+        cachegroup: Array<string>;
+        cachekey: Array<string>;
+        cachescope: any;
+        cacheuser: Array<string>;
+        zeusportalPostasApp: number;
+        zeusportalPostas: number;
+        zeusportalPostasSite: number;
+        transactionid: string;
+        body: number;
+    }): Promise<any>;
+    /**
+     * Returns all email addresses for a given user
+     * Returns all email addresses for a given user
+     * @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 {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} [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} [body]
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<module:model/PhoneNumber>} and HTTP response
+     */
+    getPhoneNumbersByUserWithHttpInfo(opts: any): Promise<any>;
+    /**
+     * Returns all email addresses for a given user
+     * Returns all email addresses for a given user
+     * @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 {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.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.body
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/PhoneNumber>}
+     */
+    getPhoneNumbersByUser(opts?: { [key: string]: any;  [key: string]: any; 
+        authorization: string;
+        cacheduration: number;
+        cachegroup: Array<string>;
+        cachekey: Array<string>;
+        cachescope: any;
+        cacheuser: Array<string>;
+        zeusportalPostasApp: number;
+        zeusportalPostas: number;
+        zeusportalPostasSite: number;
+        transactionid: string;
+        body: number;
+    }): Promise<any>;
+}
+//# sourceMappingURL=PhoneNumbersApi.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PhoneNumbersApi.d.ts","sourceRoot":"","sources":["../../src/api/PhoneNumbersApi.js"],"names":[],"mappings":"AAiBA;;;;EAIE;AACF;IAEI;;;;;;MAME;IACF,wBAHU,GAAgB,EAKzB;IADG,eAAgD;IAKpD;;;;;;;;;;;;;;;;OAgBG;IACH,8EAqCC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,+CAZG;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;QACD,mBAAmB;QACnB,gBAAgB;QAChB,oBAAoB;QACpB,aAAa;KAClC,gBAOF;IAGD;;;;;;;;;;;;;;;;OAgBG;IACH,8EAqCC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,+CAZG;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;QACD,mBAAmB;QACnB,gBAAgB;QAChB,oBAAoB;QACpB,aAAa;KAClC,gBAOF;IAGD;;;;;;;;;;;;;;;;OAgBG;IACH,oDAgCC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,qBAbG;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;QACD,mBAAmB;QACnB,gBAAgB;QAChB,oBAAoB;QACpB,aAAa;QACb,IAAI;KACzB,gBAOF;IAGD;;;;;;;;;;;;;;;;OAgBG;IACH,2DAgCC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,4BAbG;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;QACD,mBAAmB;QACnB,gBAAgB;QAChB,oBAAoB;QACpB,aAAa;QACb,IAAI;KACzB,gBAOF;IAGD;;;;;;;;;;;;;;;;OAgBG;IACH,2DAgCC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,4BAbG;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;QACD,mBAAmB;QACnB,gBAAgB;QAChB,oBAAoB;QACpB,aAAa;QACb,IAAI;KACzB,gBAOF;CAGJ"}