@zyphr-dev/node-sdk 0.1.32 → 0.1.34
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/dist/index.cjs +2245 -117
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +3139 -933
- package/dist/index.d.ts +3139 -933
- package/dist/index.js +2100 -117
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/.openapi-generator/FILES +30 -0
- package/src/client.ts +9 -0
- package/src/src/apis/AuthOrganizationsApi.ts +823 -0
- package/src/src/apis/AuthUserProfileApi.ts +62 -0
- package/src/src/apis/DomainsApi.ts +73 -0
- package/src/src/apis/InboundEmailApi.ts +264 -0
- package/src/src/apis/MuseApi.ts +531 -0
- package/src/src/apis/index.ts +3 -0
- package/src/src/models/AddOrganizationMemberRequest.ts +74 -0
- package/src/src/models/CreateOrganizationRequest.ts +82 -0
- package/src/src/models/InboundAttachmentUrlResponse.ts +88 -0
- package/src/src/models/InboundAttachmentUrlResponseData.ts +81 -0
- package/src/src/models/InboundEmail.ts +247 -0
- package/src/src/models/InboundEmailAttachment.ts +89 -0
- package/src/src/models/InboundEmailFrom.ts +73 -0
- package/src/src/models/InboundEmailListResponse.ts +88 -0
- package/src/src/models/InboundEmailListResponseMeta.ts +89 -0
- package/src/src/models/InboundEmailResponse.ts +88 -0
- package/src/src/models/LoginRequest.ts +12 -0
- package/src/src/models/Organization.ts +137 -0
- package/src/src/models/OrganizationListResponse.ts +90 -0
- package/src/src/models/OrganizationListResponseMeta.ts +73 -0
- package/src/src/models/OrganizationMembersListResponse.ts +90 -0
- package/src/src/models/OrganizationMembership.ts +119 -0
- package/src/src/models/OrganizationMembershipResponse.ts +90 -0
- package/src/src/models/OrganizationMembershipWithUser.ts +135 -0
- package/src/src/models/OrganizationResponse.ts +90 -0
- package/src/src/models/RegisterRequest.ts +23 -0
- package/src/src/models/SetDomainInboundRequest.ts +65 -0
- package/src/src/models/SwitchOrganizationRequest.ts +75 -0
- package/src/src/models/SwitchOrganizationResponse.ts +90 -0
- package/src/src/models/SwitchOrganizationResponseData.ts +99 -0
- package/src/src/models/SwitchOrganizationResponseDataTokens.ts +103 -0
- package/src/src/models/SwitchOrganizationResponseDataUser.ts +73 -0
- package/src/src/models/UpdateOrganizationMemberRoleRequest.ts +66 -0
- package/src/src/models/UpdateOrganizationRequest.ts +81 -0
- package/src/src/models/V1MuseSubjectsSuggestPostRequest.ts +105 -0
- package/src/src/models/index.ts +27 -0
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Zyphr API
|
|
5
|
+
* Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: support@zyphr.dev
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface V1MuseSubjectsSuggestPostRequest
|
|
20
|
+
*/
|
|
21
|
+
export interface V1MuseSubjectsSuggestPostRequest {
|
|
22
|
+
/**
|
|
23
|
+
* Optional template id. When provided, the route resolves the
|
|
24
|
+
* template body server-side. Cannot be combined with template_body.
|
|
25
|
+
* @type {string}
|
|
26
|
+
* @memberof V1MuseSubjectsSuggestPostRequest
|
|
27
|
+
*/
|
|
28
|
+
templateId?: string;
|
|
29
|
+
/**
|
|
30
|
+
* Optional raw template body. Empty/missing is allowed —
|
|
31
|
+
* the prompt handles sparse input by falling back to channel
|
|
32
|
+
* best-practices.
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof V1MuseSubjectsSuggestPostRequest
|
|
35
|
+
*/
|
|
36
|
+
templateBody?: string;
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @type {string}
|
|
40
|
+
* @memberof V1MuseSubjectsSuggestPostRequest
|
|
41
|
+
*/
|
|
42
|
+
channel: V1MuseSubjectsSuggestPostRequestChannelEnum;
|
|
43
|
+
/**
|
|
44
|
+
*
|
|
45
|
+
* @type {string}
|
|
46
|
+
* @memberof V1MuseSubjectsSuggestPostRequest
|
|
47
|
+
*/
|
|
48
|
+
projectId: string;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
/**
|
|
53
|
+
* @export
|
|
54
|
+
*/
|
|
55
|
+
export const V1MuseSubjectsSuggestPostRequestChannelEnum = {
|
|
56
|
+
EMAIL: 'email',
|
|
57
|
+
PUSH: 'push'
|
|
58
|
+
} as const;
|
|
59
|
+
export type V1MuseSubjectsSuggestPostRequestChannelEnum = typeof V1MuseSubjectsSuggestPostRequestChannelEnum[keyof typeof V1MuseSubjectsSuggestPostRequestChannelEnum];
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
/**
|
|
63
|
+
* Check if a given object implements the V1MuseSubjectsSuggestPostRequest interface.
|
|
64
|
+
*/
|
|
65
|
+
export function instanceOfV1MuseSubjectsSuggestPostRequest(value: object): value is V1MuseSubjectsSuggestPostRequest {
|
|
66
|
+
if (!('channel' in value) || value['channel'] === undefined) return false;
|
|
67
|
+
if (!('projectId' in value) || value['projectId'] === undefined) return false;
|
|
68
|
+
return true;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
export function V1MuseSubjectsSuggestPostRequestFromJSON(json: any): V1MuseSubjectsSuggestPostRequest {
|
|
72
|
+
return V1MuseSubjectsSuggestPostRequestFromJSONTyped(json, false);
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
export function V1MuseSubjectsSuggestPostRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): V1MuseSubjectsSuggestPostRequest {
|
|
76
|
+
if (json == null) {
|
|
77
|
+
return json;
|
|
78
|
+
}
|
|
79
|
+
return {
|
|
80
|
+
|
|
81
|
+
'templateId': json['template_id'] == null ? undefined : json['template_id'],
|
|
82
|
+
'templateBody': json['template_body'] == null ? undefined : json['template_body'],
|
|
83
|
+
'channel': json['channel'],
|
|
84
|
+
'projectId': json['project_id'],
|
|
85
|
+
};
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
export function V1MuseSubjectsSuggestPostRequestToJSON(json: any): V1MuseSubjectsSuggestPostRequest {
|
|
89
|
+
return V1MuseSubjectsSuggestPostRequestToJSONTyped(json, false);
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
export function V1MuseSubjectsSuggestPostRequestToJSONTyped(value?: V1MuseSubjectsSuggestPostRequest | null, ignoreDiscriminator: boolean = false): any {
|
|
93
|
+
if (value == null) {
|
|
94
|
+
return value;
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
return {
|
|
98
|
+
|
|
99
|
+
'template_id': value['templateId'],
|
|
100
|
+
'template_body': value['templateBody'],
|
|
101
|
+
'channel': value['channel'],
|
|
102
|
+
'project_id': value['projectId'],
|
|
103
|
+
};
|
|
104
|
+
}
|
|
105
|
+
|
package/src/src/models/index.ts
CHANGED
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
export * from './AddDomain200Response';
|
|
4
4
|
export * from './AddDomain200ResponseMeta';
|
|
5
5
|
export * from './AddDomainRequest';
|
|
6
|
+
export * from './AddOrganizationMemberRequest';
|
|
6
7
|
export * from './AddTopicSubscribersRequest';
|
|
7
8
|
export * from './ApiError';
|
|
8
9
|
export * from './ApiErrorError';
|
|
@@ -58,6 +59,7 @@ export * from './ConvertAnonymousUserRequestOneOf1';
|
|
|
58
59
|
export * from './ConvertAnonymousUserRequestOneOf1AppleUser';
|
|
59
60
|
export * from './ConvertAnonymousUserRequestOneOf1AppleUserName';
|
|
60
61
|
export * from './CreateCategoryRequest';
|
|
62
|
+
export * from './CreateOrganizationRequest';
|
|
61
63
|
export * from './CreateSubscriberRequest';
|
|
62
64
|
export * from './CreateTemplateRequest';
|
|
63
65
|
export * from './CreateTopicRequest';
|
|
@@ -114,6 +116,14 @@ export * from './GetDomain200ResponseMeta';
|
|
|
114
116
|
export * from './GetWaaSEndpoint200Response';
|
|
115
117
|
export * from './GetWaaSUsage200Response';
|
|
116
118
|
export * from './InAppNotification';
|
|
119
|
+
export * from './InboundAttachmentUrlResponse';
|
|
120
|
+
export * from './InboundAttachmentUrlResponseData';
|
|
121
|
+
export * from './InboundEmail';
|
|
122
|
+
export * from './InboundEmailAttachment';
|
|
123
|
+
export * from './InboundEmailFrom';
|
|
124
|
+
export * from './InboundEmailListResponse';
|
|
125
|
+
export * from './InboundEmailListResponseMeta';
|
|
126
|
+
export * from './InboundEmailResponse';
|
|
117
127
|
export * from './InboxListMeta';
|
|
118
128
|
export * from './InboxListResponse';
|
|
119
129
|
export * from './InboxNotificationResponse';
|
|
@@ -167,6 +177,14 @@ export * from './OAuthTokensRefreshResponse';
|
|
|
167
177
|
export * from './OAuthTokensRefreshResponseData';
|
|
168
178
|
export * from './OAuthTokensResponse';
|
|
169
179
|
export * from './OAuthTokensResponseData';
|
|
180
|
+
export * from './Organization';
|
|
181
|
+
export * from './OrganizationListResponse';
|
|
182
|
+
export * from './OrganizationListResponseMeta';
|
|
183
|
+
export * from './OrganizationMembersListResponse';
|
|
184
|
+
export * from './OrganizationMembership';
|
|
185
|
+
export * from './OrganizationMembershipResponse';
|
|
186
|
+
export * from './OrganizationMembershipWithUser';
|
|
187
|
+
export * from './OrganizationResponse';
|
|
170
188
|
export * from './PaginationMeta';
|
|
171
189
|
export * from './PasswordRequirements';
|
|
172
190
|
export * from './PasswordRequirementsResponse';
|
|
@@ -253,6 +271,7 @@ export * from './SendWebhookTestEventRequest';
|
|
|
253
271
|
export * from './SessionListResponse';
|
|
254
272
|
export * from './SessionListResponseData';
|
|
255
273
|
export * from './SessionListResponseDataSessionInfo';
|
|
274
|
+
export * from './SetDomainInboundRequest';
|
|
256
275
|
export * from './SetPreferencesRequest';
|
|
257
276
|
export * from './SetPreferencesRequestPreferencesInner';
|
|
258
277
|
export * from './SignInAnonymouslyRequest';
|
|
@@ -279,6 +298,11 @@ export * from './SubscriberListResponse';
|
|
|
279
298
|
export * from './SubscriberPreference';
|
|
280
299
|
export * from './SubscriberResponse';
|
|
281
300
|
export * from './SuccessResult';
|
|
301
|
+
export * from './SwitchOrganizationRequest';
|
|
302
|
+
export * from './SwitchOrganizationResponse';
|
|
303
|
+
export * from './SwitchOrganizationResponseData';
|
|
304
|
+
export * from './SwitchOrganizationResponseDataTokens';
|
|
305
|
+
export * from './SwitchOrganizationResponseDataUser';
|
|
282
306
|
export * from './Template';
|
|
283
307
|
export * from './TemplateListResponse';
|
|
284
308
|
export * from './TemplateRenderResponse';
|
|
@@ -307,6 +331,8 @@ export * from './UnsubscribeRequest';
|
|
|
307
331
|
export * from './UnsubscribeResponse';
|
|
308
332
|
export * from './UpdateCategoryRequest';
|
|
309
333
|
export * from './UpdateEndUserRequest';
|
|
334
|
+
export * from './UpdateOrganizationMemberRoleRequest';
|
|
335
|
+
export * from './UpdateOrganizationRequest';
|
|
310
336
|
export * from './UpdateSubscriberPreferencesRequest';
|
|
311
337
|
export * from './UpdateSubscriberPreferencesRequestPreferencesInner';
|
|
312
338
|
export * from './UpdateSubscriberRequest';
|
|
@@ -320,6 +346,7 @@ export * from './UpsertAuthEmailTemplateRequest';
|
|
|
320
346
|
export * from './UpsertSmsConfigRequest';
|
|
321
347
|
export * from './UserDevicesDeleteResponse';
|
|
322
348
|
export * from './UserDevicesDeleteResponseData';
|
|
349
|
+
export * from './V1MuseSubjectsSuggestPostRequest';
|
|
323
350
|
export * from './ValidateResetTokenRequest';
|
|
324
351
|
export * from './ValidateResetTokenResponse';
|
|
325
352
|
export * from './ValidateResetTokenResponseData';
|