@pushwoosh/rpc-v2-http-api-data 0.2.448 → 0.2.450

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/data.js CHANGED
@@ -14578,6 +14578,18 @@ export const data = {
14578
14578
  "method": "get",
14579
14579
  "path": "/api/emails_configurations/domains:diagnose"
14580
14580
  },
14581
+ "ConnectPostmaster": {
14582
+ "request": "pushwoosh.rpc_v2.emails_configurations.ConnectPostmasterRequest",
14583
+ "response": "pushwoosh.rpc_v2.emails_configurations.ConnectPostmasterResponse",
14584
+ "method": "post",
14585
+ "path": "/api/emails_configurations/domains:connect_postmaster"
14586
+ },
14587
+ "DisconnectPostmaster": {
14588
+ "request": "pushwoosh.rpc_v2.emails_configurations.DisconnectPostmasterRequest",
14589
+ "response": "pushwoosh.rpc_v2.emails_configurations.DisconnectPostmasterResponse",
14590
+ "method": "post",
14591
+ "path": "/api/emails_configurations/domains:disconnect_postmaster"
14592
+ },
14581
14593
  "RestartDomainVerification": {
14582
14594
  "request": "pushwoosh.rpc_v2.emails_configurations.RestartDomainVerificationRequest",
14583
14595
  "response": "pushwoosh.rpc_v2.emails_configurations.RestartDomainVerificationResponse",
@@ -14586,6 +14598,35 @@ export const data = {
14586
14598
  }
14587
14599
  }
14588
14600
  },
14601
+ "pushwoosh.rpc_v2.emails_configurations.Domain.PostmasterCompliance": {
14602
+ "type": "I",
14603
+ "fields": {
14604
+ "requirement": {
14605
+ "type": "string"
14606
+ },
14607
+ "status": {
14608
+ "type": "string"
14609
+ }
14610
+ }
14611
+ },
14612
+ "pushwoosh.rpc_v2.emails_configurations.Domain.Postmaster": {
14613
+ "type": "I",
14614
+ "fields": {
14615
+ "status": {
14616
+ "type": "string"
14617
+ },
14618
+ "verificationRecord": {
14619
+ "type": "string"
14620
+ },
14621
+ "statusChangedAt": {
14622
+ "type": "string"
14623
+ },
14624
+ "compliance": {
14625
+ "type": "pushwoosh.rpc_v2.emails_configurations.Domain.PostmasterCompliance",
14626
+ "array": true
14627
+ }
14628
+ }
14629
+ },
14589
14630
  "pushwoosh.rpc_v2.emails_configurations.Domain.CName": {
14590
14631
  "type": "I",
14591
14632
  "fields": {
@@ -14626,6 +14667,9 @@ export const data = {
14626
14667
  "cnamesYandex": {
14627
14668
  "type": "pushwoosh.rpc_v2.emails_configurations.Domain.CName",
14628
14669
  "array": true
14670
+ },
14671
+ "postmaster": {
14672
+ "type": "pushwoosh.rpc_v2.emails_configurations.Domain.Postmaster"
14629
14673
  }
14630
14674
  }
14631
14675
  },
@@ -14658,6 +14702,9 @@ export const data = {
14658
14702
  "emailDomains": {
14659
14703
  "type": "pushwoosh.rpc_v2.emails_configurations.Domain",
14660
14704
  "array": true
14705
+ },
14706
+ "postmasterAvailable": {
14707
+ "type": "boolean"
14661
14708
  }
14662
14709
  }
14663
14710
  },
@@ -14848,6 +14895,40 @@ export const data = {
14848
14895
  "type": "I",
14849
14896
  "fields": {}
14850
14897
  },
