Skip to content

Latest commit

 

History

History
161 lines (107 loc) · 4.48 KB

UserSettingsApi.md

File metadata and controls

161 lines (107 loc) · 4.48 KB
Raw

FastreportCloudSdk.UserSettingsApi

All URIs are relative to http://localhost

Method HTTP request Description
userSettingsAcceptAgreements POST /api/manage/v1/UserSettings/accept Use this endpoint to accept current version of service license agreement
userSettingsGetCurrentUserSettings GET /api/manage/v1/UserSettings Return current user settings.
userSettingsUpdateMySettings PUT /api/manage/v1/UserSettings Update settings of the current user

userSettingsAcceptAgreements

userSettingsAcceptAgreements(opts)

Use this endpoint to accept current version of service license agreement

Example

import FastreportCloudSdk from 'fastreport-cloud-sdk';
let defaultClient = FastreportCloudSdk.ApiClient.instance;
// Configure HTTP basic authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.username = 'YOUR USERNAME';
ApiKey.password = 'YOUR PASSWORD';
// Configure Bearer (JWT) access token for authorization: JWT
let JWT = defaultClient.authentications['JWT'];
JWT.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new FastreportCloudSdk.UserSettingsApi();
let opts = {
  'acceptAgreementsVM': new FastreportCloudSdk.AcceptAgreementsVM() // AcceptAgreementsVM | 
};
apiInstance.userSettingsAcceptAgreements(opts).then(() => {
  console.log('API called successfully.');
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
acceptAgreementsVM AcceptAgreementsVM [optional]

Return type

null (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

userSettingsGetCurrentUserSettings

UserSettingsVM userSettingsGetCurrentUserSettings()

Return current user settings.

Example

import FastreportCloudSdk from 'fastreport-cloud-sdk';
let defaultClient = FastreportCloudSdk.ApiClient.instance;
// Configure HTTP basic authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.username = 'YOUR USERNAME';
ApiKey.password = 'YOUR PASSWORD';
// Configure Bearer (JWT) access token for authorization: JWT
let JWT = defaultClient.authentications['JWT'];
JWT.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new FastreportCloudSdk.UserSettingsApi();
apiInstance.userSettingsGetCurrentUserSettings().then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

This endpoint does not need any parameter.

Return type

UserSettingsVM

Authorization

ApiKey, JWT

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

userSettingsUpdateMySettings

UserSettingsVM userSettingsUpdateMySettings(opts)

Update settings of the current user

Example

import FastreportCloudSdk from 'fastreport-cloud-sdk';
let defaultClient = FastreportCloudSdk.ApiClient.instance;
// Configure HTTP basic authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.username = 'YOUR USERNAME';
ApiKey.password = 'YOUR PASSWORD';
// Configure Bearer (JWT) access token for authorization: JWT
let JWT = defaultClient.authentications['JWT'];
JWT.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new FastreportCloudSdk.UserSettingsApi();
let opts = {
  'updateUserSettingsVM': new FastreportCloudSdk.UpdateUserSettingsVM() // UpdateUserSettingsVM | 
};
apiInstance.userSettingsUpdateMySettings(opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
updateUserSettingsVM UpdateUserSettingsVM [optional]

Return type

UserSettingsVM

Authorization

ApiKey, JWT

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: application/json