api.md

Projects

Types:

• ProjectCreateResponse
• ProjectRetrieveResponse
• ProjectUpdateResponse
• ProjectListResponse
• ProjectArchiveResponse
• ProjectUnarchiveResponse

Methods:

• client.projects.create({ ...params }) -> ProjectCreateResponse
• client.projects.retrieve(id) -> ProjectRetrieveResponse
• client.projects.update(id, { ...params }) -> ProjectUpdateResponse
• client.projects.list({ ...params }) -> ProjectListResponse
• client.projects.archive(id) -> ProjectArchiveResponse
• client.projects.unarchive(id) -> ProjectUnarchiveResponse

Applications

Types:

• ApplicationCreateResponse
• ApplicationUpdateResponse
• ApplicationGetStatisticsResponse
• ApplicationListRecentTransactionsResponse
• ApplicationUpdateSettingsResponse

Methods:

• client.projects.applications.create(id, { ...params }) -> ApplicationCreateResponse
• client.projects.applications.update(applicationID, { ...params }) -> ApplicationUpdateResponse
• client.projects.applications.getStatistics(applicationID, { ...params }) -> ApplicationGetStatisticsResponse
• client.projects.applications.listRecentTransactions(applicationID, { ...params }) -> ApplicationListRecentTransactionsResponse
• client.projects.applications.updateSettings(applicationID, { ...params }) -> ApplicationUpdateSettingsResponse

WebhookEndpoints

Types:

• WebhookEndpointCreateResponse
• WebhookEndpointRetrieveResponse
• WebhookEndpointUpdateResponse
• WebhookEndpointListResponse
• WebhookEndpointDeleteResponse
• WebhookEndpointRotateSecretResponse

Methods:

• client.projects.webhookEndpoints.create(projectID, { ...params }) -> WebhookEndpointCreateResponse
• client.projects.webhookEndpoints.retrieve(endpointID, { ...params }) -> WebhookEndpointRetrieveResponse
• client.projects.webhookEndpoints.update(endpointID, { ...params }) -> WebhookEndpointUpdateResponse
• client.projects.webhookEndpoints.list(projectID, { ...params }) -> WebhookEndpointListResponse
• client.projects.webhookEndpoints.delete(endpointID, { ...params }) -> WebhookEndpointDeleteResponse
• client.projects.webhookEndpoints.rotateSecret(endpointID, { ...params }) -> WebhookEndpointRotateSecretResponse

Events

Types:

• EventRetrieveResponse
• EventListResponse
• EventListAttemptsResponse
• EventRetryDeliveryResponse

Methods:

• client.projects.events.retrieve(eventID, { ...params }) -> EventRetrieveResponse
• client.projects.events.list(projectID, { ...params }) -> EventListResponse
• client.projects.events.listAttempts(eventID, { ...params }) -> EventListAttemptsResponse
• client.projects.events.retryDelivery(eventID, { ...params }) -> EventRetryDeliveryResponse

Me

Organizations

Types:

• OrganizationCreateResponse
• OrganizationListResponse

Methods:

• client.me.organizations.create({ ...params }) -> OrganizationCreateResponse
• client.me.organizations.list() -> OrganizationListResponse

Paywalls

Types:

• PaywallCreateResponse
• PaywallRetrieveResponse
• PaywallUpdateResponse
• PaywallListResponse
• PaywallArchiveResponse
• PaywallPublishResponse
• PaywallUnarchiveResponse

Methods:

• client.paywalls.create({ ...params }) -> PaywallCreateResponse
• client.paywalls.retrieve(id) -> PaywallRetrieveResponse
• client.paywalls.update(id, { ...params }) -> PaywallUpdateResponse
• client.paywalls.list({ ...params }) -> PaywallListResponse
• client.paywalls.archive(id) -> PaywallArchiveResponse
• client.paywalls.publish(id) -> PaywallPublishResponse
• client.paywalls.unarchive(id) -> PaywallUnarchiveResponse

Templates

Types:

• TemplateRetrieveResponse
• TemplateListResponse

Methods:

• client.paywalls.templates.retrieve(id) -> TemplateRetrieveResponse
• client.paywalls.templates.list({ ...params }) -> TemplateListResponse

Products

Types:

• ProductCreateResponse
• ProductRetrieveResponse
• ProductUpdateResponse
• ProductListResponse
• ProductDeleteResponse

Methods:

