-
Notifications
You must be signed in to change notification settings - Fork 0
/
types.gen.go
1341 lines (1050 loc) · 57.6 KB
/
types.gen.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Package authapi provides primitives to interact with the openapi HTTP API.
//
// Code generated by github.com/deepmap/oapi-codegen version v1.12.4 DO NOT EDIT.
package authapi
import (
"encoding/json"
"github.com/deepmap/oapi-codegen/pkg/runtime"
)
const (
BearerScopes = "Bearer.Scopes"
)
// Defines values for AccountVerificationSendingTo.
const (
Email AccountVerificationSendingTo = "email"
Sms AccountVerificationSendingTo = "sms"
SmsOrEmail AccountVerificationSendingTo = "smsOrEmail"
)
// Defines values for AccountVerificationVerificationMethod.
const (
AccountVerificationVerificationMethodCode AccountVerificationVerificationMethod = "code"
AccountVerificationVerificationMethodLink AccountVerificationVerificationMethod = "link"
)
// Defines values for AttributeType.
const (
Bool AttributeType = "bool"
Date AttributeType = "date"
Number AttributeType = "number"
String AttributeType = "string"
)
// Defines values for DeviceConfigurationDeviceRemembering.
const (
Always DeviceConfigurationDeviceRemembering = "always"
No DeviceConfigurationDeviceRemembering = "no"
UserOptIn DeviceConfigurationDeviceRemembering = "userOptIn"
)
// Defines values for DnsRecordType.
const (
CNAME DnsRecordType = "CNAME"
)
// Defines values for InvitationStatus.
const (
Accepted InvitationStatus = "accepted"
Expired InvitationStatus = "expired"
Pending InvitationStatus = "pending"
)
// Defines values for InvoiceLanguage.
const (
EnUS InvoiceLanguage = "en-US"
JaJP InvoiceLanguage = "ja-JP"
)
// Defines values for MfaConfigurationMfaConfiguration.
const (
On MfaConfigurationMfaConfiguration = "on"
Optional MfaConfigurationMfaConfiguration = "optional"
)
// Defines values for MfaPreferenceMethod.
const (
SoftwareToken MfaPreferenceMethod = "softwareToken"
)
// Defines values for ProrationBehavior.
const (
AlwaysInvoice ProrationBehavior = "always_invoice"
CreateProrations ProrationBehavior = "create_prorations"
None ProrationBehavior = "none"
)
// Defines values for ProviderName.
const (
Google ProviderName = "Google"
)
// Defines values for ProviderType.
const (
SAML ProviderType = "SAML"
)
// Defines values for AuthFlow.
const (
AuthFlowRefreshTokenAuth AuthFlow = "refreshTokenAuth"
AuthFlowTempCodeAuth AuthFlow = "tempCodeAuth"
)
// Defines values for GetAuthCredentialsParamsAuthFlow.
const (
GetAuthCredentialsParamsAuthFlowRefreshTokenAuth GetAuthCredentialsParamsAuthFlow = "refreshTokenAuth"
GetAuthCredentialsParamsAuthFlowTempCodeAuth GetAuthCredentialsParamsAuthFlow = "tempCodeAuth"
)
// AccountVerification アカウント認証設定(account authentication settings)
// ※ 未提供の機能のため、変更・保存はできません(This function is not yet provided, so it cannot be changed or saved.)
type AccountVerification struct {
// SendingTo email: Eメール(e-mail)
// sms: SMS
// smsOrEmail: SMS不可の場合にEメール(email if SMS is not possible)
SendingTo AccountVerificationSendingTo `json:"sending_to"`
// VerificationMethod code: 検証コード(verification code)
// link: 検証リンク(verification link)
// ※ 未提供の機能のため、変更・保存はできません(This function is not yet provided, so it cannot be changed or saved.)
VerificationMethod AccountVerificationVerificationMethod `json:"verification_method"`
}
// AccountVerificationSendingTo email: Eメール(e-mail)
// sms: SMS
// smsOrEmail: SMS不可の場合にEメール(email if SMS is not possible)
type AccountVerificationSendingTo string
// AccountVerificationVerificationMethod code: 検証コード(verification code)
// link: 検証リンク(verification link)
// ※ 未提供の機能のため、変更・保存はできません(This function is not yet provided, so it cannot be changed or saved.)
type AccountVerificationVerificationMethod string
// Attribute defines model for Attribute.
type Attribute struct {
// AttributeName 属性名(attribute name)
AttributeName string `json:"attribute_name"`
// AttributeType 型(dateはYYYY-MM-DDの形式で使用する事ができます。)
// (Type (date can be set to YYYY-MM-DD format.))
AttributeType AttributeType `json:"attribute_type"`
// DisplayName 表示名(display name)
DisplayName string `json:"display_name"`
}
// AttributeType 型(dateはYYYY-MM-DDの形式で使用する事ができます。)
// (Type (date can be set to YYYY-MM-DD format.))
type AttributeType string
// AuthInfo defines model for AuthInfo.
type AuthInfo struct {
// CallbackUrl 認証後遷移先(Redirect After Authentication)
CallbackUrl string `json:"callback_url"`
}
// AuthorizationTempCode defines model for AuthorizationTempCode.
type AuthorizationTempCode struct {
Code Uuid `json:"code"`
}
// BasicInfo defines model for BasicInfo.
type BasicInfo struct {
CertificateDnsRecord DnsRecord `json:"certificate_dns_record"`
CloudFrontDnsRecord DnsRecord `json:"cloud_front_dns_record"`
// DefaultDomainName デフォルトドメイン名(Default Domain Name)
DefaultDomainName string `json:"default_domain_name"`
// DkimDnsRecords DKIM DNS レコード(DKIM DNS Records)
DkimDnsRecords []DnsRecord `json:"dkim_dns_records"`
// DomainName ドメイン名(Domain Name)
DomainName string `json:"domain_name"`
// FromEmailAddress 認証メールの送信元メールアドレス(Sender Email for Authentication Email)
FromEmailAddress string `json:"from_email_address"`
// IsDnsValidated DNSレコードの検証結果(DNS Record Verification Results)
IsDnsValidated bool `json:"is_dns_validated"`
// IsSesSandboxGranted SESのサンドボックス解除及びCognitoのSES設定結果(SES sandbox release and Cognito SES configuration results)
IsSesSandboxGranted bool `json:"is_ses_sandbox_granted"`
// ReplyEmailAddress 認証メールの返信元メールアドレス(Reply-from email address of authentication email)
ReplyEmailAddress string `json:"reply_email_address"`
}
// BillingAddress defines model for BillingAddress.
type BillingAddress struct {
// AdditionalAddressInfo 建物名・部屋番号などの住所に関する追加情報
//
// Additional information about the address, such as a building name, floor, or department name.
AdditionalAddressInfo *string `json:"additional_address_info,omitempty"`
// City 住所の市区町村
//
// City, district, suburb, town, or village.
City string `json:"city"`
// Country 住所の国を ISO 3166-1 alpha-2 コードで指定します。
//
// Country of the address using ISO 3166-1 alpha-2 code.
Country string `json:"country"`
// PostalCode 郵便番号
//
// ZIP or postal code.
PostalCode string `json:"postal_code"`
// State 住所の都道府県または州
//
// State name or abbreviation.
State string `json:"state"`
// Street 住所の通りの名前や番地を含めた部分
//
// Street address, apartment or suite number.
Street string `json:"street"`
}
// BillingInfo defines model for BillingInfo.
type BillingInfo struct {
Address BillingAddress `json:"address"`
// InvoiceLanguage 請求書の言語
//
// Language of invoice
InvoiceLanguage InvoiceLanguage `json:"invoice_language"`
// Name 請求用のテナント名
//
// Tenant name for billing
Name string `json:"name"`
}
// ConfirmEmailUpdateParam defines model for ConfirmEmailUpdateParam.
type ConfirmEmailUpdateParam struct {
AccessToken string `json:"access_token"`
Code string `json:"code"`
}
// ConfirmExternalUserLinkParam defines model for ConfirmExternalUserLinkParam.
type ConfirmExternalUserLinkParam struct {
AccessToken string `json:"access_token"`
Code string `json:"code"`
}
// ConfirmSignUpWithAwsMarketplaceParam defines model for ConfirmSignUpWithAwsMarketplaceParam.
type ConfirmSignUpWithAwsMarketplaceParam struct {
// AccessToken アクセストークン(access token)
AccessToken string `json:"access_token"`
// RegistrationToken Registration Token
RegistrationToken string `json:"registration_token"`
// TenantName テナント名(tenant name)
TenantName *string `json:"tenant_name,omitempty"`
}
// CreateAuthCredentialsParam defines model for CreateAuthCredentialsParam.
type CreateAuthCredentialsParam = Credentials
// CreateEnvParam 環境情報(env info)
type CreateEnvParam = Env
// CreateRoleParam 役割(ロール)情報(role info)
type CreateRoleParam = Role
// CreateSaasUserParam defines model for CreateSaasUserParam.
type CreateSaasUserParam struct {
// Email メールアドレス(E-mail)
Email string `json:"email"`
// Password パスワード(Password)
Password string `json:"password"`
}
// CreateSecretCodeParam defines model for CreateSecretCodeParam.
type CreateSecretCodeParam struct {
// AccessToken アクセストークン(access token)
AccessToken string `json:"access_token"`
}
// CreateTenantAttributeParam defines model for CreateTenantAttributeParam.
type CreateTenantAttributeParam = Attribute
// CreateTenantInvitationParam defines model for CreateTenantInvitationParam.
type CreateTenantInvitationParam struct {
// AccessToken 招待を作成するユーザーのアクセストークン(access token of the user who creates an invitation)
AccessToken string `json:"access_token"`
// Email 招待するユーザーのメールアドレス(email address of the user to be invited)
Email string `json:"email"`
Envs []struct {
Id Id `json:"id"`
// RoleNames 役割名(role name)
RoleNames []string `json:"role_names"`
} `json:"envs"`
}
// CreateTenantParam defines model for CreateTenantParam.
type CreateTenantParam = TenantProps
// CreateTenantUserParam defines model for CreateTenantUserParam.
type CreateTenantUserParam struct {
// Attributes 属性情報(SaaS 開発コンソールでユーザー属性定義を行い設定された情報を取得します)
//
// Attribute information (Get information set by defining user attributes in the SaaS development console)
Attributes map[string]interface{} `json:"attributes"`
// Email メールアドレス(e-mail)
Email string `json:"email"`
}
// CreateTenantUserRolesParam defines model for CreateTenantUserRolesParam.
type CreateTenantUserRolesParam struct {
// RoleNames 役割(ロール)情報(Role Info)
RoleNames []string `json:"role_names"`
}
// CreateUserAttributeParam defines model for CreateUserAttributeParam.
type CreateUserAttributeParam = Attribute
// Credentials defines model for Credentials.
type Credentials struct {
// AccessToken アクセストークン(access token)
AccessToken string `json:"access_token"`
// IdToken IDトークン(ID token)
IdToken string `json:"id_token"`
// RefreshToken リフレッシュトークン(refresh token)
RefreshToken *string `json:"refresh_token,omitempty"`
}
// CustomizePageProps defines model for CustomizePageProps.
type CustomizePageProps struct {
// HtmlContents 画面のHTMLを編集できます
// ※ 未提供の機能のため、変更・保存はできません
//
// Edit page HTML
// ※ This function is not yet provided, so it cannot be changed or saved.
HtmlContents string `json:"html_contents"`
// IsPrivacyPolicy プライバシーポリシーチェックボックスを表示するが設定されているか(show the privacy policy checkbox)
IsPrivacyPolicy bool `json:"is_privacy_policy"`
// IsTermsOfService 利用規約の同意チェックボックスを表示するが設定されているか(display the terms of use agreement check box)
IsTermsOfService bool `json:"is_terms_of_service"`
}
// CustomizePageSettings defines model for CustomizePageSettings.
type CustomizePageSettings struct {
// Favicon ファビコン(favicon)
Favicon string `json:"favicon"`
// GoogleTagManagerContainerId Google Tag Manager コンテナ ID(Google Tag Manager container ID)
GoogleTagManagerContainerId string `json:"google_tag_manager_container_id"`
// Icon サービスアイコン(service icon)
Icon string `json:"icon"`
// PrivacyPolicyUrl プライバシーポリシーURL(privacy policy URL)
PrivacyPolicyUrl string `json:"privacy_policy_url"`
// TermsOfServiceUrl 利用規約URL(terms of service URL)
TermsOfServiceUrl string `json:"terms_of_service_url"`
// Title サービス名(service name)
Title string `json:"title"`
}
// CustomizePageSettingsProps defines model for CustomizePageSettingsProps.
type CustomizePageSettingsProps struct {
// GoogleTagManagerContainerId Google Tag Manager コンテナ ID(Google Tag Manager container ID)
GoogleTagManagerContainerId string `json:"google_tag_manager_container_id"`
// PrivacyPolicyUrl プライバシーポリシーURL(privacy policy URL)
PrivacyPolicyUrl string `json:"privacy_policy_url"`
// TermsOfServiceUrl 利用規約URL(terms of service URL)
TermsOfServiceUrl string `json:"terms_of_service_url"`
// Title サービス名(service name)
Title string `json:"title"`
}
// CustomizePages defines model for CustomizePages.
type CustomizePages struct {
PasswordResetPage CustomizePageProps `json:"password_reset_page"`
SignInPage CustomizePageProps `json:"sign_in_page"`
SignUpPage CustomizePageProps `json:"sign_up_page"`
}
// DeleteUsage stripe連携している場合で、プラン変更時に従量課金アイテムを削除するか設定できます。
// プラン変更した場合に、現在のサブスクリプションに含まれる従量課金アイテムを全て削除して、従量課金アイテムに基づく請求の発生を止めることができます。
// 即時に記録している使用量がクリアされます。それらは復元できないため、delete_usageをtrueにしたプラン変更予約は取り消しできません。
//
// If you have a stripe linkage, you can set whether to delete pay-as-you-go items when changing plans.
// When you change plan, you can remove all pay-as-you-go items included in your current subscription to stop being billed based on pay-as-you-go items.
// The recorded usage is cleared immediately. Since it cannot be restored, please note that plan change reservations with delete_usage set to true cannot be canceled.
type DeleteUsage = bool
// DeviceConfiguration 信頼済みデバイスの記憶の設定(settings for remembering trusted devices)
type DeviceConfiguration struct {
// DeviceRemembering always: 常に記憶する(always remember)
// userOptIn: ユーザーオプトイン(user opt-in)
// no: (don't save)
DeviceRemembering DeviceConfigurationDeviceRemembering `json:"device_remembering"`
}
// DeviceConfigurationDeviceRemembering always: 常に記憶する(always remember)
// userOptIn: ユーザーオプトイン(user opt-in)
// no: (don't save)
type DeviceConfigurationDeviceRemembering string
// DnsRecord defines model for DnsRecord.
type DnsRecord struct {
// Name レコード名(Record Name)
Name string `json:"name"`
// Type CNAMEリソースレコード(CNAME Resource Record)
Type DnsRecordType `json:"type"`
// Value 値(Value)
Value string `json:"value"`
}
// DnsRecordType CNAMEリソースレコード(CNAME Resource Record)
type DnsRecordType string
// Env 環境情報(env info)
type Env struct {
// DisplayName 環境表示名(env display name)
DisplayName *string `json:"display_name,omitempty"`
Id Id `json:"id"`
// Name 環境名(env name)
Name string `json:"name"`
}
// Envs env一覧(env list)
type Envs struct {
Envs []Env `json:"envs"`
}
// Error defines model for Error.
type Error struct {
Data *map[string]interface{} `json:"data,omitempty"`
// Message Error message
Message string `json:"message"`
// Type permission_denied
Type string `json:"type"`
}
// Id defines model for Id.
type Id = uint64
// IdentityProviderConfiguration 外部IDプロバイダを利用したサインインの設定をするために必要な情報です。(This information is required to set up sign-in using an external identity provider.)
// 変更はできません。(It cannot be changed.)
type IdentityProviderConfiguration struct {
// Domain ドメイン(domain)
Domain string `json:"domain"`
// EntityId 識別子(entity ID)
EntityId string `json:"entity_id"`
// RedirectUrl リダイレクトURL(redirect URL)
RedirectUrl string `json:"redirect_url"`
// ReplyUrl 応答URL(reply URL)
ReplyUrl string `json:"reply_url"`
}
// IdentityProviderProps defines model for IdentityProviderProps.
type IdentityProviderProps struct {
ApplicationId string `json:"application_id"`
ApplicationSecret string `json:"application_secret"`
ApprovalScope string `json:"approval_scope"`
IsButtonHidden *bool `json:"is_button_hidden,omitempty"`
}
// IdentityProviderSaml defines model for IdentityProviderSaml.
type IdentityProviderSaml struct {
EmailAttribute string `json:"email_attribute"`
MetadataUrl string `json:"metadata_url"`
}
// IdentityProviders defines model for IdentityProviders.
type IdentityProviders struct {
Google IdentityProviderProps `json:"google"`
}
// Invitation defines model for Invitation.
type Invitation struct {
// Email 招待されたユーザーのメールアドレス(email address of the invited user)
Email string `json:"email"`
Envs []UserEnv `json:"envs"`
// ExpiredAt 招待の有効期限(expiration date of the invitation)
ExpiredAt int `json:"expired_at"`
Id Uuid `json:"id"`
// InvitationUrl 招待URL(invitation URL)
InvitationUrl string `json:"invitation_url"`
Status InvitationStatus `json:"status"`
}
// InvitationStatus defines model for InvitationStatus.
type InvitationStatus string
// InvitationValidity 招待の有効性(invitation validity)
type InvitationValidity struct {
// IsValid 招待が有効か否か(Whether the validation is valid or not)
IsValid bool `json:"is_valid"`
}
// Invitations defines model for Invitations.
type Invitations struct {
// Invitations 招待一覧(invitation list)
Invitations []Invitation `json:"invitations"`
}
// InvoiceLanguage 請求書の言語
//
// Language of invoice
type InvoiceLanguage string
// LinkAwsMarketplaceParam defines model for LinkAwsMarketplaceParam.
type LinkAwsMarketplaceParam struct {
// AccessToken アクセストークン(access token)
AccessToken string `json:"access_token"`
// RegistrationToken Registration Token
RegistrationToken string `json:"registration_token"`
// TenantId テナントID(tenant ID)
TenantId string `json:"tenant_id"`
}
// MessageTemplate defines model for MessageTemplate.
type MessageTemplate struct {
// Message メッセージ(message)
Message string `json:"message"`
// Subject タイトル(title)
Subject string `json:"subject"`
}
// MfaConfiguration MFAデバイス認証設定(MFA device authentication settings)
// ※ 未提供の機能のため、変更・保存はできません(This function is not yet provided, so it cannot be changed or saved.)
type MfaConfiguration struct {
// MfaConfiguration on: 全ユーザーがログイン時に適用(apply when all users log in)
// optional: MFA要素が有効になっている個別ユーザーに適用(apply to individual users with MFA factor enabled)
// ※ パラメータは現在optionalで固定となります。(The parameter is currently optional and fixed.)
MfaConfiguration MfaConfigurationMfaConfiguration `json:"mfa_configuration"`
}
// MfaConfigurationMfaConfiguration on: 全ユーザーがログイン時に適用(apply when all users log in)
// optional: MFA要素が有効になっている個別ユーザーに適用(apply to individual users with MFA factor enabled)
// ※ パラメータは現在optionalで固定となります。(The parameter is currently optional and fixed.)
type MfaConfigurationMfaConfiguration string
// MfaPreference defines model for MfaPreference.
type MfaPreference struct {
// Enabled MFAを有効にするか否か(enable MFA)
Enabled bool `json:"enabled"`
// Method MFAの方法(enabledがtrueの場合は必須)(MFA method (required if enabled is true))
Method *MfaPreferenceMethod `json:"method,omitempty"`
}
// MfaPreferenceMethod MFAの方法(enabledがtrueの場合は必須)(MFA method (required if enabled is true))
type MfaPreferenceMethod string
// NotificationMessages defines model for NotificationMessages.
type NotificationMessages struct {
AuthenticationMfa MessageTemplate `json:"authentication_mfa"`
CreateUser MessageTemplate `json:"create_user"`
ForgotPassword MessageTemplate `json:"forgot_password"`
InviteTenantUser MessageTemplate `json:"invite_tenant_user"`
ResendCode MessageTemplate `json:"resend_code"`
SignUp MessageTemplate `json:"sign_up"`
UpdateUserAttribute MessageTemplate `json:"update_user_attribute"`
VerifyExternalUser MessageTemplate `json:"verify_external_user"`
VerifyUserAttribute MessageTemplate `json:"verify_user_attribute"`
}
// PasswordPolicy パスワードポリシー(password policy)
type PasswordPolicy struct {
// IsRequireLowercase 一文字以上の小文字を含むが設定されているか(contains one or more lowercase characters)
IsRequireLowercase bool `json:"is_require_lowercase"`
// IsRequireNumbers 一文字以上の数字を含むが設定されているか(contains one or more numeric characters)
IsRequireNumbers bool `json:"is_require_numbers"`
// IsRequireSymbols 一文字以上の特殊文字を含むが設定されているか(contains one or more special characters)
IsRequireSymbols bool `json:"is_require_symbols"`
// IsRequireUppercase 一文字以上の大文字を含むが設定されているか(contains one or more uppercase letters)
IsRequireUppercase bool `json:"is_require_uppercase"`
// MinimumLength 最小文字数(minimum number of characters)
MinimumLength uint64 `json:"minimum_length"`
// TemporaryPasswordValidityDays 仮パスワードの有効期限(temporary password expiration date)
TemporaryPasswordValidityDays uint64 `json:"temporary_password_validity_days"`
}
// PlanHistories defines model for PlanHistories.
type PlanHistories struct {
// PlanHistories 料金プラン履歴
PlanHistories []PlanHistory `json:"plan_histories"`
}
// PlanHistory defines model for PlanHistory.
type PlanHistory struct {
// DeleteUsage stripe連携している場合で、プラン変更時に従量課金アイテムを削除するか設定できます。
// プラン変更した場合に、現在のサブスクリプションに含まれる従量課金アイテムを全て削除して、従量課金アイテムに基づく請求の発生を止めることができます。
// 即時に記録している使用量がクリアされます。それらは復元できないため、delete_usageをtrueにしたプラン変更予約は取り消しできません。
//
// If you have a stripe linkage, you can set whether to delete pay-as-you-go items when changing plans.
// When you change plan, you can remove all pay-as-you-go items included in your current subscription to stop being billed based on pay-as-you-go items.
// The recorded usage is cleared immediately. Since it cannot be restored, please note that plan change reservations with delete_usage set to true cannot be canceled.
DeleteUsage *DeleteUsage `json:"delete_usage,omitempty"`
// PlanAppliedAt 登録日時
PlanAppliedAt int `json:"plan_applied_at"`
PlanId Uuid `json:"plan_id"`
// ProrationBehavior stripe連携している場合で、プラン変更時の比例配分の挙動を設定できます。
// プラン変更した場合に、請求金額を日割り計算し次回請求書に反映させるか、日割り計算した請求を即時に発行する、日割り計算をしないを設定できます。
//
// If you have a strine linkage, you can set the behavior of the proportional allocation when changing plans.
// When a plan is changed, you can set whether to prorate the billing amount and reflect it on the next invoice, to issue a prorated invoice immediately, or not to prorate at all.
ProrationBehavior *ProrationBehavior `json:"proration_behavior,omitempty"`
TaxRateId *Uuid `json:"tax_rate_id,omitempty"`
}
// PlanReservation defines model for PlanReservation.
type PlanReservation struct {
// DeleteUsage stripe連携している場合で、プラン変更時に従量課金アイテムを削除するか設定できます。
// プラン変更した場合に、現在のサブスクリプションに含まれる従量課金アイテムを全て削除して、従量課金アイテムに基づく請求の発生を止めることができます。
// 即時に記録している使用量がクリアされます。それらは復元できないため、delete_usageをtrueにしたプラン変更予約は取り消しできません。
//
// If you have a stripe linkage, you can set whether to delete pay-as-you-go items when changing plans.
// When you change plan, you can remove all pay-as-you-go items included in your current subscription to stop being billed based on pay-as-you-go items.
// The recorded usage is cleared immediately. Since it cannot be restored, please note that plan change reservations with delete_usage set to true cannot be canceled.
DeleteUsage *DeleteUsage `json:"delete_usage,omitempty"`
NextPlanId *Uuid `json:"next_plan_id,omitempty"`
NextPlanTaxRateId *Uuid `json:"next_plan_tax_rate_id,omitempty"`
// ProrationBehavior stripe連携している場合で、プラン変更時の比例配分の挙動を設定できます。
// プラン変更した場合に、請求金額を日割り計算し次回請求書に反映させるか、日割り計算した請求を即時に発行する、日割り計算をしないを設定できます。
//
// If you have a strine linkage, you can set the behavior of the proportional allocation when changing plans.
// When a plan is changed, you can set whether to prorate the billing amount and reflect it on the next invoice, to issue a prorated invoice immediately, or not to prorate at all.
ProrationBehavior *ProrationBehavior `json:"proration_behavior,omitempty"`
// UsingNextPlanFrom 次回料金プラン開始日時(stripe連携時、当月月初の0時(UTC)を指定すると当月月初開始のサブスクリプションを作成できます。ex. 2023年1月の場合は、1672531200 )
// (Next billing plan start time (When using stripe, you can create a subscription that starts at the beginning of the current month by specifying 00:00 (UTC) at the beginning of the current month. Ex. 1672531200 for January 2023.))
UsingNextPlanFrom *int `json:"using_next_plan_from,omitempty"`
}
// ProrationBehavior stripe連携している場合で、プラン変更時の比例配分の挙動を設定できます。
// プラン変更した場合に、請求金額を日割り計算し次回請求書に反映させるか、日割り計算した請求を即時に発行する、日割り計算をしないを設定できます。
//
// If you have a strine linkage, you can set the behavior of the proportional allocation when changing plans.
// When a plan is changed, you can set whether to prorate the billing amount and reflect it on the next invoice, to issue a prorated invoice immediately, or not to prorate at all.
type ProrationBehavior string
// ProviderName defines model for ProviderName.
type ProviderName string
// ProviderType defines model for ProviderType.
type ProviderType string
// RecaptchaProps reCAPTCHA認証設定(reCAPTCHA authentication settings)
// ※ 未提供の機能のため、変更・保存はできません(This function is not yet provided, so it cannot be changed or saved.)
type RecaptchaProps struct {
// SecretKey シークレットキー(secret key)
SecretKey string `json:"secret_key"`
// SiteKey サイトキー(site key)
SiteKey string `json:"site_key"`
}
// RequestEmailUpdateParam defines model for RequestEmailUpdateParam.
type RequestEmailUpdateParam struct {
AccessToken string `json:"access_token"`
// Email メールアドレス(Email Address)
Email string `json:"email"`
}
// RequestExternalUserLinkParam defines model for RequestExternalUserLinkParam.
type RequestExternalUserLinkParam struct {
AccessToken string `json:"access_token"`
}
// ResendSignUpConfirmationEmailParam defines model for ResendSignUpConfirmationEmailParam.
type ResendSignUpConfirmationEmailParam struct {
// Email メールアドレス(Email Address)
Email string `json:"email"`
}
// Role 役割(ロール)情報(role info)
type Role struct {
// DisplayName 役割(ロール)表示名(role display name)
DisplayName string `json:"display_name"`
// RoleName 役割(ロール)名(role name)
RoleName string `json:"role_name"`
}
// Roles defines model for Roles.
type Roles struct {
Roles []Role `json:"roles"`
}
// SaasUser defines model for SaasUser.
type SaasUser struct {
// Email メールアドレス(E-mail)
Email string `json:"email"`
Id Uuid `json:"id"`
}
// SaasUsers defines model for SaasUsers.
type SaasUsers struct {
Users []SaasUser `json:"users"`
}
// SelfRegist セルフサインアップを許可設定(self sign-up permission)
type SelfRegist struct {
Enable bool `json:"enable"`
}
// SignInSettings defines model for SignInSettings.
type SignInSettings struct {
// AccountVerification アカウント認証設定(account authentication settings)
// ※ 未提供の機能のため、変更・保存はできません(This function is not yet provided, so it cannot be changed or saved.)
AccountVerification AccountVerification `json:"account_verification"`
// DeviceConfiguration 信頼済みデバイスの記憶の設定(settings for remembering trusted devices)
DeviceConfiguration DeviceConfiguration `json:"device_configuration"`
// IdentityProviderConfiguration 外部IDプロバイダを利用したサインインの設定をするために必要な情報です。(This information is required to set up sign-in using an external identity provider.)
// 変更はできません。(It cannot be changed.)
IdentityProviderConfiguration IdentityProviderConfiguration `json:"identity_provider_configuration"`
// MfaConfiguration MFAデバイス認証設定(MFA device authentication settings)
// ※ 未提供の機能のため、変更・保存はできません(This function is not yet provided, so it cannot be changed or saved.)
MfaConfiguration MfaConfiguration `json:"mfa_configuration"`
// PasswordPolicy パスワードポリシー(password policy)
PasswordPolicy PasswordPolicy `json:"password_policy"`
// RecaptchaProps reCAPTCHA認証設定(reCAPTCHA authentication settings)
// ※ 未提供の機能のため、変更・保存はできません(This function is not yet provided, so it cannot be changed or saved.)
RecaptchaProps RecaptchaProps `json:"recaptcha_props"`
// SelfRegist セルフサインアップを許可設定(self sign-up permission)
SelfRegist SelfRegist `json:"self_regist"`
}
// SignUpParam defines model for SignUpParam.
type SignUpParam struct {
// Email メールアドレス(Email Address)
Email string `json:"email"`
}
// SignUpWithAwsMarketplaceParam defines model for SignUpWithAwsMarketplaceParam.
type SignUpWithAwsMarketplaceParam struct {
// Email メールアドレス(Email Address)
Email string `json:"email"`
// RegistrationToken Registration Token
RegistrationToken string `json:"registration_token"`
}
// SoftwareTokenSecretCode defines model for SoftwareTokenSecretCode.
type SoftwareTokenSecretCode struct {
// SecretCode シークレットコード(secret code)
SecretCode string `json:"secret_code"`
}
// Tenant defines model for Tenant.
type Tenant struct {
// Attributes 属性情報(attribute info)
Attributes map[string]interface{} `json:"attributes"`
// BackOfficeStaffEmail 事務管理部門スタッフメールアドレス(administrative staff email address)
BackOfficeStaffEmail string `json:"back_office_staff_email"`
BillingInfo *BillingInfo `json:"billing_info,omitempty"`
// DeleteUsage stripe連携している場合で、プラン変更時に従量課金アイテムを削除するか設定できます。
// プラン変更した場合に、現在のサブスクリプションに含まれる従量課金アイテムを全て削除して、従量課金アイテムに基づく請求の発生を止めることができます。
// 即時に記録している使用量がクリアされます。それらは復元できないため、delete_usageをtrueにしたプラン変更予約は取り消しできません。
//
// If you have a stripe linkage, you can set whether to delete pay-as-you-go items when changing plans.
// When you change plan, you can remove all pay-as-you-go items included in your current subscription to stop being billed based on pay-as-you-go items.
// The recorded usage is cleared immediately. Since it cannot be restored, please note that plan change reservations with delete_usage set to true cannot be canceled.
DeleteUsage *DeleteUsage `json:"delete_usage,omitempty"`
Id Uuid `json:"id"`
// Name テナント名(tenant name)
Name string `json:"name"`
NextPlanId *Uuid `json:"next_plan_id,omitempty"`
NextPlanTaxRateId *Uuid `json:"next_plan_tax_rate_id,omitempty"`
// PlanHistories 料金プラン履歴
PlanHistories []PlanHistory `json:"plan_histories"`
PlanId *Uuid `json:"plan_id,omitempty"`
// ProrationBehavior stripe連携している場合で、プラン変更時の比例配分の挙動を設定できます。
// プラン変更した場合に、請求金額を日割り計算し次回請求書に反映させるか、日割り計算した請求を即時に発行する、日割り計算をしないを設定できます。
//
// If you have a strine linkage, you can set the behavior of the proportional allocation when changing plans.
// When a plan is changed, you can set whether to prorate the billing amount and reflect it on the next invoice, to issue a prorated invoice immediately, or not to prorate at all.
ProrationBehavior *ProrationBehavior `json:"proration_behavior,omitempty"`
// UsingNextPlanFrom 次回料金プラン開始日時(stripe連携時、当月月初の0時(UTC)を指定すると当月月初開始のサブスクリプションを作成できます。ex. 2023年1月の場合は、1672531200 )
// (Next billing plan start time (When using stripe, you can create a subscription that starts at the beginning of the current month by specifying 00:00 (UTC) at the beginning of the current month. Ex. 1672531200 for January 2023.))
UsingNextPlanFrom *int `json:"using_next_plan_from,omitempty"`
}
// TenantAttributes defines model for TenantAttributes.
type TenantAttributes struct {
// TenantAttributes テナント属性定義(Tenant Attribute Definition)
TenantAttributes []Attribute `json:"tenant_attributes"`
}
// TenantDetail defines model for TenantDetail.
type TenantDetail struct {
// Attributes 属性情報(attribute info)
Attributes map[string]interface{} `json:"attributes"`
// BackOfficeStaffEmail 事務管理部門スタッフメールアドレス(administrative staff email address)
BackOfficeStaffEmail string `json:"back_office_staff_email"`
BillingInfo *BillingInfo `json:"billing_info,omitempty"`
// CurrentPlanPeriodEnd 現在のプランの終了日時(current plan period end)
CurrentPlanPeriodEnd *int `json:"current_plan_period_end,omitempty"`
// CurrentPlanPeriodStart 現在のプランの開始日時(current plan period start)
CurrentPlanPeriodStart *int `json:"current_plan_period_start,omitempty"`
// DeleteUsage stripe連携している場合で、プラン変更時に従量課金アイテムを削除するか設定できます。
// プラン変更した場合に、現在のサブスクリプションに含まれる従量課金アイテムを全て削除して、従量課金アイテムに基づく請求の発生を止めることができます。
// 即時に記録している使用量がクリアされます。それらは復元できないため、delete_usageをtrueにしたプラン変更予約は取り消しできません。
//
// If you have a stripe linkage, you can set whether to delete pay-as-you-go items when changing plans.
// When you change plan, you can remove all pay-as-you-go items included in your current subscription to stop being billed based on pay-as-you-go items.
// The recorded usage is cleared immediately. Since it cannot be restored, please note that plan change reservations with delete_usage set to true cannot be canceled.
DeleteUsage *DeleteUsage `json:"delete_usage,omitempty"`
Id Uuid `json:"id"`
// Name テナント名(tenant name)
Name string `json:"name"`
NextPlanId *Uuid `json:"next_plan_id,omitempty"`
NextPlanTaxRateId *Uuid `json:"next_plan_tax_rate_id,omitempty"`
// PlanHistories 料金プラン履歴
PlanHistories []PlanHistory `json:"plan_histories"`
PlanId *Uuid `json:"plan_id,omitempty"`
// ProrationBehavior stripe連携している場合で、プラン変更時の比例配分の挙動を設定できます。
// プラン変更した場合に、請求金額を日割り計算し次回請求書に反映させるか、日割り計算した請求を即時に発行する、日割り計算をしないを設定できます。
//
// If you have a strine linkage, you can set the behavior of the proportional allocation when changing plans.
// When a plan is changed, you can set whether to prorate the billing amount and reflect it on the next invoice, to issue a prorated invoice immediately, or not to prorate at all.
ProrationBehavior *ProrationBehavior `json:"proration_behavior,omitempty"`
// UsingNextPlanFrom 次回料金プラン開始日時(stripe連携時、当月月初の0時(UTC)を指定すると当月月初開始のサブスクリプションを作成できます。ex. 2023年1月の場合は、1672531200 )
// (Next billing plan start time (When using stripe, you can create a subscription that starts at the beginning of the current month by specifying 00:00 (UTC) at the beginning of the current month. Ex. 1672531200 for January 2023.))
UsingNextPlanFrom *int `json:"using_next_plan_from,omitempty"`
}
// TenantIdentityProviderProps defines model for TenantIdentityProviderProps.
type TenantIdentityProviderProps struct {
union json.RawMessage
}
// TenantIdentityProviders defines model for TenantIdentityProviders.
type TenantIdentityProviders struct {
Saml *struct {
EmailAttribute string `json:"email_attribute"`
MetadataUrl string `json:"metadata_url"`
SignInUrl string `json:"sign_in_url"`
} `json:"saml,omitempty"`
}
// TenantProps defines model for TenantProps.
type TenantProps struct {
// Attributes 属性情報(attribute info)
Attributes map[string]interface{} `json:"attributes"`
// BackOfficeStaffEmail 事務管理部門スタッフメールアドレス(administrative staff email address)
BackOfficeStaffEmail string `json:"back_office_staff_email"`
// Name テナント名(tenant name)
Name string `json:"name"`
}
// Tenants テナント情報(Tenant Info)
type Tenants struct {
Tenants []Tenant `json:"tenants"`
}
// UpdateAuthInfoParam defines model for UpdateAuthInfoParam.
type UpdateAuthInfoParam = AuthInfo
// UpdateBasicInfoParam defines model for UpdateBasicInfoParam.
type UpdateBasicInfoParam struct {
// DomainName ドメイン名(Domain Name)
DomainName string `json:"domain_name"`
// FromEmailAddress 認証メールの送信元メールアドレス(Sender email of authentication email)
FromEmailAddress string `json:"from_email_address"`
// ReplyEmailAddress 認証メールの返信元メールアドレス(Reply-from email address of authentication email)
ReplyEmailAddress *string `json:"reply_email_address,omitempty"`
}
// UpdateCustomizePageSettingsParam defines model for UpdateCustomizePageSettingsParam.
type UpdateCustomizePageSettingsParam struct {
// Favicon ファビコン(favicon)
Favicon string `json:"favicon"`
// GoogleTagManagerContainerId Google Tag Manager コンテナ ID(Google Tag Manager container ID)
GoogleTagManagerContainerId string `json:"google_tag_manager_container_id"`
// Icon サービスアイコン(service icon)
Icon string `json:"icon"`
// PrivacyPolicyUrl プライバシーポリシーURL(privacy policy URL)
PrivacyPolicyUrl string `json:"privacy_policy_url"`
// TermsOfServiceUrl 利用規約URL(terms of service URL)
TermsOfServiceUrl string `json:"terms_of_service_url"`
// Title サービス名(service name)
Title string `json:"title"`
}
// UpdateCustomizePagesParam defines model for UpdateCustomizePagesParam.
type UpdateCustomizePagesParam struct {
PasswordResetPage *CustomizePageProps `json:"password_reset_page,omitempty"`
SignInPage *CustomizePageProps `json:"sign_in_page,omitempty"`
SignUpPage *CustomizePageProps `json:"sign_up_page,omitempty"`
}
// UpdateEnvParam defines model for UpdateEnvParam.
type UpdateEnvParam struct {
// DisplayName 環境表示名(env display name)
DisplayName *string `json:"display_name,omitempty"`
// Name 環境名(env name)
Name string `json:"name"`
}
// UpdateIdentityProviderParam defines model for UpdateIdentityProviderParam.
type UpdateIdentityProviderParam struct {
IdentityProviderProps *IdentityProviderProps `json:"identity_provider_props,omitempty"`
Provider ProviderName `json:"provider"`
}
// UpdateNotificationMessagesParam defines model for UpdateNotificationMessagesParam.
type UpdateNotificationMessagesParam struct {
AuthenticationMfa *MessageTemplate `json:"authentication_mfa,omitempty"`
CreateUser *MessageTemplate `json:"create_user,omitempty"`
ForgotPassword *MessageTemplate `json:"forgot_password,omitempty"`
InviteTenantUser *MessageTemplate `json:"invite_tenant_user,omitempty"`
ResendCode *MessageTemplate `json:"resend_code,omitempty"`
SignUp *MessageTemplate `json:"sign_up,omitempty"`
UpdateUserAttribute *MessageTemplate `json:"update_user_attribute,omitempty"`
VerifyExternalUser *MessageTemplate `json:"verify_external_user,omitempty"`
VerifyUserAttribute *MessageTemplate `json:"verify_user_attribute,omitempty"`
}
// UpdateSaasUserEmailParam defines model for UpdateSaasUserEmailParam.
type UpdateSaasUserEmailParam struct {
// Email メールアドレス(e-mail)
Email string `json:"email"`
}
// UpdateSaasUserPasswordParam defines model for UpdateSaasUserPasswordParam.
type UpdateSaasUserPasswordParam struct {
// Password パスワード(password)
Password string `json:"password"`
}
// UpdateSignInSettingsParam defines model for UpdateSignInSettingsParam.
type UpdateSignInSettingsParam struct {
// AccountVerification アカウント認証設定(account authentication settings)
// ※ 未提供の機能のため、変更・保存はできません(This function is not yet provided, so it cannot be changed or saved.)
AccountVerification *AccountVerification `json:"account_verification,omitempty"`
// DeviceConfiguration 信頼済みデバイスの記憶の設定(settings for remembering trusted devices)
DeviceConfiguration *DeviceConfiguration `json:"device_configuration,omitempty"`
// MfaConfiguration MFAデバイス認証設定(MFA device authentication settings)
// ※ 未提供の機能のため、変更・保存はできません(This function is not yet provided, so it cannot be changed or saved.)
MfaConfiguration *MfaConfiguration `json:"mfa_configuration,omitempty"`