social-media-api - npm Package Compare versions

Comparing version 1.2.5 to 1.2.6

CHANGELOG.md

 # Changelog
 
+## [1.2.6] 2024-12-16
+
+- Updated to Profile Key for Business Plan.
+
 ## [1.2.5] 2024-11-27
@@ -4,0 +8,0 @@

index.js

@@ -104,22 +104,37 @@ import got from "got";
     this.apiKey = apiKey;
-    this.headers = {
+    this.profileKey = null;
+  }
+
+  getHeaders() {
+    const headers = {
       "Content-Type": "application/json",
-      Authorization: `Bearer ${apiKey}`
+      "Authorization": `Bearer ${this.apiKey}`
     };
+
+    if (this.profileKey) {
+      headers["Profile-Key"] = this.profileKey;
+    }
+
+    return headers;
   }
 
+  setProfileKey(profileKey) {
+    this.profileKey = profileKey;
+    return this;
+  }
+
   post(data) {
-    return doPost("post", data, this.headers);
+    return doPost("post", data, this.getHeaders());
   }
 
   delete(data) {
-    return doDelete("post", data, this.headers);
+    return doDelete("post", data, this.getHeaders());
   }
 
   updatePost(data) {
-    return doPut("post", data, this.headers);
+    return doPut("post", data, this.getHeaders());
   }
 
   retryPost(data) {
-    return doPut("post/retry", data, this.headers);
+    return doPut("post/retry", data, this.getHeaders());
   }
@@ -129,3 +144,3 @@
     const { id } = data;
-    return doGet(`post/${id}`, this.headers);
+    return doGet(`post/${id}`, this.getHeaders());
   }
@@ -144,31 +159,31 @@
 
-    return doGet(`history${id ? `/${id}` : ""}`, this.headers, params);
+    return doGet(`history${id ? `/${id}` : ""}`, this.getHeaders(), params);
   }
 
   media(params) {
-    return doGet("media", this.headers, params);
+    return doGet("media", this.getHeaders(), params);
   }
 
   verifyMediaExists(params) {
-    return doPost("media/urlExists", params, this.headers);
+    return doPost("media/urlExists", params, this.getHeaders());
   }
 
   mediaUploadUrl(params) {
-    return doGet("media/uploadUrl", this.headers, params);
+    return doGet("media/uploadUrl", this.getHeaders(), params);
   }
 
   mediaMeta(params) {
-    return doGet("media/meta", this.headers, params);
+    return doGet("media/meta", this.getHeaders(), params);
   }
 
   resizeImage(params) {
-    return doPost("media/resize", params, this.headers);
+    return doPost("media/resize", params, this.getHeaders());
   }
 
   analyticsLinks(params) {
-    return doGet("analytics/links", this.headers, params);
+    return doGet("analytics/links", this.getHeaders(), params);
   }
 
   analyticsPost(data) {
-    return doPost("analytics/post", data, this.headers);
+    return doPost("analytics/post", data, this.getHeaders());
   }
@@ -178,35 +193,35 @@
   analyticsSocial(data) {
-    return doPost("analytics/social", data, this.headers);
+    return doPost("analytics/social", data, this.getHeaders());
   }
 
   user(params) {
-    return doGet("user", this.headers, params);
+    return doGet("user", this.getHeaders(), params);
   }
 
   upload(data) {
-    return doPost("upload", data, this.headers);
+    return doPost("upload", data, this.getHeaders());
   }
 
   shorten(data) {
-    return doPost("shorten", data, this.headers);
+    return doPost("shorten", data, this.getHeaders());
   }
 
   feedAdd(data) {
-    return doPost("feed", data, this.headers);
+    return doPost("feed", data, this.getHeaders());
   }
 
   feedDelete(data) {
-    return doDelete("feed", data, this.headers);
+    return doDelete("feed", data, this.getHeaders());
   }
 
   feedGet(data) {
-    return doGet("feed", data, this.headers);
+    return doGet("feed", data, this.getHeaders());
   }
 
   feedUpdate(data) {
-    return doPut("feed", data, this.headers);
+    return doPut("feed", data, this.getHeaders());
   }
 
   postComment(data) {
-    return doPost("comments", data, this.headers);
+    return doPost("comments", data, this.getHeaders());
   }
@@ -216,3 +231,3 @@
     const { id } = params;
-    return doGet(`comments/${id}`, this.headers, params);
+    return doGet(`comments/${id}`, this.getHeaders(), params);
   }
@@ -222,95 +237,95 @@
     const { id } = params;