14898
+ "pushwoosh.rpc_v2.emails_configurations.ConnectPostmasterRequest": {
14899
+ "type": "I",
14900
+ "fields": {
14901
+ "application": {
14902
+ "type": "string"
14903
+ },
14904
+ "domain": {
14905
+ "type": "string"
14906
+ }
14907
+ }
14908
+ },
14909
+ "pushwoosh.rpc_v2.emails_configurations.ConnectPostmasterResponse": {
14910
+ "type": "I",
14911
+ "fields": {
14912
+ "postmaster": {
14913
+ "type": "pushwoosh.rpc_v2.emails_configurations.Domain.Postmaster"
14914
+ }
14915
+ }
14916
+ },
14917
+ "pushwoosh.rpc_v2.emails_configurations.DisconnectPostmasterRequest": {
14918
+ "type": "I",
14919
+ "fields": {
14920
+ "application": {
14921
+ "type": "string"
14922
+ },
14923
+ "domain": {
14924
+ "type": "string"
14925
+ }
14926
+ }
14927
+ },
14928
+ "pushwoosh.rpc_v2.emails_configurations.DisconnectPostmasterResponse": {
14929
+ "type": "I",
14930
+ "fields": {}
14931
+ },
14851
14932
  "pushwoosh.rpc.errors.v3.I18NOptions": {
14852
14933
  "type": "I",
14853
14934
  "fields": {
@@ -24521,6 +24602,18 @@ export const data = {
24521
24602
  "response": "pushwoosh.rpc_v2.media_files.GetMediaFilesUsageResponse",
24522
24603
  "method": "get",
24523
24604
  "path": "/api/media/files/usage"
24605
+ },
24606
+ "GetSettings": {
24607
+ "request": "pushwoosh.rpc_v2.media_files.GetMediaSettingsRequest",
24608
+ "response": "pushwoosh.rpc_v2.media_files.GetMediaSettingsResponse",
24609
+ "method": "get",
24610
+ "path": "/api/media/settings"
24611
+ },
24612
+ "UpdateSettings": {
24613
+ "request": "pushwoosh.rpc_v2.media_files.UpdateMediaSettingsRequest",
24614
+ "response": "pushwoosh.rpc_v2.media_files.UpdateMediaSettingsResponse",
24615
+ "method": "put",
24616
+ "path": "/api/media/settings"
24524
24617
  }
24525
24618
  }
24526
24619
  },
@@ -24768,6 +24861,9 @@ export const data = {
24768
24861
  "versionsCount": {
24769
24862
  "type": "number"
24770
24863
  },
24864
+ "originalFileSize": {
24865
+ "type": "number"
24866
+ },
24771
24867
  "imageMeta": {
24772
24868
  "type": "pushwoosh.rpc_v2.media_files.MediaFile.ImageMeta"
24773
24869
  }
@@ -24780,6 +24876,53 @@ export const data = {
24780
24876
  }
24781
24877
  }
24782
24878
  },
