deeplink-module

The library for generation deep links.

Installation

Install with npm

$ npm install deeplink-module

Install with yarn

$ yarn addd deeplink-module

Import module

import { DeepLinkModule } from 'deeplink-module'

@Module({
  imports: [DeepLinkModule, HttpModule],
  controllers: [AppController],
  providers: [
    AppService
  ],
})
export class AppModule {}

Service methods

1. makeLinks() Make deep link from url. You can send many urls in time. Options:

{
  "actions": [
    {
      "project": "coupons",  
      "affiliate": "admitad", 
      "admitadPlatform": "string",  
      "retailer": "string",
      "urls": [
        "http://test.com",
        "https://test.com"
      ],
      "subId": "string",
      "subId1": "string",
      "subId2": "string",
      "subId3": "string",
      "subId4": "string"
    }
  ]
}

where:

| Action options | Values | Required | |---|---|---| | project | Deep link project | yes | | affiliate | Affiliate network | yes | | retailer | Retailer id associated with affiliate | yes | | urls | Array of urls | yes | | admitadPlatform | Admitad platform, use only with affiliate is admiad | no | | subId | subId string | no | | subId1 | subId1 string | no | | subId2 | subId2 string | no | | subId3 | subId3 string | no | | subId4 | subId4 string | no |

Example:

    import {DeepLinkService} from 'deeplink-module'

    export interface FindAllDocuments<DocumentType> {
        data: DocumentType[];
        pagination?: Pagination;
    }
    
    export interface DeepLinkApiQueryOptions extends BaseApiRequestOptions {
        subId?: string
        retailer: string
        urls: string[]
    }

    @Injectable()
    export class MyService {
        constructor(private readonly deepLinkService: DeepLinkService) {} 
        // Make deep link
        makeLinks(): Promise<FindAllDocuments<DeepLinkApiQueryOptions>> {
          return this.deepLinkService.makeLinks({
            actions:[{retailer: 'string', urls: [], project: '', admitadPlatform: '', subId: '', affiliate: '' }]})
        }
    }

2. getRetailers() Return list retailers for affiliate Options:

| Action options | Values | Required | |---|---|---| | project | Deep link project | yes | | affiliate | Affiliate network | yes |

Example:

import {DeepLinkService} from 'deeplink-module'

    export interface FindAllDocuments<DocumentType> {
        data: DocumentType[];
        pagination?: Pagination;
    }
    
    export interface DeepLinkRetailerInterface {
        id: string
        name: string
    }

    @Injectable()
    export class MyService {
    constructor(private readonly deepLinkService: DeepLinkService) { } 

    //Get retailers id from Admitad by params
    getRetailers(): Promise<FindAllDocuments<DeepLinkRetailerInterface>> {
      return this.deepLinkService.getRetailers({ project: '', affiliate: '' })
    }  
    }  

3. getDecodedLink() Return decoded link Options:

| Action options | Values | Required | |---|---|---| | url | String | yes |

Example:

import {DeepLinkService} from 'deeplink-module'

    export interface FindAllDocuments<DocumentType> {
        data: DocumentType[];
        pagination?: Pagination;
    }
    
    export interface DeepLinkDecodeInterface {
        url: string
    }

    @Injectable()
    export class MyService {
    constructor(private readonly deepLinkService: DeepLinkService) { } 

    //Get decoded link by url
    getDecodedLink(): Promise<FindAllDocuments<DeepLinkDecodeInterface>> {
      return this.deepLinkService.getDecodedLink({ url: '' })
    }  
    }