gomarketme-react-native 1.1.1 → 4.0.0

package/README.md

@@ -2,7 +2,7 @@
 	<img src="https://static.gomarketme.net/assets/gmm-icon.png" alt="GoMarketMe"/>
 	<br>
     <h1>gomarketme-react-native</h1>
-	<p>Affiliate Marketing for React Native-Based iOS and Android Apps.</p>
+	<p>Affiliate marketing for React Native apps on iOS and Android.</p>
 </div>
 
 ## Installation
@@ -10,44 +10,87 @@
 ### Using npm
 
 ```bash
-npm install gomarketme-react-native
+npm install gomarketme-react-native@4.0.0
 ```
 
 ### Using yarn
 
 ```bash
-yarn add gomarketme-react-native
+yarn add gomarketme-react-native@4.0.0
 ```
 
 ### Using pnpm
 
 ```bash
-pnpm add gomarketme-react-native
+pnpm add gomarketme-react-native@4.0.0
 ```
+##
 
+GoMarketMe is built on top of react-native-iap, so you may also need to install the following packages: 
+```bash
+npm install react-native-iap react-native-nitro-modules
+(or yarn add react-native-iap react-native-nitro-modules)
+(or pnpm add react-native-iap react-native-nitro-modules)
+```
 
 ## Usage
 
-To initialize GoMarketMe, import the `gomarketme` package and create a new instance of `GoMarketMe`:
+⚙️ Basic Integration
+
+To initialize GoMarketMe, import the `gomarketme` package and initialize the SDK with your API key:
 
 ```tsx
 import GoMarketMe from 'gomarketme-react-native';
 
-const App: React.FC = () => {
-  const apiKey = 'YOUR_API_KEY_HERE';
+useEffect(() => {
+  
+  GoMarketMe.initialize('API_KEY'); // Initialize with your API key
+
+}, []);
+```
+
+No further steps needed. The SDK automatically attributes and reports your affiliate sales in real time.
 
-  useEffect(() => {
-    const initializeGoMarketMe = async () => {
-      await GoMarketMe.initialize(apiKey);
-    };
+⚙️ OR - Advanced Integration
 
-    initializeGoMarketMe();
-  }, []);
-};
+Use this approach for more advanced scenarios, such as:
+- Affiliate-aware paywalls: Offer exclusive pricing or promotions to users acquired through affiliate campaigns.
+- Personalized onboarding: For example, a social or fitness app can automatically make new users follow the influencer who referred them, strengthening engagement and maximizing the affiliate’s impact.
+
+```tsx
+import GoMarketMe from 'gomarketme-react-native';
+  
+const goMarketMeSDK = GoMarketMe;
+const [affiliateData, setAffiliateData] = useState<GoMarketMeAffiliateMarketingData | null>(null);
+
+useEffect(() => {
+  
+  const initGoMarketMe = async () => {
+    
+    await goMarketMeSDK.initialize('API_KEY'); // Initialize with your API key
+    const data = goMarketMeSDK.affiliateMarketingData;
+
+    if (data) { // user acquired through affiliate campaign
+      
+      console.log('Affiliate ID:', data.affiliate?.id);                         // maps to GoMarketMe > Affiliates > Export > id column
+      console.log('Affiliate %:', data.saleDistribution?.affiliatePercentage);  // maps to GoMarketMe > Campaigns > [Name] > Affiliate's Revenue Split (%)
+      console.log('Campaign ID:', data.campaign?.id);                           // maps to GoMarketMe > Campaigns > [Name] > id in the URL
+
+      setAffiliateData(data);
+    }
+
+  };
+
+  initGoMarketMe();
+}, []);
 ```
 