• client.products.create({ ...params }) -> ProductCreateResponse
• client.products.retrieve(id) -> ProductRetrieveResponse
• client.products.update(id, { ...params }) -> ProductUpdateResponse
• client.products.list({ ...params }) -> ProductListResponse
• client.products.delete(id) -> ProductDeleteResponse

Campaigns

Types:

• CampaignCreateResponse
• CampaignRetrieveResponse
• CampaignUpdateResponse
• CampaignListResponse
• CampaignArchiveResponse
• CampaignUnarchiveResponse
• CampaignUpdateAudienceResponse

Methods:

• client.campaigns.create({ ...params }) -> CampaignCreateResponse
• client.campaigns.retrieve(id) -> CampaignRetrieveResponse
• client.campaigns.update(id, { ...params }) -> CampaignUpdateResponse
• client.campaigns.list({ ...params }) -> CampaignListResponse
• client.campaigns.archive(id) -> CampaignArchiveResponse
• client.campaigns.unarchive(id) -> CampaignUnarchiveResponse
• client.campaigns.updateAudience(audienceID, { ...params }) -> CampaignUpdateAudienceResponse

Placements

Types:

• PlacementUpdateResponse
• PlacementAddResponse
• PlacementRemoveResponse

Methods:

• client.campaigns.placements.update(placementID, { ...params }) -> PlacementUpdateResponse
• client.campaigns.placements.add(id, { ...params }) -> PlacementAddResponse
• client.campaigns.placements.remove(placementID, { ...params }) -> PlacementRemoveResponse

Entitlements

Types:

• EntitlementCreateResponse
• EntitlementRetrieveResponse
• EntitlementUpdateResponse
• EntitlementListResponse
• EntitlementDeleteResponse

Methods:

• client.entitlements.create({ ...params }) -> EntitlementCreateResponse
• client.entitlements.retrieve(id) -> EntitlementRetrieveResponse
• client.entitlements.update(id, { ...params }) -> EntitlementUpdateResponse
• client.entitlements.list({ ...params }) -> EntitlementListResponse
• client.entitlements.delete(id) -> EntitlementDeleteResponse

Grants

Types:

• GrantCreateResponse
• GrantListResponse
• GrantRevokeResponse

Methods:

• client.entitlements.grants.create(id, { ...params }) -> GrantCreateResponse
• client.entitlements.grants.list(id, { ...params }) -> GrantListResponse
• client.entitlements.grants.revoke(grantID, { ...params }) -> GrantRevokeResponse

Grants

Types:

• GrantListResponse

Methods:

• client.grants.list({ ...params }) -> GrantListResponse

Charts

Types:

• ChartGetDefinitionsResponse
• ChartQueryDataResponse

Methods:

• client.charts.getDefinitions({ ...params }) -> ChartGetDefinitionsResponse
• client.charts.queryData({ ...params }) -> ChartQueryDataResponse

Users

Types:

• BooleanFromString
• UserListEventNamesResponse
• UserListFilterPropertiesResponse
• UserQueryResponse
• UserResolveResponse
• UserRetrieveActiveEntitlementsResponse
• UserRetrieveAttributesResponse
• UserRetrieveDeviceAttributesResponse
• UserRetrieveSubscriptionSummaryResponse

Methods:

• client.users.listEventNames({ ...params }) -> UserListEventNamesResponse
• client.users.listFilterProperties({ ...params }) -> UserListFilterPropertiesResponse
• client.users.query({ ...params }) -> UserQueryResponse
• client.users.resolve({ ...params }) -> UserResolveResponse
• client.users.retrieveActiveEntitlements(appUserID, { ...params }) -> UserRetrieveActiveEntitlementsResponse
• client.users.retrieveAttributes(appUserID, { ...params }) -> UserRetrieveAttributesResponse
• client.users.retrieveDeviceAttributes(appUserID, { ...params }) -> UserRetrieveDeviceAttributesResponse
• client.users.retrieveSubscriptionSummary(appUserID, { ...params }) -> UserRetrieveSubscriptionSummaryResponse

Events

Types:

• JsonValue
• EventRetrieveResponse
• EventListResponse

Methods:

• client.users.events.retrieve(eventID, { ...params }) -> EventRetrieveResponse
• client.users.events.list(appUserID, { ...params }) -> EventListResponse

TestMode

Types:

• TestModeUpdateResponse
• TestModeListResponse

Methods:

• client.users.testMode.update(appUserID, { ...params }) -> TestModeUpdateResponse
• client.users.testMode.list({ ...params }) -> TestModeListResponse