@pushwoosh/rpc-v2-http-api-data 0.2.459 → 0.2.461
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/data.js +40 -0
- package/index.d.ts +2 -0
- package/package.json +1 -1
- package/sdk_integrator.d.ts +21 -0
- package/sdk_integrator.js +3 -0
package/data.js
CHANGED
|
@@ -35938,6 +35938,46 @@ export const data = {
|
|
|
35938
35938
|
}
|
|
35939
35939
|
}
|
|
35940
35940
|
},
|
|
35941
|
+
"pushwoosh.rpc_v2.sdk_integrator.SdkIntegratorService": {
|
|
35942
|
+
"type": "S",
|
|
35943
|
+
"key": "sdkIntegrator",
|
|
35944
|
+
"methods": {
|
|
35945
|
+
"CreateInstallCode": {
|
|
35946
|
+
"request": "pushwoosh.rpc_v2.sdk_integrator.CreateInstallCodeRequest",
|
|
35947
|
+
"response": "pushwoosh.rpc_v2.sdk_integrator.CreateInstallCodeResponse",
|
|
35948
|
+
"method": "post",
|
|
35949
|
+
"path": "/api/sdk_integrator/install_code"
|
|
35950
|
+
}
|
|
35951
|
+
}
|
|
35952
|
+
},
|
|
35953
|
+
"pushwoosh.rpc_v2.sdk_integrator.CreateInstallCodeRequest": {
|
|
35954
|
+
"type": "I",
|
|
35955
|
+
"fields": {
|
|
35956
|
+
"applicationCode": {
|
|
35957
|
+
"type": "string"
|
|
35958
|
+
},
|
|
35959
|
+
"web": {
|
|
35960
|
+
"type": "boolean"
|
|
35961
|
+
}
|
|
35962
|
+
}
|
|
35963
|
+
},
|
|
35964
|
+
"pushwoosh.rpc_v2.sdk_integrator.CreateInstallCodeResponse": {
|
|
35965
|
+
"type": "I",
|
|
35966
|
+
"fields": {
|
|
35967
|
+
"code": {
|
|
35968
|
+
"type": "string"
|
|
35969
|
+
},
|
|
35970
|
+
"expiresAt": {
|
|
35971
|
+
"type": "Date"
|
|
35972
|
+
},
|
|
35973
|
+
"installCommand": {
|
|
35974
|
+
"type": "string"
|
|
35975
|
+
},
|
|
35976
|
+
"webConfigured": {
|
|
35977
|
+
"type": "boolean"
|
|
35978
|
+
}
|
|
35979
|
+
}
|
|
35980
|
+
},
|
|
35941
35981
|
"pushwoosh.rpc_v2.segment_statistics.SegmentStatisticsService": {
|
|
35942
35982
|
"type": "S",
|
|
35943
35983
|
"key": "segmentStatistics",
|
package/index.d.ts
CHANGED
|
@@ -62,6 +62,7 @@ import { presetsService as pushwoosh_rpc_v2_presets_presetsService } from './pre
|
|
|
62
62
|
import { ReferralPartnerService as pushwoosh_rpc_v2_referral_partners_ReferralPartnerService } from './referral_partners';
|
|
63
63
|
import { RestrictionsService as pushwoosh_rpc_v2_restrictions_RestrictionsService } from './restrictions';
|
|
64
64
|
import { RichMediaService as pushwoosh_rpc_v2_rich_medias_RichMediaService } from './rich_medias';
|
|
65
|
+
import { SdkIntegratorService as pushwoosh_rpc_v2_sdk_integrator_SdkIntegratorService } from './sdk_integrator';
|
|
65
66
|
import { SegmentStatisticsService as pushwoosh_rpc_v2_segment_statistics_SegmentStatisticsService } from './segment_statistics';
|
|
66
67
|
import { SegmentsService as pushwoosh_rpc_segments_v3_SegmentsService } from './pushwoosh_rpc_segments_v3';
|
|
67
68
|
import { SendRateService as pushwoosh_rpc_v2_send_rate_SendRateService } from './send_rate';
|
|
@@ -143,6 +144,7 @@ export type API = {
|
|
|
143
144
|
referralPartner: pushwoosh_rpc_v2_referral_partners_ReferralPartnerService;
|
|
144
145
|
restrictions: pushwoosh_rpc_v2_restrictions_RestrictionsService;
|
|
145
146
|
richMedia: pushwoosh_rpc_v2_rich_medias_RichMediaService;
|
|
147
|
+
sdkIntegrator: pushwoosh_rpc_v2_sdk_integrator_SdkIntegratorService;
|
|
146
148
|
segmentStatistics: pushwoosh_rpc_v2_segment_statistics_SegmentStatisticsService;
|
|
147
149
|
segments: pushwoosh_rpc_segments_v3_SegmentsService;
|
|
148
150
|
sendRate: pushwoosh_rpc_v2_send_rate_SendRateService;
|
package/package.json
CHANGED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { RpcMethod } from './commonTypes';
|
|
2
|
+
export type SdkIntegratorService_CreateInstallCode = RpcMethod<CreateInstallCodeRequest, CreateInstallCodeResponse>;
|
|
3
|
+
export interface SdkIntegratorService {
|
|
4
|
+
/** Prepares an application for the Pushwoosh SDK Integrator and returns a one-time install code with the command that uses it. Creates (or reuses) the account's "SDK Integrator" device API token and grants it this application; with web set, also generates Web push (VAPID) keys when the application has no web push configured yet. Use when a user asks to integrate a Pushwoosh SDK into their project. */
|
|
5
|
+
CreateInstallCode: SdkIntegratorService_CreateInstallCode;
|
|
6
|
+
}
|
|
7
|
+
export type CreateInstallCodeRequest = {
|
|
8
|
+
/** Application code (XXXXX-XXXXX) the SDK is integrated with. */
|
|
9
|
+
applicationCode?: string;
|
|
10
|
+
/** Also make the Web platform ready: generates VAPID keys only when no web push (VAPID or FCM) is configured, never replacing existing keys. */
|
|
11
|
+
web?: boolean;
|
|
12
|
+
};
|
|
13
|
+
export type CreateInstallCodeResponse = {
|
|
14
|
+
/** One-time code the integrator redeems for the application code and the device API token. */
|
|
15
|
+
code: string;
|
|
16
|
+
expiresAt: Date;
|
|
17
|
+
/** Shell command that runs the integrator with this code. */
|
|
18
|
+
installCommand: string;
|
|
19
|
+
/** True when this call generated the Web push keys. */
|
|
20
|
+
webConfigured: boolean;
|
|
21
|
+
};
|