glitch-javascript-sdk 0.9.2 → 0.9.4

package/dist/index.d.ts

@@ -900,6 +900,28 @@ declare class Users {
      * @returns promise
      */
     static me<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Gets the campaigns the users has been invited too.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/showMe
+     *
+     * @param user_id The id of the user to update.
+     * @param data The data to update.
+     *
+     * @returns promise
+     */
+    static getCampaignInvites<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Sync the current influencer's information.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/showMe
+     *
+     * @param user_id The id of the user to update.
+     * @param data The data to update.
+     *
+     * @returns promise
+     */
+    static syncInfluencer<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
     /**
      * Will follow and unfollow a user. If the user is not being following, it will follow the user. If they are following, it will unfollow the user. The current JWT is used for the follower.
      *
@@ -2600,6 +2622,66 @@ declare class Campaigns {
      * @returns Promise
      */
     static removeType<T>(campaign_id: string, type_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get a list of influencer invites that have been sent for this campaign.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Campaigns/getInfluencerInvites
+     *
+     * @param campaign_id The id fo the campaign to retrieve.
+     *
+     * @returns promise
+     */
+    static listInfluencerInvites<T>(campaign_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Invites an influencer to join this campaign.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Campaigns/inviteInfluencer
+     *
+     * @param campaign_id The id fo the campaign to retrieve.
+     *
+     * @returns promise
+     */
+    static sendInfluencerInvite<T>(campaign_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Invites an influencer to join this campaign.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Campaigns/getInfluencerInvite
+     *
+     * @param campaign_id The id fo the campaign to retrieve.
+     *
+     * @returns promise
+     */
+    static viewInfluencerInvite<T>(campaign_id: string, influencer_id: string, token: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+    * The route for an influencer to accept an invite.
+    *
+    * @see https://api.glitch.fun/api/documentation#/Campaigns/acceptInfluencerInvite
+    *
+    * @param campaign_id The id fo the campaign to retrieve.
+    *
+    * @returns promise
+    */
+    static acceptInfluencerInvite<T>(campaign_id: string, influencer_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * The route for an influencer to decline an invite.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Campaigns/delinceInfluencerInvite
+     *
+     * @param campaign_id The id fo the campaign to retrieve.
+     *
+     * @returns promise
+     */
+    static declineInfluencernInvite<T>(campaign_id: string, influencer_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * The route for an influencer to decline an invite.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Campaigns/withdrawInfluencerInvite
+     *
+     * @param campaign_id The id fo the campaign to retrieve.
+     *
+     * @returns promise
+     */
+    static widthdrawInfluencerInvite<T>(campaign_id: string, influencer_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
 }
 
 declare class Subscriptions {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "glitch-javascript-sdk",
-  "version": "0.9.2",
+  "version": "0.9.4",
   "description": "Javascript SDK for Glitch",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/src/api/Campaigns.ts

@@ -80,7 +80,7 @@ class Campaigns {
      * 
      * @returns promise
      */
-     public static listCampaignLinks<T>(campaign_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+    public static listCampaignLinks<T>(campaign_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
         return Requests.processRoute(CampaignsRoute.routes.listCampaignLinks, undefined, { campaign_id: campaign_id }, params);
     }
 
@@ -124,17 +124,17 @@ class Campaigns {
      */
     public static getCampaignLink<T>(campaign_id: string, link_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
 
-        return Requests.processRoute(CampaignsRoute.routes.getCampaignLink, {}, { campaign_id: campaign_id, link_id: link_id  }, params);
+        return Requests.processRoute(CampaignsRoute.routes.getCampaignLink, {}, { campaign_id: campaign_id, link_id: link_id }, params);
     }
 
-     /**
-     * List all the influencers associated with a campaign.
-     * 
-     * @see https://api.glitch.fun/api/documentation#/Campaigns/getInfluencerCampaigns
-     * 
-     * @returns promise
-     */
-     public static listInfluencerCampaigns<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+    /**
+    * List all the influencers associated with a campaign.
+    * 
+    * @see https://api.glitch.fun/api/documentation#/Campaigns/getInfluencerCampaigns
+    * 
+    * @returns promise
+    */
+    public static listInfluencerCampaigns<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
         return Requests.processRoute(CampaignsRoute.routes.listInfluencerCampaigns, undefined, undefined, params);
     }
 
@@ -148,20 +148,20 @@ class Campaigns {
      * @returns Promise
      */
     public static createInfluencerCampaign<T>(campaign_id: string, user_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
-        return Requests.processRoute(CampaignsRoute.routes.createInfluencerCampaign , data, { campaign_id: campaign_id }, params);
+        return Requests.processRoute(CampaignsRoute.routes.createInfluencerCampaign, data, { campaign_id: campaign_id }, params);
     }
 
-     /**
-     * Update an influencer campaign.
-     * 
-     * @see https://api.glitch.fun/api/documentation#/Campaigns/updateInfluencerCampaign
-     * 
-     * @param campaign_id The id of the campaign to update.
-     * @param data The data to update.
-     * 
-     * @returns promise
-     */
-     public static updateInfluencerCampaign<T>(campaign_id: string, user_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
+    /**
+    * Update an influencer campaign.
+    * 
+    * @see https://api.glitch.fun/api/documentation#/Campaigns/updateInfluencerCampaign
+    * 
+    * @param campaign_id The id of the campaign to update.
+    * @param data The data to update.
+    * 
+    * @returns promise
+    */
+    public static updateInfluencerCampaign<T>(campaign_id: string, user_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
 
         return Requests.processRoute(CampaignsRoute.routes.updateInfluencerCampaign, data, { campaign_id: campaign_id, user_id: user_id }, params);
     }
@@ -216,17 +216,17 @@ class Campaigns {
      * @returns promise
      */
     public static listInfluencerCampaignLinks<T>(campaign_id: string, user_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
-        return Requests.processRoute(CampaignsRoute.routes.listInfluencerCampaignLinks , undefined, { campaign_id: campaign_id, user_id: user_id }, params);
+        return Requests.processRoute(CampaignsRoute.routes.listInfluencerCampaignLinks, undefined, { campaign_id: campaign_id, user_id: user_id }, params);
     }
 
-     /**
-     * List all the campaign mentions.
-     * 
-     * @see https://api.glitch.fun/api/documentation#/Campaigns/getCampaignLinks
-     * 
-     * @returns promise
-     */
-     public static listCampaignMentions<T>(campaign_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+    /**
+    * List all the campaign mentions.
+    * 
+    * @see https://api.glitch.fun/api/documentation#/Campaigns/getCampaignLinks
+    * 
+    * @returns promise
+    */
+    public static listCampaignMentions<T>(campaign_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
         return Requests.processRoute(CampaignsRoute.routes.listCampaignMentions, undefined, { campaign_id: campaign_id }, params);
     }
 
@@ -270,21 +270,21 @@ class Campaigns {
      */
     public static getCampaignMention<T>(campaign_id: string, mention_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
 
-        return Requests.processRoute(CampaignsRoute.routes.getCampaignMention, {}, { campaign_id: campaign_id, mention_id: mention_id  }, params);
+        return Requests.processRoute(CampaignsRoute.routes.getCampaignMention, {}, { campaign_id: campaign_id, mention_id: mention_id }, params);
     }
 
-     /**
-     * Delete the information for a single campaign mention.
-     * 
-     * @see https://api.glitch.fun/api/documentation#/Campaigns/getCampaignLink
-     * 
-     * @param campaign_id The id fo the campaign to retrieve.
-     * 
-     * @returns promise
-     */
-     public static deleteCampaignMention<T>(campaign_id: string, mention_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
-
-        return Requests.processRoute(CampaignsRoute.routes.deleteCampaignMention, {}, { campaign_id: campaign_id, mention_id: mention_id  }, params);
+    /**
+    * Delete the information for a single campaign mention.
+    * 
+    * @see https://api.glitch.fun/api/documentation#/Campaigns/getCampaignLink
+    * 
+    * @param campaign_id The id fo the campaign to retrieve.
+    * 
+    * @returns promise
+    */
+    public static deleteCampaignMention<T>(campaign_id: string, mention_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(CampaignsRoute.routes.deleteCampaignMention, {}, { campaign_id: campaign_id, mention_id: mention_id }, params);
     }
 
     /**
@@ -298,7 +298,7 @@ class Campaigns {
      */
     public static addCountry<T>(campaign_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
 
-        return Requests.processRoute(CampaignsRoute.routes.addCountry, data, {campaign_id : campaign_id}, params);
+        return Requests.processRoute(CampaignsRoute.routes.addCountry, data, { campaign_id: campaign_id }, params);
     }
 
     /**
@@ -312,7 +312,7 @@ class Campaigns {
      */
     public static removeCountry<T>(campaign_id: string, country_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
 
-        return Requests.processRoute(CampaignsRoute.routes.removeCountry, undefined, {campaign_id : campaign_id, country_id : country_id}, params);
+        return Requests.processRoute(CampaignsRoute.routes.removeCountry, undefined, { campaign_id: campaign_id, country_id: country_id }, params);
     }
 
     /**
@@ -326,7 +326,7 @@ class Campaigns {
      */
     public static addGender<T>(campaign_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
 
-        return Requests.processRoute(CampaignsRoute.routes.addGender, data, {campaign_id : campaign_id}, params);
+        return Requests.processRoute(CampaignsRoute.routes.addGender, data, { campaign_id: campaign_id }, params);
     }
 
     /**
@@ -338,9 +338,9 @@ class Campaigns {
      * 
      * @returns Promise
      */
-    public static removeGender<T>(campaign_id : string, gender_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+    public static removeGender<T>(campaign_id: string, gender_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
 
-        return Requests.processRoute(CampaignsRoute.routes.removeGender, undefined, {campaign_id : campaign_id, gender_id : gender_id}, params);
+        return Requests.processRoute(CampaignsRoute.routes.removeGender, undefined, { campaign_id: campaign_id, gender_id: gender_id }, params);
     }
 
     /**
@@ -354,7 +354,7 @@ class Campaigns {
      */
     public static addEthnicity<T>(campaign_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
 
-        return Requests.processRoute(CampaignsRoute.routes.addEthnicity, data, {campaign_id : campaign_id}, params);
+        return Requests.processRoute(CampaignsRoute.routes.addEthnicity, data, { campaign_id: campaign_id }, params);
     }
 
     /**
@@ -368,35 +368,128 @@ class Campaigns {
      */
     public static removeEthnicity<T>(campaign_id: string, ethnicity_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
 
-        return Requests.processRoute(CampaignsRoute.routes.removeEthnicity, undefined, {campaign_id : campaign_id, ethnicity_id : ethnicity_id}, params);
+        return Requests.processRoute(CampaignsRoute.routes.removeEthnicity, undefined, { campaign_id: campaign_id, ethnicity_id: ethnicity_id }, params);
     }
 
-     /**
-     * Associate a type with the campaign.
+    /**
+    * Associate a type with the campaign.
+    * 
+    * @see https://api.glitch.fun/api/documentation#/Campaigns/addGenderToCampaign
+    * 
+    * @param data The type information to be passed to update the campaign information.
+    * 
+    * @returns Promise
+    */
+    public static addType<T>(campaign_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(CampaignsRoute.routes.addType, data, { campaign_id: campaign_id }, params);
+    }
+
+    /**
+     * Remove an type
      * 
-     * @see https://api.glitch.fun/api/documentation#/Campaigns/addGenderToCampaign
+     * @see https://api.glitch.fun/api/documentation#/Campaigns/removeGender
      * 
-     * @param data The type information to be passed to update the campaign information.
+     * @param type_id The id of the ethnicity to remove.
      * 
      * @returns Promise
      */
-     public static addType<T>(campaign_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
+    public static removeType<T>(campaign_id: string, type_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
 
-        return Requests.processRoute(CampaignsRoute.routes.addType, data, {campaign_id : campaign_id}, params);
+        return Requests.processRoute(CampaignsRoute.routes.removeType, undefined, { campaign_id: campaign_id, type_id: type_id }, params);
     }
 
+
     /**
-     * Remove an type
+     * Get a list of influencer invites that have been sent for this campaign.
      * 
-     * @see https://api.glitch.fun/api/documentation#/Campaigns/removeGender
+     * @see https://api.glitch.fun/api/documentation#/Campaigns/getInfluencerInvites
      * 
-     * @param type_id The id of the ethnicity to remove.
+     * @param campaign_id The id fo the campaign to retrieve.
      * 
-     * @returns Promise
+     * @returns promise
      */
-    public static removeType<T>(campaign_id: string, type_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+    public static listInfluencerInvites<T>(campaign_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(CampaignsRoute.routes.listInfluencerInvites, {}, { campaign_id: campaign_id }, params);
+    }
+
+    /**
+     * Invites an influencer to join this campaign.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Campaigns/inviteInfluencer
+     * 
+     * @param campaign_id The id fo the campaign to retrieve.
+     * 
+     * @returns promise
+     */
+    public static sendInfluencerInvite<T>(campaign_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(CampaignsRoute.routes.sendInfluencerInvite, {}, { campaign_id: campaign_id }, params);
+    }
+
+    /**
+     * Invites an influencer to join this campaign.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Campaigns/getInfluencerInvite
+     * 
+     * @param campaign_id The id fo the campaign to retrieve.
+     * 
+     * @returns promise
+     */
+    public static viewInfluencerInvite<T>(campaign_id: string, influencer_id: string, token: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+
+        // Ensure params is defined and includes the token
+        const updatedParams = { ...params, token };
+
+        return Requests.processRoute(
+            CampaignsRoute.routes.viewInfluencerInvite,
+            {},
+            { campaign_id: campaign_id, influencer_id: influencer_id },
+            updatedParams
+        );
+    }
+
+    /**
+    * The route for an influencer to accept an invite.
+    * 
+    * @see https://api.glitch.fun/api/documentation#/Campaigns/acceptInfluencerInvite
+    * 
+    * @param campaign_id The id fo the campaign to retrieve.
+    * 
+    * @returns promise
+    */
+    public static acceptInfluencerInvite<T>(campaign_id: string, influencer_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(CampaignsRoute.routes.acceptInfluencerInvite, {}, { campaign_id: campaign_id, influencer_id: influencer_id }, params);
+    }
+
+    /**
+     * The route for an influencer to decline an invite.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Campaigns/delinceInfluencerInvite
+     * 
+     * @param campaign_id The id fo the campaign to retrieve.
+     * 
+     * @returns promise
+     */
+    public static declineInfluencernInvite<T>(campaign_id: string, influencer_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(CampaignsRoute.routes.declineInfluencernInvite, {}, { campaign_id: campaign_id, influencer_id: influencer_id }, params);
+    }
+
+    /**
+     * The route for an influencer to decline an invite.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Campaigns/withdrawInfluencerInvite
+     * 
+     * @param campaign_id The id fo the campaign to retrieve.
+     * 
+     * @returns promise
+     */
+    public static widthdrawInfluencerInvite<T>(campaign_id: string, influencer_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
 
-        return Requests.processRoute(CampaignsRoute.routes.removeType, undefined, {campaign_id : campaign_id, type_id : type_id}, params);
+        return Requests.processRoute(CampaignsRoute.routes.widthdrawInfluencerInvite, {}, { campaign_id: campaign_id, influencer_id: influencer_id }, params);
     }
 
 

package/src/api/Users.ts

@@ -46,6 +46,36 @@ class Users {
         return Requests.processRoute(UserRoutes.routes.me, {}, undefined, params);
     }
 
+    /**
+     * Gets the campaigns the users has been invited too.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/showMe
+     * 
+     * @param user_id The id of the user to update.
+     * @param data The data to update.
+     * 
+     * @returns promise
+     */
+    public static getCampaignInvites<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(UserRoutes.routes.getCampaignInvites, {}, undefined, params);
+    }
+
+    /**
+     * Sync the current influencer's information.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/showMe
+     * 
+     * @param user_id The id of the user to update.
+     * @param data The data to update.
+     * 
+     * @returns promise
+     */
+    public static syncInfluencer<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(UserRoutes.routes.syncInfluencer, {}, undefined, params);
+    }
+
     /**
      * Will follow and unfollow a user. If the user is not being following, it will follow the user. If they are following, it will unfollow the user. The current JWT is used for the follower.
      * 

package/src/routes/CampaignsRoute.ts

@@ -32,7 +32,14 @@ class CampaignsRoute {
       addEthnicity : { url: '/campaigns/{campaign_id}/addEthnicity', method: HTTP_METHODS.POST },
       removeEthnicity : { url: '/campaigns/{campaign_id}/removeEthnicity/{ethnicity_id}', method: HTTP_METHODS.DELETE },
       addType : { url: '/campaigns/{campaign_id}/addType', method: HTTP_METHODS.POST },
-      removeType : { url: '/campaigns/{campaign_id}/removeType/{type_id}', method: HTTP_METHODS.DELETE },             
+      removeType : { url: '/campaigns/{campaign_id}/removeType/{type_id}', method: HTTP_METHODS.DELETE },
+      inviteInfluencer : { url: '/campaigns/{campaign_id}/influencers/invites', method: HTTP_METHODS.POST },
+      viewInfluencerInvite : { url: '/campaigns/{campaign_id}/influencers/invites/{influencer_id}', method: HTTP_METHODS.GET },
+      listInfluencerInvites : { url: '/campaigns/{campaign_id}/influencers/invites', method: HTTP_METHODS.GET }, 
+      sendInfluencerInvite : { url: '/campaigns/{campaign_id}/influencers/invites', method: HTTP_METHODS.POST },
+      acceptInfluencerInvite : { url: '/campaigns/{campaign_id}/influencers/invites/{influencer_id}/accept', method: HTTP_METHODS.POST },
+      declineInfluencernInvite : { url: '/campaigns/{campaign_id}/influencers/invites/{influencer_id}/decline', method: HTTP_METHODS.POST }, 
+      widthdrawInfluencerInvite : { url: '/campaigns/{campaign_id}/influencers/invites/{influencer_id}/withdraw', method: HTTP_METHODS.POST },                
     };
 
   }

package/src/routes/UserRoutes.ts

@@ -9,6 +9,7 @@ class UserRoutes {
       follow : { url: '/users/{user_id}/follow', method: HTTP_METHODS.POST  },
       profile  :{ url: '/users/{user_id}/profile', method: HTTP_METHODS.GET  },
       me : { url: '/users/me', method: HTTP_METHODS.GET },
+      syncInfluencer : { url: '/users/syncInfluencer', method: HTTP_METHODS.POST },
       oneTimeToken : { url: '/users/oneTimeToken', method: HTTP_METHODS.GET },
       uploadAvatar : { url: '/users/uploadAvatarImage', method: HTTP_METHODS.POST },
       uploadBanner : { url: '/users/uploadBannerImage', method: HTTP_METHODS.POST },
@@ -32,6 +33,7 @@ class UserRoutes {
       removeGenre : { url: '/users/removeGenre/{genre_id}', method: HTTP_METHODS.DELETE },
       addType : { url: '/users/addType', method: HTTP_METHODS.POST },
       removeType : { url: '/users/removeType/{type_id}', method: HTTP_METHODS.DELETE },
+      getCampaignInvites : { url: '/users/getCampaignInvites', method: HTTP_METHODS.GET },
     };
 
   }