1.1.0 • Published 3 years ago

aimastering v1.1.0

Weekly downloads
-
License
Apache 2.0
Repository
-
Last release
3 years ago

aimastering

Aimastering - JavaScript client for aimastering This is a AI Mastering API document. You can use the mastering feature of AI Mastering through this API. This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.1.0
  • Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install aimastering --save
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your aimastering from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('aimastering') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var Aimastering = require('aimastering');

var defaultClient = Aimastering.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new Aimastering.AccessTokenApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAccessToken(callback);

Documentation for API Endpoints

All URIs are relative to https://api.bakuage.com:443

ClassMethodHTTP requestDescription
Aimastering.AccessTokenApicreateAccessTokenPOST /access_tokensCreate an API access token.
Aimastering.AmazonSubscriptionApilistAmazonSubscriptionsGET /amazon_subscriptionsGet all accessable amazon subscriptions.
Aimastering.AudioApicreateAudioPOST /audiosCreate a new audio.
Aimastering.AudioApidownloadAudioGET /audios/{id}/downloadDownload an audio data by id.
Aimastering.AudioApidownloadAudioByTokenGET /audios/download_by_tokenDownload an audio data by audio_download_token.
Aimastering.AudioApigetAudioGET /audios/{id}Get an audio by id.
Aimastering.AudioApigetAudioAnalysisGET /audios/{id}/analysisGet an audio analysis by id.
Aimastering.AudioApigetAudioDownloadTokenGET /audios/{id}/download_tokenGet an audio download token by id.
Aimastering.AudioApilistAudiosGET /audiosGet all audios accessable.
Aimastering.ConfigApigetConfigGET /configGet config.
Aimastering.ExternalSearchApisearchExternalGET /external_searchSearch external music and get name, url, thumbnails, etc.
Aimastering.LibraryAudioApicreateLibraryAudioPOST /library_audiosCreate a new library audio.
Aimastering.LibraryAudioApicreateLibraryAudioLikePOST /library_audios/{id}/likeCreate a new library audio like.
Aimastering.LibraryAudioApideleteLibraryAudioDELETE /library_audios/{id}Delete library audio.
Aimastering.LibraryAudioApigetLibraryAudioGET /library_audios/{id}Get a library audio by id.
Aimastering.LibraryAudioApigetLibraryAudioAnalysisGET /library_audios/{id}/analysisGet a library audio analysis by id.
Aimastering.LibraryAudioApilistLibraryAudiosGET /library_audiosGet all library audios accessable.
Aimastering.LibraryAudioApiupdateLibraryAudioPUT /library_audios/{id}Update library audio.
Aimastering.MasteringApicancelMasteringPUT /masterings/{id}/cancelCancel a mastering by id.
Aimastering.MasteringApicreateMasteringPOST /masteringsCreate a new mastering.
Aimastering.MasteringApideleteMasteringDELETE /masterings/{id}Delete mastering.
Aimastering.MasteringApifreeUnlockMasteringPUT /masterings/{id}/free_unlockFree unlock a mastering by id.
Aimastering.MasteringApigetMasteringGET /masterings/{id}Get a mastering by id.
Aimastering.MasteringApigetMasteringUnlockProductGET /masterings/{id}/unlock_productReview a mastering by id.
Aimastering.MasteringApilistMasteringsGET /masteringsGet all accessable masterings.
Aimastering.MasteringApipublishMasteringPOST /masterings/{id}/publishPublish a mastering by id.
Aimastering.MasteringApireviewMasteringPUT /masterings/{id}/reviewReview a mastering by id.
Aimastering.MasteringApiupdateMasteringPUT /masterings/{id}Update a mastering.
Aimastering.PaymentApicreatePaymentPOST /paymentsCreate a new payment.
Aimastering.PaymentApiexecutePaymentPUT /payments/{id}/executeExecute a payment by id.
Aimastering.PaymentApigetPaymentGET /payments/{id}Get a payment by id.
Aimastering.PaymentApilistPaymentsGET /paymentsGet all accessable payments.
Aimastering.PaymentCustomerApigetDefaultPaymentCustomerGET /payment_customers/defaultGet a default payment customer.
Aimastering.PlanApilistPlansGET /plansGet all accessable plans.
Aimastering.SpSubscriptionApicreateSpSubscriptionPOST /sp_subscriptionsCreate a new smartphone subscription.
Aimastering.SpSubscriptionApilistSpSubscriptionsGET /sp_subscriptionsGet all accessable smartphone subscriptions.
Aimastering.StatisticsApigetGroupBuyStatisticsGET /statistics/group_buyGet group buy statistics.
Aimastering.StatisticsApilistAnonymizedMasteringsGET /statistics/anonymized_masteringsGet anonymized masterings.
Aimastering.StatisticsApilistKpisGET /statistics/kpisGet KPIs.
Aimastering.SubscriptionApicancelSubscriptionPUT /subscriptions/{id}/cancelCancel a subscription by id.
Aimastering.SubscriptionApicancelSubscriptionCancellationPUT /subscriptions/{id}/cancel_cancellationCancel the subscription cancellation by id.
Aimastering.SubscriptionApicreateSubscriptionPOST /subscriptionsCreate a new subscription.
Aimastering.SubscriptionApigetSubscriptionGET /subscriptions/{id}Get a subscription by id.
Aimastering.SubscriptionApilistSubscriptionsGET /subscriptionsGet all accessable subscriptions.
Aimastering.UserApigetSelfGET /users/selfGet self user.
Aimastering.UserApinotifyRegistrationPUT /users/self/notify_registrationNotify user is registered.
Aimastering.UserApisendInvitationPOST /users/self/send_invitationSend invitation.
Aimastering.UserApiupdateSelfPUT /users/selfUpdate self user.
Aimastering.VideoApidownloadVideoGET /videos/{id}/downloadDownload an video data by id.
Aimastering.VideoApidownloadVideoByTokenGET /videos/download_by_tokenDownload an video data by video_download_token.
Aimastering.VideoApigetVideoGET /videos/{id}Get an video by id.
Aimastering.VideoApigetVideoDownloadTokenGET /videos/{id}/download_tokenGet an video download token by id.
Aimastering.VideoApilistVideosGET /videosGet all videos accessable.

Documentation for Models

Documentation for Authorization

bearer

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header
1.1.0

3 years ago

1.0.0

6 years ago