-Make sure to replace API_KEY with your actual GoMarketMe API key. You can find it on the product onboarding page and under Profile > API Key.
+Make sure to replace `API_KEY` with your actual GoMarketMe API key. You can find it on the product onboarding page and under **Profile > API Key**.
+
+For Expo, go to [https://www.npmjs.com/package/gomarketme-react-native-expo](https://www.npmjs.com/package/gomarketme-react-native-expo).
 
 ## Support
 
-If you encounter any problems or issues, please contact us at [integrations@gomarketme.co](mailto:integrations@gomarketme.co) or visit [https://gomarketme.co](https://gomarketme.co).
+Check out our sample React Native app at [https://github.com/GoMarketMe/gomarketme-react-native-sample-app](https://github.com/GoMarketMe/gomarketme-react-native-sample-app).
+
+If you run into any issues, please reach out to us at [integrations@gomarketme.co](mailto:integrations@gomarketme.co) or visit [https://gomarketme.co](https://gomarketme.co).

package/dist/index.d.ts

@@ -1,30 +1,71 @@
+export declare class GoMarketMeAffiliateMarketingData {
+    campaign: Campaign;
+    affiliate: Affiliate;
+    saleDistribution: SaleDistribution;
+    affiliateCampaignCode: string;
+    deviceId: string;
+    offerCode?: string;
+    constructor(campaign: Campaign, affiliate: Affiliate, saleDistribution: SaleDistribution, affiliateCampaignCode: string, deviceId: string, offerCode?: string);
+    static fromJson(json: Record<string, any>): GoMarketMeAffiliateMarketingData | null;
+}
+export declare class Campaign {
+    id: string;
+    name: string;
+    status: string;
+    type: string;
+    publicLinkUrl?: string;
+    constructor(id: string, name: string, status: string, type: string, publicLinkUrl?: string);
+    static fromJson(json: Record<string, any>): Campaign;
+}
+export declare class Affiliate {
+    id: string;
+    firstName: string;
+    lastName: string;
+    countryCode: string;
+    instagramAccount: string;
+    tiktokAccount: string;
+    xAccount: string;
+    constructor(id: string, firstName: string, lastName: string, countryCode: string, instagramAccount: string, tiktokAccount: string, xAccount: string);
+    static fromJson(json: Record<string, any>): Affiliate;
+}
+export declare class SaleDistribution {
+    platformPercentage: string;
+    affiliatePercentage: string;
+    constructor(platformPercentage: string, affiliatePercentage: string);
+    static fromJson(json: Record<string, any>): SaleDistribution;
+}
 declare class GoMarketMe {
     private static instance;
+    private sdkType;
+    private sdkVersion;
     private sdkInitializedKey;
-    private affiliateCampaignCode;
-    private deviceId;
     private sdkInitializationUrl;
     private systemInfoUrl;
     private eventUrl;
+    private _affiliateCampaignCode;
+    private _deviceId;
+    private _packageName;
+    private _purchaseUpdateUnsub?;
+    private _purchaseErrorUnsub?;
+    affiliateMarketingData?: GoMarketMeAffiliateMarketingData | null;
     private constructor();
     static getInstance(): GoMarketMe;
     initialize(apiKey: string): Promise<void>;
-    private addListener;
-    private getSystemInfo;
-    private postSDKInitialization;
-    private postSystemInfo;
-    private readAndroidDeviceInfo;
-    private readIosDeviceInfo;
-    private getTimeZone;
-    private getLanguageCode;
-    private fetchPurchases;
-    private fetchPurchaseProducts;
-    private sendEventToServer;
-    private serializePurchaseDetails;
-    private serializeProductDetails;
-    private serializeSubscriptionDetails;
-    private markSDKAsInitialized;
-    private isSDKInitialized;
+    removeListeners(): void;
+    private _addListeners;
+    private _getSystemInfo;
+    private _postSDKInitialization;
+    private _postSystemInfo;
+    private _readAndroidDeviceInfo;
+    private _readIosDeviceInfo;
+    private _fetchConsolidatedPurchases;
+    private _sendEventToServer;
+    private _serializePurchaseDetails;
+    private _serializeProductDetails;
+    private _markSDKAsInitialized;
+    private _isSDKInitialized;
+    private _isProduction;
+    private _fetchExistingPurchases;
 }
 declare const _default: GoMarketMe;
 export default _default;