@trycourier/courier 6.4.2 → 6.6.0
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.js +1 -1
- package/README.md +2 -2
- package/api/resources/audiences/client/Client.js +5 -5
- package/api/resources/auditEvents/client/Client.js +2 -2
- package/api/resources/authTokens/client/Client.js +1 -1
- package/api/resources/automations/client/Client.js +2 -2
- package/api/resources/brands/client/Client.js +5 -5
- package/api/resources/bulk/client/Client.js +5 -5
- package/api/resources/commons/types/BaseTemplateTenantAssociation.d.ts +15 -0
- package/api/resources/commons/types/ListTemplateTenantAssociation.d.ts +7 -0
- package/api/resources/commons/types/SingleTemplateTenantAssociation.d.ts +7 -0
- package/api/resources/commons/types/TenantTemplateData.d.ts +11 -0
- package/api/resources/commons/types/TenantTemplateDataNoContent.d.ts +10 -0
- package/api/resources/commons/types/index.d.ts +5 -0
- package/api/resources/commons/types/index.js +5 -0
- package/api/resources/inbound/client/Client.js +1 -1
- package/api/resources/lists/client/Client.d.ts +3 -2
- package/api/resources/lists/client/Client.js +17 -15
- package/api/resources/lists/client/requests/RestoreListRequest.d.ts +9 -0
- package/api/resources/lists/client/requests/index.d.ts +1 -0
- package/api/resources/lists/types/List.d.ts +2 -2
- package/api/resources/messages/client/Client.js +6 -6
- package/api/resources/messages/types/Reason.d.ts +13 -1
- package/api/resources/messages/types/Reason.js +3 -0
- package/api/resources/notifications/client/Client.js +6 -6
- package/api/resources/profiles/client/Client.js +8 -8
- package/api/resources/send/types/Channel.d.ts +1 -0
- package/api/resources/send/types/MessageProvidersType.d.ts +4 -3
- package/api/resources/send/types/Routing.d.ts +1 -1
- package/api/resources/send/types/index.d.ts +0 -3
- package/api/resources/send/types/index.js +0 -3
- package/api/resources/templates/client/Client.js +1 -1
- package/api/resources/tenants/client/Client.d.ts +24 -0
- package/api/resources/tenants/client/Client.js +135 -7
- package/api/resources/tenants/client/requests/GetTemplateListByTenantParams.d.ts +17 -0
- package/api/resources/tenants/client/requests/GetTemplateListByTenantParams.js +5 -0
- package/api/resources/tenants/client/requests/index.d.ts +1 -0
- package/api/resources/{send/types/RoutingChannel.d.ts → tenants/types/GetTemplateByTenantResponse.d.ts} +2 -1
- package/api/resources/tenants/types/GetTemplateByTenantResponse.js +5 -0
- package/api/resources/tenants/types/ListTemplatesByTenantResponse.d.ts +23 -0
- package/api/resources/tenants/types/ListTemplatesByTenantResponse.js +5 -0
- package/api/resources/tenants/types/index.d.ts +2 -0
- package/api/resources/tenants/types/index.js +2 -0
- package/api/resources/translations/client/Client.js +2 -2
- package/api/resources/users/resources/preferences/client/Client.js +3 -3
- package/api/resources/users/resources/tenants/client/Client.js +5 -5
- package/api/resources/users/resources/tokens/client/Client.js +6 -6
- package/dist/Client.js +1 -1
- package/dist/api/resources/audiences/client/Client.js +5 -5
- package/dist/api/resources/auditEvents/client/Client.js +2 -2
- package/dist/api/resources/authTokens/client/Client.js +1 -1
- package/dist/api/resources/automations/client/Client.js +2 -2
- package/dist/api/resources/brands/client/Client.js +5 -5
- package/dist/api/resources/bulk/client/Client.js +5 -5
- package/dist/api/resources/commons/types/BaseTemplateTenantAssociation.d.ts +15 -0
- package/dist/api/resources/commons/types/BaseTemplateTenantAssociation.js +5 -0
- package/dist/api/resources/commons/types/ListTemplateTenantAssociation.d.ts +7 -0
- package/dist/api/resources/commons/types/ListTemplateTenantAssociation.js +5 -0
- package/dist/api/resources/commons/types/SingleTemplateTenantAssociation.d.ts +7 -0
- package/dist/api/resources/commons/types/SingleTemplateTenantAssociation.js +5 -0
- package/dist/api/resources/commons/types/TenantTemplateData.d.ts +11 -0
- package/dist/api/resources/commons/types/TenantTemplateData.js +5 -0
- package/dist/api/resources/commons/types/TenantTemplateDataNoContent.d.ts +10 -0
- package/dist/api/resources/commons/types/TenantTemplateDataNoContent.js +5 -0
- package/dist/api/resources/commons/types/index.d.ts +5 -0
- package/dist/api/resources/commons/types/index.js +5 -0
- package/dist/api/resources/inbound/client/Client.js +1 -1
- package/dist/api/resources/lists/client/Client.d.ts +3 -2
- package/dist/api/resources/lists/client/Client.js +17 -15
- package/dist/api/resources/lists/client/requests/RestoreListRequest.d.ts +9 -0
- package/dist/api/resources/lists/client/requests/RestoreListRequest.js +5 -0
- package/dist/api/resources/lists/client/requests/index.d.ts +1 -0
- package/dist/api/resources/lists/types/List.d.ts +2 -2
- package/dist/api/resources/messages/client/Client.js +6 -6
- package/dist/api/resources/messages/types/Reason.d.ts +13 -1
- package/dist/api/resources/messages/types/Reason.js +3 -0
- package/dist/api/resources/notifications/client/Client.js +6 -6
- package/dist/api/resources/profiles/client/Client.js +8 -8
- package/dist/api/resources/send/types/Channel.d.ts +1 -0
- package/dist/api/resources/send/types/MessageProvidersType.d.ts +4 -3
- package/dist/api/resources/send/types/Routing.d.ts +1 -1
- package/dist/api/resources/send/types/index.d.ts +0 -3
- package/dist/api/resources/send/types/index.js +0 -3
- package/dist/api/resources/templates/client/Client.js +1 -1
- package/dist/api/resources/tenants/client/Client.d.ts +24 -0
- package/dist/api/resources/tenants/client/Client.js +135 -7
- package/dist/api/resources/tenants/client/requests/GetTemplateListByTenantParams.d.ts +17 -0
- package/dist/api/resources/tenants/client/requests/GetTemplateListByTenantParams.js +5 -0
- package/dist/api/resources/tenants/client/requests/index.d.ts +1 -0
- package/dist/api/resources/{send/types/RoutingChannel.d.ts → tenants/types/GetTemplateByTenantResponse.d.ts} +2 -1
- package/dist/api/resources/tenants/types/GetTemplateByTenantResponse.js +5 -0
- package/dist/api/resources/tenants/types/ListTemplatesByTenantResponse.d.ts +23 -0
- package/dist/api/resources/tenants/types/ListTemplatesByTenantResponse.js +5 -0
- package/dist/api/resources/tenants/types/index.d.ts +2 -0
- package/dist/api/resources/tenants/types/index.js +2 -0
- package/dist/api/resources/translations/client/Client.js +2 -2
- package/dist/api/resources/users/resources/preferences/client/Client.js +3 -3
- package/dist/api/resources/users/resources/tenants/client/Client.js +5 -5
- package/dist/api/resources/users/resources/tokens/client/Client.js +6 -6
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/reference.md +122 -2
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/api/resources/send/types/RoutingStrategyChannel.d.ts +0 -11
- package/api/resources/send/types/RoutingStrategyProvider.d.ts +0 -10
- package/dist/api/resources/send/types/RoutingStrategyChannel.d.ts +0 -11
- package/dist/api/resources/send/types/RoutingStrategyProvider.d.ts +0 -10
- /package/api/resources/{send/types/RoutingChannel.js → commons/types/BaseTemplateTenantAssociation.js} +0 -0
- /package/api/resources/{send/types/RoutingStrategyChannel.js → commons/types/ListTemplateTenantAssociation.js} +0 -0
- /package/api/resources/{send/types/RoutingStrategyProvider.js → commons/types/SingleTemplateTenantAssociation.js} +0 -0
- /package/{dist/api/resources/send/types/RoutingChannel.js → api/resources/commons/types/TenantTemplateData.js} +0 -0
- /package/{dist/api/resources/send/types/RoutingStrategyChannel.js → api/resources/commons/types/TenantTemplateDataNoContent.js} +0 -0
- /package/{dist/api/resources/send/types/RoutingStrategyProvider.js → api/resources/lists/client/requests/RestoreListRequest.js} +0 -0
package/reference.md
CHANGED
|
@@ -1633,7 +1633,7 @@ await client.lists.get("list_id");
|
|
|
1633
1633
|
</dl>
|
|
1634
1634
|
</details>
|
|
1635
1635
|
|
|
1636
|
-
<details><summary><code>client.lists.<a href="/src/api/resources/lists/client/Client.ts">update</a>(listId, { ...params }) ->
|
|
1636
|
+
<details><summary><code>client.lists.<a href="/src/api/resources/lists/client/Client.ts">update</a>(listId, { ...params }) -> void</code></summary>
|
|
1637
1637
|
<dl>
|
|
1638
1638
|
<dd>
|
|
1639
1639
|
|
|
@@ -1770,7 +1770,7 @@ await client.lists.delete("list_id");
|
|
|
1770
1770
|
</dl>
|
|
1771
1771
|
</details>
|
|
1772
1772
|
|
|
1773
|
-
<details><summary><code>client.lists.<a href="/src/api/resources/lists/client/Client.ts">restore</a>(listId) -> void</code></summary>
|
|
1773
|
+
<details><summary><code>client.lists.<a href="/src/api/resources/lists/client/Client.ts">restore</a>(listId, { ...params }) -> void</code></summary>
|
|
1774
1774
|
<dl>
|
|
1775
1775
|
<dd>
|
|
1776
1776
|
|
|
@@ -1822,6 +1822,14 @@ await client.lists.restore("list_id");
|
|
|
1822
1822
|
<dl>
|
|
1823
1823
|
<dd>
|
|
1824
1824
|
|
|
1825
|
+
**request:** `Courier.RestoreListRequest`
|
|
1826
|
+
|
|
1827
|
+
</dd>
|
|
1828
|
+
</dl>
|
|
1829
|
+
|
|
1830
|
+
<dl>
|
|
1831
|
+
<dd>
|
|
1832
|
+
|
|
1825
1833
|
**requestOptions:** `Lists.RequestOptions`
|
|
1826
1834
|
|
|
1827
1835
|
</dd>
|
|
@@ -3937,6 +3945,118 @@ await client.tenants.removeDefaultPreferencesForTopic("tenant_id", "topic_id");
|
|
|
3937
3945
|
</dl>
|
|
3938
3946
|
</details>
|
|
3939
3947
|
|
|
3948
|
+
<details><summary><code>client.tenants.<a href="/src/api/resources/tenants/client/Client.ts">getTemplateByTenant</a>(tenantId, templateId) -> Courier.GetTemplateByTenantResponse</code></summary>
|
|
3949
|
+
<dl>
|
|
3950
|
+
<dd>
|
|
3951
|
+
|
|
3952
|
+
#### 🔌 Usage
|
|
3953
|
+
|
|
3954
|
+
<dl>
|
|
3955
|
+
<dd>
|
|
3956
|
+
|
|
3957
|
+
<dl>
|
|
3958
|
+
<dd>
|
|
3959
|
+
|
|
3960
|
+
```typescript
|
|
3961
|
+
await client.tenants.getTemplateByTenant("tenant_id", "template_id");
|
|
3962
|
+
```
|
|
3963
|
+
|
|
3964
|
+
</dd>
|
|
3965
|
+
</dl>
|
|
3966
|
+
</dd>
|
|
3967
|
+
</dl>
|
|
3968
|
+
|
|
3969
|
+
#### ⚙️ Parameters
|
|
3970
|
+
|
|
3971
|
+
<dl>
|
|
3972
|
+
<dd>
|
|
3973
|
+
|
|
3974
|
+
<dl>
|
|
3975
|
+
<dd>
|
|
3976
|
+
|
|
3977
|
+
**tenantId:** `string` — Id of the tenant for which to retrieve the template.
|
|
3978
|
+
|
|
3979
|
+
</dd>
|
|
3980
|
+
</dl>
|
|
3981
|
+
|
|
3982
|
+
<dl>
|
|
3983
|
+
<dd>
|
|
3984
|
+
|
|
3985
|
+
**templateId:** `string` — Id of the template to be retrieved.
|
|
3986
|
+
|
|
3987
|
+
</dd>
|
|
3988
|
+
</dl>
|
|
3989
|
+
|
|
3990
|
+
<dl>
|
|
3991
|
+
<dd>
|
|
3992
|
+
|
|
3993
|
+
**requestOptions:** `Tenants.RequestOptions`
|
|
3994
|
+
|
|
3995
|
+
</dd>
|
|
3996
|
+
</dl>
|
|
3997
|
+
</dd>
|
|
3998
|
+
</dl>
|
|
3999
|
+
|
|
4000
|
+
</dd>
|
|
4001
|
+
</dl>
|
|
4002
|
+
</details>
|
|
4003
|
+
|
|
4004
|
+
<details><summary><code>client.tenants.<a href="/src/api/resources/tenants/client/Client.ts">getTemplateListByTenant</a>(tenantId, { ...params }) -> Courier.ListTemplatesByTenantResponse</code></summary>
|
|
4005
|
+
<dl>
|
|
4006
|
+
<dd>
|
|
4007
|
+
|
|
4008
|
+
#### 🔌 Usage
|
|
4009
|
+
|
|
4010
|
+
<dl>
|
|
4011
|
+
<dd>
|
|
4012
|
+
|
|
4013
|
+
<dl>
|
|
4014
|
+
<dd>
|
|
4015
|
+
|
|
4016
|
+
```typescript
|
|
4017
|
+
await client.tenants.getTemplateListByTenant("tenant_id");
|
|
4018
|
+
```
|
|
4019
|
+
|
|
4020
|
+
</dd>
|
|
4021
|
+
</dl>
|
|
4022
|
+
</dd>
|
|
4023
|
+
</dl>
|
|
4024
|
+
|
|
4025
|
+
#### ⚙️ Parameters
|
|
4026
|
+
|
|
4027
|
+
<dl>
|
|
4028
|
+
<dd>
|
|
4029
|
+
|
|
4030
|
+
<dl>
|
|
4031
|
+
<dd>
|
|
4032
|
+
|
|
4033
|
+
**tenantId:** `string` — Id of the tenant for which to retrieve the templates.
|
|
4034
|
+
|
|
4035
|
+
</dd>
|
|
4036
|
+
</dl>
|
|
4037
|
+
|
|
4038
|
+
<dl>
|
|
4039
|
+
<dd>
|
|
4040
|
+
|
|
4041
|
+
**request:** `Courier.GetTemplateListByTenantParams`
|
|
4042
|
+
|
|
4043
|
+
</dd>
|
|
4044
|
+
</dl>
|
|
4045
|
+
|
|
4046
|
+
<dl>
|
|
4047
|
+
<dd>
|
|
4048
|
+
|
|
4049
|
+
**requestOptions:** `Tenants.RequestOptions`
|
|
4050
|
+
|
|
4051
|
+
</dd>
|
|
4052
|
+
</dl>
|
|
4053
|
+
</dd>
|
|
4054
|
+
</dl>
|
|
4055
|
+
|
|
4056
|
+
</dd>
|
|
4057
|
+
</dl>
|
|
4058
|
+
</details>
|
|
4059
|
+
|
|
3940
4060
|
## Translations
|
|
3941
4061
|
|
|
3942
4062
|
<details><summary><code>client.translations.<a href="/src/api/resources/translations/client/Client.ts">get</a>(domain, locale) -> string</code></summary>
|
package/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "6.
|
|
1
|
+
export declare const SDK_VERSION = "6.6.0";
|
package/version.js
CHANGED
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
import * as Courier from "../../../index";
|
|
5
|
-
export interface RoutingStrategyChannel {
|
|
6
|
-
channel: string;
|
|
7
|
-
config?: Record<string, any>;
|
|
8
|
-
method?: Courier.RoutingMethod;
|
|
9
|
-
providers?: Courier.MessageProviders;
|
|
10
|
-
if?: string;
|
|
11
|
-
}
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
import * as Courier from "../../../index";
|
|
5
|
-
export interface RoutingStrategyProvider {
|
|
6
|
-
name: string;
|
|
7
|
-
config?: Record<string, any>;
|
|
8
|
-
if?: string;
|
|
9
|
-
metadata: Courier.Metadata;
|
|
10
|
-
}
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
import * as Courier from "../../../index";
|
|
5
|
-
export interface RoutingStrategyChannel {
|
|
6
|
-
channel: string;
|
|
7
|
-
config?: Record<string, any>;
|
|
8
|
-
method?: Courier.RoutingMethod;
|
|
9
|
-
providers?: Courier.MessageProviders;
|
|
10
|
-
if?: string;
|
|
11
|
-
}
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
import * as Courier from "../../../index";
|
|
5
|
-
export interface RoutingStrategyProvider {
|
|
6
|
-
name: string;
|
|
7
|
-
config?: Record<string, any>;
|
|
8
|
-
if?: string;
|
|
9
|
-
metadata: Courier.Metadata;
|
|
10
|
-
}
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|