24879
+ "pushwoosh.rpc_v2.media_files.MediaSettings": {
24880
+ "type": "I",
24881
+ "fields": {
24882
+ "compressPng": {
24883
+ "type": "boolean"
24884
+ }
24885
+ }
24886
+ },
24887
+ "pushwoosh.rpc_v2.media_files.GetMediaSettingsRequest": {
24888
+ "type": "I",
24889
+ "fields": {
24890
+ "application": {
24891
+ "type": "string"
24892
+ }
24893
+ }
24894
+ },
24895
+ "pushwoosh.rpc_v2.media_files.GetMediaSettingsResponse": {
24896
+ "type": "I",
24897
+ "fields": {
24898
+ "settings": {
24899
+ "type": "pushwoosh.rpc_v2.media_files.MediaSettings"
24900
+ },
24901
+ "canModify": {
24902
+ "type": "boolean"
24903
+ }
24904
+ }
24905
+ },
24906
+ "pushwoosh.rpc_v2.media_files.UpdateMediaSettingsRequest": {
24907
+ "type": "I",
24908
+ "fields": {
24909
+ "application": {
24910
+ "type": "string"
24911
+ },
24912
+ "compressPng": {
24913
+ "type": "boolean",
24914
+ "optional": true
24915
+ }
24916
+ }
24917
+ },
24918
+ "pushwoosh.rpc_v2.media_files.UpdateMediaSettingsResponse": {
24919
+ "type": "I",
24920
+ "fields": {
24921
+ "settings": {
24922
+ "type": "pushwoosh.rpc_v2.media_files.MediaSettings"
24923
+ }
24924
+ }
24925
+ },
24783
24926
  "pushwoosh.rpc_v2.messages.MessagesService": {
24784
24927
  "type": "S",
24785
24928
  "key": "messages",
@@ -8,6 +8,8 @@ export type EmailsConfigurationsService_UpsertCustomTrackingDomain = RpcMethod<U
8
8
  export type EmailsConfigurationsService_DeleteCustomTrackingDomain = RpcMethod<DeleteCustomTrackingDomainRequest, DeleteCustomTrackingDomainResponse>;
9
9
  export type EmailsConfigurationsService_VerifyCustomTrackingDomain = RpcMethod<VerifyCustomTrackingDomainRequest, VerifyCustomTrackingDomainResponse>;
10
10
  export type EmailsConfigurationsService_DiagnoseDomain = RpcMethod<DiagnoseDomainRequest, DiagnoseDomainResponse>;
11
+ export type EmailsConfigurationsService_ConnectPostmaster = RpcMethod<ConnectPostmasterRequest, ConnectPostmasterResponse>;
12
+ export type EmailsConfigurationsService_DisconnectPostmaster = RpcMethod<DisconnectPostmasterRequest, DisconnectPostmasterResponse>;
11
13
  export type EmailsConfigurationsService_RestartDomainVerification = RpcMethod<RestartDomainVerificationRequest, RestartDomainVerificationResponse>;
12
14
  export interface EmailsConfigurationsService {
13
15
  /** Lists the sender email domains configured for an application's account (format XXXXX-XXXXX) with their DKIM/SPF/DMARC statuses and the DNS CNAME records to add. Use to show email sender-domain setup; covers both Amazon SES and SMTP-service domains. */
@@ -28,9 +30,30 @@ export interface EmailsConfigurationsService {
28
30
  VerifyCustomTrackingDomain: EmailsConfigurationsService_VerifyCustomTrackingDomain;
29
31
  /** Checks live DNS for every record a sender email domain needs (DKIM CNAMEs, SPF, DMARC) and explains what is missing or mistyped, e.g. a record created with the domain appended twice. Read-only; use when a domain stays unverified. */
30
32
  DiagnoseDomain: EmailsConfigurationsService_DiagnoseDomain;
33
+ /** Connects a sender email domain to Gmail Postmaster and returns the TXT record the customer publishes at the domain apex. Verification then runs on its own (hourly for 72 hours, then daily for 30 days) and on update_email_domain_statuses; once verified, Gmail spam rate and delivery errors of the whole domain appear on Home → Email. Calling it again after a failed verification restarts it. */
34
+ ConnectPostmaster: EmailsConfigurationsService_ConnectPostmaster;
35
+ /** Disconnects a sender email domain from Gmail Postmaster; its Gmail stats stop being collected. The customer can remove the TXT record afterwards. */
36
+ DisconnectPostmaster: EmailsConfigurationsService_DisconnectPostmaster;
31
37
  /** Restarts Amazon SES DKIM verification for a sender email domain that SES gave up on (it stops checking 72 hours after the domain is added). DNS records stay the same; the SMTP selector is not touched. */
32
38
  RestartDomainVerification: EmailsConfigurationsService_RestartDomainVerification;
33
39
  }
40
+ export type Domain_PostmasterCompliance = {
41
+ /** dmarc_alignment, one_click_unsubscribe or honor_unsubscribe: the Gmail requirements our DNS checks do not cover. */
42
+ requirement: string;
43
+ /** compliant or needs_work. */
44
+ status: string;
45
+ };
46
+ /** Gmail Postmaster connection of the domain. */
47
+ export type Domain_Postmaster = {
48
+ /** not_connected, pending, verified or failed (gave up after 30 days without the TXT record). */
49
+ status: string;
50
+ /** TXT record value for the domain apex, google-site-verification=...; empty when not connected. */
51
+ verificationRecord: string;
52
+ /** RFC 3339 time the status last changed. */
53
+ statusChangedAt: string;
54
+ /** Filled once the domain is verified and Gmail has assessed it. */
55
+ compliance: Domain_PostmasterCompliance[];
56
+ };
34
57
  export type Domain_CName = {
35
58
  name: string;
36
59
  value: string;
@@ -44,6 +67,7 @@ export type Domain = {
44
67
  cnamesAmazon: Domain_CName[];
45
68
  cnames: Domain_CName[];
46
69
  cnamesYandex: Domain_CName[];
70
+ postmaster: Domain_Postmaster;
47
71
  };
48
72
  export type AddDomainRequest = {
49
73
  /** Sender email domain to register (e.g. mail.example.com). */
@@ -58,6 +82,8 @@ export type GetDomainsRequest = {
58
82
  };
59
83
  export type GetDomainsResponse = {
60
84
  emailDomains: Domain[];
85
+ /** Whether Gmail Postmaster can be connected in this installation. */
86
+ postmasterAvailable: boolean;
61
87
  };
62
88
  export type UpdateDomainStatusesRequest = {
63
89
  /** Application code (format XXXXX-XXXXX). */
@@ -137,7 +163,7 @@ export type DnsRecordCheck = {
137
163
  diagnosis: RecordDiagnosis;
138
164
  /** Whether the provider the sender routes through needs this record to verify the domain. */
139
165
  required: boolean;
140
- /** dkim, spf or dmarc. */
166
+ /** dkim, spf, dmarc or postmaster. */
141
167
  purpose: string;
142
168
  /** amazon, smtp or yandex; empty for SPF and DMARC. */
143
169
  provider: string;
@@ -156,3 +182,19 @@ export type RestartDomainVerificationRequest = {
156
182
  domain?: string;
157
183
  };
158
184
  export type RestartDomainVerificationResponse = {};
185
+ export type ConnectPostmasterRequest = {
186
+ /** Application code (format XXXXX-XXXXX). */
187
+ application?: string;
188
+ /** Sender email domain of the account. */
189
+ domain?: string;
190
+ };
191
+ export type ConnectPostmasterResponse = {
192
+ postmaster: Domain_Postmaster;
193
+ };
194
+ export type DisconnectPostmasterRequest = {
195
+ /** Application code (format XXXXX-XXXXX). */
196
+ application?: string;
197
+ /** Sender email domain of the account. */
198
+ domain?: string;
199
+ };
200
+ export type DisconnectPostmasterResponse = {};
package/media_files.d.ts CHANGED
@@ -3,6 +3,8 @@ export type MediaFilesService_List = RpcMethod<ListMediaFilesRequest, ListMediaF
3
3
  export type MediaFilesService_CreateVariant = RpcMethod<CreateVariantRequest, CreateVariantResponse>;
4
4
  export type MediaFilesService_Delete = RpcMethod<DeleteMediaFileRequest, DeleteMediaFileResponse>;
5
5
  export type MediaFilesService_GetUsage = RpcMethod<GetMediaFilesUsageRequest, GetMediaFilesUsageResponse>;
6
+ export type MediaFilesService_GetSettings = RpcMethod<GetMediaSettingsRequest, GetMediaSettingsResponse>;
7
+ export type MediaFilesService_UpdateSettings = RpcMethod<UpdateMediaSettingsRequest, UpdateMediaSettingsResponse>;
6
8
  export interface MediaFilesService {
7
9
  /** Lists an application's media image files newest-first, with paging and an optional filename substring search. Returns only originals by default, and of an edited image only its newest version (versions_count tells how many exist); pass parent_uuid to list the cropped variants of an original, or version_root_uuid to list every version of one image. */
8
10
  List: MediaFilesService_List;
@@ -12,6 +14,10 @@ export interface MediaFilesService {
12
14
  Delete: MediaFilesService_Delete;
13
15
  /** Returns an application's media storage footprint: count of original files, total file count including cropped variants, and total bytes stored in S3 (originals, variants and thumbnails). Use to check or report media quota usage for an application code. */
14
16
  GetUsage: MediaFilesService_GetUsage;
17
+ /** Returns an application's media storage settings, e.g. whether PNG images are compressed on upload, and whether the caller may change them. */
18
+ GetSettings: MediaFilesService_GetSettings;
19
+ /** Changes an application's media storage settings. Only the fields present in the request change, the rest keep their value. Applies to images uploaded afterwards; files already stored are not touched. */
20
+ UpdateSettings: MediaFilesService_UpdateSettings;
15
21
  }
16
22
  /** AspectRatio enumerates the supported aspect ratios for image variants. */
17
23
  export type AspectRatio = 'ASPECT_RATIO_UNSPECIFIED' | 'ASPECT_RATIO_1_1' | 'ASPECT_RATIO_4_3' | 'ASPECT_RATIO_3_2' | 'ASPECT_RATIO_4_5' | 'ASPECT_RATIO_5_4' | 'ASPECT_RATIO_16_9' | 'ASPECT_RATIO_16_10' | 'ASPECT_RATIO_21_9' | 'ASPECT_RATIO_9_16'
@@ -161,5 +167,30 @@ export type MediaFile = {
161
167
  versionRootUuid: string;
162
168
  /** versions_count is how many versions of this image exist, this one included. */
163
169
  versionsCount: number;
170
+ /** original_file_size is the size before PNG compression; set only in an upload response when compression shrank the file. */
171
+ originalFileSize: number;
164
172
  meta: MediaFile_meta;
165
173
  };
174
+ /** MediaSettings are per-application media storage settings. The zero value of every field is the default. */
175
+ export type MediaSettings = {
176
+ /** compress_png quantizes PNG images on upload (lossy palette compression, transparency kept). */
177
+ compressPng: boolean;
178
+ };
179
+ export type GetMediaSettingsRequest = {
180
+ /** Application code (format XXXXX-XXXXX) whose media settings to read. */
181
+ application?: string;
182
+ };
183
+ export type GetMediaSettingsResponse = {
184
+ settings: MediaSettings;
185
+ /** can_modify tells whether the caller may change the settings. */
186
+ canModify: boolean;
187
+ };
188
+ export type UpdateMediaSettingsRequest = {
189
+ /** Application code (format XXXXX-XXXXX) whose media settings to change. */
190
+ application?: string;
191
+ /** Unset leaves the stored value as is. */
192
+ compressPng?: boolean;
193
+ };
194
+ export type UpdateMediaSettingsResponse = {
195
+ settings: MediaSettings;
196
+ };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pushwoosh/rpc-v2-http-api-data",
3
- "version": "0.2.448",
3
+ "version": "0.2.450",
4
4
  "description": "RPC V2 HTTP API Types and Data",
5
5
  "main": "index.js",
6
6
  "module": "index.js",