-    return doDelete(`comments/${id}`, params, this.headers);
+    return doDelete(`comments/${id}`, params, this.getHeaders());
   }
 
   replyComment(params) {
-    return doPost(`comments/reply`, params, this.headers);
+    return doPost(`comments/reply`, params, this.getHeaders());
   }
 
   createProfile(data) {
-    return doPost("profiles/profile", data, this.headers);
+    return doPost("profiles/profile", data, this.getHeaders());
   }
 
   deleteProfile(data) {
-    return doDelete("profiles/profile", data, this.headers);
+    return doDelete("profiles/profile", data, this.getHeaders());
   }
 
   updateProfile(data) {
-    return doPut("profiles/profile", data, this.headers);
+    return doPut("profiles/profile", data, this.getHeaders());
   }
 
   getProfiles(params) {
-    return doGet("profiles", this.headers, params);
+    return doGet("profiles", this.getHeaders(), params);
   }
 
   generateJWT(data) {
-    return doPost("profiles/generateJWT", data, this.headers);
+    return doPost("profiles/generateJWT", data, this.getHeaders());
   }
 
   unlinkSocial(data) {
-    return doDelete("profiles/social", data, this.headers);
+    return doDelete("profiles/social", data, this.getHeaders());
   }
 
   setAutoSchedule(data) {
-    return doPost("auto-schedule/set", data, this.headers);
+    return doPost("auto-schedule/set", data, this.getHeaders());
   }
 
   deleteAutoSchedule(data) {
-    return doDelete("auto-schedule/delete", data, this.headers);
+    return doDelete("auto-schedule/delete", data, this.getHeaders());
   }
 
   listAutoSchedule(params) {
-    return doGet("auto-schedule/list", this.headers, params);
+    return doGet("auto-schedule/list", this.getHeaders(), params);
   }
 
   registerWebhook(data) {
-    return doPost("hook/webhook", data, this.headers);
+    return doPost("hook/webhook", data, this.getHeaders());
   }
 
   unregisterWebhook(data) {
-    return doDelete("hook/webhook", data, this.headers);
+    return doDelete("hook/webhook", data, this.getHeaders());
   }
 
   listWebhooks(params) {
-    return doGet("hook/webhook", this.headers, params);
+    return doGet("hook/webhook", this.getHeaders(), params);
   }
 
   getBrandByUser(params) {
-    return doGet("brand/byUser", this.headers, params);
+    return doGet("brand/byUser", this.getHeaders(), params);
   }
 
   generatePost(params) {
-    return doPost("generate/post", params, this.headers);
+    return doPost("generate/post", params, this.getHeaders());
   }
 
   generateRewrite(params) {
-    return doPost("generate/rewrite", params, this.headers);
+    return doPost("generate/rewrite", params, this.getHeaders());
   }
 
   generateTranscription(params) {
-    return doPost("generate/transcription", params, this.headers);
+    return doPost("generate/transcription", params, this.getHeaders());
   }
 
   generateTranslation(params) {
-    return doPost("generate/translate", params, this.headers);
+    return doPost("generate/translate", params, this.getHeaders());
   }
 
   generateAltText(params) {
-    return doPost("generate/altText", params, this.headers);
+    return doPost("generate/altText", params, this.getHeaders());
   }
 
   autoHashtags(params) {
-    return doPost("hashtags/auto", params, this.headers);
+    return doPost("hashtags/auto", params, this.getHeaders());
   }
 
   recommendHashtags(params) {
-    return doGet(`hashtags/recommend`, this.headers, params);
+    return doGet(`hashtags/recommend`, this.getHeaders(), params);
   }
 
   checkBannedHashtags(params) {
-    return doGet("hashtags/banned", this.headers, params);
+    return doGet("hashtags/banned", this.getHeaders(), params);
   }
 
   shortLink(params) {
-    return doPost("links", params, this.headers);
+    return doPost("links", params, this.getHeaders());
   }
@@ -320,7 +335,7 @@
     const { id } = params;
-    return doGet(`links/${id}`, this.headers, params);
+    return doGet(`links/${id}`, this.getHeaders(), params);
   }
 
   reviews(params) {
-    return doGet("reviews", this.headers, params);
+    return doGet("reviews", this.getHeaders(), params);
   }
@@ -330,11 +345,11 @@
     const { id } = params;
-    return doGet(`reviews/${id}`, this.headers, params);
+    return doGet(`reviews/${id}`, this.getHeaders(), params);
   }
 
   replyReview(params) {
-    return doPost("reviews", params, this.headers);
+    return doPost("reviews", params, this.getHeaders());
   }
 
   deleteReplyReview(params) {
-    return doDelete("reviews", params, this.headers);
+    return doDelete("reviews", params, this.getHeaders());
   }
@@ -341,0 +356,0 @@ }

package.json

 {
   "name": "social-media-api",
-  "version": "1.2.5",
+  "version": "1.2.6",
   "description": "Social Media API for Instagram, Facebook, LinkedIn, YouTube, X/Twitter, Google Business Profile, Reddit, TikTok, and Telegram. Easily integrate with your platform or app to schedule posts, get analytics, or manage comments on behalf of your users.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -370,10 +370,11 @@ # Social Media APIs for Posting, Scheduling, and Analytics
 
-A User Profile PROFILE_KEY can be used in the body or query parameters with the `profileKey` field. For example:
+A User Profile PROFILE_KEY can be set with the `setProfileKey` function.
 
 ``` javascript
-const post = await social.post({
-    profileKey: "PROFILE_KEY",
-  }).catch(console.error);
+const social = new SocialMediaAPI(API_KEY);
+social.setProfileKey(PROFILE_KEY);
 ```
 
+Replace PROFILE_KEY with the Profile Key of the user you want to use.
+
 Please see the [Authorization](https://www.ayrshare.com/docs/apis/overview#authorization) docs for more details.
@@ -380,0 +381,0 @@

test.js

@@ -16,2 +16,3 @@ // npx rollup index.js --file index.cjs --format cjs
 const social = new SocialMediaAPI(API_KEY);
+social.setProfileKey(PROFILE_KEY);
 
@@ -69,3 +70,3 @@ /** Test history */
   });
-  console.log("testPost: ", post);
+  console.log("testPost: ", JSON.stringify(post, null, 2));
 
@@ -365,2 +366,13 @@ return post.id;
 
+const testWithProfileKey = async () => {
+  social.setProfileKey(PROFILE_KEY);
+  
+  const post = await social.post({
+    randomPost: true,
+    platforms: ["twitter"],
+    shortenLinks: true
+  });
+  console.log("testWithProfileKey post:", post);
+};
+
 const run = async () => {
@@ -375,2 +387,3 @@ const id = await testPost();
   // testDelete(id);
+  // await testWithProfileKey();
 };
@@ -377,0 +390,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

68652

increased by1.32%

Lines of code

1304

increased by1.48%

Number of lines in readme file

661

increased by0.15%

Worsened metrics

Number of package files

7

decreased by-12.5%

No dependency changes