post_puma_open_api_3_0

PostPumaOpenApi30 - JavaScript client for post_puma_open_api_3_0 PostPuma API specifications This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.9.0
• Build package: org.openapitools.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 post_puma_open_api_3_0 --save

Finally, you need to build the module:

npm run build

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

To use the link you just defined in your project, switch to the directory you want to use your post_puma_open_api_3_0 from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

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):

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 PostPumaOpenApi30 = require('post_puma_open_api_3_0');

var defaultClient = PostPumaOpenApi30.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

var api = new PostPumaOpenApi30.AccountsApi()
var accountUuid = "accountUuid_example"; // {String} Account UUID
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccount(accountUuid, callback);

Documentation for API Endpoints

All URIs are relative to https://app.postpuma.com/app/5afgg2-1egj4n-7612ng-g313ie

Class	Method	HTTP request	Description
PostPumaOpenApi30.AccountsApi	getAccount	GET /accounts/{accountUuid}	Get account
PostPumaOpenApi30.AccountsApi	listAccounts	GET /accounts	List accounts
PostPumaOpenApi30.MediaApi	deleteMediaFiles	DELETE /media	Delete media files
PostPumaOpenApi30.MediaApi	getMediaFile	GET /media/{mediaUuid}	Get media file
PostPumaOpenApi30.MediaApi	listMediaFiles	GET /media	List media files
PostPumaOpenApi30.MediaApi	uploadMediaFile	POST /media	Upload media file
PostPumaOpenApi30.PostsApi	createPost	POST /posts	Create post
PostPumaOpenApi30.PostsApi	deletePost	DELETE /posts/{postUuid}	Delete post
PostPumaOpenApi30.PostsApi	deletePosts	DELETE /posts	Delete posts
PostPumaOpenApi30.PostsApi	getPost	GET /posts/{postUuid}	Get post
PostPumaOpenApi30.PostsApi	listPosts	GET /posts	List posts
PostPumaOpenApi30.PostsApi	queuePost	POST /posts/add-to-queue/{postUuid}	Queue post
PostPumaOpenApi30.PostsApi	schedulePost	POST /posts/schedule/{postUuid}	Schedule post
PostPumaOpenApi30.PostsApi	updatePost	PUT /posts/{postUuid}	Update post
PostPumaOpenApi30.TagsApi	createTag	POST /tags	Create tag
PostPumaOpenApi30.TagsApi	deleteTag	DELETE /tags/{tagUuid}	Delete tag
PostPumaOpenApi30.TagsApi	getTag	GET /tags/{tagUuid}	Get tag
PostPumaOpenApi30.TagsApi	listTags	GET /tags	List tags
PostPumaOpenApi30.TagsApi	updateTag	PUT /tags/{tagUuid}	Update tag

Documentation for Models

• PostPumaOpenApi30.Account
• PostPumaOpenApi30.AccountData
• PostPumaOpenApi30.CreatePostRequest
• PostPumaOpenApi30.CreateTagRequest
• PostPumaOpenApi30.DeleteMediaFiles200Response
• PostPumaOpenApi30.DeleteMediaFilesRequest
• PostPumaOpenApi30.DeletePostRequest
• PostPumaOpenApi30.DeletePosts200Response
• PostPumaOpenApi30.DeletePosts200ResponseOneOf
• PostPumaOpenApi30.DeletePosts200ResponseOneOf1
• PostPumaOpenApi30.DeletePostsRequest
• PostPumaOpenApi30.ListAccounts200Response
• PostPumaOpenApi30.ListMediaFiles200Response
• PostPumaOpenApi30.ListPosts200Response
• PostPumaOpenApi30.ListTags200Response
• PostPumaOpenApi30.MediaFile
• PostPumaOpenApi30.Post
• PostPumaOpenApi30.PostUser
• PostPumaOpenApi30.QueuePost200Response
• PostPumaOpenApi30.SchedulePostRequest
• PostPumaOpenApi30.Tag
• PostPumaOpenApi30.UpdatePostRequest
• PostPumaOpenApi30.UpdateTagRequest
• PostPumaOpenApi30.Version
• PostPumaOpenApi30.VersionContent
• PostPumaOpenApi30.VersionOptions
• PostPumaOpenApi30.VersionOptionsInstagram
• PostPumaOpenApi30.VersionOptionsLinkedin
• PostPumaOpenApi30.VersionOptionsMastodon
• PostPumaOpenApi30.VersionOptionsPinterest
• PostPumaOpenApi30.VersionOptionsPinterestBoards
• PostPumaOpenApi30.VersionOptionsTiktok
• PostPumaOpenApi30.VersionOptionsTiktokPrivacyLevel
• PostPumaOpenApi30.VersionOptionsYoutube

Documentation for Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication