@trycourier/courier 6.1.1 → 6.1.3
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 +31 -2
- package/Client.js +35 -6
- package/api/client/requests/SendMessageRequest.d.ts +28 -1
- package/api/client/requests/index.d.ts +1 -1
- package/api/resources/audiences/client/Client.d.ts +47 -1
- package/api/resources/audiences/client/Client.js +68 -12
- package/api/resources/audiences/client/requests/AudienceMembersListParams.d.ts +6 -0
- package/api/resources/audiences/client/requests/AudienceUpdateParams.d.ts +13 -1
- package/api/resources/audiences/client/requests/AudiencesListParams.d.ts +6 -0
- package/api/resources/audiences/client/requests/index.d.ts +3 -3
- package/api/resources/audiences/types/Audience.d.ts +1 -1
- package/api/resources/audiences/types/AudienceListResponse.d.ts +1 -1
- package/api/resources/audiences/types/AudienceMemberGetResponse.d.ts +1 -1
- package/api/resources/audiences/types/AudienceMemberListResponse.d.ts +1 -1
- package/api/resources/audiences/types/AudienceUpdateResponse.d.ts +1 -1
- package/api/resources/audiences/types/BaseFilterConfig.d.ts +1 -1
- package/api/resources/audiences/types/Filter.d.ts +1 -1
- package/api/resources/audiences/types/FilterConfig.d.ts +1 -1
- package/api/resources/audiences/types/NestedFilterConfig.d.ts +1 -1
- package/api/resources/audiences/types/Operator.d.ts +1 -1
- package/api/resources/audiences/types/SingleFilterConfig.d.ts +1 -1
- package/api/resources/auditEvents/client/Client.d.ts +15 -1
- package/api/resources/auditEvents/client/Client.js +23 -5
- package/api/resources/auditEvents/client/requests/ListAuditEventsRequest.d.ts +6 -0
- package/api/resources/auditEvents/client/requests/index.d.ts +1 -1
- package/api/resources/auditEvents/types/AuditEvent.d.ts +1 -1
- package/api/resources/auditEvents/types/ListAuditEventsResponse.d.ts +1 -1
- package/api/resources/authTokens/client/Client.d.ts +11 -2
- package/api/resources/authTokens/client/Client.js +15 -6
- package/api/resources/authTokens/client/requests/IssueTokenParams.d.ts +7 -0
- package/api/resources/authTokens/client/requests/index.d.ts +1 -1
- package/api/resources/automations/client/Client.d.ts +31 -3
- package/api/resources/automations/client/Client.js +40 -12
- package/api/resources/automations/types/Automation.d.ts +1 -1
- package/api/resources/automations/types/AutomationAdHocInvokeParams.d.ts +1 -1
- package/api/resources/automations/types/AutomationAddToBatchRetain.d.ts +1 -1
- package/api/resources/automations/types/AutomationAddToBatchStep.d.ts +1 -1
- package/api/resources/automations/types/AutomationAddToDigestStep.d.ts +1 -1
- package/api/resources/automations/types/AutomationCancelStep.d.ts +1 -1
- package/api/resources/automations/types/AutomationDelayStep.d.ts +1 -1
- package/api/resources/automations/types/AutomationFetchDataStep.d.ts +1 -1
- package/api/resources/automations/types/AutomationFetchDataWebhook.d.ts +1 -1
- package/api/resources/automations/types/AutomationInvokeParams.d.ts +1 -1
- package/api/resources/automations/types/AutomationInvokeStep.d.ts +1 -1
- package/api/resources/automations/types/AutomationInvokeTemplateParams.d.ts +1 -1
- package/api/resources/automations/types/AutomationRunContext.d.ts +1 -1
- package/api/resources/automations/types/AutomationSendListStep.d.ts +1 -1
- package/api/resources/automations/types/AutomationSendStep.d.ts +1 -1
- package/api/resources/automations/types/AutomationStepOption.d.ts +1 -1
- package/api/resources/automations/types/AutomationThrottleStep.d.ts +1 -1
- package/api/resources/automations/types/AutomationUpdateProfileStep.d.ts +1 -1
- package/api/resources/automations/types/AutomationV2SendStep.d.ts +1 -1
- package/api/resources/brands/client/Client.d.ts +57 -2
- package/api/resources/brands/client/Client.js +77 -14
- package/api/resources/brands/client/requests/BrandUpdateParameters.d.ts +21 -1
- package/api/resources/brands/client/requests/ListBrandsRequest.d.ts +6 -0
- package/api/resources/brands/client/requests/index.d.ts +2 -2
- package/api/resources/brands/types/Brand.d.ts +1 -1
- package/api/resources/brands/types/BrandGetAllResponse.d.ts +1 -1
- package/api/resources/brands/types/BrandParameters.d.ts +1 -1
- package/api/resources/brands/types/BrandSettings.d.ts +1 -1
- package/api/resources/brands/types/BrandSnippets.d.ts +1 -1
- package/api/resources/brands/types/BrandsResponse.d.ts +1 -1
- package/api/resources/bulk/client/Client.d.ts +67 -2
- package/api/resources/bulk/client/Client.js +90 -21
- package/api/resources/bulk/client/requests/BulkCreateJobParams.d.ts +24 -1
- package/api/resources/bulk/client/requests/index.d.ts +1 -1
- package/api/resources/bulk/types/BulkGetJobResponse.d.ts +1 -1
- package/api/resources/bulk/types/BulkGetJobUsersResponse.d.ts +1 -1
- package/api/resources/bulk/types/BulkIngestUsersParams.d.ts +1 -1
- package/api/resources/bulk/types/BulkIngestUsersResponse.d.ts +1 -1
- package/api/resources/bulk/types/BulkMessageUserResponse.d.ts +1 -1
- package/api/resources/bulk/types/InboundBulkContentMessage.d.ts +1 -1
- package/api/resources/bulk/types/InboundBulkMessage.d.ts +1 -1
- package/api/resources/bulk/types/InboundBulkMessageUser.d.ts +1 -1
- package/api/resources/bulk/types/InboundBulkMessageV2.d.ts +1 -1
- package/api/resources/bulk/types/InboundBulkTemplateMessage.d.ts +1 -1
- package/api/resources/bulk/types/JobDetails.d.ts +1 -1
- package/api/resources/commons/errors/AlreadyExistsError.d.ts +2 -2
- package/api/resources/commons/errors/AlreadyExistsError.js +1 -1
- package/api/resources/commons/errors/BadRequestError.d.ts +2 -2
- package/api/resources/commons/errors/BadRequestError.js +1 -1
- package/api/resources/commons/errors/ConflictError.d.ts +2 -2
- package/api/resources/commons/errors/ConflictError.js +1 -1
- package/api/resources/commons/errors/MessageNotFoundError.d.ts +2 -2
- package/api/resources/commons/errors/MessageNotFoundError.js +1 -1
- package/api/resources/commons/errors/NotFoundError.d.ts +2 -2
- package/api/resources/commons/errors/NotFoundError.js +1 -1
- package/api/resources/commons/errors/PaymentRequiredError.d.ts +2 -2
- package/api/resources/commons/errors/PaymentRequiredError.js +1 -1
- package/api/resources/commons/types/AlreadyExists.d.ts +1 -1
- package/api/resources/commons/types/BadRequest.d.ts +1 -1
- package/api/resources/commons/types/ChannelPreference.d.ts +1 -1
- package/api/resources/commons/types/Conflict.d.ts +1 -1
- package/api/resources/commons/types/MessageNotFound.d.ts +1 -1
- package/api/resources/commons/types/NotFound.d.ts +1 -1
- package/api/resources/commons/types/NotificationPreferenceDetails.d.ts +1 -1
- package/api/resources/commons/types/NotificationPreferences.d.ts +1 -1
- package/api/resources/commons/types/PaymentRequired.d.ts +1 -1
- package/api/resources/commons/types/RecipientPreferences.d.ts +1 -1
- package/api/resources/commons/types/UserTenantAssociation.d.ts +4 -3
- package/api/resources/lists/client/Client.d.ts +197 -4
- package/api/resources/lists/client/Client.js +236 -25
- package/api/resources/lists/client/requests/AddSubscribersToList.d.ts +41 -0
- package/api/resources/lists/client/requests/AddSubscribersToList.js +5 -0
- package/api/resources/lists/client/requests/GetAllListsRequest.d.ts +7 -0
- package/api/resources/lists/client/requests/GetSubscriptionForListRequest.d.ts +6 -0
- package/api/resources/lists/client/requests/SubscribeUserToListRequest.d.ts +32 -1
- package/api/resources/lists/client/requests/SubscribeUsersToListRequest.d.ts +41 -0
- package/api/resources/lists/client/requests/SubscribeUsersToListRequest.js +5 -0
- package/api/resources/lists/client/requests/index.d.ts +5 -3
- package/api/resources/lists/types/ListGetAllResponse.d.ts +1 -1
- package/api/resources/lists/types/ListGetSubscriptionsResponse.d.ts +1 -1
- package/api/resources/lists/types/ListPutParams.d.ts +1 -1
- package/api/resources/lists/types/ListSubscriptionRecipient.d.ts +1 -1
- package/api/resources/lists/types/PutSubscriptionsRecipient.d.ts +1 -1
- package/api/resources/messages/client/Client.d.ts +59 -2
- package/api/resources/messages/client/Client.js +89 -28
- package/api/resources/messages/client/requests/GetMessageHistoryRequest.d.ts +6 -0
- package/api/resources/messages/client/requests/ListMessagesRequest.d.ts +19 -8
- package/api/resources/messages/client/requests/index.d.ts +2 -2
- package/api/resources/messages/types/ListMessagesResponse.d.ts +1 -1
- package/api/resources/messages/types/MessageDetails.d.ts +1 -1
- package/api/resources/messages/types/MessageHistoryResponse.d.ts +1 -2
- package/api/resources/messages/types/RenderOutput.d.ts +1 -1
- package/api/resources/messages/types/RenderOutputResponse.d.ts +1 -1
- package/api/resources/messages/types/RenderedMessageContent.d.ts +1 -1
- package/api/resources/notifications/client/Client.d.ts +113 -1
- package/api/resources/notifications/client/Client.js +145 -17
- package/api/resources/notifications/client/requests/NotificationDraftUpdateVariationsParams.d.ts +26 -1
- package/api/resources/notifications/client/requests/NotificationListParams.d.ts +6 -0
- package/api/resources/notifications/client/requests/NotificationUpdateVariationsParams.d.ts +26 -1
- package/api/resources/notifications/client/requests/SubmissionChecksReplaceParams.d.ts +11 -1
- package/api/resources/notifications/client/requests/index.d.ts +4 -4
- package/api/resources/notifications/types/BaseCheck.d.ts +1 -1
- package/api/resources/notifications/types/Check.d.ts +1 -1
- package/api/resources/notifications/types/MessageRouting.d.ts +1 -1
- package/api/resources/notifications/types/MessageRoutingChannel.d.ts +1 -1
- package/api/resources/notifications/types/Notification.d.ts +5 -1
- package/api/resources/notifications/types/NotificationBlock.d.ts +1 -1
- package/api/resources/notifications/types/NotificationChannel.d.ts +1 -1
- package/api/resources/notifications/types/NotificationContent.d.ts +1 -1
- package/api/resources/notifications/types/NotificationGetContentResponse.d.ts +1 -1
- package/api/resources/notifications/types/NotificationListResponse.d.ts +1 -1
- package/api/resources/notifications/types/NotificationTag.d.ts +7 -0
- package/api/resources/notifications/types/NotificationTag.js +5 -0
- package/api/resources/notifications/types/NotificationTagData.d.ts +7 -0
- package/api/resources/notifications/types/NotificationTagData.js +5 -0
- package/api/resources/notifications/types/SubmissionChecksGetResponse.d.ts +1 -1
- package/api/resources/notifications/types/SubmissionChecksReplaceResponse.d.ts +1 -1
- package/api/resources/notifications/types/index.d.ts +2 -0
- package/api/resources/notifications/types/index.js +2 -0
- package/api/resources/profiles/client/Client.d.ts +71 -2
- package/api/resources/profiles/client/Client.js +102 -23
- package/api/resources/profiles/client/requests/GetListSubscriptionsRequest.d.ts +6 -0
- package/api/resources/profiles/client/requests/MergeProfileRequest.d.ts +10 -0
- package/api/resources/profiles/client/requests/ReplaceProfileRequest.d.ts +10 -0
- package/api/resources/profiles/client/requests/index.d.ts +3 -3
- package/api/resources/profiles/types/AirshipProfile.d.ts +1 -1
- package/api/resources/profiles/types/Discord.d.ts +1 -1
- package/api/resources/profiles/types/Expo.d.ts +1 -1
- package/api/resources/profiles/types/GetListSubscriptionsList.d.ts +1 -1
- package/api/resources/profiles/types/GetListSubscriptionsResponse.d.ts +1 -1
- package/api/resources/profiles/types/Intercom.d.ts +1 -1
- package/api/resources/profiles/types/MsTeams.d.ts +1 -1
- package/api/resources/profiles/types/MultipleTokens.d.ts +1 -1
- package/api/resources/profiles/types/ProfileGetResponse.d.ts +1 -1
- package/api/resources/profiles/types/SendToMsTeamsChannelId.d.ts +1 -1
- package/api/resources/profiles/types/SendToMsTeamsChannelName.d.ts +1 -1
- package/api/resources/profiles/types/SendToMsTeamsConversationId.d.ts +1 -1
- package/api/resources/profiles/types/SendToMsTeamsEmail.d.ts +1 -1
- package/api/resources/profiles/types/SendToMsTeamsUserId.d.ts +1 -1
- package/api/resources/profiles/types/SendToSlackChannel.d.ts +1 -1
- package/api/resources/profiles/types/SendToSlackEmail.d.ts +1 -1
- package/api/resources/profiles/types/SendToSlackUserId.d.ts +1 -1
- package/api/resources/profiles/types/Slack.d.ts +1 -1
- package/api/resources/profiles/types/SnoozeRule.d.ts +1 -1
- package/api/resources/profiles/types/SubscribeToListsRequest.d.ts +1 -1
- package/api/resources/profiles/types/SubscribeToListsRequestListObject.d.ts +1 -1
- package/api/resources/profiles/types/UserProfile.d.ts +1 -1
- package/api/resources/send/types/AudienceRecipient.d.ts +1 -1
- package/api/resources/send/types/BaseMessage.d.ts +1 -1
- package/api/resources/send/types/BaseMessageSendTo.d.ts +1 -1
- package/api/resources/send/types/BrandSettingsEmail.d.ts +1 -1
- package/api/resources/send/types/BrandSettingsInApp.d.ts +1 -1
- package/api/resources/send/types/BrandSettingsSocialPresence.d.ts +1 -1
- package/api/resources/send/types/BrandTemplateOverride.d.ts +1 -1
- package/api/resources/send/types/Channel.d.ts +1 -1
- package/api/resources/send/types/ChannelMetadata.d.ts +1 -1
- package/api/resources/send/types/Content.d.ts +1 -1
- package/api/resources/send/types/ContentMessage.d.ts +1 -1
- package/api/resources/send/types/ElementalActionNode.d.ts +1 -1
- package/api/resources/send/types/ElementalChannelNode.d.ts +1 -1
- package/api/resources/send/types/ElementalContent.d.ts +1 -1
- package/api/resources/send/types/ElementalDividerNode.d.ts +1 -1
- package/api/resources/send/types/ElementalGroupNode.d.ts +1 -1
- package/api/resources/send/types/ElementalImageNode.d.ts +1 -1
- package/api/resources/send/types/ElementalMetaNode.d.ts +1 -1
- package/api/resources/send/types/ElementalNode.d.ts +1 -1
- package/api/resources/send/types/ElementalQuoteNode.d.ts +1 -1
- package/api/resources/send/types/ElementalTextNode.d.ts +1 -1
- package/api/resources/send/types/EmailHeader.d.ts +1 -1
- package/api/resources/send/types/Expiry.d.ts +1 -1
- package/api/resources/send/types/IPreferences.d.ts +1 -1
- package/api/resources/send/types/IProfilePreferences.d.ts +1 -1
- package/api/resources/send/types/ListPatternRecipient.d.ts +1 -1
- package/api/resources/send/types/ListRecipient.d.ts +1 -1
- package/api/resources/send/types/Locales.d.ts +1 -1
- package/api/resources/send/types/Message.d.ts +1 -1
- package/api/resources/send/types/MessageChannelEmailOverride.d.ts +1 -1
- package/api/resources/send/types/MessageChannels.d.ts +1 -1
- package/api/resources/send/types/MessageMetadata.d.ts +1 -1
- package/api/resources/send/types/MessageProviders.d.ts +1 -1
- package/api/resources/send/types/MessageProvidersType.d.ts +1 -1
- package/api/resources/send/types/MessageRecipient.d.ts +1 -1
- package/api/resources/send/types/Metadata.d.ts +1 -1
- package/api/resources/send/types/MsTeamsRecipient.d.ts +1 -1
- package/api/resources/send/types/Preference.d.ts +1 -1
- package/api/resources/send/types/Recipient.d.ts +1 -1
- package/api/resources/send/types/Routing.d.ts +1 -1
- package/api/resources/send/types/RoutingChannel.d.ts +1 -1
- package/api/resources/send/types/RoutingStrategyChannel.d.ts +1 -1
- package/api/resources/send/types/RoutingStrategyProvider.d.ts +1 -1
- package/api/resources/send/types/SlackRecipient.d.ts +1 -1
- package/api/resources/send/types/TemplateMessage.d.ts +1 -1
- package/api/resources/send/types/Timeout.d.ts +1 -1
- package/api/resources/send/types/UserRecipient.d.ts +1 -1
- package/api/resources/templates/client/Client.d.ts +9 -1
- package/api/resources/templates/client/Client.js +13 -3
- package/api/resources/templates/client/requests/ListTemplatesRequest.d.ts +6 -0
- package/api/resources/templates/client/requests/index.d.ts +1 -1
- package/api/resources/templates/types/ListTemplatesResponse.d.ts +1 -1
- package/api/resources/templates/types/NotificationTemplates.d.ts +1 -1
- package/api/resources/templates/types/RoutingStrategy.d.ts +1 -1
- package/api/resources/templates/types/Tag.d.ts +1 -1
- package/api/resources/tenants/client/Client.d.ts +82 -1
- package/api/resources/tenants/client/Client.js +190 -13
- package/api/resources/tenants/client/requests/ListTenantParams.d.ts +13 -1
- package/api/resources/tenants/client/requests/ListUsersForTenantParams.d.ts +7 -0
- package/api/resources/tenants/client/requests/TenantCreateOrReplaceParams.d.ts +23 -2
- package/api/resources/tenants/client/requests/index.d.ts +3 -3
- package/api/resources/tenants/types/DefaultPreferences.d.ts +2 -2
- package/api/resources/tenants/types/ListUsersForTenantResponse.d.ts +1 -1
- package/api/resources/tenants/types/SubscriptionTopic.d.ts +2 -3
- package/api/resources/tenants/types/SubscriptionTopicNew.d.ts +11 -0
- package/api/resources/tenants/types/SubscriptionTopicNew.js +5 -0
- package/api/resources/tenants/types/TemplateProperty.d.ts +3 -0
- package/api/resources/tenants/types/Tenant.d.ts +2 -2
- package/api/resources/tenants/types/TenantListResponse.d.ts +1 -1
- package/api/resources/tenants/types/index.d.ts +1 -0
- package/api/resources/tenants/types/index.js +1 -0
- package/api/resources/translations/client/Client.d.ts +17 -0
- package/api/resources/translations/client/Client.js +28 -7
- package/api/resources/users/resources/preferences/client/Client.d.ts +22 -1
- package/api/resources/users/resources/preferences/client/Client.js +36 -9
- package/api/resources/users/resources/preferences/client/requests/UserPreferencesUpdateParams.d.ts +1 -1
- package/api/resources/users/resources/preferences/client/requests/index.d.ts +1 -1
- package/api/resources/users/resources/preferences/types/TopicPreference.d.ts +1 -1
- package/api/resources/users/resources/preferences/types/TopicPreferenceUpdate.d.ts +1 -1
- package/api/resources/users/resources/preferences/types/UserPreferencesGetResponse.d.ts +1 -1
- package/api/resources/users/resources/preferences/types/UserPreferencesListResponse.d.ts +1 -1
- package/api/resources/users/resources/tenants/client/Client.d.ts +57 -2
- package/api/resources/users/resources/tenants/client/Client.js +78 -13
- package/api/resources/users/resources/tenants/client/requests/AddUserToMultipleTenantsParams.d.ts +16 -1
- package/api/resources/users/resources/tenants/client/requests/AddUserToSingleTenantsParams.d.ts +11 -2
- package/api/resources/users/resources/tenants/client/requests/ListTenantsForUserParams.d.ts +7 -0
- package/api/resources/users/resources/tenants/client/requests/index.d.ts +3 -3
- package/api/resources/users/resources/tenants/types/AddUserToSingleTenantsParamsProfile.d.ts +3 -0
- package/api/resources/users/resources/tenants/types/ListTenantsForUserResponse.d.ts +1 -1
- package/api/resources/users/resources/tokens/client/Client.d.ts +73 -1
- package/api/resources/users/resources/tokens/client/Client.js +136 -13
- package/api/resources/users/resources/tokens/types/GetAllTokensResponse.d.ts +1 -1
- package/api/resources/users/resources/tokens/types/GetUserTokenResponse.d.ts +1 -1
- package/api/resources/users/resources/tokens/types/PatchUserTokenOpts.d.ts +1 -1
- package/api/resources/users/resources/tokens/types/PutUserTokenOpts.d.ts +1 -1
- package/api/resources/users/resources/tokens/types/PutUserTokensOpts.d.ts +1 -1
- package/api/resources/users/resources/tokens/types/UserToken.d.ts +1 -1
- package/core/fetcher/Fetcher.d.ts +2 -2
- package/core/fetcher/Fetcher.js +60 -6
- package/core/index.d.ts +1 -0
- package/core/index.js +1 -0
- package/core/runtime/index.d.ts +1 -0
- package/core/runtime/index.js +5 -0
- package/core/runtime/runtime.d.ts +8 -0
- package/core/runtime/runtime.js +82 -0
- package/dist/Client.d.ts +31 -2
- package/dist/Client.js +35 -6
- package/dist/api/client/requests/SendMessageRequest.d.ts +28 -1
- package/dist/api/client/requests/index.d.ts +1 -1
- package/dist/api/resources/audiences/client/Client.d.ts +47 -1
- package/dist/api/resources/audiences/client/Client.js +68 -12
- package/dist/api/resources/audiences/client/requests/AudienceMembersListParams.d.ts +6 -0
- package/dist/api/resources/audiences/client/requests/AudienceUpdateParams.d.ts +13 -1
- package/dist/api/resources/audiences/client/requests/AudiencesListParams.d.ts +6 -0
- package/dist/api/resources/audiences/client/requests/index.d.ts +3 -3
- package/dist/api/resources/audiences/types/Audience.d.ts +1 -1
- package/dist/api/resources/audiences/types/AudienceListResponse.d.ts +1 -1
- package/dist/api/resources/audiences/types/AudienceMemberGetResponse.d.ts +1 -1
- package/dist/api/resources/audiences/types/AudienceMemberListResponse.d.ts +1 -1
- package/dist/api/resources/audiences/types/AudienceUpdateResponse.d.ts +1 -1
- package/dist/api/resources/audiences/types/BaseFilterConfig.d.ts +1 -1
- package/dist/api/resources/audiences/types/Filter.d.ts +1 -1
- package/dist/api/resources/audiences/types/FilterConfig.d.ts +1 -1
- package/dist/api/resources/audiences/types/NestedFilterConfig.d.ts +1 -1
- package/dist/api/resources/audiences/types/Operator.d.ts +1 -1
- package/dist/api/resources/audiences/types/SingleFilterConfig.d.ts +1 -1
- package/dist/api/resources/auditEvents/client/Client.d.ts +15 -1
- package/dist/api/resources/auditEvents/client/Client.js +23 -5
- package/dist/api/resources/auditEvents/client/requests/ListAuditEventsRequest.d.ts +6 -0
- package/dist/api/resources/auditEvents/client/requests/index.d.ts +1 -1
- package/dist/api/resources/auditEvents/types/AuditEvent.d.ts +1 -1
- package/dist/api/resources/auditEvents/types/ListAuditEventsResponse.d.ts +1 -1
- package/dist/api/resources/authTokens/client/Client.d.ts +11 -2
- package/dist/api/resources/authTokens/client/Client.js +15 -6
- package/dist/api/resources/authTokens/client/requests/IssueTokenParams.d.ts +7 -0
- package/dist/api/resources/authTokens/client/requests/index.d.ts +1 -1
- package/dist/api/resources/automations/client/Client.d.ts +31 -3
- package/dist/api/resources/automations/client/Client.js +40 -12
- package/dist/api/resources/automations/types/Automation.d.ts +1 -1
- package/dist/api/resources/automations/types/AutomationAdHocInvokeParams.d.ts +1 -1
- package/dist/api/resources/automations/types/AutomationAddToBatchRetain.d.ts +1 -1
- package/dist/api/resources/automations/types/AutomationAddToBatchStep.d.ts +1 -1
- package/dist/api/resources/automations/types/AutomationAddToDigestStep.d.ts +1 -1
- package/dist/api/resources/automations/types/AutomationCancelStep.d.ts +1 -1
- package/dist/api/resources/automations/types/AutomationDelayStep.d.ts +1 -1
- package/dist/api/resources/automations/types/AutomationFetchDataStep.d.ts +1 -1
- package/dist/api/resources/automations/types/AutomationFetchDataWebhook.d.ts +1 -1
- package/dist/api/resources/automations/types/AutomationInvokeParams.d.ts +1 -1
- package/dist/api/resources/automations/types/AutomationInvokeStep.d.ts +1 -1
- package/dist/api/resources/automations/types/AutomationInvokeTemplateParams.d.ts +1 -1
- package/dist/api/resources/automations/types/AutomationRunContext.d.ts +1 -1
- package/dist/api/resources/automations/types/AutomationSendListStep.d.ts +1 -1
- package/dist/api/resources/automations/types/AutomationSendStep.d.ts +1 -1
- package/dist/api/resources/automations/types/AutomationStepOption.d.ts +1 -1
- package/dist/api/resources/automations/types/AutomationThrottleStep.d.ts +1 -1
- package/dist/api/resources/automations/types/AutomationUpdateProfileStep.d.ts +1 -1
- package/dist/api/resources/automations/types/AutomationV2SendStep.d.ts +1 -1
- package/dist/api/resources/brands/client/Client.d.ts +57 -2
- package/dist/api/resources/brands/client/Client.js +77 -14
- package/dist/api/resources/brands/client/requests/BrandUpdateParameters.d.ts +21 -1
- package/dist/api/resources/brands/client/requests/ListBrandsRequest.d.ts +6 -0
- package/dist/api/resources/brands/client/requests/index.d.ts +2 -2
- package/dist/api/resources/brands/types/Brand.d.ts +1 -1
- package/dist/api/resources/brands/types/BrandGetAllResponse.d.ts +1 -1
- package/dist/api/resources/brands/types/BrandParameters.d.ts +1 -1
- package/dist/api/resources/brands/types/BrandSettings.d.ts +1 -1
- package/dist/api/resources/brands/types/BrandSnippets.d.ts +1 -1
- package/dist/api/resources/brands/types/BrandsResponse.d.ts +1 -1
- package/dist/api/resources/bulk/client/Client.d.ts +67 -2
- package/dist/api/resources/bulk/client/Client.js +90 -21
- package/dist/api/resources/bulk/client/requests/BulkCreateJobParams.d.ts +24 -1
- package/dist/api/resources/bulk/client/requests/index.d.ts +1 -1
- package/dist/api/resources/bulk/types/BulkGetJobResponse.d.ts +1 -1
- package/dist/api/resources/bulk/types/BulkGetJobUsersResponse.d.ts +1 -1
- package/dist/api/resources/bulk/types/BulkIngestUsersParams.d.ts +1 -1
- package/dist/api/resources/bulk/types/BulkIngestUsersResponse.d.ts +1 -1
- package/dist/api/resources/bulk/types/BulkMessageUserResponse.d.ts +1 -1
- package/dist/api/resources/bulk/types/InboundBulkContentMessage.d.ts +1 -1
- package/dist/api/resources/bulk/types/InboundBulkMessage.d.ts +1 -1
- package/dist/api/resources/bulk/types/InboundBulkMessageUser.d.ts +1 -1
- package/dist/api/resources/bulk/types/InboundBulkMessageV2.d.ts +1 -1
- package/dist/api/resources/bulk/types/InboundBulkTemplateMessage.d.ts +1 -1
- package/dist/api/resources/bulk/types/JobDetails.d.ts +1 -1
- package/dist/api/resources/commons/errors/AlreadyExistsError.d.ts +2 -2
- package/dist/api/resources/commons/errors/AlreadyExistsError.js +1 -1
- package/dist/api/resources/commons/errors/BadRequestError.d.ts +2 -2
- package/dist/api/resources/commons/errors/BadRequestError.js +1 -1
- package/dist/api/resources/commons/errors/ConflictError.d.ts +2 -2
- package/dist/api/resources/commons/errors/ConflictError.js +1 -1
- package/dist/api/resources/commons/errors/MessageNotFoundError.d.ts +2 -2
- package/dist/api/resources/commons/errors/MessageNotFoundError.js +1 -1
- package/dist/api/resources/commons/errors/NotFoundError.d.ts +2 -2
- package/dist/api/resources/commons/errors/NotFoundError.js +1 -1
- package/dist/api/resources/commons/errors/PaymentRequiredError.d.ts +2 -2
- package/dist/api/resources/commons/errors/PaymentRequiredError.js +1 -1
- package/dist/api/resources/commons/types/AlreadyExists.d.ts +1 -1
- package/dist/api/resources/commons/types/BadRequest.d.ts +1 -1
- package/dist/api/resources/commons/types/ChannelPreference.d.ts +1 -1
- package/dist/api/resources/commons/types/Conflict.d.ts +1 -1
- package/dist/api/resources/commons/types/MessageNotFound.d.ts +1 -1
- package/dist/api/resources/commons/types/NotFound.d.ts +1 -1
- package/dist/api/resources/commons/types/NotificationPreferenceDetails.d.ts +1 -1
- package/dist/api/resources/commons/types/NotificationPreferences.d.ts +1 -1
- package/dist/api/resources/commons/types/PaymentRequired.d.ts +1 -1
- package/dist/api/resources/commons/types/RecipientPreferences.d.ts +1 -1
- package/dist/api/resources/commons/types/UserTenantAssociation.d.ts +4 -3
- package/dist/api/resources/lists/client/Client.d.ts +197 -4
- package/dist/api/resources/lists/client/Client.js +236 -25
- package/dist/api/resources/lists/client/requests/AddSubscribersToList.d.ts +41 -0
- package/dist/api/resources/lists/client/requests/AddSubscribersToList.js +5 -0
- package/dist/api/resources/lists/client/requests/GetAllListsRequest.d.ts +7 -0
- package/dist/api/resources/lists/client/requests/GetSubscriptionForListRequest.d.ts +6 -0
- package/dist/api/resources/lists/client/requests/SubscribeUserToListRequest.d.ts +32 -1
- package/dist/api/resources/lists/client/requests/SubscribeUsersToListRequest.d.ts +41 -0
- package/dist/api/resources/lists/client/requests/SubscribeUsersToListRequest.js +5 -0
- package/dist/api/resources/lists/client/requests/index.d.ts +5 -3
- package/dist/api/resources/lists/types/ListGetAllResponse.d.ts +1 -1
- package/dist/api/resources/lists/types/ListGetSubscriptionsResponse.d.ts +1 -1
- package/dist/api/resources/lists/types/ListPutParams.d.ts +1 -1
- package/dist/api/resources/lists/types/ListSubscriptionRecipient.d.ts +1 -1
- package/dist/api/resources/lists/types/PutSubscriptionsRecipient.d.ts +1 -1
- package/dist/api/resources/messages/client/Client.d.ts +59 -2
- package/dist/api/resources/messages/client/Client.js +89 -28
- package/dist/api/resources/messages/client/requests/GetMessageHistoryRequest.d.ts +6 -0
- package/dist/api/resources/messages/client/requests/ListMessagesRequest.d.ts +19 -8
- package/dist/api/resources/messages/client/requests/index.d.ts +2 -2
- package/dist/api/resources/messages/types/ListMessagesResponse.d.ts +1 -1
- package/dist/api/resources/messages/types/MessageDetails.d.ts +1 -1
- package/dist/api/resources/messages/types/MessageHistoryResponse.d.ts +1 -2
- package/dist/api/resources/messages/types/RenderOutput.d.ts +1 -1
- package/dist/api/resources/messages/types/RenderOutputResponse.d.ts +1 -1
- package/dist/api/resources/messages/types/RenderedMessageContent.d.ts +1 -1
- package/dist/api/resources/notifications/client/Client.d.ts +113 -1
- package/dist/api/resources/notifications/client/Client.js +145 -17
- package/dist/api/resources/notifications/client/requests/NotificationDraftUpdateVariationsParams.d.ts +26 -1
- package/dist/api/resources/notifications/client/requests/NotificationListParams.d.ts +6 -0
- package/dist/api/resources/notifications/client/requests/NotificationUpdateVariationsParams.d.ts +26 -1
- package/dist/api/resources/notifications/client/requests/SubmissionChecksReplaceParams.d.ts +11 -1
- package/dist/api/resources/notifications/client/requests/index.d.ts +4 -4
- package/dist/api/resources/notifications/types/BaseCheck.d.ts +1 -1
- package/dist/api/resources/notifications/types/Check.d.ts +1 -1
- package/dist/api/resources/notifications/types/MessageRouting.d.ts +1 -1
- package/dist/api/resources/notifications/types/MessageRoutingChannel.d.ts +1 -1
- package/dist/api/resources/notifications/types/Notification.d.ts +5 -1
- package/dist/api/resources/notifications/types/NotificationBlock.d.ts +1 -1
- package/dist/api/resources/notifications/types/NotificationChannel.d.ts +1 -1
- package/dist/api/resources/notifications/types/NotificationContent.d.ts +1 -1
- package/dist/api/resources/notifications/types/NotificationGetContentResponse.d.ts +1 -1
- package/dist/api/resources/notifications/types/NotificationListResponse.d.ts +1 -1
- package/dist/api/resources/notifications/types/NotificationTag.d.ts +7 -0
- package/dist/api/resources/notifications/types/NotificationTag.js +5 -0
- package/dist/api/resources/notifications/types/NotificationTagData.d.ts +7 -0
- package/dist/api/resources/notifications/types/NotificationTagData.js +5 -0
- package/dist/api/resources/notifications/types/SubmissionChecksGetResponse.d.ts +1 -1
- package/dist/api/resources/notifications/types/SubmissionChecksReplaceResponse.d.ts +1 -1
- package/dist/api/resources/notifications/types/index.d.ts +2 -0
- package/dist/api/resources/notifications/types/index.js +2 -0
- package/dist/api/resources/profiles/client/Client.d.ts +71 -2
- package/dist/api/resources/profiles/client/Client.js +102 -23
- package/dist/api/resources/profiles/client/requests/GetListSubscriptionsRequest.d.ts +6 -0
- package/dist/api/resources/profiles/client/requests/MergeProfileRequest.d.ts +10 -0
- package/dist/api/resources/profiles/client/requests/ReplaceProfileRequest.d.ts +10 -0
- package/dist/api/resources/profiles/client/requests/index.d.ts +3 -3
- package/dist/api/resources/profiles/types/AirshipProfile.d.ts +1 -1
- package/dist/api/resources/profiles/types/Discord.d.ts +1 -1
- package/dist/api/resources/profiles/types/Expo.d.ts +1 -1
- package/dist/api/resources/profiles/types/GetListSubscriptionsList.d.ts +1 -1
- package/dist/api/resources/profiles/types/GetListSubscriptionsResponse.d.ts +1 -1
- package/dist/api/resources/profiles/types/Intercom.d.ts +1 -1
- package/dist/api/resources/profiles/types/MsTeams.d.ts +1 -1
- package/dist/api/resources/profiles/types/MultipleTokens.d.ts +1 -1
- package/dist/api/resources/profiles/types/ProfileGetResponse.d.ts +1 -1
- package/dist/api/resources/profiles/types/SendToMsTeamsChannelId.d.ts +1 -1
- package/dist/api/resources/profiles/types/SendToMsTeamsChannelName.d.ts +1 -1
- package/dist/api/resources/profiles/types/SendToMsTeamsConversationId.d.ts +1 -1
- package/dist/api/resources/profiles/types/SendToMsTeamsEmail.d.ts +1 -1
- package/dist/api/resources/profiles/types/SendToMsTeamsUserId.d.ts +1 -1
- package/dist/api/resources/profiles/types/SendToSlackChannel.d.ts +1 -1
- package/dist/api/resources/profiles/types/SendToSlackEmail.d.ts +1 -1
- package/dist/api/resources/profiles/types/SendToSlackUserId.d.ts +1 -1
- package/dist/api/resources/profiles/types/Slack.d.ts +1 -1
- package/dist/api/resources/profiles/types/SnoozeRule.d.ts +1 -1
- package/dist/api/resources/profiles/types/SubscribeToListsRequest.d.ts +1 -1
- package/dist/api/resources/profiles/types/SubscribeToListsRequestListObject.d.ts +1 -1
- package/dist/api/resources/profiles/types/UserProfile.d.ts +1 -1
- package/dist/api/resources/send/types/AudienceRecipient.d.ts +1 -1
- package/dist/api/resources/send/types/BaseMessage.d.ts +1 -1
- package/dist/api/resources/send/types/BaseMessageSendTo.d.ts +1 -1
- package/dist/api/resources/send/types/BrandSettingsEmail.d.ts +1 -1
- package/dist/api/resources/send/types/BrandSettingsInApp.d.ts +1 -1
- package/dist/api/resources/send/types/BrandSettingsSocialPresence.d.ts +1 -1
- package/dist/api/resources/send/types/BrandTemplateOverride.d.ts +1 -1
- package/dist/api/resources/send/types/Channel.d.ts +1 -1
- package/dist/api/resources/send/types/ChannelMetadata.d.ts +1 -1
- package/dist/api/resources/send/types/Content.d.ts +1 -1
- package/dist/api/resources/send/types/ContentMessage.d.ts +1 -1
- package/dist/api/resources/send/types/ElementalActionNode.d.ts +1 -1
- package/dist/api/resources/send/types/ElementalChannelNode.d.ts +1 -1
- package/dist/api/resources/send/types/ElementalContent.d.ts +1 -1
- package/dist/api/resources/send/types/ElementalDividerNode.d.ts +1 -1
- package/dist/api/resources/send/types/ElementalGroupNode.d.ts +1 -1
- package/dist/api/resources/send/types/ElementalImageNode.d.ts +1 -1
- package/dist/api/resources/send/types/ElementalMetaNode.d.ts +1 -1
- package/dist/api/resources/send/types/ElementalNode.d.ts +1 -1
- package/dist/api/resources/send/types/ElementalQuoteNode.d.ts +1 -1
- package/dist/api/resources/send/types/ElementalTextNode.d.ts +1 -1
- package/dist/api/resources/send/types/EmailHeader.d.ts +1 -1
- package/dist/api/resources/send/types/Expiry.d.ts +1 -1
- package/dist/api/resources/send/types/IPreferences.d.ts +1 -1
- package/dist/api/resources/send/types/IProfilePreferences.d.ts +1 -1
- package/dist/api/resources/send/types/ListPatternRecipient.d.ts +1 -1
- package/dist/api/resources/send/types/ListRecipient.d.ts +1 -1
- package/dist/api/resources/send/types/Locales.d.ts +1 -1
- package/dist/api/resources/send/types/Message.d.ts +1 -1
- package/dist/api/resources/send/types/MessageChannelEmailOverride.d.ts +1 -1
- package/dist/api/resources/send/types/MessageChannels.d.ts +1 -1
- package/dist/api/resources/send/types/MessageMetadata.d.ts +1 -1
- package/dist/api/resources/send/types/MessageProviders.d.ts +1 -1
- package/dist/api/resources/send/types/MessageProvidersType.d.ts +1 -1
- package/dist/api/resources/send/types/MessageRecipient.d.ts +1 -1
- package/dist/api/resources/send/types/Metadata.d.ts +1 -1
- package/dist/api/resources/send/types/MsTeamsRecipient.d.ts +1 -1
- package/dist/api/resources/send/types/Preference.d.ts +1 -1
- package/dist/api/resources/send/types/Recipient.d.ts +1 -1
- package/dist/api/resources/send/types/Routing.d.ts +1 -1
- package/dist/api/resources/send/types/RoutingChannel.d.ts +1 -1
- package/dist/api/resources/send/types/RoutingStrategyChannel.d.ts +1 -1
- package/dist/api/resources/send/types/RoutingStrategyProvider.d.ts +1 -1
- package/dist/api/resources/send/types/SlackRecipient.d.ts +1 -1
- package/dist/api/resources/send/types/TemplateMessage.d.ts +1 -1
- package/dist/api/resources/send/types/Timeout.d.ts +1 -1
- package/dist/api/resources/send/types/UserRecipient.d.ts +1 -1
- package/dist/api/resources/templates/client/Client.d.ts +9 -1
- package/dist/api/resources/templates/client/Client.js +13 -3
- package/dist/api/resources/templates/client/requests/ListTemplatesRequest.d.ts +6 -0
- package/dist/api/resources/templates/client/requests/index.d.ts +1 -1
- package/dist/api/resources/templates/types/ListTemplatesResponse.d.ts +1 -1
- package/dist/api/resources/templates/types/NotificationTemplates.d.ts +1 -1
- package/dist/api/resources/templates/types/RoutingStrategy.d.ts +1 -1
- package/dist/api/resources/templates/types/Tag.d.ts +1 -1
- package/dist/api/resources/tenants/client/Client.d.ts +82 -1
- package/dist/api/resources/tenants/client/Client.js +190 -13
- package/dist/api/resources/tenants/client/requests/ListTenantParams.d.ts +13 -1
- package/dist/api/resources/tenants/client/requests/ListUsersForTenantParams.d.ts +7 -0
- package/dist/api/resources/tenants/client/requests/TenantCreateOrReplaceParams.d.ts +23 -2
- package/dist/api/resources/tenants/client/requests/index.d.ts +3 -3
- package/dist/api/resources/tenants/types/DefaultPreferences.d.ts +2 -2
- package/dist/api/resources/tenants/types/ListUsersForTenantResponse.d.ts +1 -1
- package/dist/api/resources/tenants/types/SubscriptionTopic.d.ts +2 -3
- package/dist/api/resources/tenants/types/SubscriptionTopicNew.d.ts +11 -0
- package/dist/api/resources/tenants/types/SubscriptionTopicNew.js +5 -0
- package/dist/api/resources/tenants/types/TemplateProperty.d.ts +3 -0
- package/dist/api/resources/tenants/types/Tenant.d.ts +2 -2
- package/dist/api/resources/tenants/types/TenantListResponse.d.ts +1 -1
- package/dist/api/resources/tenants/types/index.d.ts +1 -0
- package/dist/api/resources/tenants/types/index.js +1 -0
- package/dist/api/resources/translations/client/Client.d.ts +17 -0
- package/dist/api/resources/translations/client/Client.js +28 -7
- package/dist/api/resources/users/resources/preferences/client/Client.d.ts +22 -1
- package/dist/api/resources/users/resources/preferences/client/Client.js +36 -9
- package/dist/api/resources/users/resources/preferences/client/requests/UserPreferencesUpdateParams.d.ts +1 -1
- package/dist/api/resources/users/resources/preferences/client/requests/index.d.ts +1 -1
- package/dist/api/resources/users/resources/preferences/types/TopicPreference.d.ts +1 -1
- package/dist/api/resources/users/resources/preferences/types/TopicPreferenceUpdate.d.ts +1 -1
- package/dist/api/resources/users/resources/preferences/types/UserPreferencesGetResponse.d.ts +1 -1
- package/dist/api/resources/users/resources/preferences/types/UserPreferencesListResponse.d.ts +1 -1
- package/dist/api/resources/users/resources/tenants/client/Client.d.ts +57 -2
- package/dist/api/resources/users/resources/tenants/client/Client.js +78 -13
- package/dist/api/resources/users/resources/tenants/client/requests/AddUserToMultipleTenantsParams.d.ts +16 -1
- package/dist/api/resources/users/resources/tenants/client/requests/AddUserToSingleTenantsParams.d.ts +11 -2
- package/dist/api/resources/users/resources/tenants/client/requests/ListTenantsForUserParams.d.ts +7 -0
- package/dist/api/resources/users/resources/tenants/client/requests/index.d.ts +3 -3
- package/dist/api/resources/users/resources/tenants/types/AddUserToSingleTenantsParamsProfile.d.ts +3 -0
- package/dist/api/resources/users/resources/tenants/types/ListTenantsForUserResponse.d.ts +1 -1
- package/dist/api/resources/users/resources/tokens/client/Client.d.ts +73 -1
- package/dist/api/resources/users/resources/tokens/client/Client.js +136 -13
- package/dist/api/resources/users/resources/tokens/types/GetAllTokensResponse.d.ts +1 -1
- package/dist/api/resources/users/resources/tokens/types/GetUserTokenResponse.d.ts +1 -1
- package/dist/api/resources/users/resources/tokens/types/PatchUserTokenOpts.d.ts +1 -1
- package/dist/api/resources/users/resources/tokens/types/PutUserTokenOpts.d.ts +1 -1
- package/dist/api/resources/users/resources/tokens/types/PutUserTokensOpts.d.ts +1 -1
- package/dist/api/resources/users/resources/tokens/types/UserToken.d.ts +1 -1
- package/dist/core/fetcher/Fetcher.d.ts +2 -2
- package/dist/core/fetcher/Fetcher.js +60 -6
- package/dist/core/index.d.ts +1 -0
- package/dist/core/index.js +1 -0
- package/dist/core/runtime/index.d.ts +1 -0
- package/dist/core/runtime/index.js +5 -0
- package/dist/core/runtime/runtime.d.ts +8 -0
- package/dist/core/runtime/runtime.js +82 -0
- package/jest.config.js +2 -2
- package/package.json +8 -6
- package/tests/client.test.ts +0 -11
|
@@ -41,28 +41,38 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
41
41
|
exports.Translations = void 0;
|
|
42
42
|
const environments = __importStar(require("../../../../environments"));
|
|
43
43
|
const core = __importStar(require("../../../../core"));
|
|
44
|
-
const Courier = __importStar(require("
|
|
44
|
+
const Courier = __importStar(require("../../../index"));
|
|
45
45
|
const url_join_1 = __importDefault(require("url-join"));
|
|
46
|
-
const errors = __importStar(require("../../../../errors"));
|
|
46
|
+
const errors = __importStar(require("../../../../errors/index"));
|
|
47
47
|
class Translations {
|
|
48
48
|
constructor(_options = {}) {
|
|
49
49
|
this._options = _options;
|
|
50
50
|
}
|
|
51
51
|
/**
|
|
52
52
|
* Get translations by locale
|
|
53
|
+
*
|
|
54
|
+
* @param {string} domain - The domain you want to retrieve translations for. Only `default` is supported at the moment
|
|
55
|
+
* @param {string} locale - The locale you want to retrieve the translations for
|
|
56
|
+
* @param {Translations.RequestOptions} requestOptions - Request-specific configuration.
|
|
57
|
+
*
|
|
53
58
|
* @throws {@link Courier.NotFoundError}
|
|
59
|
+
*
|
|
60
|
+
* @example
|
|
61
|
+
* await courier.translations.get("string", "string")
|
|
54
62
|
*/
|
|
55
63
|
get(domain, locale, requestOptions) {
|
|
56
64
|
var _a, _b;
|
|
57
65
|
return __awaiter(this, void 0, void 0, function* () {
|
|
58
66
|
const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
|
|
59
|
-
url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/translations/${domain}/${locale}`),
|
|
67
|
+
url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/translations/${encodeURIComponent(domain)}/${encodeURIComponent(locale)}`),
|
|
60
68
|
method: "GET",
|
|
61
69
|
headers: {
|
|
62
70
|
Authorization: yield this._getAuthorizationHeader(),
|
|
63
71
|
"X-Fern-Language": "JavaScript",
|
|
64
72
|
"X-Fern-SDK-Name": "@trycourier/courier",
|
|
65
|
-
"X-Fern-SDK-Version": "v6.1.
|
|
73
|
+
"X-Fern-SDK-Version": "v6.1.3",
|
|
74
|
+
"X-Fern-Runtime": core.RUNTIME.type,
|
|
75
|
+
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
66
76
|
},
|
|
67
77
|
contentType: "application/json",
|
|
68
78
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -99,19 +109,30 @@ class Translations {
|
|
|
99
109
|
}
|
|
100
110
|
/**
|
|
101
111
|
* Update a translation
|
|
112
|
+
*
|
|
113
|
+
* @param {string} domain - The domain you want to retrieve translations for. Only `default` is supported at the moment
|
|
114
|
+
* @param {string} locale - The locale you want to retrieve the translations for
|
|
115
|
+
* @param {string} request
|
|
116
|
+
* @param {Translations.RequestOptions} requestOptions - Request-specific configuration.
|
|
117
|
+
*
|
|
102
118
|
* @throws {@link Courier.NotFoundError}
|
|
119
|
+
*
|
|
120
|
+
* @example
|
|
121
|
+
* await courier.translations.update("string", "string", "string")
|
|
103
122
|
*/
|
|
104
123
|
update(domain, locale, request, requestOptions) {
|
|
105
124
|
var _a, _b;
|
|
106
125
|
return __awaiter(this, void 0, void 0, function* () {
|
|
107
126
|
const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
|
|
108
|
-
url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/translations/${domain}/${locale}`),
|
|
127
|
+
url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/translations/${encodeURIComponent(domain)}/${encodeURIComponent(locale)}`),
|
|
109
128
|
method: "PUT",
|
|
110
129
|
headers: {
|
|
111
130
|
Authorization: yield this._getAuthorizationHeader(),
|
|
112
131
|
"X-Fern-Language": "JavaScript",
|
|
113
132
|
"X-Fern-SDK-Name": "@trycourier/courier",
|
|
114
|
-
"X-Fern-SDK-Version": "v6.1.
|
|
133
|
+
"X-Fern-SDK-Version": "v6.1.3",
|
|
134
|
+
"X-Fern-Runtime": core.RUNTIME.type,
|
|
135
|
+
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
115
136
|
},
|
|
116
137
|
contentType: "application/json",
|
|
117
138
|
body: request,
|
|
@@ -150,7 +171,7 @@ class Translations {
|
|
|
150
171
|
_getAuthorizationHeader() {
|
|
151
172
|
var _a;
|
|
152
173
|
return __awaiter(this, void 0, void 0, function* () {
|
|
153
|
-
const bearer = (_a = (yield core.Supplier.get(this._options.authorizationToken))) !== null && _a !== void 0 ? _a : process.env["COURIER_AUTH_TOKEN"];
|
|
174
|
+
const bearer = (_a = (yield core.Supplier.get(this._options.authorizationToken))) !== null && _a !== void 0 ? _a : process === null || process === void 0 ? void 0 : process.env["COURIER_AUTH_TOKEN"];
|
|
154
175
|
if (bearer == null) {
|
|
155
176
|
throw new errors.CourierError({
|
|
156
177
|
message: "Please specify COURIER_AUTH_TOKEN when instantiating the client.",
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
import * as environments from "../../../../../../environments";
|
|
5
5
|
import * as core from "../../../../../../core";
|
|
6
|
-
import * as Courier from "
|
|
6
|
+
import * as Courier from "../../../../../index";
|
|
7
7
|
export declare namespace Preferences {
|
|
8
8
|
interface Options {
|
|
9
9
|
environment?: core.Supplier<environments.CourierEnvironment | string>;
|
|
@@ -20,16 +20,37 @@ export declare class Preferences {
|
|
|
20
20
|
constructor(_options?: Preferences.Options);
|
|
21
21
|
/**
|
|
22
22
|
* Fetch all user preferences.
|
|
23
|
+
*
|
|
24
|
+
* @param {string} userId - A unique identifier associated with the user whose preferences you wish to retrieve.
|
|
25
|
+
* @param {Preferences.RequestOptions} requestOptions - Request-specific configuration.
|
|
26
|
+
*
|
|
23
27
|
* @throws {@link Courier.BadRequestError}
|
|
28
|
+
*
|
|
29
|
+
* @example
|
|
30
|
+
* await courier.users.preferences.list("string")
|
|
24
31
|
*/
|
|
25
32
|
list(userId: string, requestOptions?: Preferences.RequestOptions): Promise<Courier.users.UserPreferencesListResponse>;
|
|
26
33
|
/**
|
|
27
34
|
* Fetch user preferences for a specific subscription topic.
|
|
35
|
+
*
|
|
36
|
+
* @param {string} userId - A unique identifier associated with the user whose preferences you wish to retrieve.
|
|
37
|
+
* @param {string} topicId - A unique identifier associated with a subscription topic.
|
|
38
|
+
* @param {Preferences.RequestOptions} requestOptions - Request-specific configuration.
|
|
39
|
+
*
|
|
28
40
|
* @throws {@link Courier.NotFoundError}
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* await courier.users.preferences.get("string", "string")
|
|
29
44
|
*/
|
|
30
45
|
get(userId: string, topicId: string, requestOptions?: Preferences.RequestOptions): Promise<Courier.users.UserPreferencesGetResponse>;
|
|
31
46
|
/**
|
|
32
47
|
* Update or Create user preferences for a specific subscription topic.
|
|
48
|
+
*
|
|
49
|
+
* @param {string} userId - A unique identifier associated with the user whose preferences you wish to retrieve.
|
|
50
|
+
* @param {string} topicId - A unique identifier associated with a subscription topic.
|
|
51
|
+
* @param {Courier.users.UserPreferencesUpdateParams} request
|
|
52
|
+
* @param {Preferences.RequestOptions} requestOptions - Request-specific configuration.
|
|
53
|
+
*
|
|
33
54
|
* @throws {@link Courier.BadRequestError}
|
|
34
55
|
*
|
|
35
56
|
* @example
|
|
@@ -41,28 +41,37 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
41
41
|
exports.Preferences = void 0;
|
|
42
42
|
const environments = __importStar(require("../../../../../../environments"));
|
|
43
43
|
const core = __importStar(require("../../../../../../core"));
|
|
44
|
-
const Courier = __importStar(require("
|
|
44
|
+
const Courier = __importStar(require("../../../../../index"));
|
|
45
45
|
const url_join_1 = __importDefault(require("url-join"));
|
|
46
|
-
const errors = __importStar(require("../../../../../../errors"));
|
|
46
|
+
const errors = __importStar(require("../../../../../../errors/index"));
|
|
47
47
|
class Preferences {
|
|
48
48
|
constructor(_options = {}) {
|
|
49
49
|
this._options = _options;
|
|
50
50
|
}
|
|
51
51
|
/**
|
|
52
52
|
* Fetch all user preferences.
|
|
53
|
+
*
|
|
54
|
+
* @param {string} userId - A unique identifier associated with the user whose preferences you wish to retrieve.
|
|
55
|
+
* @param {Preferences.RequestOptions} requestOptions - Request-specific configuration.
|
|
56
|
+
*
|
|
53
57
|
* @throws {@link Courier.BadRequestError}
|
|
58
|
+
*
|
|
59
|
+
* @example
|
|
60
|
+
* await courier.users.preferences.list("string")
|
|
54
61
|
*/
|
|
55
62
|
list(userId, requestOptions) {
|
|
56
63
|
var _a, _b;
|
|
57
64
|
return __awaiter(this, void 0, void 0, function* () {
|
|
58
65
|
const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
|
|
59
|
-
url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/users/${userId}/preferences`),
|
|
66
|
+
url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/users/${encodeURIComponent(userId)}/preferences`),
|
|
60
67
|
method: "GET",
|
|
61
68
|
headers: {
|
|
62
69
|
Authorization: yield this._getAuthorizationHeader(),
|
|
63
70
|
"X-Fern-Language": "JavaScript",
|
|
64
71
|
"X-Fern-SDK-Name": "@trycourier/courier",
|
|
65
|
-
"X-Fern-SDK-Version": "v6.1.
|
|
72
|
+
"X-Fern-SDK-Version": "v6.1.3",
|
|
73
|
+
"X-Fern-Runtime": core.RUNTIME.type,
|
|
74
|
+
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
66
75
|
},
|
|
67
76
|
contentType: "application/json",
|
|
68
77
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -99,19 +108,29 @@ class Preferences {
|
|
|
99
108
|
}
|
|
100
109
|
/**
|
|
101
110
|
* Fetch user preferences for a specific subscription topic.
|
|
111
|
+
*
|
|
112
|
+
* @param {string} userId - A unique identifier associated with the user whose preferences you wish to retrieve.
|
|
113
|
+
* @param {string} topicId - A unique identifier associated with a subscription topic.
|
|
114
|
+
* @param {Preferences.RequestOptions} requestOptions - Request-specific configuration.
|
|
115
|
+
*
|
|
102
116
|
* @throws {@link Courier.NotFoundError}
|
|
117
|
+
*
|
|
118
|
+
* @example
|
|
119
|
+
* await courier.users.preferences.get("string", "string")
|
|
103
120
|
*/
|
|
104
121
|
get(userId, topicId, requestOptions) {
|
|
105
122
|
var _a, _b;
|
|
106
123
|
return __awaiter(this, void 0, void 0, function* () {
|
|
107
124
|
const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
|
|
108
|
-
url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/users/${userId}/preferences/${topicId}`),
|
|
125
|
+
url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/users/${encodeURIComponent(userId)}/preferences/${encodeURIComponent(topicId)}`),
|
|
109
126
|
method: "GET",
|
|
110
127
|
headers: {
|
|
111
128
|
Authorization: yield this._getAuthorizationHeader(),
|
|
112
129
|
"X-Fern-Language": "JavaScript",
|
|
113
130
|
"X-Fern-SDK-Name": "@trycourier/courier",
|
|
114
|
-
"X-Fern-SDK-Version": "v6.1.
|
|
131
|
+
"X-Fern-SDK-Version": "v6.1.3",
|
|
132
|
+
"X-Fern-Runtime": core.RUNTIME.type,
|
|
133
|
+
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
115
134
|
},
|
|
116
135
|
contentType: "application/json",
|
|
117
136
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -148,6 +167,12 @@ class Preferences {
|
|
|
148
167
|
}
|
|
149
168
|
/**
|
|
150
169
|
* Update or Create user preferences for a specific subscription topic.
|
|
170
|
+
*
|
|
171
|
+
* @param {string} userId - A unique identifier associated with the user whose preferences you wish to retrieve.
|
|
172
|
+
* @param {string} topicId - A unique identifier associated with a subscription topic.
|
|
173
|
+
* @param {Courier.users.UserPreferencesUpdateParams} request
|
|
174
|
+
* @param {Preferences.RequestOptions} requestOptions - Request-specific configuration.
|
|
175
|
+
*
|
|
151
176
|
* @throws {@link Courier.BadRequestError}
|
|
152
177
|
*
|
|
153
178
|
* @example
|
|
@@ -163,13 +188,15 @@ class Preferences {
|
|
|
163
188
|
var _a, _b;
|
|
164
189
|
return __awaiter(this, void 0, void 0, function* () {
|
|
165
190
|
const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
|
|
166
|
-
url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/users/${userId}/preferences/${topicId}`),
|
|
191
|
+
url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/users/${encodeURIComponent(userId)}/preferences/${encodeURIComponent(topicId)}`),
|
|
167
192
|
method: "PUT",
|
|
168
193
|
headers: {
|
|
169
194
|
Authorization: yield this._getAuthorizationHeader(),
|
|
170
195
|
"X-Fern-Language": "JavaScript",
|
|
171
196
|
"X-Fern-SDK-Name": "@trycourier/courier",
|
|
172
|
-
"X-Fern-SDK-Version": "v6.1.
|
|
197
|
+
"X-Fern-SDK-Version": "v6.1.3",
|
|
198
|
+
"X-Fern-Runtime": core.RUNTIME.type,
|
|
199
|
+
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
173
200
|
},
|
|
174
201
|
contentType: "application/json",
|
|
175
202
|
body: request,
|
|
@@ -208,7 +235,7 @@ class Preferences {
|
|
|
208
235
|
_getAuthorizationHeader() {
|
|
209
236
|
var _a;
|
|
210
237
|
return __awaiter(this, void 0, void 0, function* () {
|
|
211
|
-
const bearer = (_a = (yield core.Supplier.get(this._options.authorizationToken))) !== null && _a !== void 0 ? _a : process.env["COURIER_AUTH_TOKEN"];
|
|
238
|
+
const bearer = (_a = (yield core.Supplier.get(this._options.authorizationToken))) !== null && _a !== void 0 ? _a : process === null || process === void 0 ? void 0 : process.env["COURIER_AUTH_TOKEN"];
|
|
212
239
|
if (bearer == null) {
|
|
213
240
|
throw new errors.CourierError({
|
|
214
241
|
message: "Please specify COURIER_AUTH_TOKEN when instantiating the client.",
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export { UserPreferencesUpdateParams } from "./UserPreferencesUpdateParams";
|
|
1
|
+
export { type UserPreferencesUpdateParams } from "./UserPreferencesUpdateParams";
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
|
-
import * as Courier from "
|
|
4
|
+
import * as Courier from "../../../../../index";
|
|
5
5
|
export interface TopicPreference {
|
|
6
6
|
/** The Channels a user has chosen to receive notifications through for this topic */
|
|
7
7
|
custom_routing?: Courier.ChannelClassification[];
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
|
-
import * as Courier from "
|
|
4
|
+
import * as Courier from "../../../../../index";
|
|
5
5
|
export interface TopicPreferenceUpdate {
|
|
6
6
|
status: Courier.PreferenceStatus;
|
|
7
7
|
/** The Channels a user has chosen to receive notifications through for this topic */
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
|
-
import * as Courier from "
|
|
4
|
+
import * as Courier from "../../../../../index";
|
|
5
5
|
export interface UserPreferencesListResponse {
|
|
6
6
|
paging: Courier.Paging;
|
|
7
7
|
/** The Preferences associated with the user_id. */
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
import * as environments from "../../../../../../environments";
|
|
5
5
|
import * as core from "../../../../../../core";
|
|
6
|
-
import * as Courier from "
|
|
6
|
+
import * as Courier from "../../../../../index";
|
|
7
7
|
export declare namespace Tenants {
|
|
8
8
|
interface Options {
|
|
9
9
|
environment?: core.Supplier<environments.CourierEnvironment | string>;
|
|
@@ -24,6 +24,24 @@ export declare class Tenants {
|
|
|
24
24
|
* A custom profile can also be supplied for each tenant.
|
|
25
25
|
* This profile will be merged with the user's main
|
|
26
26
|
* profile when sending to the user with that tenant.
|
|
27
|
+
*
|
|
28
|
+
* @param {string} userId - The user's ID. This can be any uniquely identifiable string.
|
|
29
|
+
* @param {Courier.users.AddUserToMultipleTenantsParams} request
|
|
30
|
+
* @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* await courier.users.tenants.addMultple("string", {
|
|
34
|
+
* tenants: [{
|
|
35
|
+
* user_id: "string",
|
|
36
|
+
* type: "user",
|
|
37
|
+
* tenant_id: "string",
|
|
38
|
+
* profile: {
|
|
39
|
+
* "string": {
|
|
40
|
+
* "key": "value"
|
|
41
|
+
* }
|
|
42
|
+
* }
|
|
43
|
+
* }]
|
|
44
|
+
* })
|
|
27
45
|
*/
|
|
28
46
|
addMultple(userId: string, request: Courier.users.AddUserToMultipleTenantsParams, requestOptions?: Tenants.RequestOptions): Promise<void>;
|
|
29
47
|
/**
|
|
@@ -32,18 +50,55 @@ export declare class Tenants {
|
|
|
32
50
|
* A custom profile can also be supplied with the tenant.
|
|
33
51
|
* This profile will be merged with the user's main profile
|
|
34
52
|
* when sending to the user with that tenant.
|
|
53
|
+
*
|
|
54
|
+
* @param {string} userId - Id of the user to be added to the supplied tenant.
|
|
55
|
+
* @param {string} tenantId - Id of the tenant the user should be added to.
|
|
56
|
+
* @param {Courier.users.AddUserToSingleTenantsParams} request
|
|
57
|
+
* @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
|
|
58
|
+
*
|
|
59
|
+
* @example
|
|
60
|
+
* await courier.users.tenants.add("string", "string", {
|
|
61
|
+
* profile: {
|
|
62
|
+
* "string": {
|
|
63
|
+
* "key": "value"
|
|
64
|
+
* }
|
|
65
|
+
* }
|
|
66
|
+
* })
|
|
35
67
|
*/
|
|
36
|
-
add(userId: string, tenantId: string, request
|
|
68
|
+
add(userId: string, tenantId: string, request?: Courier.users.AddUserToSingleTenantsParams, requestOptions?: Tenants.RequestOptions): Promise<void>;
|
|
37
69
|
/**
|
|
38
70
|
* Removes a user from any tenants they may have been associated with.
|
|
71
|
+
*
|
|
72
|
+
* @param {string} userId - Id of the user to be removed from the supplied tenant.
|
|
73
|
+
* @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
|
|
74
|
+
*
|
|
75
|
+
* @example
|
|
76
|
+
* await courier.users.tenants.removeAll("string")
|
|
39
77
|
*/
|
|
40
78
|
removeAll(userId: string, requestOptions?: Tenants.RequestOptions): Promise<void>;
|
|
41
79
|
/**
|
|
42
80
|
* Removes a user from the supplied tenant.
|
|
81
|
+
*
|
|
82
|
+
* @param {string} userId - Id of the user to be removed from the supplied tenant.
|
|
83
|
+
* @param {string} tenantId - Id of the tenant the user should be removed from.
|
|
84
|
+
* @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
|
|
85
|
+
*
|
|
86
|
+
* @example
|
|
87
|
+
* await courier.users.tenants.remove("string", "string")
|
|
43
88
|
*/
|
|
44
89
|
remove(userId: string, tenantId: string, requestOptions?: Tenants.RequestOptions): Promise<void>;
|
|
45
90
|
/**
|
|
46
91
|
* Returns a paginated list of user tenant associations.
|
|
92
|
+
*
|
|
93
|
+
* @param {string} userId - Id of the user to retrieve all associated tenants for.
|
|
94
|
+
* @param {Courier.users.ListTenantsForUserParams} request
|
|
95
|
+
* @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
|
|
96
|
+
*
|
|
97
|
+
* @example
|
|
98
|
+
* await courier.users.tenants.list("string", {
|
|
99
|
+
* limit: 1,
|
|
100
|
+
* cursor: "string"
|
|
101
|
+
* })
|
|
47
102
|
*/
|
|
48
103
|
list(userId: string, request?: Courier.users.ListTenantsForUserParams, requestOptions?: Tenants.RequestOptions): Promise<Courier.users.ListTenantsForUserResponse>;
|
|
49
104
|
protected _getAuthorizationHeader(): Promise<string>;
|
|
@@ -42,7 +42,7 @@ exports.Tenants = void 0;
|
|
|
42
42
|
const environments = __importStar(require("../../../../../../environments"));
|
|
43
43
|
const core = __importStar(require("../../../../../../core"));
|
|
44
44
|
const url_join_1 = __importDefault(require("url-join"));
|
|
45
|
-
const errors = __importStar(require("../../../../../../errors"));
|
|
45
|
+
const errors = __importStar(require("../../../../../../errors/index"));
|
|
46
46
|
class Tenants {
|
|
47
47
|
constructor(_options = {}) {
|
|
48
48
|
this._options = _options;
|
|
@@ -53,18 +53,38 @@ class Tenants {
|
|
|
53
53
|
* A custom profile can also be supplied for each tenant.
|
|
54
54
|
* This profile will be merged with the user's main
|
|
55
55
|
* profile when sending to the user with that tenant.
|
|
56
|
+
*
|
|
57
|
+
* @param {string} userId - The user's ID. This can be any uniquely identifiable string.
|
|
58
|
+
* @param {Courier.users.AddUserToMultipleTenantsParams} request
|
|
59
|
+
* @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
|
|
60
|
+
*
|
|
61
|
+
* @example
|
|
62
|
+
* await courier.users.tenants.addMultple("string", {
|
|
63
|
+
* tenants: [{
|
|
64
|
+
* user_id: "string",
|
|
65
|
+
* type: "user",
|
|
66
|
+
* tenant_id: "string",
|
|
67
|
+
* profile: {
|
|
68
|
+
* "string": {
|
|
69
|
+
* "key": "value"
|
|
70
|
+
* }
|
|
71
|
+
* }
|
|
72
|
+
* }]
|
|
73
|
+
* })
|
|
56
74
|
*/
|
|
57
75
|
addMultple(userId, request, requestOptions) {
|
|
58
76
|
var _a, _b;
|
|
59
77
|
return __awaiter(this, void 0, void 0, function* () {
|
|
60
78
|
const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
|
|
61
|
-
url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `users/${userId}/tenants`),
|
|
79
|
+
url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `users/${encodeURIComponent(userId)}/tenants`),
|
|
62
80
|
method: "PUT",
|
|
63
81
|
headers: {
|
|
64
82
|
Authorization: yield this._getAuthorizationHeader(),
|
|
65
83
|
"X-Fern-Language": "JavaScript",
|
|
66
84
|
"X-Fern-SDK-Name": "@trycourier/courier",
|
|
67
|
-
"X-Fern-SDK-Version": "v6.1.
|
|
85
|
+
"X-Fern-SDK-Version": "v6.1.3",
|
|
86
|
+
"X-Fern-Runtime": core.RUNTIME.type,
|
|
87
|
+
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
68
88
|
},
|
|
69
89
|
contentType: "application/json",
|
|
70
90
|
body: request,
|
|
@@ -101,18 +121,34 @@ class Tenants {
|
|
|
101
121
|
* A custom profile can also be supplied with the tenant.
|
|
102
122
|
* This profile will be merged with the user's main profile
|
|
103
123
|
* when sending to the user with that tenant.
|
|
124
|
+
*
|
|
125
|
+
* @param {string} userId - Id of the user to be added to the supplied tenant.
|
|
126
|
+
* @param {string} tenantId - Id of the tenant the user should be added to.
|
|
127
|
+
* @param {Courier.users.AddUserToSingleTenantsParams} request
|
|
128
|
+
* @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
|
|
129
|
+
*
|
|
130
|
+
* @example
|
|
131
|
+
* await courier.users.tenants.add("string", "string", {
|
|
132
|
+
* profile: {
|
|
133
|
+
* "string": {
|
|
134
|
+
* "key": "value"
|
|
135
|
+
* }
|
|
136
|
+
* }
|
|
137
|
+
* })
|
|
104
138
|
*/
|
|
105
|
-
add(userId, tenantId, request, requestOptions) {
|
|
139
|
+
add(userId, tenantId, request = {}, requestOptions) {
|
|
106
140
|
var _a, _b;
|
|
107
141
|
return __awaiter(this, void 0, void 0, function* () {
|
|
108
142
|
const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
|
|
109
|
-
url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `users/${userId}/tenants/${tenantId}`),
|
|
143
|
+
url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `users/${encodeURIComponent(userId)}/tenants/${encodeURIComponent(tenantId)}`),
|
|
110
144
|
method: "PUT",
|
|
111
145
|
headers: {
|
|
112
146
|
Authorization: yield this._getAuthorizationHeader(),
|
|
113
147
|
"X-Fern-Language": "JavaScript",
|
|
114
148
|
"X-Fern-SDK-Name": "@trycourier/courier",
|
|
115
|
-
"X-Fern-SDK-Version": "v6.1.
|
|
149
|
+
"X-Fern-SDK-Version": "v6.1.3",
|
|
150
|
+
"X-Fern-Runtime": core.RUNTIME.type,
|
|
151
|
+
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
116
152
|
},
|
|
117
153
|
contentType: "application/json",
|
|
118
154
|
body: request,
|
|
@@ -145,18 +181,26 @@ class Tenants {
|
|
|
145
181
|
}
|
|
146
182
|
/**
|
|
147
183
|
* Removes a user from any tenants they may have been associated with.
|
|
184
|
+
*
|
|
185
|
+
* @param {string} userId - Id of the user to be removed from the supplied tenant.
|
|
186
|
+
* @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
|
|
187
|
+
*
|
|
188
|
+
* @example
|
|
189
|
+
* await courier.users.tenants.removeAll("string")
|
|
148
190
|
*/
|
|
149
191
|
removeAll(userId, requestOptions) {
|
|
150
192
|
var _a, _b;
|
|
151
193
|
return __awaiter(this, void 0, void 0, function* () {
|
|
152
194
|
const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
|
|
153
|
-
url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `users/${userId}/tenants`),
|
|
195
|
+
url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `users/${encodeURIComponent(userId)}/tenants`),
|
|
154
196
|
method: "DELETE",
|
|
155
197
|
headers: {
|
|
156
198
|
Authorization: yield this._getAuthorizationHeader(),
|
|
157
199
|
"X-Fern-Language": "JavaScript",
|
|
158
200
|
"X-Fern-SDK-Name": "@trycourier/courier",
|
|
159
|
-
"X-Fern-SDK-Version": "v6.1.
|
|
201
|
+
"X-Fern-SDK-Version": "v6.1.3",
|
|
202
|
+
"X-Fern-Runtime": core.RUNTIME.type,
|
|
203
|
+
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
160
204
|
},
|
|
161
205
|
contentType: "application/json",
|
|
162
206
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -188,18 +232,27 @@ class Tenants {
|
|
|
188
232
|
}
|
|
189
233
|
/**
|
|
190
234
|
* Removes a user from the supplied tenant.
|
|
235
|
+
*
|
|
236
|
+
* @param {string} userId - Id of the user to be removed from the supplied tenant.
|
|
237
|
+
* @param {string} tenantId - Id of the tenant the user should be removed from.
|
|
238
|
+
* @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
|
|
239
|
+
*
|
|
240
|
+
* @example
|
|
241
|
+
* await courier.users.tenants.remove("string", "string")
|
|
191
242
|
*/
|
|
192
243
|
remove(userId, tenantId, requestOptions) {
|
|
193
244
|
var _a, _b;
|
|
194
245
|
return __awaiter(this, void 0, void 0, function* () {
|
|
195
246
|
const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
|
|
196
|
-
url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `users/${userId}/tenants/${tenantId}`),
|
|
247
|
+
url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `users/${encodeURIComponent(userId)}/tenants/${encodeURIComponent(tenantId)}`),
|
|
197
248
|
method: "DELETE",
|
|
198
249
|
headers: {
|
|
199
250
|
Authorization: yield this._getAuthorizationHeader(),
|
|
200
251
|
"X-Fern-Language": "JavaScript",
|
|
201
252
|
"X-Fern-SDK-Name": "@trycourier/courier",
|
|
202
|
-
"X-Fern-SDK-Version": "v6.1.
|
|
253
|
+
"X-Fern-SDK-Version": "v6.1.3",
|
|
254
|
+
"X-Fern-Runtime": core.RUNTIME.type,
|
|
255
|
+
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
203
256
|
},
|
|
204
257
|
contentType: "application/json",
|
|
205
258
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -231,6 +284,16 @@ class Tenants {
|
|
|
231
284
|
}
|
|
232
285
|
/**
|
|
233
286
|
* Returns a paginated list of user tenant associations.
|
|
287
|
+
*
|
|
288
|
+
* @param {string} userId - Id of the user to retrieve all associated tenants for.
|
|
289
|
+
* @param {Courier.users.ListTenantsForUserParams} request
|
|
290
|
+
* @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
|
|
291
|
+
*
|
|
292
|
+
* @example
|
|
293
|
+
* await courier.users.tenants.list("string", {
|
|
294
|
+
* limit: 1,
|
|
295
|
+
* cursor: "string"
|
|
296
|
+
* })
|
|
234
297
|
*/
|
|
235
298
|
list(userId, request = {}, requestOptions) {
|
|
236
299
|
var _a, _b;
|
|
@@ -244,13 +307,15 @@ class Tenants {
|
|
|
244
307
|
_queryParams["cursor"] = cursor;
|
|
245
308
|
}
|
|
246
309
|
const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
|
|
247
|
-
url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `users/${userId}/tenants`),
|
|
310
|
+
url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `users/${encodeURIComponent(userId)}/tenants`),
|
|
248
311
|
method: "GET",
|
|
249
312
|
headers: {
|
|
250
313
|
Authorization: yield this._getAuthorizationHeader(),
|
|
251
314
|
"X-Fern-Language": "JavaScript",
|
|
252
315
|
"X-Fern-SDK-Name": "@trycourier/courier",
|
|
253
|
-
"X-Fern-SDK-Version": "v6.1.
|
|
316
|
+
"X-Fern-SDK-Version": "v6.1.3",
|
|
317
|
+
"X-Fern-Runtime": core.RUNTIME.type,
|
|
318
|
+
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
254
319
|
},
|
|
255
320
|
contentType: "application/json",
|
|
256
321
|
queryParameters: _queryParams,
|
|
@@ -284,7 +349,7 @@ class Tenants {
|
|
|
284
349
|
_getAuthorizationHeader() {
|
|
285
350
|
var _a;
|
|
286
351
|
return __awaiter(this, void 0, void 0, function* () {
|
|
287
|
-
const bearer = (_a = (yield core.Supplier.get(this._options.authorizationToken))) !== null && _a !== void 0 ? _a : process.env["COURIER_AUTH_TOKEN"];
|
|
352
|
+
const bearer = (_a = (yield core.Supplier.get(this._options.authorizationToken))) !== null && _a !== void 0 ? _a : process === null || process === void 0 ? void 0 : process.env["COURIER_AUTH_TOKEN"];
|
|
288
353
|
if (bearer == null) {
|
|
289
354
|
throw new errors.CourierError({
|
|
290
355
|
message: "Please specify COURIER_AUTH_TOKEN when instantiating the client.",
|
package/api/resources/users/resources/tenants/client/requests/AddUserToMultipleTenantsParams.d.ts
CHANGED
|
@@ -1,7 +1,22 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
|
-
import * as Courier from "
|
|
4
|
+
import * as Courier from "../../../../../../index";
|
|
5
|
+
/**
|
|
6
|
+
* @example
|
|
7
|
+
* {
|
|
8
|
+
* tenants: [{
|
|
9
|
+
* user_id: "string",
|
|
10
|
+
* type: "user",
|
|
11
|
+
* tenant_id: "string",
|
|
12
|
+
* profile: {
|
|
13
|
+
* "string": {
|
|
14
|
+
* "key": "value"
|
|
15
|
+
* }
|
|
16
|
+
* }
|
|
17
|
+
* }]
|
|
18
|
+
* }
|
|
19
|
+
*/
|
|
5
20
|
export interface AddUserToMultipleTenantsParams {
|
|
6
21
|
tenants: Courier.UserTenantAssociation[];
|
|
7
22
|
}
|
package/api/resources/users/resources/tenants/client/requests/AddUserToSingleTenantsParams.d.ts
CHANGED
|
@@ -1,7 +1,16 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
|
-
|
|
4
|
+
/**
|
|
5
|
+
* @example
|
|
6
|
+
* {
|
|
7
|
+
* profile: {
|
|
8
|
+
* "string": {
|
|
9
|
+
* "key": "value"
|
|
10
|
+
* }
|
|
11
|
+
* }
|
|
12
|
+
* }
|
|
13
|
+
*/
|
|
5
14
|
export interface AddUserToSingleTenantsParams {
|
|
6
|
-
profile
|
|
15
|
+
profile?: Record<string, any>;
|
|
7
16
|
}
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
export { AddUserToMultipleTenantsParams } from "./AddUserToMultipleTenantsParams";
|
|
2
|
-
export { AddUserToSingleTenantsParams } from "./AddUserToSingleTenantsParams";
|
|
3
|
-
export { ListTenantsForUserParams } from "./ListTenantsForUserParams";
|
|
1
|
+
export { type AddUserToMultipleTenantsParams } from "./AddUserToMultipleTenantsParams";
|
|
2
|
+
export { type AddUserToSingleTenantsParams } from "./AddUserToSingleTenantsParams";
|
|
3
|
+
export { type ListTenantsForUserParams } from "./ListTenantsForUserParams";
|