Skip to content

Commit a869eac

Browse files
thomaswhyyouthomaswhyyou
committed
Build SDK
Stainless-Generated-From: 28d5b4a80ff2958785266a520f002f3bd755ebb7
1 parent e24434a commit a869eac

137 files changed

Lines changed: 10032 additions & 2192 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.stats.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
configured_endpoints: 73
1+
configured_endpoints: 98

‎CHANGELOG.md‎

Lines changed: 0 additions & 243 deletions
This file was deleted.

‎README.md‎

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -197,29 +197,17 @@ from knock_mapi import KnockMgmt
197197

198198
client = KnockMgmt()
199199

200-
response = client.email_layouts.upsert(
201-
email_layout_key="email_layout_key",
200+
response = client.templates.preview(
202201
environment="development",
203-
email_layout={
204-
"html_layout": "<html><body>Hello, world!</body></html>",
205-
"name": "Transactional",
206-
"text_layout": "Hello, world!",
207-
"branding_overrides": {
208-
"dark_logo_url": "https://cdn.example.com/logo-dark.png",
209-
"dark_primary_color": "#1A1A2E",
210-
"dark_primary_color_contrast": "#FFFFFF",
211-
"primary_color": "#4F46E5",
212-
"primary_color_contrast": "#FFFFFF",
213-
},
214-
"footer_links": [
215-
{
216-
"text": "Example",
217-
"url": "http://example.com",
218-
}
219-
],
202+
channel_type="email",
203+
recipient="user_123",
204+
template={
205+
"settings": {},
206+
"subject": "Hello {{ recipient.name }}",
220207
},
208+
layout={},
221209
)
222-
print(response.email_layout)
210+
print(response.layout)
223211
```
224212

225213
## Handling errors

‎api.md‎

Lines changed: 151 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,22 @@
22

33
```python
44
from knock_mapi.types import (
5+
GoalAttachment,
56
MessageTypeBooleanField,
67
MessageTypeButtonField,
8+
MessageTypeColorField,
79
MessageTypeImageField,
810
MessageTypeJsonField,
11+
MessageTypeListField,
912
MessageTypeMarkdownField,
1013
MessageTypeMultiSelectField,
14+
MessageTypeNumberField,
1115
MessageTypeSelectField,
1216
MessageTypeTextField,
1317
MessageTypeTextareaField,
1418
MessageTypeURLField,
1519
PageInfo,
20+
RecipientReference,
1621
)
1722
```
1823

@@ -29,21 +34,34 @@ from knock_mapi.types import (
2934
RequestTemplate,
3035
SMSTemplate,
3136
WebhookTemplate,
37+
TemplatePreviewResponse,
3238
)
3339
```
3440

41+
Methods:
42+
43+
- <code title="post /v1/templates/preview">client.templates.<a href="./src/knock_mapi/resources/templates.py">preview</a>(\*\*<a href="src/knock_mapi/types/template_preview_params.py">params</a>) -> <a href="./src/knock_mapi/types/template_preview_response.py">TemplatePreviewResponse</a></code>
44+
3545
# EmailLayouts
3646

3747
Types:
3848

3949
```python
40-
from knock_mapi.types import EmailLayout, EmailLayoutUpsertResponse, EmailLayoutValidateResponse
50+
from knock_mapi.types import (
51+
BrandingOverrides,
52+
EmailLayout,
53+
EmailLayoutRequest,
54+
EmailLayoutPreviewResponse,
55+
EmailLayoutUpsertResponse,
56+
EmailLayoutValidateResponse,
57+
)
4158
```
4259

4360
Methods:
4461

4562
- <code title="get /v1/email_layouts/{email_layout_key}">client.email_layouts.<a href="./src/knock_mapi/resources/email_layouts.py">retrieve</a>(email_layout_key, \*\*<a href="src/knock_mapi/types/email_layout_retrieve_params.py">params</a>) -> <a href="./src/knock_mapi/types/email_layout.py">EmailLayout</a></code>
4663
- <code title="get /v1/email_layouts">client.email_layouts.<a href="./src/knock_mapi/resources/email_layouts.py">list</a>(\*\*<a href="src/knock_mapi/types/email_layout_list_params.py">params</a>) -> <a href="./src/knock_mapi/types/email_layout.py">SyncEntriesCursor[EmailLayout]</a></code>
64+
- <code title="post /v1/email_layouts/preview">client.email_layouts.<a href="./src/knock_mapi/resources/email_layouts.py">preview</a>(\*\*<a href="src/knock_mapi/types/email_layout_preview_params.py">params</a>) -> <a href="./src/knock_mapi/types/email_layout_preview_response.py">EmailLayoutPreviewResponse</a></code>
4765
- <code title="put /v1/email_layouts/{email_layout_key}">client.email_layouts.<a href="./src/knock_mapi/resources/email_layouts.py">upsert</a>(email_layout_key, \*\*<a href="src/knock_mapi/types/email_layout_upsert_params.py">params</a>) -> <a href="./src/knock_mapi/types/email_layout_upsert_response.py">EmailLayoutUpsertResponse</a></code>
4866
- <code title="put /v1/email_layouts/{email_layout_key}/validate">client.email_layouts.<a href="./src/knock_mapi/resources/email_layouts.py">validate</a>(email_layout_key, \*\*<a href="src/knock_mapi/types/email_layout_validate_params.py">params</a>) -> <a href="./src/knock_mapi/types/email_layout_validate_response.py">EmailLayoutValidateResponse</a></code>
4967

@@ -73,13 +91,20 @@ Methods:
7391
Types:
7492

7593
```python
76-
from knock_mapi.types import Partial, PartialUpsertResponse, PartialValidateResponse
94+
from knock_mapi.types import (
95+
Partial,
96+
PartialRequest,
97+
PartialPreviewResponse,
98+
PartialUpsertResponse,
99+
PartialValidateResponse,
100+
)
77101
```
78102

79103
Methods:
80104

81105
- <code title="get /v1/partials/{partial_key}">client.partials.<a href="./src/knock_mapi/resources/partials.py">retrieve</a>(partial_key, \*\*<a href="src/knock_mapi/types/partial_retrieve_params.py">params</a>) -> <a href="./src/knock_mapi/types/partial.py">Partial</a></code>
82106
- <code title="get /v1/partials">client.partials.<a href="./src/knock_mapi/resources/partials.py">list</a>(\*\*<a href="src/knock_mapi/types/partial_list_params.py">params</a>) -> <a href="./src/knock_mapi/types/partial.py">SyncEntriesCursor[Partial]</a></code>
107+
- <code title="post /v1/partials/preview">client.partials.<a href="./src/knock_mapi/resources/partials.py">preview</a>(\*\*<a href="src/knock_mapi/types/partial_preview_params.py">params</a>) -> <a href="./src/knock_mapi/types/partial_preview_response.py">PartialPreviewResponse</a></code>
83108
- <code title="put /v1/partials/{partial_key}">client.partials.<a href="./src/knock_mapi/resources/partials.py">upsert</a>(partial_key, \*\*<a href="src/knock_mapi/types/partial_upsert_params.py">params</a>) -> <a href="./src/knock_mapi/types/partial_upsert_response.py">PartialUpsertResponse</a></code>
84109
- <code title="put /v1/partials/{partial_key}/validate">client.partials.<a href="./src/knock_mapi/resources/partials.py">validate</a>(partial_key, \*\*<a href="src/knock_mapi/types/partial_validate_params.py">params</a>) -> <a href="./src/knock_mapi/types/partial_validate_response.py">PartialValidateResponse</a></code>
85110

@@ -90,6 +115,7 @@ Types:
90115
```python
91116
from knock_mapi.types import (
92117
Translation,
118+
TranslationRequest,
93119
TranslationRetrieveResponse,
94120
TranslationUpsertResponse,
95121
TranslationValidateResponse,
@@ -111,7 +137,9 @@ Types:
111137
from knock_mapi.types import (
112138
Condition,
113139
ConditionGroup,
140+
ConditionGroupAllMatch,
114141
Duration,
142+
InlineIdentifyUserRequest,
115143
SendWindow,
116144
Workflow,
117145
WorkflowAIAgentStep,
@@ -122,8 +150,11 @@ from knock_mapi.types import (
122150
WorkflowEmailStep,
123151
WorkflowFetchStep,
124152
WorkflowInAppFeedStep,
153+
WorkflowInAppGuideStep,
125154
WorkflowPushStep,
126155
WorkflowRandomCohortStep,
156+
WorkflowRandomCohortStepBranch,
157+
WorkflowRequest,
127158
WorkflowSMSStep,
128159
WorkflowStep,
129160
WorkflowThrottleStep,
@@ -169,6 +200,7 @@ Types:
169200
```python
170201
from knock_mapi.types import (
171202
MessageType,
203+
MessageTypeRequest,
172204
MessageTypeVariant,
173205
MessageTypeUpsertResponse,
174206
MessageTypeValidateResponse,
@@ -328,6 +360,7 @@ Types:
328360
from knock_mapi.types import (
329361
Guide,
330362
GuideActivationURLPattern,
363+
GuideRequest,
331364
GuideStep,
332365
GuideActivateResponse,
333366
GuideArchiveResponse,
@@ -359,6 +392,7 @@ Methods:
359392
- <code title="get /v1/branches/{branch_slug}">client.branches.<a href="./src/knock_mapi/resources/branches.py">retrieve</a>(branch_slug, \*\*<a href="src/knock_mapi/types/branch_retrieve_params.py">params</a>) -> <a href="./src/knock_mapi/types/branch.py">Branch</a></code>
360393
- <code title="get /v1/branches">client.branches.<a href="./src/knock_mapi/resources/branches.py">list</a>(\*\*<a href="src/knock_mapi/types/branch_list_params.py">params</a>) -> <a href="./src/knock_mapi/types/branch.py">SyncEntriesCursor[Branch]</a></code>
361394
- <code title="delete /v1/branches/{branch_slug}">client.branches.<a href="./src/knock_mapi/resources/branches.py">delete</a>(branch_slug, \*\*<a href="src/knock_mapi/types/branch_delete_params.py">params</a>) -> None</code>
395+
- <code title="put /v1/branches/{branch_slug}/rebase">client.branches.<a href="./src/knock_mapi/resources/branches.py">rebase</a>(branch_slug, \*\*<a href="src/knock_mapi/types/branch_rebase_params.py">params</a>) -> <a href="./src/knock_mapi/types/branch.py">Branch</a></code>
362396

363397
# Broadcasts
364398

@@ -392,6 +426,7 @@ Types:
392426
from knock_mapi.types import (
393427
Audience,
394428
AudienceCondition,
429+
AudienceRequest,
395430
DynamicAudience,
396431
StaticAudience,
397432
AudienceArchiveResponse,
@@ -407,3 +442,117 @@ Methods:
407442
- <code title="delete /v1/audiences/{audience_key}">client.audiences.<a href="./src/knock_mapi/resources/audiences.py">archive</a>(audience_key, \*\*<a href="src/knock_mapi/types/audience_archive_params.py">params</a>) -> <a href="./src/knock_mapi/types/audience_archive_response.py">AudienceArchiveResponse</a></code>
408443
- <code title="put /v1/audiences/{audience_key}">client.audiences.<a href="./src/knock_mapi/resources/audiences.py">upsert</a>(audience_key, \*\*<a href="src/knock_mapi/types/audience_upsert_params.py">params</a>) -> <a href="./src/knock_mapi/types/audience_upsert_response.py">AudienceUpsertResponse</a></code>
409444
- <code title="put /v1/audiences/{audience_key}/validate">client.audiences.<a href="./src/knock_mapi/resources/audiences.py">validate</a>(audience_key, \*\*<a href="src/knock_mapi/types/audience_validate_params.py">params</a>) -> <a href="./src/knock_mapi/types/audience_validate_response.py">AudienceValidateResponse</a></code>
445+
446+
# Goals
447+
448+
Types:
449+
450+
```python
451+
from knock_mapi.types import (
452+
Goal,
453+
GoalCondition,
454+
GoalRequest,
455+
GoalArchiveResponse,
456+
GoalCloneResponse,
457+
GoalUpsertResponse,
458+
GoalValidateResponse,
459+
)
460+
```
461+
462+
Methods:
463+
464+
- <code title="get /v1/goals/{goal_key}">client.goals.<a href="./src/knock_mapi/resources/goals.py">retrieve</a>(goal_key, \*\*<a href="src/knock_mapi/types/goal_retrieve_params.py">params</a>) -> <a href="./src/knock_mapi/types/goal.py">Goal</a></code>
465+
- <code title="get /v1/goals">client.goals.<a href="./src/knock_mapi/resources/goals.py">list</a>(\*\*<a href="src/knock_mapi/types/goal_list_params.py">params</a>) -> <a href="./src/knock_mapi/types/goal.py">SyncEntriesCursor[Goal]</a></code>
466+
- <code title="delete /v1/goals/{goal_key}">client.goals.<a href="./src/knock_mapi/resources/goals.py">archive</a>(goal_key, \*\*<a href="src/knock_mapi/types/goal_archive_params.py">params</a>) -> <a href="./src/knock_mapi/types/goal_archive_response.py">GoalArchiveResponse</a></code>
467+
- <code title="post /v1/goals/{goal_key}/clone">client.goals.<a href="./src/knock_mapi/resources/goals.py">clone</a>(goal_key, \*\*<a href="src/knock_mapi/types/goal_clone_params.py">params</a>) -> <a href="./src/knock_mapi/types/goal_clone_response.py">GoalCloneResponse</a></code>
468+
- <code title="put /v1/goals/{goal_key}">client.goals.<a href="./src/knock_mapi/resources/goals.py">upsert</a>(goal_key, \*\*<a href="src/knock_mapi/types/goal_upsert_params.py">params</a>) -> <a href="./src/knock_mapi/types/goal_upsert_response.py">GoalUpsertResponse</a></code>
469+
- <code title="put /v1/goals/{goal_key}/validate">client.goals.<a href="./src/knock_mapi/resources/goals.py">validate</a>(goal_key, \*\*<a href="src/knock_mapi/types/goal_validate_params.py">params</a>) -> <a href="./src/knock_mapi/types/goal_validate_response.py">GoalValidateResponse</a></code>
470+
471+
# Assets
472+
473+
Types:
474+
475+
```python
476+
from knock_mapi.types import Asset
477+
```
478+
479+
Methods:
480+
481+
- <code title="get /v1/assets">client.assets.<a href="./src/knock_mapi/resources/assets.py">list</a>(\*\*<a href="src/knock_mapi/types/asset_list_params.py">params</a>) -> <a href="./src/knock_mapi/types/asset.py">SyncEntriesCursor[Asset]</a></code>
482+
483+
# Tags
484+
485+
Types:
486+
487+
```python
488+
from knock_mapi.types import Tag, TagListResponse, TagUpsertResponse
489+
```
490+
491+
Methods:
492+
493+
- <code title="get /v1/tags">client.tags.<a href="./src/knock_mapi/resources/tags.py">list</a>() -> <a href="./src/knock_mapi/types/tag_list_response.py">TagListResponse</a></code>
494+
- <code title="delete /v1/tags/{name}">client.tags.<a href="./src/knock_mapi/resources/tags.py">delete</a>(name) -> None</code>
495+
- <code title="put /v1/tags/{name}">client.tags.<a href="./src/knock_mapi/resources/tags.py">upsert</a>(name, \*\*<a href="src/knock_mapi/types/tag_upsert_params.py">params</a>) -> <a href="./src/knock_mapi/types/tag_upsert_response.py">TagUpsertResponse</a></code>
496+
497+
# Schemas
498+
499+
Types:
500+
501+
```python
502+
from knock_mapi.types import ItemSchema, SchemaListResponse
503+
```
504+
505+
Methods:
506+
507+
- <code title="get /v1/schemas/{item_type}">client.schemas.<a href="./src/knock_mapi/resources/schemas.py">retrieve</a>(item_type, \*\*<a href="src/knock_mapi/types/schema_retrieve_params.py">params</a>) -> object</code>
508+
- <code title="get /v1/schemas">client.schemas.<a href="./src/knock_mapi/resources/schemas.py">list</a>(\*\*<a href="src/knock_mapi/types/schema_list_params.py">params</a>) -> <a href="./src/knock_mapi/types/schema_list_response.py">SchemaListResponse</a></code>
509+
- <code title="put /v1/schemas/{item_type}">client.schemas.<a href="./src/knock_mapi/resources/schemas.py">upsert</a>(item_type, \*\*<a href="src/knock_mapi/types/schema_upsert_params.py">params</a>) -> object</code>
510+
- <code title="put /v1/schemas/{item_type}/validate">client.schemas.<a href="./src/knock_mapi/resources/schemas.py">validate</a>(item_type, \*\*<a href="src/knock_mapi/types/schema_validate_params.py">params</a>) -> object</code>
511+
512+
# PreferenceCenter
513+
514+
Types:
515+
516+
```python
517+
from knock_mapi.types import (
518+
PreferenceCenterRetrieveResponse,
519+
PreferenceCenterResetResponse,
520+
PreferenceCenterUpsertResponse,
521+
)
522+
```
523+
524+
Methods:
525+
526+
- <code title="get /v1/preference_center">client.preference_center.<a href="./src/knock_mapi/resources/preference_center.py">retrieve</a>(\*\*<a href="src/knock_mapi/types/preference_center_retrieve_params.py">params</a>) -> <a href="./src/knock_mapi/types/preference_center_retrieve_response.py">PreferenceCenterRetrieveResponse</a></code>
527+
- <code title="put /v1/preference_center/reset">client.preference_center.<a href="./src/knock_mapi/resources/preference_center.py">reset</a>(\*\*<a href="src/knock_mapi/types/preference_center_reset_params.py">params</a>) -> <a href="./src/knock_mapi/types/preference_center_reset_response.py">PreferenceCenterResetResponse</a></code>
528+
- <code title="put /v1/preference_center">client.preference_center.<a href="./src/knock_mapi/resources/preference_center.py">upsert</a>(\*\*<a href="src/knock_mapi/types/preference_center_upsert_params.py">params</a>) -> <a href="./src/knock_mapi/types/preference_center_upsert_response.py">PreferenceCenterUpsertResponse</a></code>
529+
530+
# Billing
531+
532+
Types:
533+
534+
```python
535+
from knock_mapi.types import BillingSummary
536+
```
537+
538+
Methods:
539+
540+
- <code title="get /v1/billing/summary">client.billing.<a href="./src/knock_mapi/resources/billing.py">retrieve_summary</a>() -> <a href="./src/knock_mapi/types/billing_summary.py">BillingSummary</a></code>
541+
542+
# PreferenceCategories
543+
544+
Types:
545+
546+
```python
547+
from knock_mapi.types import (
548+
PreferenceCategory,
549+
PreferenceCategoryListResponse,
550+
PreferenceCategoryUpsertResponse,
551+
)
552+
```
553+
554+
Methods:
555+
556+
- <code title="get /v1/preference_categories">client.preference_categories.<a href="./src/knock_mapi/resources/preference_categories.py">list</a>() -> <a href="./src/knock_mapi/types/preference_category_list_response.py">PreferenceCategoryListResponse</a></code>
557+
- <code title="delete /v1/preference_categories/{name}">client.preference_categories.<a href="./src/knock_mapi/resources/preference_categories.py">delete</a>(name) -> None</code>
558+
- <code title="put /v1/preference_categories/{name}">client.preference_categories.<a href="./src/knock_mapi/resources/preference_categories.py">upsert</a>(name) -> <a href="./src/knock_mapi/types/preference_category_upsert_response.py">PreferenceCategoryUpsertResponse</a></code>

0 commit comments

Comments
 (0)