@zyphr-dev/node-sdk 0.1.33 → 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 +588 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +664 -1
- package/dist/index.d.ts +664 -1
- package/dist/index.js +537 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/.openapi-generator/FILES +10 -0
- package/src/client.ts +4 -0
- package/src/src/apis/DomainsApi.ts +73 -0
- package/src/src/apis/InboundEmailApi.ts +264 -0
- package/src/src/apis/index.ts +1 -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/SetDomainInboundRequest.ts +65 -0
- package/src/src/models/index.ts +9 -0
package/dist/index.js
CHANGED
|
@@ -4702,6 +4702,301 @@ function InAppNotificationToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
4702
4702
|
};
|
|
4703
4703
|
}
|
|
4704
4704
|
|
|
4705
|
+
// src/src/models/InboundAttachmentUrlResponseData.ts
|
|
4706
|
+
function instanceOfInboundAttachmentUrlResponseData(value) {
|
|
4707
|
+
return true;
|
|
4708
|
+
}
|
|
4709
|
+
function InboundAttachmentUrlResponseDataFromJSON(json) {
|
|
4710
|
+
return InboundAttachmentUrlResponseDataFromJSONTyped(json, false);
|
|
4711
|
+
}
|
|
4712
|
+
function InboundAttachmentUrlResponseDataFromJSONTyped(json, ignoreDiscriminator) {
|
|
4713
|
+
if (json == null) {
|
|
4714
|
+
return json;
|
|
4715
|
+
}
|
|
4716
|
+
return {
|
|
4717
|
+
"downloadUrl": json["download_url"] == null ? void 0 : json["download_url"],
|
|
4718
|
+
"filename": json["filename"] == null ? void 0 : json["filename"],
|
|
4719
|
+
"contentType": json["content_type"] == null ? void 0 : json["content_type"]
|
|
4720
|
+
};
|
|
4721
|
+
}
|
|
4722
|
+
function InboundAttachmentUrlResponseDataToJSON(json) {
|
|
4723
|
+
return InboundAttachmentUrlResponseDataToJSONTyped(json, false);
|
|
4724
|
+
}
|
|
4725
|
+
function InboundAttachmentUrlResponseDataToJSONTyped(value, ignoreDiscriminator = false) {
|
|
4726
|
+
if (value == null) {
|
|
4727
|
+
return value;
|
|
4728
|
+
}
|
|
4729
|
+
return {
|
|
4730
|
+
"download_url": value["downloadUrl"],
|
|
4731
|
+
"filename": value["filename"],
|
|
4732
|
+
"content_type": value["contentType"]
|
|
4733
|
+
};
|
|
4734
|
+
}
|
|
4735
|
+
|
|
4736
|
+
// src/src/models/InboundAttachmentUrlResponse.ts
|
|
4737
|
+
function instanceOfInboundAttachmentUrlResponse(value) {
|
|
4738
|
+
return true;
|
|
4739
|
+
}
|
|
4740
|
+
function InboundAttachmentUrlResponseFromJSON(json) {
|
|
4741
|
+
return InboundAttachmentUrlResponseFromJSONTyped(json, false);
|
|
4742
|
+
}
|
|
4743
|
+
function InboundAttachmentUrlResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
4744
|
+
if (json == null) {
|
|
4745
|
+
return json;
|
|
4746
|
+
}
|
|
4747
|
+
return {
|
|
4748
|
+
"data": json["data"] == null ? void 0 : InboundAttachmentUrlResponseDataFromJSON(json["data"]),
|
|
4749
|
+
"meta": json["meta"] == null ? void 0 : RequestMetaFromJSON(json["meta"])
|
|
4750
|
+
};
|
|
4751
|
+
}
|
|
4752
|
+
function InboundAttachmentUrlResponseToJSON(json) {
|
|
4753
|
+
return InboundAttachmentUrlResponseToJSONTyped(json, false);
|
|
4754
|
+
}
|
|
4755
|
+
function InboundAttachmentUrlResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
4756
|
+
if (value == null) {
|
|
4757
|
+
return value;
|
|
4758
|
+
}
|
|
4759
|
+
return {
|
|
4760
|
+
"data": InboundAttachmentUrlResponseDataToJSON(value["data"]),
|
|
4761
|
+
"meta": RequestMetaToJSON(value["meta"])
|
|
4762
|
+
};
|
|
4763
|
+
}
|
|
4764
|
+
|
|
4765
|
+
// src/src/models/InboundEmailFrom.ts
|
|
4766
|
+
function instanceOfInboundEmailFrom(value) {
|
|
4767
|
+
return true;
|
|
4768
|
+
}
|
|
4769
|
+
function InboundEmailFromFromJSON(json) {
|
|
4770
|
+
return InboundEmailFromFromJSONTyped(json, false);
|
|
4771
|
+
}
|
|
4772
|
+
function InboundEmailFromFromJSONTyped(json, ignoreDiscriminator) {
|
|
4773
|
+
if (json == null) {
|
|
4774
|
+
return json;
|
|
4775
|
+
}
|
|
4776
|
+
return {
|
|
4777
|
+
"email": json["email"] == null ? void 0 : json["email"],
|
|
4778
|
+
"name": json["name"] == null ? void 0 : json["name"]
|
|
4779
|
+
};
|
|
4780
|
+
}
|
|
4781
|
+
function InboundEmailFromToJSON(json) {
|
|
4782
|
+
return InboundEmailFromToJSONTyped(json, false);
|
|
4783
|
+
}
|
|
4784
|
+
function InboundEmailFromToJSONTyped(value, ignoreDiscriminator = false) {
|
|
4785
|
+
if (value == null) {
|
|
4786
|
+
return value;
|
|
4787
|
+
}
|
|
4788
|
+
return {
|
|
4789
|
+
"email": value["email"],
|
|
4790
|
+
"name": value["name"]
|
|
4791
|
+
};
|
|
4792
|
+
}
|
|
4793
|
+
|
|
4794
|
+
// src/src/models/InboundEmailAttachment.ts
|
|
4795
|
+
function instanceOfInboundEmailAttachment(value) {
|
|
4796
|
+
return true;
|
|
4797
|
+
}
|
|
4798
|
+
function InboundEmailAttachmentFromJSON(json) {
|
|
4799
|
+
return InboundEmailAttachmentFromJSONTyped(json, false);
|
|
4800
|
+
}
|
|
4801
|
+
function InboundEmailAttachmentFromJSONTyped(json, ignoreDiscriminator) {
|
|
4802
|
+
if (json == null) {
|
|
4803
|
+
return json;
|
|
4804
|
+
}
|
|
4805
|
+
return {
|
|
4806
|
+
"id": json["id"] == null ? void 0 : json["id"],
|
|
4807
|
+
"filename": json["filename"] == null ? void 0 : json["filename"],
|
|
4808
|
+
"contentType": json["content_type"] == null ? void 0 : json["content_type"],
|
|
4809
|
+
"size": json["size"] == null ? void 0 : json["size"]
|
|
4810
|
+
};
|
|
4811
|
+
}
|
|
4812
|
+
function InboundEmailAttachmentToJSON(json) {
|
|
4813
|
+
return InboundEmailAttachmentToJSONTyped(json, false);
|
|
4814
|
+
}
|
|
4815
|
+
function InboundEmailAttachmentToJSONTyped(value, ignoreDiscriminator = false) {
|
|
4816
|
+
if (value == null) {
|
|
4817
|
+
return value;
|
|
4818
|
+
}
|
|
4819
|
+
return {
|
|
4820
|
+
"id": value["id"],
|
|
4821
|
+
"filename": value["filename"],
|
|
4822
|
+
"content_type": value["contentType"],
|
|
4823
|
+
"size": value["size"]
|
|
4824
|
+
};
|
|
4825
|
+
}
|
|
4826
|
+
|
|
4827
|
+
// src/src/models/InboundEmail.ts
|
|
4828
|
+
var InboundEmailSpfVerdictEnum = {
|
|
4829
|
+
PASS: "PASS",
|
|
4830
|
+
FAIL: "FAIL",
|
|
4831
|
+
GRAY: "GRAY",
|
|
4832
|
+
PROCESSING_FAILED: "PROCESSING_FAILED"
|
|
4833
|
+
};
|
|
4834
|
+
var InboundEmailDkimVerdictEnum = {
|
|
4835
|
+
PASS: "PASS",
|
|
4836
|
+
FAIL: "FAIL",
|
|
4837
|
+
GRAY: "GRAY",
|
|
4838
|
+
PROCESSING_FAILED: "PROCESSING_FAILED"
|
|
4839
|
+
};
|
|
4840
|
+
var InboundEmailDmarcVerdictEnum = {
|
|
4841
|
+
PASS: "PASS",
|
|
4842
|
+
FAIL: "FAIL",
|
|
4843
|
+
GRAY: "GRAY",
|
|
4844
|
+
PROCESSING_FAILED: "PROCESSING_FAILED"
|
|
4845
|
+
};
|
|
4846
|
+
var InboundEmailStatusEnum = {
|
|
4847
|
+
RECEIVED: "received",
|
|
4848
|
+
PROCESSED: "processed",
|
|
4849
|
+
QUARANTINED: "quarantined",
|
|
4850
|
+
DROPPED: "dropped",
|
|
4851
|
+
FAILED: "failed"
|
|
4852
|
+
};
|
|
4853
|
+
function instanceOfInboundEmail(value) {
|
|
4854
|
+
return true;
|
|
4855
|
+
}
|
|
4856
|
+
function InboundEmailFromJSON(json) {
|
|
4857
|
+
return InboundEmailFromJSONTyped(json, false);
|
|
4858
|
+
}
|
|
4859
|
+
function InboundEmailFromJSONTyped(json, ignoreDiscriminator) {
|
|
4860
|
+
if (json == null) {
|
|
4861
|
+
return json;
|
|
4862
|
+
}
|
|
4863
|
+
return {
|
|
4864
|
+
"id": json["id"] == null ? void 0 : json["id"],
|
|
4865
|
+
"toEmail": json["to_email"] == null ? void 0 : json["to_email"],
|
|
4866
|
+
"from": json["from"] == null ? void 0 : InboundEmailFromFromJSON(json["from"]),
|
|
4867
|
+
"cc": json["cc"] == null ? void 0 : json["cc"],
|
|
4868
|
+
"subject": json["subject"] == null ? void 0 : json["subject"],
|
|
4869
|
+
"textBody": json["text_body"] == null ? void 0 : json["text_body"],
|
|
4870
|
+
"htmlBody": json["html_body"] == null ? void 0 : json["html_body"],
|
|
4871
|
+
"inReplyTo": json["in_reply_to"] == null ? void 0 : json["in_reply_to"],
|
|
4872
|
+
"repliedToMessageId": json["replied_to_message_id"] == null ? void 0 : json["replied_to_message_id"],
|
|
4873
|
+
"verified": json["verified"] == null ? void 0 : json["verified"],
|
|
4874
|
+
"spfVerdict": json["spf_verdict"] == null ? void 0 : json["spf_verdict"],
|
|
4875
|
+
"dkimVerdict": json["dkim_verdict"] == null ? void 0 : json["dkim_verdict"],
|
|
4876
|
+
"dmarcVerdict": json["dmarc_verdict"] == null ? void 0 : json["dmarc_verdict"],
|
|
4877
|
+
"status": json["status"] == null ? void 0 : json["status"],
|
|
4878
|
+
"attachments": json["attachments"] == null ? void 0 : json["attachments"].map(InboundEmailAttachmentFromJSON),
|
|
4879
|
+
"createdAt": json["created_at"] == null ? void 0 : new Date(json["created_at"])
|
|
4880
|
+
};
|
|
4881
|
+
}
|
|
4882
|
+
function InboundEmailToJSON(json) {
|
|
4883
|
+
return InboundEmailToJSONTyped(json, false);
|
|
4884
|
+
}
|
|
4885
|
+
function InboundEmailToJSONTyped(value, ignoreDiscriminator = false) {
|
|
4886
|
+
if (value == null) {
|
|
4887
|
+
return value;
|
|
4888
|
+
}
|
|
4889
|
+
return {
|
|
4890
|
+
"id": value["id"],
|
|
4891
|
+
"to_email": value["toEmail"],
|
|
4892
|
+
"from": InboundEmailFromToJSON(value["from"]),
|
|
4893
|
+
"cc": value["cc"],
|
|
4894
|
+
"subject": value["subject"],
|
|
4895
|
+
"text_body": value["textBody"],
|
|
4896
|
+
"html_body": value["htmlBody"],
|
|
4897
|
+
"in_reply_to": value["inReplyTo"],
|
|
4898
|
+
"replied_to_message_id": value["repliedToMessageId"],
|
|
4899
|
+
"verified": value["verified"],
|
|
4900
|
+
"spf_verdict": value["spfVerdict"],
|
|
4901
|
+
"dkim_verdict": value["dkimVerdict"],
|
|
4902
|
+
"dmarc_verdict": value["dmarcVerdict"],
|
|
4903
|
+
"status": value["status"],
|
|
4904
|
+
"attachments": value["attachments"] == null ? void 0 : value["attachments"].map(InboundEmailAttachmentToJSON),
|
|
4905
|
+
"created_at": value["createdAt"] == null ? void 0 : value["createdAt"].toISOString()
|
|
4906
|
+
};
|
|
4907
|
+
}
|
|
4908
|
+
|
|
4909
|
+
// src/src/models/InboundEmailListResponseMeta.ts
|
|
4910
|
+
function instanceOfInboundEmailListResponseMeta(value) {
|
|
4911
|
+
return true;
|
|
4912
|
+
}
|
|
4913
|
+
function InboundEmailListResponseMetaFromJSON(json) {
|
|
4914
|
+
return InboundEmailListResponseMetaFromJSONTyped(json, false);
|
|
4915
|
+
}
|
|
4916
|
+
function InboundEmailListResponseMetaFromJSONTyped(json, ignoreDiscriminator) {
|
|
4917
|
+
if (json == null) {
|
|
4918
|
+
return json;
|
|
4919
|
+
}
|
|
4920
|
+
return {
|
|
4921
|
+
"requestId": json["request_id"] == null ? void 0 : json["request_id"],
|
|
4922
|
+
"total": json["total"] == null ? void 0 : json["total"],
|
|
4923
|
+
"limit": json["limit"] == null ? void 0 : json["limit"],
|
|
4924
|
+
"offset": json["offset"] == null ? void 0 : json["offset"]
|
|
4925
|
+
};
|
|
4926
|
+
}
|
|
4927
|
+
function InboundEmailListResponseMetaToJSON(json) {
|
|
4928
|
+
return InboundEmailListResponseMetaToJSONTyped(json, false);
|
|
4929
|
+
}
|
|
4930
|
+
function InboundEmailListResponseMetaToJSONTyped(value, ignoreDiscriminator = false) {
|
|
4931
|
+
if (value == null) {
|
|
4932
|
+
return value;
|
|
4933
|
+
}
|
|
4934
|
+
return {
|
|
4935
|
+
"request_id": value["requestId"],
|
|
4936
|
+
"total": value["total"],
|
|
4937
|
+
"limit": value["limit"],
|
|
4938
|
+
"offset": value["offset"]
|
|
4939
|
+
};
|
|
4940
|
+
}
|
|
4941
|
+
|
|
4942
|
+
// src/src/models/InboundEmailListResponse.ts
|
|
4943
|
+
function instanceOfInboundEmailListResponse(value) {
|
|
4944
|
+
return true;
|
|
4945
|
+
}
|
|
4946
|
+
function InboundEmailListResponseFromJSON(json) {
|
|
4947
|
+
return InboundEmailListResponseFromJSONTyped(json, false);
|
|
4948
|
+
}
|
|
4949
|
+
function InboundEmailListResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
4950
|
+
if (json == null) {
|
|
4951
|
+
return json;
|
|
4952
|
+
}
|
|
4953
|
+
return {
|
|
4954
|
+
"data": json["data"] == null ? void 0 : json["data"].map(InboundEmailFromJSON),
|
|
4955
|
+
"meta": json["meta"] == null ? void 0 : InboundEmailListResponseMetaFromJSON(json["meta"])
|
|
4956
|
+
};
|
|
4957
|
+
}
|
|
4958
|
+
function InboundEmailListResponseToJSON(json) {
|
|
4959
|
+
return InboundEmailListResponseToJSONTyped(json, false);
|
|
4960
|
+
}
|
|
4961
|
+
function InboundEmailListResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
4962
|
+
if (value == null) {
|
|
4963
|
+
return value;
|
|
4964
|
+
}
|
|
4965
|
+
return {
|
|
4966
|
+
"data": value["data"] == null ? void 0 : value["data"].map(InboundEmailToJSON),
|
|
4967
|
+
"meta": InboundEmailListResponseMetaToJSON(value["meta"])
|
|
4968
|
+
};
|
|
4969
|
+
}
|
|
4970
|
+
|
|
4971
|
+
// src/src/models/InboundEmailResponse.ts
|
|
4972
|
+
function instanceOfInboundEmailResponse(value) {
|
|
4973
|
+
return true;
|
|
4974
|
+
}
|
|
4975
|
+
function InboundEmailResponseFromJSON(json) {
|
|
4976
|
+
return InboundEmailResponseFromJSONTyped(json, false);
|
|
4977
|
+
}
|
|
4978
|
+
function InboundEmailResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
4979
|
+
if (json == null) {
|
|
4980
|
+
return json;
|
|
4981
|
+
}
|
|
4982
|
+
return {
|
|
4983
|
+
"data": json["data"] == null ? void 0 : InboundEmailFromJSON(json["data"]),
|
|
4984
|
+
"meta": json["meta"] == null ? void 0 : RequestMetaFromJSON(json["meta"])
|
|
4985
|
+
};
|
|
4986
|
+
}
|
|
4987
|
+
function InboundEmailResponseToJSON(json) {
|
|
4988
|
+
return InboundEmailResponseToJSONTyped(json, false);
|
|
4989
|
+
}
|
|
4990
|
+
function InboundEmailResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
4991
|
+
if (value == null) {
|
|
4992
|
+
return value;
|
|
4993
|
+
}
|
|
4994
|
+
return {
|
|
4995
|
+
"data": InboundEmailToJSON(value["data"]),
|
|
4996
|
+
"meta": RequestMetaToJSON(value["meta"])
|
|
4997
|
+
};
|
|
4998
|
+
}
|
|
4999
|
+
|
|
4705
5000
|
// src/src/models/InboxListMeta.ts
|
|
4706
5001
|
function instanceOfInboxListMeta(value) {
|
|
4707
5002
|
return true;
|
|
@@ -9674,6 +9969,33 @@ function SessionListResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
9674
9969
|
};
|
|
9675
9970
|
}
|
|
9676
9971
|
|
|
9972
|
+
// src/src/models/SetDomainInboundRequest.ts
|
|
9973
|
+
function instanceOfSetDomainInboundRequest(value) {
|
|
9974
|
+
return true;
|
|
9975
|
+
}
|
|
9976
|
+
function SetDomainInboundRequestFromJSON(json) {
|
|
9977
|
+
return SetDomainInboundRequestFromJSONTyped(json, false);
|
|
9978
|
+
}
|
|
9979
|
+
function SetDomainInboundRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
9980
|
+
if (json == null) {
|
|
9981
|
+
return json;
|
|
9982
|
+
}
|
|
9983
|
+
return {
|
|
9984
|
+
"enabled": json["enabled"] == null ? void 0 : json["enabled"]
|
|
9985
|
+
};
|
|
9986
|
+
}
|
|
9987
|
+
function SetDomainInboundRequestToJSON(json) {
|
|
9988
|
+
return SetDomainInboundRequestToJSONTyped(json, false);
|
|
9989
|
+
}
|
|
9990
|
+
function SetDomainInboundRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
9991
|
+
if (value == null) {
|
|
9992
|
+
return value;
|
|
9993
|
+
}
|
|
9994
|
+
return {
|
|
9995
|
+
"enabled": value["enabled"]
|
|
9996
|
+
};
|
|
9997
|
+
}
|
|
9998
|
+
|
|
9677
9999
|
// src/src/models/SetPreferencesRequestPreferencesInner.ts
|
|
9678
10000
|
function instanceOfSetPreferencesRequestPreferencesInner(value) {
|
|
9679
10001
|
return true;
|
|
@@ -17053,6 +17375,45 @@ var DomainsApi = class extends BaseAPI {
|
|
|
17053
17375
|
const response = await this.listDomainsRaw(initOverrides);
|
|
17054
17376
|
return await response.value();
|
|
17055
17377
|
}
|
|
17378
|
+
/**
|
|
17379
|
+
* Toggle email receiving for a domain. When enabled, the domain\'s DNS records gain an MX record on the `inbound.` subdomain that the tenant must publish. Requires a plan with inbound email (Starter+).
|
|
17380
|
+
* Enable or disable inbound email for a domain
|
|
17381
|
+
*/
|
|
17382
|
+
async setDomainInboundRaw(requestParameters, initOverrides) {
|
|
17383
|
+
if (requestParameters["id"] == null) {
|
|
17384
|
+
throw new RequiredError(
|
|
17385
|
+
"id",
|
|
17386
|
+
'Required parameter "id" was null or undefined when calling setDomainInbound().'
|
|
17387
|
+
);
|
|
17388
|
+
}
|
|
17389
|
+
if (requestParameters["setDomainInboundRequest"] == null) {
|
|
17390
|
+
throw new RequiredError(
|
|
17391
|
+
"setDomainInboundRequest",
|
|
17392
|
+
'Required parameter "setDomainInboundRequest" was null or undefined when calling setDomainInbound().'
|
|
17393
|
+
);
|
|
17394
|
+
}
|
|
17395
|
+
const queryParameters = {};
|
|
17396
|
+
const headerParameters = {};
|
|
17397
|
+
headerParameters["Content-Type"] = "application/json";
|
|
17398
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
17399
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key");
|
|
17400
|
+
}
|
|
17401
|
+
const response = await this.request({
|
|
17402
|
+
path: `/domains/{id}/inbound`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters["id"]))),
|
|
17403
|
+
method: "PUT",
|
|
17404
|
+
headers: headerParameters,
|
|
17405
|
+
query: queryParameters,
|
|
17406
|
+
body: SetDomainInboundRequestToJSON(requestParameters["setDomainInboundRequest"])
|
|
17407
|
+
}, initOverrides);
|
|
17408
|
+
return new VoidApiResponse(response);
|
|
17409
|
+
}
|
|
17410
|
+
/**
|
|
17411
|
+
* Toggle email receiving for a domain. When enabled, the domain\'s DNS records gain an MX record on the `inbound.` subdomain that the tenant must publish. Requires a plan with inbound email (Starter+).
|
|
17412
|
+
* Enable or disable inbound email for a domain
|
|
17413
|
+
*/
|
|
17414
|
+
async setDomainInbound(id, setDomainInboundRequest, initOverrides) {
|
|
17415
|
+
await this.setDomainInboundRaw({ id, setDomainInboundRequest }, initOverrides);
|
|
17416
|
+
}
|
|
17056
17417
|
/**
|
|
17057
17418
|
* Queue an asynchronous DNS verification check. Returns immediately with a `job_id`. Poll `GET /v1/domains/{id}/verification-status` (or the higher-level `GET /v1/domains/{id}`) for the result, or subscribe to the `domain.verified` webhook event when sc-5444 ships. Returns 409 if a verification is already in progress for this domain (within the last 2 minutes).
|
|
17058
17419
|
* Trigger domain verification
|
|
@@ -17402,6 +17763,128 @@ var ExecutionsApi = class extends BaseAPI {
|
|
|
17402
17763
|
}
|
|
17403
17764
|
};
|
|
17404
17765
|
|
|
17766
|
+
// src/src/apis/InboundEmailApi.ts
|
|
17767
|
+
var InboundEmailApi = class extends BaseAPI {
|
|
17768
|
+
/**
|
|
17769
|
+
* Return a short-lived presigned S3 download URL for one attachment of a received email. `attachmentId` is the positional id from the email\'s `attachments` array.
|
|
17770
|
+
* Get an attachment download URL
|
|
17771
|
+
*/
|
|
17772
|
+
async getInboundAttachmentUrlRaw(requestParameters, initOverrides) {
|
|
17773
|
+
if (requestParameters["id"] == null) {
|
|
17774
|
+
throw new RequiredError(
|
|
17775
|
+
"id",
|
|
17776
|
+
'Required parameter "id" was null or undefined when calling getInboundAttachmentUrl().'
|
|
17777
|
+
);
|
|
17778
|
+
}
|
|
17779
|
+
if (requestParameters["attachmentId"] == null) {
|
|
17780
|
+
throw new RequiredError(
|
|
17781
|
+
"attachmentId",
|
|
17782
|
+
'Required parameter "attachmentId" was null or undefined when calling getInboundAttachmentUrl().'
|
|
17783
|
+
);
|
|
17784
|
+
}
|
|
17785
|
+
const queryParameters = {};
|
|
17786
|
+
const headerParameters = {};
|
|
17787
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
17788
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key");
|
|
17789
|
+
}
|
|
17790
|
+
const response = await this.request({
|
|
17791
|
+
path: `/inbound-emails/{id}/attachments/{attachmentId}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters["id"]))).replace(`{${"attachmentId"}}`, encodeURIComponent(String(requestParameters["attachmentId"]))),
|
|
17792
|
+
method: "GET",
|
|
17793
|
+
headers: headerParameters,
|
|
17794
|
+
query: queryParameters
|
|
17795
|
+
}, initOverrides);
|
|
17796
|
+
return new JSONApiResponse(response, (jsonValue) => InboundAttachmentUrlResponseFromJSON(jsonValue));
|
|
17797
|
+
}
|
|
17798
|
+
/**
|
|
17799
|
+
* Return a short-lived presigned S3 download URL for one attachment of a received email. `attachmentId` is the positional id from the email\'s `attachments` array.
|
|
17800
|
+
* Get an attachment download URL
|
|
17801
|
+
*/
|
|
17802
|
+
async getInboundAttachmentUrl(id, attachmentId, initOverrides) {
|
|
17803
|
+
const response = await this.getInboundAttachmentUrlRaw({ id, attachmentId }, initOverrides);
|
|
17804
|
+
return await response.value();
|
|
17805
|
+
}
|
|
17806
|
+
/**
|
|
17807
|
+
* Retrieve a single inbound email by id (scoped to the project).
|
|
17808
|
+
* Get a received email
|
|
17809
|
+
*/
|
|
17810
|
+
async getInboundEmailRaw(requestParameters, initOverrides) {
|
|
17811
|
+
if (requestParameters["id"] == null) {
|
|
17812
|
+
throw new RequiredError(
|
|
17813
|
+
"id",
|
|
17814
|
+
'Required parameter "id" was null or undefined when calling getInboundEmail().'
|
|
17815
|
+
);
|
|
17816
|
+
}
|
|
17817
|
+
const queryParameters = {};
|
|
17818
|
+
const headerParameters = {};
|
|
17819
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
17820
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key");
|
|
17821
|
+
}
|
|
17822
|
+
const response = await this.request({
|
|
17823
|
+
path: `/inbound-emails/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters["id"]))),
|
|
17824
|
+
method: "GET",
|
|
17825
|
+
headers: headerParameters,
|
|
17826
|
+
query: queryParameters
|
|
17827
|
+
}, initOverrides);
|
|
17828
|
+
return new JSONApiResponse(response, (jsonValue) => InboundEmailResponseFromJSON(jsonValue));
|
|
17829
|
+
}
|
|
17830
|
+
/**
|
|
17831
|
+
* Retrieve a single inbound email by id (scoped to the project).
|
|
17832
|
+
* Get a received email
|
|
17833
|
+
*/
|
|
17834
|
+
async getInboundEmail(id, initOverrides) {
|
|
17835
|
+
const response = await this.getInboundEmailRaw({ id }, initOverrides);
|
|
17836
|
+
return await response.value();
|
|
17837
|
+
}
|
|
17838
|
+
/**
|
|
17839
|
+
* List inbound (received) emails for the project, newest first. By default only delivered mail (`received`/`processed`) is returned; pass `include_withheld=true` to also see quarantined/dropped.
|
|
17840
|
+
* List received emails
|
|
17841
|
+
*/
|
|
17842
|
+
async listInboundEmailsRaw(requestParameters, initOverrides) {
|
|
17843
|
+
const queryParameters = {};
|
|
17844
|
+
if (requestParameters["status"] != null) {
|
|
17845
|
+
queryParameters["status"] = requestParameters["status"];
|
|
17846
|
+
}
|
|
17847
|
+
if (requestParameters["to"] != null) {
|
|
17848
|
+
queryParameters["to"] = requestParameters["to"];
|
|
17849
|
+
}
|
|
17850
|
+
if (requestParameters["includeWithheld"] != null) {
|
|
17851
|
+
queryParameters["include_withheld"] = requestParameters["includeWithheld"];
|
|
17852
|
+
}
|
|
17853
|
+
if (requestParameters["limit"] != null) {
|
|
17854
|
+
queryParameters["limit"] = requestParameters["limit"];
|
|
17855
|
+
}
|
|
17856
|
+
if (requestParameters["offset"] != null) {
|
|
17857
|
+
queryParameters["offset"] = requestParameters["offset"];
|
|
17858
|
+
}
|
|
17859
|
+
const headerParameters = {};
|
|
17860
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
17861
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key");
|
|
17862
|
+
}
|
|
17863
|
+
const response = await this.request({
|
|
17864
|
+
path: `/inbound-emails`,
|
|
17865
|
+
method: "GET",
|
|
17866
|
+
headers: headerParameters,
|
|
17867
|
+
query: queryParameters
|
|
17868
|
+
}, initOverrides);
|
|
17869
|
+
return new JSONApiResponse(response, (jsonValue) => InboundEmailListResponseFromJSON(jsonValue));
|
|
17870
|
+
}
|
|
17871
|
+
/**
|
|
17872
|
+
* List inbound (received) emails for the project, newest first. By default only delivered mail (`received`/`processed`) is returned; pass `include_withheld=true` to also see quarantined/dropped.
|
|
17873
|
+
* List received emails
|
|
17874
|
+
*/
|
|
17875
|
+
async listInboundEmails(status, to, includeWithheld, limit, offset, initOverrides) {
|
|
17876
|
+
const response = await this.listInboundEmailsRaw({ status, to, includeWithheld, limit, offset }, initOverrides);
|
|
17877
|
+
return await response.value();
|
|
17878
|
+
}
|
|
17879
|
+
};
|
|
17880
|
+
var ListInboundEmailsStatusEnum = {
|
|
17881
|
+
RECEIVED: "received",
|
|
17882
|
+
PROCESSED: "processed",
|
|
17883
|
+
QUARANTINED: "quarantined",
|
|
17884
|
+
DROPPED: "dropped",
|
|
17885
|
+
FAILED: "failed"
|
|
17886
|
+
};
|
|
17887
|
+
|
|
17405
17888
|
// src/src/apis/InboxApi.ts
|
|
17406
17889
|
var InboxApi = class extends BaseAPI {
|
|
17407
17890
|
/**
|
|
@@ -22377,6 +22860,8 @@ var Zyphr = class {
|
|
|
22377
22860
|
topics;
|
|
22378
22861
|
devices;
|
|
22379
22862
|
domains;
|
|
22863
|
+
/** Inbound (received) email — read access. Requires the `email:read` scope. */
|
|
22864
|
+
inbound;
|
|
22380
22865
|
waas;
|
|
22381
22866
|
auth;
|
|
22382
22867
|
options;
|
|
@@ -22402,6 +22887,7 @@ var Zyphr = class {
|
|
|
22402
22887
|
this.topics = new TopicsApi(config);
|
|
22403
22888
|
this.devices = new DevicesApi(config);
|
|
22404
22889
|
this.domains = new DomainsApi(config);
|
|
22890
|
+
this.inbound = new InboundEmailApi(config);
|
|
22405
22891
|
this.waas = {
|
|
22406
22892
|
applications: new WaaSApplicationsApi(config),
|
|
22407
22893
|
eventTypes: new WaaSEventTypesApi(config),
|
|
@@ -22965,6 +23451,43 @@ export {
|
|
|
22965
23451
|
InAppNotificationPriorityEnum,
|
|
22966
23452
|
InAppNotificationToJSON,
|
|
22967
23453
|
InAppNotificationToJSONTyped,
|
|
23454
|
+
InboundAttachmentUrlResponseDataFromJSON,
|
|
23455
|
+
InboundAttachmentUrlResponseDataFromJSONTyped,
|
|
23456
|
+
InboundAttachmentUrlResponseDataToJSON,
|
|
23457
|
+
InboundAttachmentUrlResponseDataToJSONTyped,
|
|
23458
|
+
InboundAttachmentUrlResponseFromJSON,
|
|
23459
|
+
InboundAttachmentUrlResponseFromJSONTyped,
|
|
23460
|
+
InboundAttachmentUrlResponseToJSON,
|
|
23461
|
+
InboundAttachmentUrlResponseToJSONTyped,
|
|
23462
|
+
InboundEmailApi,
|
|
23463
|
+
InboundEmailAttachmentFromJSON,
|
|
23464
|
+
InboundEmailAttachmentFromJSONTyped,
|
|
23465
|
+
InboundEmailAttachmentToJSON,
|
|
23466
|
+
InboundEmailAttachmentToJSONTyped,
|
|
23467
|
+
InboundEmailDkimVerdictEnum,
|
|
23468
|
+
InboundEmailDmarcVerdictEnum,
|
|
23469
|
+
InboundEmailFromFromJSON,
|
|
23470
|
+
InboundEmailFromFromJSONTyped,
|
|
23471
|
+
InboundEmailFromJSON,
|
|
23472
|
+
InboundEmailFromJSONTyped,
|
|
23473
|
+
InboundEmailFromToJSON,
|
|
23474
|
+
InboundEmailFromToJSONTyped,
|
|
23475
|
+
InboundEmailListResponseFromJSON,
|
|
23476
|
+
InboundEmailListResponseFromJSONTyped,
|
|
23477
|
+
InboundEmailListResponseMetaFromJSON,
|
|
23478
|
+
InboundEmailListResponseMetaFromJSONTyped,
|
|
23479
|
+
InboundEmailListResponseMetaToJSON,
|
|
23480
|
+
InboundEmailListResponseMetaToJSONTyped,
|
|
23481
|
+
InboundEmailListResponseToJSON,
|
|
23482
|
+
InboundEmailListResponseToJSONTyped,
|
|
23483
|
+
InboundEmailResponseFromJSON,
|
|
23484
|
+
InboundEmailResponseFromJSONTyped,
|
|
23485
|
+
InboundEmailResponseToJSON,
|
|
23486
|
+
InboundEmailResponseToJSONTyped,
|
|
23487
|
+
InboundEmailSpfVerdictEnum,
|
|
23488
|
+
InboundEmailStatusEnum,
|
|
23489
|
+
InboundEmailToJSON,
|
|
23490
|
+
InboundEmailToJSONTyped,
|
|
22968
23491
|
InboxApi,
|
|
22969
23492
|
InboxListMetaFromJSON,
|
|
22970
23493
|
InboxListMetaFromJSONTyped,
|
|
@@ -22982,6 +23505,7 @@ export {
|
|
|
22982
23505
|
ListAllInboxStatusEnum,
|
|
22983
23506
|
ListDevicesPlatformEnum,
|
|
22984
23507
|
ListEmailsStatusEnum,
|
|
23508
|
+
ListInboundEmailsStatusEnum,
|
|
22985
23509
|
ListPushStatusEnum,
|
|
22986
23510
|
ListSlackMessagesStatusEnum,
|
|
22987
23511
|
ListSmsStatusEnum,
|
|
@@ -23584,6 +24108,10 @@ export {
|
|
|
23584
24108
|
SessionListResponseFromJSONTyped,
|
|
23585
24109
|
SessionListResponseToJSON,
|
|
23586
24110
|
SessionListResponseToJSONTyped,
|
|
24111
|
+
SetDomainInboundRequestFromJSON,
|
|
24112
|
+
SetDomainInboundRequestFromJSONTyped,
|
|
24113
|
+
SetDomainInboundRequestToJSON,
|
|
24114
|
+
SetDomainInboundRequestToJSONTyped,
|
|
23587
24115
|
SetPreferencesRequestFromJSON,
|
|
23588
24116
|
SetPreferencesRequestFromJSONTyped,
|
|
23589
24117
|
SetPreferencesRequestPreferencesInnerFromJSON,
|
|
@@ -24361,6 +24889,14 @@ export {
|
|
|
24361
24889
|
instanceOfGetWaaSEndpoint200Response,
|
|
24362
24890
|
instanceOfGetWaaSUsage200Response,
|
|
24363
24891
|
instanceOfInAppNotification,
|
|
24892
|
+
instanceOfInboundAttachmentUrlResponse,
|
|
24893
|
+
instanceOfInboundAttachmentUrlResponseData,
|
|
24894
|
+
instanceOfInboundEmail,
|
|
24895
|
+
instanceOfInboundEmailAttachment,
|
|
24896
|
+
instanceOfInboundEmailFrom,
|
|
24897
|
+
instanceOfInboundEmailListResponse,
|
|
24898
|
+
instanceOfInboundEmailListResponseMeta,
|
|
24899
|
+
instanceOfInboundEmailResponse,
|
|
24364
24900
|
instanceOfInboxListMeta,
|
|
24365
24901
|
instanceOfInboxListResponse,
|
|
24366
24902
|
instanceOfInboxNotificationResponse,
|
|
@@ -24508,6 +25044,7 @@ export {
|
|
|
24508
25044
|
instanceOfSessionListResponse,
|
|
24509
25045
|
instanceOfSessionListResponseData,
|
|
24510
25046
|
instanceOfSessionListResponseDataSessionInfo,
|
|
25047
|
+
instanceOfSetDomainInboundRequest,
|
|
24511
25048
|
instanceOfSetPreferencesRequest,
|
|
24512
25049
|
instanceOfSetPreferencesRequestPreferencesInner,
|
|
24513
25050
|
instanceOfSignInAnonymouslyRequest,
|