@trycourier/courier 6.0.1 → 6.0.2
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/Client.d.ts +8 -8
- package/Client.js +16 -16
- package/README.md +112 -110
- package/api/resources/audiences/client/Client.d.ts +5 -5
- package/api/resources/audiences/client/Client.js +7 -7
- package/api/resources/audiences/client/requests/{ListAudienceMembersRequest.d.ts → AudienceMembersListParams.d.ts} +1 -2
- package/{dist/api/resources/audiences/types/AudienceRequest.d.ts → api/resources/audiences/client/requests/AudienceUpdateParams.d.ts} +2 -4
- package/api/resources/audiences/client/requests/{ListAudiencesRequest.d.ts → AudiencesListParams.d.ts} +1 -2
- package/api/resources/audiences/client/requests/index.d.ts +3 -2
- package/api/resources/audiences/types/{AudiencePutResponse.d.ts → AudienceUpdateResponse.d.ts} +1 -1
- package/api/resources/audiences/types/BaseFilterConfig.d.ts +1 -4
- package/api/resources/audiences/types/index.d.ts +1 -2
- package/api/resources/audiences/types/index.js +1 -2
- package/api/resources/auditEvents/client/Client.d.ts +2 -2
- package/api/resources/auditEvents/client/Client.js +3 -3
- package/api/resources/auditEvents/client/requests/ListAuditEventsRequest.d.ts +0 -1
- package/api/resources/authTokens/client/Client.d.ts +3 -3
- package/api/resources/authTokens/client/Client.js +2 -2
- package/api/resources/authTokens/client/index.d.ts +1 -1
- package/api/resources/authTokens/client/index.js +15 -0
- package/api/resources/authTokens/{types/AuthIssueTokenParameters.d.ts → client/requests/IssueTokenParams.d.ts} +2 -2
- package/api/resources/authTokens/client/requests/index.d.ts +1 -0
- package/api/resources/authTokens/types/{AuthIssueTokenResponse.d.ts → IssueTokenResponse.d.ts} +1 -1
- package/api/resources/authTokens/types/index.d.ts +1 -2
- package/api/resources/authTokens/types/index.js +1 -2
- package/api/resources/automations/client/Client.d.ts +3 -3
- package/api/resources/automations/client/Client.js +6 -5
- package/api/resources/brands/client/Client.d.ts +6 -2
- package/api/resources/brands/client/Client.js +49 -5
- package/api/resources/brands/{types/BrandPutParameters.d.ts → client/requests/BrandUpdateParameters.d.ts} +3 -4
- package/api/resources/brands/client/requests/index.d.ts +1 -0
- package/api/resources/brands/types/index.d.ts +0 -1
- package/api/resources/brands/types/index.js +0 -1
- package/api/resources/bulk/client/Client.d.ts +4 -4
- package/api/resources/bulk/client/Client.js +8 -9
- package/api/resources/bulk/client/index.d.ts +1 -1
- package/api/resources/bulk/client/index.js +15 -0
- package/{dist/api/resources/bulk/types → api/resources/bulk/client/requests}/BulkCreateJobParams.d.ts +1 -1
- package/api/resources/bulk/client/requests/index.d.ts +1 -0
- package/api/resources/bulk/types/BulkIngestUsersParams.d.ts +0 -1
- package/api/resources/bulk/types/InboundBulkContentMessage.d.ts +15 -0
- package/api/resources/bulk/types/InboundBulkMessage.d.ts +2 -2
- package/api/resources/bulk/types/InboundBulkMessageV1.d.ts +23 -0
- package/api/resources/bulk/types/InboundBulkMessageV2.d.ts +16 -0
- package/api/resources/bulk/types/InboundBulkTemplateMessage.d.ts +11 -0
- package/api/resources/bulk/types/index.d.ts +4 -4
- package/api/resources/bulk/types/index.js +4 -4
- package/api/resources/index.d.ts +7 -4
- package/api/resources/index.js +8 -5
- package/api/resources/lists/client/Client.d.ts +14 -6
- package/api/resources/lists/client/Client.js +99 -13
- package/api/resources/lists/client/requests/GetAllListsRequest.d.ts +0 -1
- package/api/resources/lists/client/requests/GetListRequest.d.ts +0 -1
- package/api/resources/lists/client/requests/SubscribeUserToListRequest.d.ts +0 -2
- package/api/resources/messages/client/Client.d.ts +2 -2
- package/api/resources/messages/client/Client.js +8 -8
- package/api/resources/messages/client/requests/ListMessagesRequest.d.ts +1 -1
- package/api/resources/notifications/client/Client.d.ts +29 -0
- package/api/resources/notifications/client/Client.js +392 -0
- package/api/resources/notifications/client/index.d.ts +1 -0
- package/api/resources/notifications/client/index.js +17 -0
- package/api/resources/notifications/client/requests/NotificationDraftUpdateVariationsParams.d.ts +8 -0
- package/api/resources/{bulk/types/BulkRunJobParams.d.ts → notifications/client/requests/NotificationListParams.d.ts} +2 -2
- package/api/resources/notifications/client/requests/NotificationUpdateVariationsParams.d.ts +8 -0
- package/api/resources/notifications/client/requests/SubmissionChecksReplaceParams.d.ts +7 -0
- package/api/resources/notifications/client/requests/index.d.ts +4 -0
- package/api/resources/notifications/types/BaseCheck.d.ts +9 -0
- package/api/resources/notifications/types/BlockType.d.ts +15 -0
- package/api/resources/notifications/types/BlockType.js +17 -0
- package/api/resources/{tokenManagement/types/PatchUserTokenOpts.d.ts → notifications/types/Check.d.ts} +2 -2
- package/api/resources/notifications/types/CheckStatus.d.ts +9 -0
- package/api/resources/notifications/types/CheckStatus.js +11 -0
- package/api/resources/notifications/types/MessageRouting.d.ts +8 -0
- package/api/resources/notifications/types/MessageRoutingChannel.d.ts +5 -0
- package/api/resources/notifications/types/MessageRoutingMethod.d.ts +8 -0
- package/api/resources/notifications/types/MessageRoutingMethod.js +10 -0
- package/api/resources/notifications/types/Notification.d.ts +9 -0
- package/api/resources/notifications/types/NotificationBlock.d.ts +13 -0
- package/api/resources/notifications/types/NotificationChannel.d.ts +11 -0
- package/api/resources/notifications/types/NotificationChannelContent.d.ts +7 -0
- package/api/resources/notifications/types/NotificationContent.d.ts +5 -0
- package/api/resources/notifications/types/NotificationContentHierarchy.d.ts +7 -0
- package/api/resources/notifications/types/NotificationGetContentResponse.d.ts +9 -0
- package/api/resources/notifications/types/NotificationListResponse.d.ts +8 -0
- package/api/resources/notifications/types/SubmissionChecksGetResponse.d.ts +7 -0
- package/api/resources/notifications/types/SubmissionChecksReplaceResponse.d.ts +7 -0
- package/api/resources/notifications/types/index.d.ts +17 -0
- package/api/resources/notifications/types/index.js +33 -0
- package/api/resources/profiles/client/Client.d.ts +2 -3
- package/api/resources/profiles/client/Client.js +8 -9
- package/api/resources/send/types/BaseMessage.d.ts +1 -8
- package/api/resources/send/types/Channel.d.ts +0 -4
- package/api/resources/send/types/ContentMessage.d.ts +2 -2
- package/api/resources/send/types/ElementalChannelNode.d.ts +0 -4
- package/api/resources/send/types/ElementalMetaNode.d.ts +0 -1
- package/api/resources/send/types/ElementalTextNode.d.ts +0 -1
- package/api/resources/send/types/MessageContext.d.ts +0 -1
- package/api/resources/send/types/MessageProvidersType.d.ts +0 -1
- package/api/resources/send/types/Routing.d.ts +0 -2
- package/api/resources/send/types/TemplateMessage.d.ts +2 -1
- package/api/resources/send/types/UserRecipient.d.ts +0 -1
- package/api/resources/templates/client/Client.d.ts +2 -2
- package/api/resources/templates/client/Client.js +2 -2
- package/api/resources/tenants/client/Client.d.ts +9 -3
- package/api/resources/tenants/client/Client.js +130 -2
- package/api/resources/tenants/client/index.d.ts +1 -1
- package/api/resources/tenants/client/index.js +15 -0
- package/{dist/api/resources/tenants/types/CreateOrReplaceTenantRequest.d.ts → api/resources/tenants/client/requests/TenantCreateOrReplaceParams.d.ts} +7 -7
- package/api/resources/tenants/client/requests/index.d.ts +1 -0
- package/api/resources/tenants/types/{CreateOrReplaceTenantResponse.d.ts → Tenant.d.ts} +3 -3
- package/api/resources/tenants/types/TenantListResponse.d.ts +21 -0
- package/api/resources/tenants/types/index.d.ts +2 -2
- package/api/resources/tenants/types/index.js +2 -2
- package/api/resources/translations/client/Client.d.ts +2 -2
- package/api/resources/translations/client/Client.js +3 -3
- package/api/resources/users/client/Client.d.ts +28 -0
- package/api/resources/users/client/Client.js +27 -0
- package/api/resources/users/client/index.js +2 -0
- package/api/resources/users/index.d.ts +2 -0
- package/api/resources/users/index.js +18 -0
- package/api/resources/users/resources/index.d.ts +8 -0
- package/api/resources/users/resources/index.js +37 -0
- package/api/resources/users/resources/preferences/client/Client.d.ts +36 -0
- package/api/resources/{userPreferences → users/resources/preferences}/client/Client.js +14 -14
- package/api/resources/users/resources/preferences/client/index.d.ts +1 -0
- package/api/resources/users/resources/preferences/client/index.js +17 -0
- package/api/resources/{userPreferences/types/UpdateSubscriptionTopicRequest.d.ts → users/resources/preferences/client/requests/UserPreferencesUpdateParams.d.ts} +3 -3
- package/api/resources/users/resources/preferences/client/requests/index.d.ts +1 -0
- package/api/resources/users/resources/preferences/client/requests/index.js +2 -0
- package/api/resources/{userPreferences → users/resources/preferences}/types/TopicPreference.d.ts +1 -1
- package/api/resources/users/resources/preferences/types/UserPreferencesGetResponse.d.ts +7 -0
- package/api/resources/{userPreferences/types/UserPreferences.d.ts → users/resources/preferences/types/UserPreferencesListResponse.d.ts} +3 -3
- package/{dist/api/resources/userPreferences/types/UpdateSubscriptionTopicResponse.d.ts → api/resources/users/resources/preferences/types/UserPreferencesUpdateResponse.d.ts} +1 -1
- package/api/resources/users/resources/preferences/types/index.d.ts +4 -0
- package/{dist/api/resources/userPreferences → api/resources/users/resources/preferences}/types/index.js +3 -3
- package/api/resources/users/resources/tenants/client/Client.d.ts +45 -0
- package/api/resources/users/resources/tenants/client/Client.js +254 -0
- package/api/resources/users/resources/tenants/client/index.d.ts +1 -0
- package/api/resources/users/resources/tenants/client/index.js +17 -0
- package/api/resources/users/resources/tenants/client/requests/AddUserToMultipleTenantsParams.d.ts +7 -0
- package/api/resources/users/resources/tenants/client/requests/AddUserToSingleTenantsParams.d.ts +6 -0
- package/api/resources/users/resources/tenants/client/requests/ListTenantsForUserParams.d.ts +14 -0
- package/api/resources/users/resources/tenants/client/requests/index.d.ts +3 -0
- package/api/resources/users/resources/tenants/client/requests/index.js +2 -0
- package/api/resources/users/resources/tenants/types/ListTenantsForUserResponse.d.ts +23 -0
- package/api/resources/users/resources/tenants/types/UserTenantAssociation.d.ts +8 -0
- package/api/resources/users/resources/tenants/types/index.d.ts +2 -0
- package/api/resources/users/resources/tenants/types/index.js +18 -0
- package/api/resources/users/resources/tokens/client/Client.d.ts +46 -0
- package/api/resources/{tokenManagement → users/resources/tokens}/client/Client.js +14 -14
- package/api/resources/users/resources/tokens/client/index.js +2 -0
- package/api/resources/{tokenManagement → users/resources/tokens}/types/GetAllTokensResponse.d.ts +2 -2
- package/api/resources/users/resources/tokens/types/GetUserTokenResponse.d.ts +9 -0
- package/api/resources/users/resources/tokens/types/PatchUserTokenOpts.d.ts +7 -0
- package/{dist/api/resources/tokenManagement → api/resources/users/resources/tokens}/types/PutUserTokenOpts.d.ts +2 -2
- package/api/resources/{tokenManagement → users/resources/tokens}/types/PutUserTokensOpts.d.ts +2 -2
- package/{dist/api/resources/tokenManagement → api/resources/users/resources/tokens}/types/UserToken.d.ts +5 -5
- package/api/types/SendMessageResponse.d.ts +0 -1
- package/core/fetcher/APIResponse.d.ts +1 -0
- package/core/fetcher/Fetcher.d.ts +1 -4
- package/core/fetcher/Fetcher.js +52 -31
- package/core/fetcher/getHeader.d.ts +1 -0
- package/core/fetcher/getHeader.js +12 -0
- package/core/fetcher/index.d.ts +1 -0
- package/core/fetcher/index.js +3 -1
- package/dist/Client.d.ts +8 -8
- package/dist/Client.js +16 -16
- package/dist/api/resources/audiences/client/Client.d.ts +5 -5
- package/dist/api/resources/audiences/client/Client.js +7 -7
- package/dist/api/resources/audiences/client/requests/{ListAudienceMembersRequest.d.ts → AudienceMembersListParams.d.ts} +1 -2
- package/{api/resources/audiences/types/AudienceRequest.d.ts → dist/api/resources/audiences/client/requests/AudienceUpdateParams.d.ts} +2 -4
- package/dist/api/resources/audiences/client/requests/{ListAudiencesRequest.d.ts → AudiencesListParams.d.ts} +1 -2
- package/dist/api/resources/audiences/client/requests/index.d.ts +3 -2
- package/dist/api/resources/audiences/types/{AudiencePutResponse.d.ts → AudienceUpdateResponse.d.ts} +1 -1
- package/dist/api/resources/audiences/types/BaseFilterConfig.d.ts +1 -4
- package/dist/api/resources/audiences/types/index.d.ts +1 -2
- package/dist/api/resources/audiences/types/index.js +1 -2
- package/dist/api/resources/auditEvents/client/Client.d.ts +2 -2
- package/dist/api/resources/auditEvents/client/Client.js +3 -3
- package/dist/api/resources/auditEvents/client/requests/ListAuditEventsRequest.d.ts +0 -1
- package/dist/api/resources/authTokens/client/Client.d.ts +3 -3
- package/dist/api/resources/authTokens/client/Client.js +2 -2
- package/dist/api/resources/authTokens/client/index.d.ts +1 -1
- package/dist/api/resources/authTokens/client/index.js +15 -0
- package/dist/api/resources/authTokens/{types/AuthIssueTokenParameters.d.ts → client/requests/IssueTokenParams.d.ts} +2 -2
- package/dist/api/resources/authTokens/client/requests/IssueTokenParams.js +5 -0
- package/dist/api/resources/authTokens/client/requests/index.d.ts +1 -0
- package/dist/api/resources/authTokens/client/requests/index.js +2 -0
- package/dist/api/resources/authTokens/types/{AuthIssueTokenResponse.d.ts → IssueTokenResponse.d.ts} +1 -1
- package/dist/api/resources/authTokens/types/IssueTokenResponse.js +5 -0
- package/dist/api/resources/authTokens/types/index.d.ts +1 -2
- package/dist/api/resources/authTokens/types/index.js +1 -2
- package/dist/api/resources/automations/client/Client.d.ts +3 -3
- package/dist/api/resources/automations/client/Client.js +6 -5
- package/dist/api/resources/brands/client/Client.d.ts +6 -2
- package/dist/api/resources/brands/client/Client.js +49 -5
- package/dist/api/resources/brands/{types/BrandPutParameters.d.ts → client/requests/BrandUpdateParameters.d.ts} +3 -4
- package/dist/api/resources/brands/client/requests/BrandUpdateParameters.js +5 -0
- package/dist/api/resources/brands/client/requests/index.d.ts +1 -0
- package/dist/api/resources/brands/types/index.d.ts +0 -1
- package/dist/api/resources/brands/types/index.js +0 -1
- package/dist/api/resources/bulk/client/Client.d.ts +4 -4
- package/dist/api/resources/bulk/client/Client.js +8 -9
- package/dist/api/resources/bulk/client/index.d.ts +1 -1
- package/dist/api/resources/bulk/client/index.js +15 -0
- package/{api/resources/bulk/types → dist/api/resources/bulk/client/requests}/BulkCreateJobParams.d.ts +1 -1
- package/dist/api/resources/bulk/client/requests/BulkCreateJobParams.js +5 -0
- package/dist/api/resources/bulk/client/requests/index.d.ts +1 -0
- package/dist/api/resources/bulk/client/requests/index.js +2 -0
- package/dist/api/resources/bulk/types/BulkIngestUsersParams.d.ts +0 -1
- package/dist/api/resources/bulk/types/InboundBulkContentMessage.d.ts +15 -0
- package/dist/api/resources/bulk/types/InboundBulkContentMessage.js +5 -0
- package/dist/api/resources/bulk/types/InboundBulkMessage.d.ts +2 -2
- package/dist/api/resources/bulk/types/InboundBulkMessageV1.d.ts +23 -0
- package/dist/api/resources/bulk/types/InboundBulkMessageV1.js +5 -0
- package/dist/api/resources/bulk/types/InboundBulkMessageV2.d.ts +16 -0
- package/dist/api/resources/bulk/types/InboundBulkMessageV2.js +5 -0
- package/dist/api/resources/bulk/types/InboundBulkTemplateMessage.d.ts +11 -0
- package/dist/api/resources/bulk/types/InboundBulkTemplateMessage.js +5 -0
- package/dist/api/resources/bulk/types/index.d.ts +4 -4
- package/dist/api/resources/bulk/types/index.js +4 -4
- package/dist/api/resources/index.d.ts +7 -4
- package/dist/api/resources/index.js +8 -5
- package/dist/api/resources/lists/client/Client.d.ts +14 -6
- package/dist/api/resources/lists/client/Client.js +99 -13
- package/dist/api/resources/lists/client/requests/GetAllListsRequest.d.ts +0 -1
- package/dist/api/resources/lists/client/requests/GetListRequest.d.ts +0 -1
- package/dist/api/resources/lists/client/requests/SubscribeUserToListRequest.d.ts +0 -2
- package/dist/api/resources/messages/client/Client.d.ts +2 -2
- package/dist/api/resources/messages/client/Client.js +8 -8
- package/dist/api/resources/messages/client/requests/ListMessagesRequest.d.ts +1 -1
- package/dist/api/resources/notifications/client/Client.d.ts +29 -0
- package/dist/api/resources/notifications/client/Client.js +392 -0
- package/dist/api/resources/notifications/client/index.d.ts +1 -0
- package/dist/api/resources/notifications/client/index.js +17 -0
- package/dist/api/resources/notifications/client/requests/NotificationDraftUpdateVariationsParams.d.ts +8 -0
- package/dist/api/resources/notifications/client/requests/NotificationDraftUpdateVariationsParams.js +5 -0
- package/dist/api/resources/notifications/client/requests/NotificationListParams.d.ts +6 -0
- package/dist/api/resources/notifications/client/requests/NotificationListParams.js +5 -0
- package/dist/api/resources/notifications/client/requests/NotificationUpdateVariationsParams.d.ts +8 -0
- package/dist/api/resources/notifications/client/requests/NotificationUpdateVariationsParams.js +5 -0
- package/dist/api/resources/notifications/client/requests/SubmissionChecksReplaceParams.d.ts +7 -0
- package/dist/api/resources/notifications/client/requests/SubmissionChecksReplaceParams.js +5 -0
- package/dist/api/resources/notifications/client/requests/index.d.ts +4 -0
- package/dist/api/resources/notifications/client/requests/index.js +2 -0
- package/dist/api/resources/notifications/index.d.ts +2 -0
- package/dist/api/resources/notifications/index.js +18 -0
- package/dist/api/resources/notifications/types/BaseCheck.d.ts +9 -0
- package/dist/api/resources/notifications/types/BaseCheck.js +5 -0
- package/dist/api/resources/notifications/types/BlockType.d.ts +15 -0
- package/dist/api/resources/notifications/types/BlockType.js +17 -0
- package/dist/api/resources/{tokenManagement/types/PatchUserTokenOpts.d.ts → notifications/types/Check.d.ts} +2 -2
- package/dist/api/resources/notifications/types/Check.js +5 -0
- package/dist/api/resources/notifications/types/CheckStatus.d.ts +9 -0
- package/dist/api/resources/notifications/types/CheckStatus.js +11 -0
- package/dist/api/resources/notifications/types/MessageRouting.d.ts +8 -0
- package/dist/api/resources/notifications/types/MessageRouting.js +5 -0
- package/dist/api/resources/notifications/types/MessageRoutingChannel.d.ts +5 -0
- package/dist/api/resources/notifications/types/MessageRoutingChannel.js +5 -0
- package/dist/api/resources/notifications/types/MessageRoutingMethod.d.ts +8 -0
- package/dist/api/resources/notifications/types/MessageRoutingMethod.js +10 -0
- package/dist/api/resources/notifications/types/Notification.d.ts +9 -0
- package/dist/api/resources/notifications/types/Notification.js +5 -0
- package/dist/api/resources/notifications/types/NotificationBlock.d.ts +13 -0
- package/dist/api/resources/notifications/types/NotificationBlock.js +5 -0
- package/dist/api/resources/notifications/types/NotificationChannel.d.ts +11 -0
- package/dist/api/resources/notifications/types/NotificationChannel.js +5 -0
- package/dist/api/resources/notifications/types/NotificationChannelContent.d.ts +7 -0
- package/dist/api/resources/notifications/types/NotificationChannelContent.js +5 -0
- package/dist/api/resources/notifications/types/NotificationContent.d.ts +5 -0
- package/dist/api/resources/notifications/types/NotificationContent.js +5 -0
- package/dist/api/resources/notifications/types/NotificationContentHierarchy.d.ts +7 -0
- package/dist/api/resources/notifications/types/NotificationContentHierarchy.js +5 -0
- package/dist/api/resources/notifications/types/NotificationGetContentResponse.d.ts +9 -0
- package/dist/api/resources/notifications/types/NotificationGetContentResponse.js +5 -0
- package/dist/api/resources/notifications/types/NotificationListResponse.d.ts +8 -0
- package/dist/api/resources/notifications/types/NotificationListResponse.js +5 -0
- package/dist/api/resources/notifications/types/SubmissionChecksGetResponse.d.ts +7 -0
- package/dist/api/resources/notifications/types/SubmissionChecksGetResponse.js +5 -0
- package/dist/api/resources/notifications/types/SubmissionChecksReplaceResponse.d.ts +7 -0
- package/dist/api/resources/notifications/types/SubmissionChecksReplaceResponse.js +5 -0
- package/dist/api/resources/notifications/types/index.d.ts +17 -0
- package/dist/api/resources/notifications/types/index.js +33 -0
- package/dist/api/resources/profiles/client/Client.d.ts +2 -3
- package/dist/api/resources/profiles/client/Client.js +8 -9
- package/dist/api/resources/send/types/BaseMessage.d.ts +1 -8
- package/dist/api/resources/send/types/Channel.d.ts +0 -4
- package/dist/api/resources/send/types/ContentMessage.d.ts +2 -2
- package/dist/api/resources/send/types/ElementalChannelNode.d.ts +0 -4
- package/dist/api/resources/send/types/ElementalMetaNode.d.ts +0 -1
- package/dist/api/resources/send/types/ElementalTextNode.d.ts +0 -1
- package/dist/api/resources/send/types/MessageContext.d.ts +0 -1
- package/dist/api/resources/send/types/MessageProvidersType.d.ts +0 -1
- package/dist/api/resources/send/types/Routing.d.ts +0 -2
- package/dist/api/resources/send/types/TemplateMessage.d.ts +2 -1
- package/dist/api/resources/send/types/UserRecipient.d.ts +0 -1
- package/dist/api/resources/templates/client/Client.d.ts +2 -2
- package/dist/api/resources/templates/client/Client.js +2 -2
- package/dist/api/resources/tenants/client/Client.d.ts +9 -3
- package/dist/api/resources/tenants/client/Client.js +130 -2
- package/dist/api/resources/tenants/client/index.d.ts +1 -1
- package/dist/api/resources/tenants/client/index.js +15 -0
- package/{api/resources/tenants/types/CreateOrReplaceTenantRequest.d.ts → dist/api/resources/tenants/client/requests/TenantCreateOrReplaceParams.d.ts} +7 -7
- package/dist/api/resources/tenants/client/requests/TenantCreateOrReplaceParams.js +5 -0
- package/dist/api/resources/tenants/client/requests/index.d.ts +1 -0
- package/dist/api/resources/tenants/client/requests/index.js +2 -0
- package/dist/api/resources/tenants/types/{CreateOrReplaceTenantResponse.d.ts → Tenant.d.ts} +3 -3
- package/dist/api/resources/tenants/types/Tenant.js +5 -0
- package/dist/api/resources/tenants/types/TenantListResponse.d.ts +21 -0
- package/dist/api/resources/tenants/types/TenantListResponse.js +5 -0
- package/dist/api/resources/tenants/types/index.d.ts +2 -2
- package/dist/api/resources/tenants/types/index.js +2 -2
- package/dist/api/resources/translations/client/Client.d.ts +2 -2
- package/dist/api/resources/translations/client/Client.js +3 -3
- package/dist/api/resources/users/client/Client.d.ts +28 -0
- package/dist/api/resources/users/client/Client.js +27 -0
- package/dist/api/resources/users/client/index.js +2 -0
- package/dist/api/resources/users/index.d.ts +2 -0
- package/dist/api/resources/users/index.js +18 -0
- package/dist/api/resources/users/resources/index.d.ts +8 -0
- package/dist/api/resources/users/resources/index.js +37 -0
- package/dist/api/resources/users/resources/preferences/client/Client.d.ts +36 -0
- package/dist/api/resources/{userPreferences → users/resources/preferences}/client/Client.js +14 -14
- package/dist/api/resources/users/resources/preferences/client/index.d.ts +1 -0
- package/dist/api/resources/users/resources/preferences/client/index.js +17 -0
- package/dist/api/resources/{userPreferences/types/UpdateSubscriptionTopicRequest.d.ts → users/resources/preferences/client/requests/UserPreferencesUpdateParams.d.ts} +3 -3
- package/dist/api/resources/users/resources/preferences/client/requests/UserPreferencesUpdateParams.js +5 -0
- package/dist/api/resources/users/resources/preferences/client/requests/index.d.ts +1 -0
- package/dist/api/resources/users/resources/preferences/client/requests/index.js +2 -0
- package/dist/api/resources/users/resources/preferences/index.d.ts +2 -0
- package/dist/api/resources/users/resources/preferences/index.js +18 -0
- package/dist/api/resources/{userPreferences → users/resources/preferences}/types/TopicPreference.d.ts +1 -1
- package/dist/api/resources/users/resources/preferences/types/TopicPreference.js +5 -0
- package/dist/api/resources/users/resources/preferences/types/UserPreferencesGetResponse.d.ts +7 -0
- package/dist/api/resources/users/resources/preferences/types/UserPreferencesGetResponse.js +5 -0
- package/dist/api/resources/{userPreferences/types/UserPreferences.d.ts → users/resources/preferences/types/UserPreferencesListResponse.d.ts} +3 -3
- package/dist/api/resources/users/resources/preferences/types/UserPreferencesListResponse.js +5 -0
- package/{api/resources/userPreferences/types/UpdateSubscriptionTopicResponse.d.ts → dist/api/resources/users/resources/preferences/types/UserPreferencesUpdateResponse.d.ts} +1 -1
- package/dist/api/resources/users/resources/preferences/types/UserPreferencesUpdateResponse.js +5 -0
- package/dist/api/resources/users/resources/preferences/types/index.d.ts +4 -0
- package/{api/resources/userPreferences → dist/api/resources/users/resources/preferences}/types/index.js +3 -3
- package/dist/api/resources/users/resources/tenants/client/Client.d.ts +45 -0
- package/dist/api/resources/users/resources/tenants/client/Client.js +254 -0
- package/dist/api/resources/users/resources/tenants/client/index.d.ts +1 -0
- package/dist/api/resources/users/resources/tenants/client/index.js +17 -0
- package/dist/api/resources/users/resources/tenants/client/requests/AddUserToMultipleTenantsParams.d.ts +7 -0
- package/dist/api/resources/users/resources/tenants/client/requests/AddUserToMultipleTenantsParams.js +5 -0
- package/dist/api/resources/users/resources/tenants/client/requests/AddUserToSingleTenantsParams.d.ts +6 -0
- package/dist/api/resources/users/resources/tenants/client/requests/AddUserToSingleTenantsParams.js +5 -0
- package/dist/api/resources/users/resources/tenants/client/requests/ListTenantsForUserParams.d.ts +14 -0
- package/dist/api/resources/users/resources/tenants/client/requests/ListTenantsForUserParams.js +5 -0
- package/dist/api/resources/users/resources/tenants/client/requests/index.d.ts +3 -0
- package/dist/api/resources/users/resources/tenants/client/requests/index.js +2 -0
- package/dist/api/resources/users/resources/tenants/index.d.ts +2 -0
- package/dist/api/resources/users/resources/tenants/index.js +18 -0
- package/dist/api/resources/users/resources/tenants/types/ListTenantsForUserResponse.d.ts +23 -0
- package/dist/api/resources/users/resources/tenants/types/ListTenantsForUserResponse.js +5 -0
- package/dist/api/resources/users/resources/tenants/types/UserTenantAssociation.d.ts +8 -0
- package/dist/api/resources/users/resources/tenants/types/UserTenantAssociation.js +5 -0
- package/dist/api/resources/users/resources/tenants/types/index.d.ts +2 -0
- package/dist/api/resources/users/resources/tenants/types/index.js +18 -0
- package/dist/api/resources/users/resources/tokens/client/Client.d.ts +46 -0
- package/dist/api/resources/{tokenManagement → users/resources/tokens}/client/Client.js +14 -14
- package/dist/api/resources/users/resources/tokens/client/index.js +2 -0
- package/dist/api/resources/users/resources/tokens/index.d.ts +2 -0
- package/dist/api/resources/users/resources/tokens/index.js +18 -0
- package/dist/api/resources/users/resources/tokens/types/DeleteUserTokenOpts.js +5 -0
- package/dist/api/resources/users/resources/tokens/types/Device.js +5 -0
- package/dist/api/resources/users/resources/tokens/types/ExpiryDate.js +5 -0
- package/dist/api/resources/{tokenManagement → users/resources/tokens}/types/GetAllTokensResponse.d.ts +2 -2
- package/dist/api/resources/users/resources/tokens/types/GetAllTokensResponse.js +5 -0
- package/dist/api/resources/users/resources/tokens/types/GetUserTokenOpts.js +5 -0
- package/dist/api/resources/users/resources/tokens/types/GetUserTokenResponse.d.ts +9 -0
- package/dist/api/resources/users/resources/tokens/types/GetUserTokenResponse.js +5 -0
- package/dist/api/resources/users/resources/tokens/types/GetUserTokensOpts.js +5 -0
- package/dist/api/resources/users/resources/tokens/types/PatchOperation.js +5 -0
- package/dist/api/resources/users/resources/tokens/types/PatchUserTokenOpts.d.ts +7 -0
- package/dist/api/resources/users/resources/tokens/types/PatchUserTokenOpts.js +5 -0
- package/{api/resources/tokenManagement → dist/api/resources/users/resources/tokens}/types/PutUserTokenOpts.d.ts +2 -2
- package/dist/api/resources/users/resources/tokens/types/PutUserTokenOpts.js +5 -0
- package/dist/api/resources/{tokenManagement → users/resources/tokens}/types/PutUserTokensOpts.d.ts +2 -2
- package/dist/api/resources/users/resources/tokens/types/PutUserTokensOpts.js +5 -0
- package/dist/api/resources/users/resources/tokens/types/Tracking.js +5 -0
- package/{api/resources/tokenManagement → dist/api/resources/users/resources/tokens}/types/UserToken.d.ts +5 -5
- package/dist/api/resources/users/resources/tokens/types/UserToken.js +5 -0
- package/dist/api/types/SendMessageResponse.d.ts +0 -1
- package/dist/core/fetcher/APIResponse.d.ts +1 -0
- package/dist/core/fetcher/Fetcher.d.ts +1 -4
- package/dist/core/fetcher/Fetcher.js +52 -31
- package/dist/core/fetcher/getHeader.d.ts +1 -0
- package/dist/core/fetcher/getHeader.js +12 -0
- package/dist/core/fetcher/index.d.ts +1 -0
- package/dist/core/fetcher/index.js +3 -1
- package/package.json +6 -4
- package/api/resources/bulk/types/InboundBulkMessageApiV1.d.ts +0 -13
- package/api/resources/bulk/types/InboundBulkMessageApiV2.d.ts +0 -4
- package/api/resources/tokenManagement/client/Client.d.ts +0 -46
- package/api/resources/tokenManagement/types/GetUserTokenResponse.d.ts +0 -9
- package/api/resources/userPreferences/client/Client.d.ts +0 -36
- package/api/resources/userPreferences/types/index.d.ts +0 -4
- package/dist/api/resources/bulk/types/BulkRunJobParams.d.ts +0 -6
- package/dist/api/resources/bulk/types/InboundBulkMessageApiV1.d.ts +0 -13
- package/dist/api/resources/bulk/types/InboundBulkMessageApiV2.d.ts +0 -4
- package/dist/api/resources/tokenManagement/client/Client.d.ts +0 -46
- package/dist/api/resources/tokenManagement/types/GetUserTokenResponse.d.ts +0 -9
- package/dist/api/resources/userPreferences/client/Client.d.ts +0 -36
- package/dist/api/resources/userPreferences/types/index.d.ts +0 -4
- /package/api/resources/audiences/client/requests/{ListAudienceMembersRequest.js → AudienceMembersListParams.js} +0 -0
- /package/api/resources/audiences/client/requests/{ListAudiencesRequest.js → AudienceUpdateParams.js} +0 -0
- /package/api/resources/audiences/{types/AudiencePutResponse.js → client/requests/AudiencesListParams.js} +0 -0
- /package/api/resources/audiences/types/{AudienceRequest.js → AudienceUpdateResponse.js} +0 -0
- /package/api/resources/authTokens/{types/AuthIssueTokenParameters.js → client/requests/IssueTokenParams.js} +0 -0
- /package/api/resources/{tokenManagement/client → authTokens/client/requests}/index.js +0 -0
- /package/api/resources/authTokens/types/{AuthIssueTokenResponse.js → IssueTokenResponse.js} +0 -0
- /package/api/resources/brands/{types/BrandPutParameters.js → client/requests/BrandUpdateParameters.js} +0 -0
- /package/api/resources/bulk/{types → client/requests}/BulkCreateJobParams.js +0 -0
- /package/api/resources/{userPreferences/client → bulk/client/requests}/index.js +0 -0
- /package/api/resources/bulk/types/{BulkRunJobParams.js → InboundBulkContentMessage.js} +0 -0
- /package/api/resources/bulk/types/{InboundBulkMessageApiV1.js → InboundBulkMessageV1.js} +0 -0
- /package/api/resources/bulk/types/{InboundBulkMessageApiV2.js → InboundBulkMessageV2.js} +0 -0
- /package/api/resources/{tenants/types/CreateOrReplaceTenantRequest.js → bulk/types/InboundBulkTemplateMessage.js} +0 -0
- /package/api/resources/{tenants/types/CreateOrReplaceTenantResponse.js → notifications/client/requests/NotificationDraftUpdateVariationsParams.js} +0 -0
- /package/api/resources/{tokenManagement/types/DeleteUserTokenOpts.js → notifications/client/requests/NotificationListParams.js} +0 -0
- /package/api/resources/{tokenManagement/types/Device.js → notifications/client/requests/NotificationUpdateVariationsParams.js} +0 -0
- /package/api/resources/{tokenManagement/types/ExpiryDate.js → notifications/client/requests/SubmissionChecksReplaceParams.js} +0 -0
- /package/{dist/api/resources/tokenManagement/client → api/resources/notifications/client/requests}/index.js +0 -0
- /package/api/resources/{tokenManagement → notifications}/index.d.ts +0 -0
- /package/api/resources/{tokenManagement → notifications}/index.js +0 -0
- /package/api/resources/{tokenManagement/types/GetAllTokensResponse.js → notifications/types/BaseCheck.js} +0 -0
- /package/api/resources/{tokenManagement/types/GetUserTokenOpts.js → notifications/types/Check.js} +0 -0
- /package/api/resources/{tokenManagement/types/GetUserTokenResponse.js → notifications/types/MessageRouting.js} +0 -0
- /package/api/resources/{tokenManagement/types/GetUserTokensOpts.js → notifications/types/MessageRoutingChannel.js} +0 -0
- /package/api/resources/{tokenManagement/types/PatchOperation.js → notifications/types/Notification.js} +0 -0
- /package/api/resources/{tokenManagement/types/PatchUserTokenOpts.js → notifications/types/NotificationBlock.js} +0 -0
- /package/api/resources/{tokenManagement/types/PutUserTokenOpts.js → notifications/types/NotificationChannel.js} +0 -0
- /package/api/resources/{tokenManagement/types/PutUserTokensOpts.js → notifications/types/NotificationChannelContent.js} +0 -0
- /package/api/resources/{tokenManagement/types/Tracking.js → notifications/types/NotificationContent.js} +0 -0
- /package/api/resources/{tokenManagement/types/UserToken.js → notifications/types/NotificationContentHierarchy.js} +0 -0
- /package/api/resources/{userPreferences/types/TopicPreference.js → notifications/types/NotificationGetContentResponse.js} +0 -0
- /package/api/resources/{userPreferences/types/UpdateSubscriptionTopicRequest.js → notifications/types/NotificationListResponse.js} +0 -0
- /package/api/resources/{userPreferences/types/UpdateSubscriptionTopicResponse.js → notifications/types/SubmissionChecksGetResponse.js} +0 -0
- /package/api/resources/{userPreferences/types/UserPreferences.js → notifications/types/SubmissionChecksReplaceResponse.js} +0 -0
- /package/{dist/api/resources/audiences/client/requests/ListAudienceMembersRequest.js → api/resources/tenants/client/requests/TenantCreateOrReplaceParams.js} +0 -0
- /package/{dist/api/resources/userPreferences/client → api/resources/tenants/client/requests}/index.js +0 -0
- /package/{dist/api/resources/audiences/client/requests/ListAudiencesRequest.js → api/resources/tenants/types/Tenant.js} +0 -0
- /package/{dist/api/resources/audiences/types/AudiencePutResponse.js → api/resources/tenants/types/TenantListResponse.js} +0 -0
- /package/api/resources/{tokenManagement → users}/client/index.d.ts +0 -0
- /package/{dist/api/resources/audiences/types/AudienceRequest.js → api/resources/users/resources/preferences/client/requests/UserPreferencesUpdateParams.js} +0 -0
- /package/api/resources/{userPreferences → users/resources/preferences}/index.d.ts +0 -0
- /package/api/resources/{userPreferences → users/resources/preferences}/index.js +0 -0
- /package/{dist/api/resources/userPreferences → api/resources/users/resources/preferences}/types/TopicPreference.js +0 -0
- /package/{dist/api/resources/authTokens/types/AuthIssueTokenParameters.js → api/resources/users/resources/preferences/types/UserPreferencesGetResponse.js} +0 -0
- /package/{dist/api/resources/authTokens/types/AuthIssueTokenResponse.js → api/resources/users/resources/preferences/types/UserPreferencesListResponse.js} +0 -0
- /package/{dist/api/resources/brands/types/BrandPutParameters.js → api/resources/users/resources/preferences/types/UserPreferencesUpdateResponse.js} +0 -0
- /package/{dist/api/resources/bulk/types/BulkCreateJobParams.js → api/resources/users/resources/tenants/client/requests/AddUserToMultipleTenantsParams.js} +0 -0
- /package/{dist/api/resources/bulk/types/BulkRunJobParams.js → api/resources/users/resources/tenants/client/requests/AddUserToSingleTenantsParams.js} +0 -0
- /package/{dist/api/resources/bulk/types/InboundBulkMessageApiV1.js → api/resources/users/resources/tenants/client/requests/ListTenantsForUserParams.js} +0 -0
- /package/{dist/api/resources/tokenManagement → api/resources/users/resources/tenants}/index.d.ts +0 -0
- /package/{dist/api/resources/tokenManagement → api/resources/users/resources/tenants}/index.js +0 -0
- /package/{dist/api/resources/bulk/types/InboundBulkMessageApiV2.js → api/resources/users/resources/tenants/types/ListTenantsForUserResponse.js} +0 -0
- /package/{dist/api/resources/tenants/types/CreateOrReplaceTenantRequest.js → api/resources/users/resources/tenants/types/UserTenantAssociation.js} +0 -0
- /package/api/resources/{userPreferences → users/resources/tokens}/client/index.d.ts +0 -0
- /package/{dist/api/resources/userPreferences → api/resources/users/resources/tokens}/index.d.ts +0 -0
- /package/{dist/api/resources/userPreferences → api/resources/users/resources/tokens}/index.js +0 -0
- /package/api/resources/{tokenManagement → users/resources/tokens}/types/DeleteUserTokenOpts.d.ts +0 -0
- /package/{dist/api/resources/tokenManagement → api/resources/users/resources/tokens}/types/DeleteUserTokenOpts.js +0 -0
- /package/api/resources/{tokenManagement → users/resources/tokens}/types/Device.d.ts +0 -0
- /package/{dist/api/resources/tokenManagement → api/resources/users/resources/tokens}/types/Device.js +0 -0
- /package/api/resources/{tokenManagement → users/resources/tokens}/types/ExpiryDate.d.ts +0 -0
- /package/{dist/api/resources/tokenManagement → api/resources/users/resources/tokens}/types/ExpiryDate.js +0 -0
- /package/{dist/api/resources/tokenManagement → api/resources/users/resources/tokens}/types/GetAllTokensResponse.js +0 -0
- /package/api/resources/{tokenManagement → users/resources/tokens}/types/GetUserTokenOpts.d.ts +0 -0
- /package/{dist/api/resources/tokenManagement → api/resources/users/resources/tokens}/types/GetUserTokenOpts.js +0 -0
- /package/{dist/api/resources/tokenManagement → api/resources/users/resources/tokens}/types/GetUserTokenResponse.js +0 -0
- /package/api/resources/{tokenManagement → users/resources/tokens}/types/GetUserTokensOpts.d.ts +0 -0
- /package/{dist/api/resources/tokenManagement → api/resources/users/resources/tokens}/types/GetUserTokensOpts.js +0 -0
- /package/api/resources/{tokenManagement → users/resources/tokens}/types/PatchOp.d.ts +0 -0
- /package/api/resources/{tokenManagement → users/resources/tokens}/types/PatchOp.js +0 -0
- /package/api/resources/{tokenManagement → users/resources/tokens}/types/PatchOperation.d.ts +0 -0
- /package/{dist/api/resources/tokenManagement → api/resources/users/resources/tokens}/types/PatchOperation.js +0 -0
- /package/{dist/api/resources/tokenManagement → api/resources/users/resources/tokens}/types/PatchUserTokenOpts.js +0 -0
- /package/api/resources/{tokenManagement → users/resources/tokens}/types/ProviderKey.d.ts +0 -0
- /package/api/resources/{tokenManagement → users/resources/tokens}/types/ProviderKey.js +0 -0
- /package/{dist/api/resources/tokenManagement → api/resources/users/resources/tokens}/types/PutUserTokenOpts.js +0 -0
- /package/{dist/api/resources/tokenManagement → api/resources/users/resources/tokens}/types/PutUserTokensOpts.js +0 -0
- /package/api/resources/{tokenManagement → users/resources/tokens}/types/TokenStatus.d.ts +0 -0
- /package/api/resources/{tokenManagement → users/resources/tokens}/types/TokenStatus.js +0 -0
- /package/api/resources/{tokenManagement → users/resources/tokens}/types/Tracking.d.ts +0 -0
- /package/{dist/api/resources/tokenManagement → api/resources/users/resources/tokens}/types/Tracking.js +0 -0
- /package/{dist/api/resources/tokenManagement → api/resources/users/resources/tokens}/types/UserToken.js +0 -0
- /package/api/resources/{tokenManagement → users/resources/tokens}/types/index.d.ts +0 -0
- /package/api/resources/{tokenManagement → users/resources/tokens}/types/index.js +0 -0
- /package/dist/api/resources/{tenants/types/CreateOrReplaceTenantResponse.js → audiences/client/requests/AudienceMembersListParams.js} +0 -0
- /package/dist/api/resources/{userPreferences/types/UpdateSubscriptionTopicRequest.js → audiences/client/requests/AudienceUpdateParams.js} +0 -0
- /package/dist/api/resources/{userPreferences/types/UpdateSubscriptionTopicResponse.js → audiences/client/requests/AudiencesListParams.js} +0 -0
- /package/dist/api/resources/{userPreferences/types/UserPreferences.js → audiences/types/AudienceUpdateResponse.js} +0 -0
- /package/dist/api/resources/{tokenManagement → users}/client/index.d.ts +0 -0
- /package/dist/api/resources/{userPreferences → users/resources/tokens}/client/index.d.ts +0 -0
- /package/dist/api/resources/{tokenManagement → users/resources/tokens}/types/DeleteUserTokenOpts.d.ts +0 -0
- /package/dist/api/resources/{tokenManagement → users/resources/tokens}/types/Device.d.ts +0 -0
- /package/dist/api/resources/{tokenManagement → users/resources/tokens}/types/ExpiryDate.d.ts +0 -0
- /package/dist/api/resources/{tokenManagement → users/resources/tokens}/types/GetUserTokenOpts.d.ts +0 -0
- /package/dist/api/resources/{tokenManagement → users/resources/tokens}/types/GetUserTokensOpts.d.ts +0 -0
- /package/dist/api/resources/{tokenManagement → users/resources/tokens}/types/PatchOp.d.ts +0 -0
- /package/dist/api/resources/{tokenManagement → users/resources/tokens}/types/PatchOp.js +0 -0
- /package/dist/api/resources/{tokenManagement → users/resources/tokens}/types/PatchOperation.d.ts +0 -0
- /package/dist/api/resources/{tokenManagement → users/resources/tokens}/types/ProviderKey.d.ts +0 -0
- /package/dist/api/resources/{tokenManagement → users/resources/tokens}/types/ProviderKey.js +0 -0
- /package/dist/api/resources/{tokenManagement → users/resources/tokens}/types/TokenStatus.d.ts +0 -0
- /package/dist/api/resources/{tokenManagement → users/resources/tokens}/types/TokenStatus.js +0 -0
- /package/dist/api/resources/{tokenManagement → users/resources/tokens}/types/Tracking.d.ts +0 -0
- /package/dist/api/resources/{tokenManagement → users/resources/tokens}/types/index.d.ts +0 -0
- /package/dist/api/resources/{tokenManagement → users/resources/tokens}/types/index.js +0 -0
package/Client.d.ts
CHANGED
|
@@ -12,16 +12,16 @@ import { Brands } from "./api/resources/brands/client/Client";
|
|
|
12
12
|
import { Bulk } from "./api/resources/bulk/client/Client";
|
|
13
13
|
import { Lists } from "./api/resources/lists/client/Client";
|
|
14
14
|
import { Messages } from "./api/resources/messages/client/Client";
|
|
15
|
+
import { Notifications } from "./api/resources/notifications/client/Client";
|
|
15
16
|
import { Profiles } from "./api/resources/profiles/client/Client";
|
|
16
17
|
import { Templates } from "./api/resources/templates/client/Client";
|
|
17
18
|
import { Tenants } from "./api/resources/tenants/client/Client";
|
|
18
|
-
import { TokenManagement } from "./api/resources/tokenManagement/client/Client";
|
|
19
19
|
import { Translations } from "./api/resources/translations/client/Client";
|
|
20
|
-
import {
|
|
20
|
+
import { Users } from "./api/resources/users/client/Client";
|
|
21
21
|
export declare namespace CourierClient {
|
|
22
22
|
interface Options {
|
|
23
23
|
environment?: core.Supplier<environments.CourierEnvironment | string>;
|
|
24
|
-
authorizationToken
|
|
24
|
+
authorizationToken?: core.Supplier<core.BearerToken | undefined>;
|
|
25
25
|
}
|
|
26
26
|
interface RequestOptions {
|
|
27
27
|
timeoutInSeconds?: number;
|
|
@@ -34,7 +34,7 @@ export declare namespace CourierClient {
|
|
|
34
34
|
}
|
|
35
35
|
export declare class CourierClient {
|
|
36
36
|
protected readonly _options: CourierClient.Options;
|
|
37
|
-
constructor(_options
|
|
37
|
+
constructor(_options?: CourierClient.Options);
|
|
38
38
|
/**
|
|
39
39
|
* Use the send API to send a message to one or more recipients.
|
|
40
40
|
*/
|
|
@@ -55,17 +55,17 @@ export declare class CourierClient {
|
|
|
55
55
|
get lists(): Lists;
|
|
56
56
|
protected _messages: Messages | undefined;
|
|
57
57
|
get messages(): Messages;
|
|
58
|
+
protected _notifications: Notifications | undefined;
|
|
59
|
+
get notifications(): Notifications;
|
|
58
60
|
protected _profiles: Profiles | undefined;
|
|
59
61
|
get profiles(): Profiles;
|
|
60
62
|
protected _templates: Templates | undefined;
|
|
61
63
|
get templates(): Templates;
|
|
62
64
|
protected _tenants: Tenants | undefined;
|
|
63
65
|
get tenants(): Tenants;
|
|
64
|
-
protected _tokenManagement: TokenManagement | undefined;
|
|
65
|
-
get tokenManagement(): TokenManagement;
|
|
66
66
|
protected _translations: Translations | undefined;
|
|
67
67
|
get translations(): Translations;
|
|
68
|
-
protected
|
|
69
|
-
get
|
|
68
|
+
protected _users: Users | undefined;
|
|
69
|
+
get users(): Users;
|
|
70
70
|
protected _getAuthorizationHeader(): Promise<string>;
|
|
71
71
|
}
|
package/Client.js
CHANGED
|
@@ -51,14 +51,14 @@ const Client_5 = require("./api/resources/brands/client/Client");
|
|
|
51
51
|
const Client_6 = require("./api/resources/bulk/client/Client");
|
|
52
52
|
const Client_7 = require("./api/resources/lists/client/Client");
|
|
53
53
|
const Client_8 = require("./api/resources/messages/client/Client");
|
|
54
|
-
const Client_9 = require("./api/resources/
|
|
55
|
-
const Client_10 = require("./api/resources/
|
|
56
|
-
const Client_11 = require("./api/resources/
|
|
57
|
-
const Client_12 = require("./api/resources/
|
|
54
|
+
const Client_9 = require("./api/resources/notifications/client/Client");
|
|
55
|
+
const Client_10 = require("./api/resources/profiles/client/Client");
|
|
56
|
+
const Client_11 = require("./api/resources/templates/client/Client");
|
|
57
|
+
const Client_12 = require("./api/resources/tenants/client/Client");
|
|
58
58
|
const Client_13 = require("./api/resources/translations/client/Client");
|
|
59
|
-
const Client_14 = require("./api/resources/
|
|
59
|
+
const Client_14 = require("./api/resources/users/client/Client");
|
|
60
60
|
class CourierClient {
|
|
61
|
-
constructor(_options) {
|
|
61
|
+
constructor(_options = {}) {
|
|
62
62
|
this._options = _options;
|
|
63
63
|
}
|
|
64
64
|
/**
|
|
@@ -74,7 +74,7 @@ class CourierClient {
|
|
|
74
74
|
Authorization: yield this._getAuthorizationHeader(),
|
|
75
75
|
"X-Fern-Language": "JavaScript",
|
|
76
76
|
"X-Fern-SDK-Name": "@trycourier/courier",
|
|
77
|
-
"X-Fern-SDK-Version": "
|
|
77
|
+
"X-Fern-SDK-Version": "v6.0.2",
|
|
78
78
|
"Idempotency-Key": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey : undefined,
|
|
79
79
|
"X-Idempotency-Expiration": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry) != null
|
|
80
80
|
? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry.toString()
|
|
@@ -141,29 +141,29 @@ class CourierClient {
|
|
|
141
141
|
var _a;
|
|
142
142
|
return ((_a = this._messages) !== null && _a !== void 0 ? _a : (this._messages = new Client_8.Messages(this._options)));
|
|
143
143
|
}
|
|
144
|
+
get notifications() {
|
|
145
|
+
var _a;
|
|
146
|
+
return ((_a = this._notifications) !== null && _a !== void 0 ? _a : (this._notifications = new Client_9.Notifications(this._options)));
|
|
147
|
+
}
|
|
144
148
|
get profiles() {
|
|
145
149
|
var _a;
|
|
146
|
-
return ((_a = this._profiles) !== null && _a !== void 0 ? _a : (this._profiles = new
|
|
150
|
+
return ((_a = this._profiles) !== null && _a !== void 0 ? _a : (this._profiles = new Client_10.Profiles(this._options)));
|
|
147
151
|
}
|
|
148
152
|
get templates() {
|
|
149
153
|
var _a;
|
|
150
|
-
return ((_a = this._templates) !== null && _a !== void 0 ? _a : (this._templates = new
|
|
154
|
+
return ((_a = this._templates) !== null && _a !== void 0 ? _a : (this._templates = new Client_11.Templates(this._options)));
|
|
151
155
|
}
|
|
152
156
|
get tenants() {
|
|
153
157
|
var _a;
|
|
154
|
-
return ((_a = this._tenants) !== null && _a !== void 0 ? _a : (this._tenants = new
|
|
155
|
-
}
|
|
156
|
-
get tokenManagement() {
|
|
157
|
-
var _a;
|
|
158
|
-
return ((_a = this._tokenManagement) !== null && _a !== void 0 ? _a : (this._tokenManagement = new Client_12.TokenManagement(this._options)));
|
|
158
|
+
return ((_a = this._tenants) !== null && _a !== void 0 ? _a : (this._tenants = new Client_12.Tenants(this._options)));
|
|
159
159
|
}
|
|
160
160
|
get translations() {
|
|
161
161
|
var _a;
|
|
162
162
|
return ((_a = this._translations) !== null && _a !== void 0 ? _a : (this._translations = new Client_13.Translations(this._options)));
|
|
163
163
|
}
|
|
164
|
-
get
|
|
164
|
+
get users() {
|
|
165
165
|
var _a;
|
|
166
|
-
return ((_a = this.
|
|
166
|
+
return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_14.Users(this._options)));
|
|
167
167
|
}
|
|
168
168
|
_getAuthorizationHeader() {
|
|
169
169
|
var _a;
|
package/README.md
CHANGED
|
@@ -9,11 +9,6 @@ This is the official node.js module for sending notifications with node.js with
|
|
|
9
9
|
|
|
10
10
|
## Installation (via [npm](https://www.npmjs.com/package/@trycourier/courier))
|
|
11
11
|
|
|
12
|
-
|
|
13
|
-
### Note
|
|
14
|
-
|
|
15
|
-
Recent version v6 can be unstable, its recommended to use version `v5.7.0`. We are actively working on making v6 stable and will be updating the README accordingly soon.
|
|
16
|
-
|
|
17
12
|
```bash
|
|
18
13
|
npm install @trycourier/courier
|
|
19
14
|
```
|
|
@@ -24,6 +19,33 @@ You will need to get a Courier API key to get started. You can sign up and creat
|
|
|
24
19
|
|
|
25
20
|
## Upgrade Guides
|
|
26
21
|
|
|
22
|
+
### v5 to v6
|
|
23
|
+
|
|
24
|
+
v6 of our SDK is automatically generated by [Fern](https://buildwithfern.com/). v6 comes
|
|
25
|
+
with several improvements that we describe below:
|
|
26
|
+
|
|
27
|
+
- **Resource-scoped SDK methods**: Endpoints are scoped under their resource. For
|
|
28
|
+
example, instead of `courier.deleteBrands` the SDK now reads `courier.brands.delete(...)`
|
|
29
|
+
- **Docs on Hover**: All endpoint and parameter level documentation that you see
|
|
30
|
+
on our docs website is now embedded directly within the SDKs.
|
|
31
|
+
- **Retries with exponential backoff**: The SDK will automatically retry failures with
|
|
32
|
+
exponential backoff. You can configure the retries by setting `maxRetries`.
|
|
33
|
+
```typescript
|
|
34
|
+
const response = courier.send(..., {
|
|
35
|
+
maxReries: 0 // set to 0 if you want to disable retries
|
|
36
|
+
})
|
|
37
|
+
```
|
|
38
|
+
- **Configurable Timeouts**: The SDK defaults to a 60 second timeout. You can also
|
|
39
|
+
configure this value per-request.
|
|
40
|
+
```typescript
|
|
41
|
+
const response = courier.send(..., {
|
|
42
|
+
timeoutInSeconds: 45 // set to 45 seconds for this particular request
|
|
43
|
+
})
|
|
44
|
+
```
|
|
45
|
+
- **Support for multiple runtimes**: The SDK uses global fetch when available, otherwise
|
|
46
|
+
defaults to node-fetch. This means you can use Courier in multiple runtimes; Node.js,
|
|
47
|
+
Vercel, and Cloudflare Workers.
|
|
48
|
+
|
|
27
49
|
### v3 to v4
|
|
28
50
|
|
|
29
51
|
v4 uses native fetch client to make requests or falls back to a polyfill if the client doesn't exist in the environment it's running in. Check [Error Handling](#Error-Handling) out.
|
|
@@ -31,9 +53,9 @@ v4 uses native fetch client to make requests or falls back to a polyfill if the
|
|
|
31
53
|
## Getting Started
|
|
32
54
|
|
|
33
55
|
```javascript
|
|
34
|
-
|
|
56
|
+
import { CourierClient } from "@trycourier/courier";
|
|
35
57
|
|
|
36
|
-
const courier = CourierClient({ authorizationToken: "<AUTH_TOKEN>" }); // get from the Courier UI
|
|
58
|
+
const courier = new CourierClient({ authorizationToken: "<AUTH_TOKEN>" }); // get from the Courier UI
|
|
37
59
|
|
|
38
60
|
// Example: send a basic message to an email recipient
|
|
39
61
|
const { requestId } = await courier.send({
|
|
@@ -154,6 +176,10 @@ const { requestId } = await courier.send({
|
|
|
154
176
|
// Example: send a message to a list, pattern and user
|
|
155
177
|
const { requestId } = await courier.send({
|
|
156
178
|
message: {
|
|
179
|
+
content: {
|
|
180
|
+
title: "Hello",
|
|
181
|
+
body: "Good morning!"
|
|
182
|
+
},
|
|
157
183
|
to: [
|
|
158
184
|
{
|
|
159
185
|
list_pattern: "<PATTERN>", // e.g. example.list.*
|
|
@@ -165,11 +191,10 @@ const { requestId } = await courier.send({
|
|
|
165
191
|
email: "test@email.com"
|
|
166
192
|
}
|
|
167
193
|
]
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
},
|
|
194
|
+
},
|
|
195
|
+
routing: {
|
|
196
|
+
method: "single",
|
|
197
|
+
channels: ["email"],
|
|
173
198
|
},
|
|
174
199
|
});
|
|
175
200
|
|
|
@@ -244,7 +269,6 @@ async function run() {
|
|
|
244
269
|
},
|
|
245
270
|
data: {}, // optional
|
|
246
271
|
brand_id: "<BRAND_ID>", //optional
|
|
247
|
-
routing: {},
|
|
248
272
|
channels: {}, // optional
|
|
249
273
|
providers: {}, // optional
|
|
250
274
|
},
|
|
@@ -316,57 +340,59 @@ async function run() {
|
|
|
316
340
|
**/
|
|
317
341
|
|
|
318
342
|
// Example: get a message status
|
|
319
|
-
const messageStatus = await courier.
|
|
343
|
+
const messageStatus = await courier.messages.get(requestId);
|
|
320
344
|
console.log(messageStatus);
|
|
321
345
|
|
|
322
346
|
// Example: get a message history
|
|
323
|
-
const { results } = await courier.
|
|
347
|
+
const { results } = await courier.messages.getHistory(requestId);
|
|
324
348
|
console.log(results);
|
|
325
349
|
|
|
326
350
|
// Example: get a message output
|
|
327
|
-
const { results } = await courier.
|
|
351
|
+
const { results } = await courier.messages.getContent(requestId);
|
|
328
352
|
console.log(results);
|
|
329
353
|
|
|
330
354
|
// Example: get all messages
|
|
331
|
-
const { paging, results } = await courier.
|
|
355
|
+
const { paging, results } = await courier.messages.list();
|
|
332
356
|
console.log(results);
|
|
333
357
|
|
|
334
358
|
// Example: replace a recipient's profile
|
|
335
|
-
const { status: replaceStatus } = await courier.
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
359
|
+
const { status: replaceStatus } = await courier.profiles.replace(
|
|
360
|
+
"<RECIPIENT_ID>",
|
|
361
|
+
{
|
|
362
|
+
profile: {
|
|
363
|
+
email: "example@example.com",
|
|
364
|
+
},
|
|
365
|
+
}
|
|
366
|
+
);
|
|
341
367
|
console.log(replaceStatus);
|
|
342
368
|
|
|
343
369
|
// Example: merge into a recipient's profile
|
|
344
|
-
const { status: mergeStatus } = await courier.
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
370
|
+
const { status: mergeStatus } = await courier.profiles.create(
|
|
371
|
+
"<RECIPIENT_ID>",
|
|
372
|
+
{
|
|
373
|
+
profile: {
|
|
374
|
+
sms: "555-555-5555",
|
|
375
|
+
},
|
|
376
|
+
}
|
|
377
|
+
);
|
|
350
378
|
console.log(mergeStatus);
|
|
351
379
|
|
|
352
380
|
// Example: get a recipient's profile
|
|
353
|
-
const { profile } = await courier.
|
|
354
|
-
recipientId: "<RECIPIENT_ID>",
|
|
355
|
-
});
|
|
381
|
+
const { profile } = await courier.profiles.get("<RECIPIENT_ID>");
|
|
356
382
|
console.log(profile);
|
|
357
383
|
|
|
358
384
|
// Example: get all brands
|
|
359
|
-
const { paging, results } = await courier.
|
|
385
|
+
const { paging, results } = await courier.brands.list({
|
|
360
386
|
cursor: "<CURSOR>", // optional
|
|
361
387
|
});
|
|
362
388
|
console.log(results);
|
|
363
389
|
|
|
364
390
|
// Example: get a specific brand
|
|
365
|
-
const brand = await courier.
|
|
391
|
+
const brand = await courier.brands.get("<BRAND_ID>");
|
|
366
392
|
console.log(brand);
|
|
367
393
|
|
|
368
394
|
// Example: create a brand
|
|
369
|
-
const newBrand = await courier.
|
|
395
|
+
const newBrand = await courier.brands.create({
|
|
370
396
|
name: "My Brand",
|
|
371
397
|
settings: {
|
|
372
398
|
colors: {
|
|
@@ -379,11 +405,10 @@ async function run() {
|
|
|
379
405
|
console.log(newBrand);
|
|
380
406
|
|
|
381
407
|
// Example: replace a brand
|
|
382
|
-
const replacedBrand = await courier.
|
|
383
|
-
id: "<BRAND_ID>",
|
|
408
|
+
const replacedBrand = await courier.brands.replace("<BRAND_ID>", {
|
|
384
409
|
name: "My New Brand",
|
|
385
410
|
settings: {
|
|
386
|
-
|
|
411
|
+
colors: {
|
|
387
412
|
primary: "#FF0000",
|
|
388
413
|
secondary: "#00FF00",
|
|
389
414
|
tertiary: "#0000FF",
|
|
@@ -393,7 +418,7 @@ async function run() {
|
|
|
393
418
|
console.log(replacedBrand);
|
|
394
419
|
|
|
395
420
|
// Example: delete a brand
|
|
396
|
-
await courier.
|
|
421
|
+
await courier.brands.delete("<BRAND_ID>");
|
|
397
422
|
|
|
398
423
|
// Example: get all lists
|
|
399
424
|
const { paging, items } = await courier.lists.list({
|
|
@@ -406,7 +431,7 @@ async function run() {
|
|
|
406
431
|
console.log(list);
|
|
407
432
|
|
|
408
433
|
// Example: create or replace a list
|
|
409
|
-
const replacedList = await courier.lists.
|
|
434
|
+
const replacedList = await courier.lists.update("<LIST_ID>", {
|
|
410
435
|
name: "My New List",
|
|
411
436
|
});
|
|
412
437
|
console.log(replacedList);
|
|
@@ -417,25 +442,25 @@ async function run() {
|
|
|
417
442
|
// Example: restore a list
|
|
418
443
|
await courier.lists.restore("<LIST_ID>");
|
|
419
444
|
|
|
420
|
-
// Example: get a list's
|
|
421
|
-
const { paging, items } = await courier.lists.
|
|
445
|
+
// Example: get a list's subscribers
|
|
446
|
+
const { paging, items } = await courier.lists.getSubscribers("<LIST_ID>");
|
|
422
447
|
console.log(items);
|
|
423
448
|
|
|
424
449
|
// Example: replace many recipients to a new or existing list
|
|
425
|
-
await courier.lists.
|
|
450
|
+
await courier.lists.updateSubscribers("<LIST_ID>", [
|
|
426
451
|
{ recipientId: "RECIPIENT_ID_1" },
|
|
427
452
|
{ recipientId: "RECIPIENT_ID_2" },
|
|
428
453
|
]);
|
|
429
454
|
|
|
430
455
|
// Example: subscribe single recipient to a new or existing list
|
|
431
|
-
|
|
456
|
+
await courier.lists.subscribe("<LIST_ID>", "<RECIPIENT_ID>");
|
|
432
457
|
console.log(recipient);
|
|
433
458
|
|
|
434
459
|
// Example: unsubscribe recipient from list
|
|
435
460
|
await courier.lists.unsubscribe("<LIST_ID>", "<RECIPIENT_ID>");
|
|
436
461
|
|
|
437
462
|
// Example: get a recipient's subscribed lists
|
|
438
|
-
const { paging, items } = await courier.lists.
|
|
463
|
+
const { paging, items } = await courier.lists.getSubscribers(
|
|
439
464
|
"<RECIPIENT_ID>"
|
|
440
465
|
);
|
|
441
466
|
console.log(items);
|
|
@@ -463,22 +488,24 @@ async function run() {
|
|
|
463
488
|
console.log(runId);
|
|
464
489
|
|
|
465
490
|
// Example: Automation Invoke Template
|
|
466
|
-
const { runId } = await courier.automations.invokeAutomationTemplate(
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
491
|
+
const { runId } = await courier.automations.invokeAutomationTemplate(
|
|
492
|
+
"AUTOMATION_TEMPLATE_ID",
|
|
493
|
+
{
|
|
494
|
+
brand: "BRAND_ID",
|
|
495
|
+
data: {
|
|
496
|
+
example: "EXAMPLE_DATA",
|
|
497
|
+
},
|
|
498
|
+
profile: {
|
|
499
|
+
email: "foo@bar.com",
|
|
500
|
+
},
|
|
501
|
+
recipient: "RECIPIENT_ID",
|
|
502
|
+
template: "TEMPLATE_NAME_OR_ID",
|
|
503
|
+
}
|
|
504
|
+
);
|
|
478
505
|
console.log(runId);
|
|
479
506
|
|
|
480
507
|
// Example: List notifications
|
|
481
|
-
const { paging, results } = await courier.notifications.list(
|
|
508
|
+
const { paging, results } = await courier.notifications.list();
|
|
482
509
|
console.log(results);
|
|
483
510
|
|
|
484
511
|
// Example: Get notification content
|
|
@@ -496,7 +523,7 @@ async function run() {
|
|
|
496
523
|
console.log(channels);
|
|
497
524
|
|
|
498
525
|
// Example: Post notification variations
|
|
499
|
-
await courier.notifications.
|
|
526
|
+
await courier.notifications.updateVariations("notification1", {
|
|
500
527
|
blocks: [
|
|
501
528
|
{
|
|
502
529
|
id: "block_1d4c32e0-bca8-43f6-b5d5-8c043199bce6",
|
|
@@ -536,7 +563,7 @@ async function run() {
|
|
|
536
563
|
});
|
|
537
564
|
|
|
538
565
|
// Example: Post notification draft variations
|
|
539
|
-
await courier.notifications.
|
|
566
|
+
await courier.notifications.updateDraftVariations("notification1", {
|
|
540
567
|
blocks: [
|
|
541
568
|
{
|
|
542
569
|
id: "block_1d4c32e0-bca8-43f6-b5d5-8c043199bce6",
|
|
@@ -583,7 +610,7 @@ async function run() {
|
|
|
583
610
|
console.log(checks);
|
|
584
611
|
|
|
585
612
|
// Example: Put notification submission checks
|
|
586
|
-
const { checks } = await courier.notifications.
|
|
613
|
+
const { checks } = await courier.notifications.replaceSubmissionChecks(
|
|
587
614
|
"notification1",
|
|
588
615
|
"submission1",
|
|
589
616
|
{
|
|
@@ -653,14 +680,12 @@ async function run() {
|
|
|
653
680
|
console.log(response);
|
|
654
681
|
|
|
655
682
|
// Example: Run a job
|
|
656
|
-
await courier.bulk.runJob(
|
|
657
|
-
jobId: "1-61efe386-6ff57552409e311b7a1f371f",
|
|
658
|
-
});
|
|
683
|
+
await courier.bulk.runJob("1-61efe386-6ff57552409e311b7a1f371f");
|
|
659
684
|
|
|
660
685
|
// Example: Get user details in a job
|
|
661
|
-
const response = await courier.bulk.
|
|
662
|
-
|
|
663
|
-
|
|
686
|
+
const response = await courier.bulk.getUsers(
|
|
687
|
+
"1-61efe386-6ff57552409e311b7a1f371f"
|
|
688
|
+
);
|
|
664
689
|
console.log(response);
|
|
665
690
|
}
|
|
666
691
|
|
|
@@ -680,18 +705,15 @@ All network related promise rejections are not handled in any way. All successfu
|
|
|
680
705
|
|
|
681
706
|
```javascript
|
|
682
707
|
// Error handling example
|
|
683
|
-
|
|
684
|
-
CourierClient,
|
|
685
|
-
CourierHttpClientError,
|
|
686
|
-
} = require("@trycourier/courier");
|
|
708
|
+
import { CourierError, CourierClient } from "@trycourier/courier";
|
|
687
709
|
|
|
688
|
-
const courier = CourierClient();
|
|
710
|
+
const courier = new CourierClient();
|
|
689
711
|
|
|
690
712
|
try {
|
|
691
713
|
await courier.send(/* ... */);
|
|
692
714
|
} catch (error) {
|
|
693
|
-
if (error instanceof
|
|
694
|
-
console.log("Failed to send with status code:", error.
|
|
715
|
+
if (error instanceof CourierError) {
|
|
716
|
+
console.log("Failed to send with status code:", error.statusCode);
|
|
695
717
|
console.log("The Courier response is:", error.data);
|
|
696
718
|
console.log("The error message is:", error.message);
|
|
697
719
|
} else {
|
|
@@ -707,10 +729,10 @@ try {
|
|
|
707
729
|
For `POST` methods, you can supply an `idempotencyKey` in the config parameter to ensure the idempotency of the API Call. We recommend that you use a `V4 UUID` for the key. Keys are eligible to be removed from the system after they're at least 24 hours old, and a new request is generated if a key is reused after the original has been removed. For more info, see [Idempotent Requests](https://docs.courier.com/reference/idempotent-requests) in the Courier documentation.
|
|
708
730
|
|
|
709
731
|
```javascript
|
|
710
|
-
|
|
732
|
+
import { CourierClient } from "@trycourier/courier";
|
|
711
733
|
import uuid4 from "uuid4";
|
|
712
734
|
|
|
713
|
-
const courier = CourierClient();
|
|
735
|
+
const courier = new CourierClient();
|
|
714
736
|
const idempotencyKey = uuid4();
|
|
715
737
|
|
|
716
738
|
async function run() {
|
|
@@ -785,8 +807,7 @@ Use Cases:
|
|
|
785
807
|
#### Creating a Tenant
|
|
786
808
|
|
|
787
809
|
```ts
|
|
788
|
-
const {
|
|
789
|
-
id: "<TENANT_ID>",
|
|
810
|
+
const { id } = await courier.tenants.createOrReplace("<TENANT_ID>", {
|
|
790
811
|
name: "Courier",
|
|
791
812
|
user_profile: {
|
|
792
813
|
slack: {
|
|
@@ -799,7 +820,7 @@ const { tenantId } = await courier.tenants.put({
|
|
|
799
820
|
#### Retrieving a Tenant
|
|
800
821
|
|
|
801
822
|
```ts
|
|
802
|
-
const
|
|
823
|
+
const tenant = await courier.tenants.get("<TENANT_ID>");
|
|
803
824
|
```
|
|
804
825
|
|
|
805
826
|
#### Deleting a Tenant
|
|
@@ -811,26 +832,7 @@ await courier.tenants.delete("<TENANT_ID>");
|
|
|
811
832
|
#### Listing Tenants
|
|
812
833
|
|
|
813
834
|
```ts
|
|
814
|
-
const { items: tenants, has_more
|
|
815
|
-
```
|
|
816
|
-
|
|
817
|
-
### Users
|
|
818
|
-
|
|
819
|
-
#### Updating user
|
|
820
|
-
|
|
821
|
-
```ts
|
|
822
|
-
await courier.users.put("<USER_ID>", {
|
|
823
|
-
accounts: [{ account_id: "ACCOUNT_ID", profile: { foo: "bar" } }],
|
|
824
|
-
profile: { name: "John Doe" },
|
|
825
|
-
});
|
|
826
|
-
```
|
|
827
|
-
|
|
828
|
-
#### Updating user accounts
|
|
829
|
-
|
|
830
|
-
```ts
|
|
831
|
-
await courier.users.putAccounts("<USER_ID>", {
|
|
832
|
-
accounts: [{ account_id: "ACCOUNT_ID", profile: { foo: "bar" } }],
|
|
833
|
-
});
|
|
835
|
+
const { items: tenants, has_more } = await courier.tenants.list();
|
|
834
836
|
```
|
|
835
837
|
|
|
836
838
|
#### Updating user preferences
|
|
@@ -838,10 +840,10 @@ await courier.users.putAccounts("<USER_ID>", {
|
|
|
838
840
|
Courier currently does not allow creating new topics via the API. You must create topics via the Courier UI. Once a topic is created, you can update a user's preferences for that topic via the API.
|
|
839
841
|
|
|
840
842
|
```ts
|
|
841
|
-
await courier.users.
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
});
|
|
843
|
+
await courier.users.preferences.update("<USER_ID>", "<VALID_TOPIC_ID>", {
|
|
844
|
+
default_status: "OPTED_IN",
|
|
845
|
+
status: "OPTED_OUT",
|
|
846
|
+
});
|
|
845
847
|
```
|
|
846
848
|
|
|
847
849
|
#### Getting user preferences
|
|
@@ -849,18 +851,18 @@ await courier.users.putUserPreferenceByTopic(mockUserId, "<VALID_TOPIC_ID>", {
|
|
|
849
851
|
- Get all topic level preferences for a user
|
|
850
852
|
|
|
851
853
|
```ts
|
|
852
|
-
const { items: userPreferences } = await courier.users.
|
|
853
|
-
|
|
854
|
-
);
|
|
854
|
+
const { items: userPreferences } = await courier.users.preferences.list(
|
|
855
|
+
"<USER_ID>"
|
|
856
|
+
);
|
|
855
857
|
```
|
|
856
858
|
|
|
857
859
|
- Get a specific topic level preference for a user
|
|
858
860
|
|
|
859
861
|
```ts
|
|
860
|
-
const userPreference = await courier.users.
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
);
|
|
862
|
+
const userPreference = await courier.users.preferences.get(
|
|
863
|
+
"<USER_ID>",
|
|
864
|
+
"<VALID_TOPIC_ID>"
|
|
865
|
+
);
|
|
864
866
|
```
|
|
865
867
|
|
|
866
868
|
## Contributing
|
|
@@ -7,7 +7,7 @@ import * as Courier from "../../..";
|
|
|
7
7
|
export declare namespace Audiences {
|
|
8
8
|
interface Options {
|
|
9
9
|
environment?: core.Supplier<environments.CourierEnvironment | string>;
|
|
10
|
-
authorizationToken
|
|
10
|
+
authorizationToken?: core.Supplier<core.BearerToken | undefined>;
|
|
11
11
|
}
|
|
12
12
|
interface RequestOptions {
|
|
13
13
|
timeoutInSeconds?: number;
|
|
@@ -16,7 +16,7 @@ export declare namespace Audiences {
|
|
|
16
16
|
}
|
|
17
17
|
export declare class Audiences {
|
|
18
18
|
protected readonly _options: Audiences.Options;
|
|
19
|
-
constructor(_options
|
|
19
|
+
constructor(_options?: Audiences.Options);
|
|
20
20
|
/**
|
|
21
21
|
* Returns the specified audience by id.
|
|
22
22
|
*/
|
|
@@ -24,7 +24,7 @@ export declare class Audiences {
|
|
|
24
24
|
/**
|
|
25
25
|
* Creates or updates audience.
|
|
26
26
|
*/
|
|
27
|
-
update(audienceId: string, request
|
|
27
|
+
update(audienceId: string, request?: Courier.AudienceUpdateParams, requestOptions?: Audiences.RequestOptions): Promise<Courier.AudienceUpdateResponse>;
|
|
28
28
|
/**
|
|
29
29
|
* Deletes the specified recipient Profile.
|
|
30
30
|
*/
|
|
@@ -33,11 +33,11 @@ export declare class Audiences {
|
|
|
33
33
|
* Get list of members of an audience.
|
|
34
34
|
* @throws {@link Courier.BadRequestError}
|
|
35
35
|
*/
|
|
36
|
-
listMembers(audienceId: string, request?: Courier.
|
|
36
|
+
listMembers(audienceId: string, request?: Courier.AudienceMembersListParams, requestOptions?: Audiences.RequestOptions): Promise<Courier.AudienceMemberListResponse>;
|
|
37
37
|
/**
|
|
38
38
|
* Get the audiences associated with the authorization token.
|
|
39
39
|
* @throws {@link Courier.BadRequestError}
|
|
40
40
|
*/
|
|
41
|
-
listAudiences(request?: Courier.
|
|
41
|
+
listAudiences(request?: Courier.AudiencesListParams, requestOptions?: Audiences.RequestOptions): Promise<Courier.AudienceListResponse>;
|
|
42
42
|
protected _getAuthorizationHeader(): Promise<string>;
|
|
43
43
|
}
|
|
@@ -45,7 +45,7 @@ const Courier = __importStar(require("../../.."));
|
|
|
45
45
|
const url_join_1 = __importDefault(require("url-join"));
|
|
46
46
|
const errors = __importStar(require("../../../../errors"));
|
|
47
47
|
class Audiences {
|
|
48
|
-
constructor(_options) {
|
|
48
|
+
constructor(_options = {}) {
|
|
49
49
|
this._options = _options;
|
|
50
50
|
}
|
|
51
51
|
/**
|
|
@@ -61,7 +61,7 @@ class Audiences {
|
|
|
61
61
|
Authorization: yield this._getAuthorizationHeader(),
|
|
62
62
|
"X-Fern-Language": "JavaScript",
|
|
63
63
|
"X-Fern-SDK-Name": "@trycourier/courier",
|
|
64
|
-
"X-Fern-SDK-Version": "
|
|
64
|
+
"X-Fern-SDK-Version": "v6.0.2",
|
|
65
65
|
},
|
|
66
66
|
contentType: "application/json",
|
|
67
67
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -94,7 +94,7 @@ class Audiences {
|
|
|
94
94
|
/**
|
|
95
95
|
* Creates or updates audience.
|
|
96
96
|
*/
|
|
97
|
-
update(audienceId, request, requestOptions) {
|
|
97
|
+
update(audienceId, request = {}, requestOptions) {
|
|
98
98
|
var _a;
|
|
99
99
|
return __awaiter(this, void 0, void 0, function* () {
|
|
100
100
|
const _response = yield core.fetcher({
|
|
@@ -104,7 +104,7 @@ class Audiences {
|
|
|
104
104
|
Authorization: yield this._getAuthorizationHeader(),
|
|
105
105
|
"X-Fern-Language": "JavaScript",
|
|
106
106
|
"X-Fern-SDK-Name": "@trycourier/courier",
|
|
107
|
-
"X-Fern-SDK-Version": "
|
|
107
|
+
"X-Fern-SDK-Version": "v6.0.2",
|
|
108
108
|
},
|
|
109
109
|
contentType: "application/json",
|
|
110
110
|
body: request,
|
|
@@ -148,7 +148,7 @@ class Audiences {
|
|
|
148
148
|
Authorization: yield this._getAuthorizationHeader(),
|
|
149
149
|
"X-Fern-Language": "JavaScript",
|
|
150
150
|
"X-Fern-SDK-Name": "@trycourier/courier",
|
|
151
|
-
"X-Fern-SDK-Version": "
|
|
151
|
+
"X-Fern-SDK-Version": "v6.0.2",
|
|
152
152
|
},
|
|
153
153
|
contentType: "application/json",
|
|
154
154
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -197,7 +197,7 @@ class Audiences {
|
|
|
197
197
|
Authorization: yield this._getAuthorizationHeader(),
|
|
198
198
|
"X-Fern-Language": "JavaScript",
|
|
199
199
|
"X-Fern-SDK-Name": "@trycourier/courier",
|
|
200
|
-
"X-Fern-SDK-Version": "
|
|
200
|
+
"X-Fern-SDK-Version": "v6.0.2",
|
|
201
201
|
},
|
|
202
202
|
contentType: "application/json",
|
|
203
203
|
queryParameters: _queryParams,
|
|
@@ -252,7 +252,7 @@ class Audiences {
|
|
|
252
252
|
Authorization: yield this._getAuthorizationHeader(),
|
|
253
253
|
"X-Fern-Language": "JavaScript",
|
|
254
254
|
"X-Fern-SDK-Name": "@trycourier/courier",
|
|
255
|
-
"X-Fern-SDK-Version": "
|
|
255
|
+
"X-Fern-SDK-Version": "v6.0.2",
|
|
256
256
|
},
|
|
257
257
|
contentType: "application/json",
|
|
258
258
|
queryParameters: _queryParams,
|