zyphr 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.
Files changed (107) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +54 -0
  3. data/docs/AddOrganizationMemberRequest.md +20 -0
  4. data/docs/AuthOrganizationsApi.md +864 -0
  5. data/docs/AuthUserProfileApi.md +76 -0
  6. data/docs/CreateOrganizationRequest.md +22 -0
  7. data/docs/DomainsApi.md +73 -0
  8. data/docs/InboundAttachmentUrlResponse.md +20 -0
  9. data/docs/InboundAttachmentUrlResponseData.md +22 -0
  10. data/docs/InboundEmail.md +48 -0
  11. data/docs/InboundEmailApi.md +235 -0
  12. data/docs/InboundEmailAttachment.md +24 -0
  13. data/docs/InboundEmailFrom.md +20 -0
  14. data/docs/InboundEmailListResponse.md +20 -0
  15. data/docs/InboundEmailListResponseMeta.md +24 -0
  16. data/docs/InboundEmailResponse.md +20 -0
  17. data/docs/LoginRequest.md +3 -1
  18. data/docs/MuseApi.md +681 -0
  19. data/docs/Organization.md +34 -0
  20. data/docs/OrganizationListResponse.md +20 -0
  21. data/docs/OrganizationListResponseMeta.md +20 -0
  22. data/docs/OrganizationMembersListResponse.md +20 -0
  23. data/docs/OrganizationMembership.md +30 -0
  24. data/docs/OrganizationMembershipResponse.md +20 -0
  25. data/docs/OrganizationMembershipWithUser.md +34 -0
  26. data/docs/OrganizationResponse.md +20 -0
  27. data/docs/RegisterRequest.md +5 -1
  28. data/docs/SetDomainInboundRequest.md +18 -0
  29. data/docs/SwitchOrganizationRequest.md +20 -0
  30. data/docs/SwitchOrganizationResponse.md +20 -0
  31. data/docs/SwitchOrganizationResponseData.md +22 -0
  32. data/docs/SwitchOrganizationResponseDataTokens.md +24 -0
  33. data/docs/SwitchOrganizationResponseDataUser.md +20 -0
  34. data/docs/UpdateOrganizationMemberRoleRequest.md +18 -0
  35. data/docs/UpdateOrganizationRequest.md +22 -0
  36. data/docs/V1MuseSubjectsSuggestPostRequest.md +24 -0
  37. data/lib/zyphr/api/auth_organizations_api.rb +773 -0
  38. data/lib/zyphr/api/auth_user_profile_api.rb +61 -0
  39. data/lib/zyphr/api/domains_api.rb +72 -0
  40. data/lib/zyphr/api/inbound_email_api.rb +234 -0
  41. data/lib/zyphr/api/muse_api.rb +644 -0
  42. data/lib/zyphr/models/add_organization_member_request.rb +248 -0
  43. data/lib/zyphr/models/create_organization_request.rb +258 -0
  44. data/lib/zyphr/models/inbound_attachment_url_response.rb +229 -0
  45. data/lib/zyphr/models/inbound_attachment_url_response_data.rb +240 -0
  46. data/lib/zyphr/models/inbound_email.rb +441 -0
  47. data/lib/zyphr/models/inbound_email_attachment.rb +250 -0
  48. data/lib/zyphr/models/inbound_email_from.rb +230 -0
  49. data/lib/zyphr/models/inbound_email_list_response.rb +231 -0
  50. data/lib/zyphr/models/inbound_email_list_response_meta.rb +247 -0
  51. data/lib/zyphr/models/inbound_email_response.rb +229 -0
  52. data/lib/zyphr/models/login_request.rb +14 -4
  53. data/lib/zyphr/models/organization.rb +434 -0
  54. data/lib/zyphr/models/organization_list_response.rb +265 -0
  55. data/lib/zyphr/models/organization_list_response_meta.rb +230 -0
  56. data/lib/zyphr/models/organization_members_list_response.rb +265 -0
  57. data/lib/zyphr/models/organization_membership.rb +379 -0
  58. data/lib/zyphr/models/organization_membership_response.rb +263 -0
  59. data/lib/zyphr/models/organization_membership_with_user.rb +405 -0
  60. data/lib/zyphr/models/organization_response.rb +263 -0
  61. data/lib/zyphr/models/register_request.rb +43 -4
  62. data/lib/zyphr/models/set_domain_inbound_request.rb +220 -0
  63. data/lib/zyphr/models/switch_organization_request.rb +263 -0
  64. data/lib/zyphr/models/switch_organization_response.rb +263 -0
  65. data/lib/zyphr/models/switch_organization_response_data.rb +289 -0
  66. data/lib/zyphr/models/switch_organization_response_data_tokens.rb +339 -0
  67. data/lib/zyphr/models/switch_organization_response_data_user.rb +230 -0
  68. data/lib/zyphr/models/update_organization_member_role_request.rb +223 -0
  69. data/lib/zyphr/models/update_organization_request.rb +239 -0
  70. data/lib/zyphr/models/v1_muse_subjects_suggest_post_request.rb +326 -0
  71. data/lib/zyphr.rb +30 -0
  72. data/spec/api/auth_organizations_api_spec.rb +171 -0
  73. data/spec/api/auth_user_profile_api_spec.rb +12 -0
  74. data/spec/api/domains_api_spec.rb +13 -0
  75. data/spec/api/inbound_email_api_spec.rb +76 -0
  76. data/spec/api/muse_api_spec.rb +156 -0
  77. data/spec/models/add_organization_member_request_spec.rb +42 -0
  78. data/spec/models/create_organization_request_spec.rb +48 -0
  79. data/spec/models/inbound_attachment_url_response_data_spec.rb +48 -0
  80. data/spec/models/inbound_attachment_url_response_spec.rb +42 -0
  81. data/spec/models/inbound_email_attachment_spec.rb +54 -0
  82. data/spec/models/inbound_email_from_spec.rb +42 -0
  83. data/spec/models/inbound_email_list_response_meta_spec.rb +54 -0
  84. data/spec/models/inbound_email_list_response_spec.rb +42 -0
  85. data/spec/models/inbound_email_response_spec.rb +42 -0
  86. data/spec/models/inbound_email_spec.rb +142 -0
  87. data/spec/models/login_request_spec.rb +6 -0
  88. data/spec/models/organization_list_response_meta_spec.rb +42 -0
  89. data/spec/models/organization_list_response_spec.rb +42 -0
  90. data/spec/models/organization_members_list_response_spec.rb +42 -0
  91. data/spec/models/organization_membership_response_spec.rb +42 -0
  92. data/spec/models/organization_membership_spec.rb +72 -0
  93. data/spec/models/organization_membership_with_user_spec.rb +84 -0
  94. data/spec/models/organization_response_spec.rb +42 -0
  95. data/spec/models/organization_spec.rb +84 -0
  96. data/spec/models/register_request_spec.rb +12 -0
  97. data/spec/models/set_domain_inbound_request_spec.rb +36 -0
  98. data/spec/models/switch_organization_request_spec.rb +42 -0
  99. data/spec/models/switch_organization_response_data_spec.rb +48 -0
  100. data/spec/models/switch_organization_response_data_tokens_spec.rb +58 -0
  101. data/spec/models/switch_organization_response_data_user_spec.rb +42 -0
  102. data/spec/models/switch_organization_response_spec.rb +42 -0
  103. data/spec/models/update_organization_member_role_request_spec.rb +36 -0
  104. data/spec/models/update_organization_request_spec.rb +48 -0
  105. data/spec/models/v1_muse_subjects_suggest_post_request_spec.rb +58 -0
  106. data/zyphr.gemspec +1 -1
  107. metadata +122 -2
@@ -0,0 +1,20 @@
1
+ # Zyphr::OrganizationListResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Array<Organization>**](Organization.md) | | |
8
+ | **meta** | [**OrganizationListResponseMeta**](OrganizationListResponseMeta.md) | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zyphr'
14
+
15
+ instance = Zyphr::OrganizationListResponse.new(
16
+ data: null,
17
+ meta: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # Zyphr::OrganizationListResponseMeta
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **request_id** | **String** | | [optional] |
8
+ | **next_cursor** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zyphr'
14
+
15
+ instance = Zyphr::OrganizationListResponseMeta.new(
16
+ request_id: null,
17
+ next_cursor: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # Zyphr::OrganizationMembersListResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Array<OrganizationMembershipWithUser>**](OrganizationMembershipWithUser.md) | | |
8
+ | **meta** | [**OrganizationListResponseMeta**](OrganizationListResponseMeta.md) | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zyphr'
14
+
15
+ instance = Zyphr::OrganizationMembersListResponse.new(
16
+ data: null,
17
+ meta: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,30 @@
1
+ # Zyphr::OrganizationMembership
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | |
8
+ | **organization_id** | **String** | | |
9
+ | **end_user_id** | **String** | | |
10
+ | **environment_id** | **String** | | |
11
+ | **role** | **String** | Opaque role string. Not interpreted by Zyphr in v1. | [optional] |
12
+ | **created_at** | **Time** | | |
13
+ | **updated_at** | **Time** | | |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'zyphr'
19
+
20
+ instance = Zyphr::OrganizationMembership.new(
21
+ id: null,
22
+ organization_id: null,
23
+ end_user_id: null,
24
+ environment_id: null,
25
+ role: null,
26
+ created_at: null,
27
+ updated_at: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,20 @@
1
+ # Zyphr::OrganizationMembershipResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**OrganizationMembership**](OrganizationMembership.md) | | |
8
+ | **meta** | [**GetDomain200ResponseMeta**](GetDomain200ResponseMeta.md) | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zyphr'
14
+
15
+ instance = Zyphr::OrganizationMembershipResponse.new(
16
+ data: null,
17
+ meta: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,34 @@
1
+ # Zyphr::OrganizationMembershipWithUser
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | |
8
+ | **organization_id** | **String** | | |
9
+ | **end_user_id** | **String** | | |
10
+ | **environment_id** | **String** | | |
11
+ | **role** | **String** | Opaque role string. Not interpreted by Zyphr in v1. | [optional] |
12
+ | **created_at** | **Time** | | |
13
+ | **updated_at** | **Time** | | |
14
+ | **email** | **String** | | [optional] |
15
+ | **name** | **String** | | [optional] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'zyphr'
21
+
22
+ instance = Zyphr::OrganizationMembershipWithUser.new(
23
+ id: null,
24
+ organization_id: null,
25
+ end_user_id: null,
26
+ environment_id: null,
27
+ role: null,
28
+ created_at: null,
29
+ updated_at: null,
30
+ email: null,
31
+ name: null
32
+ )
33
+ ```
34
+
@@ -0,0 +1,20 @@
1
+ # Zyphr::OrganizationResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Organization**](Organization.md) | | |
8
+ | **meta** | [**GetDomain200ResponseMeta**](GetDomain200ResponseMeta.md) | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zyphr'
14
+
15
+ instance = Zyphr::OrganizationResponse.new(
16
+ data: null,
17
+ meta: null
18
+ )
19
+ ```
20
+
@@ -8,6 +8,8 @@
8
8
  | **password** | **String** | | |
9
9
  | **name** | **String** | | [optional] |
10
10
  | **metadata** | **Hash<String, Object>** | | [optional] |
11
+ | **organization_id** | **String** | Optional organization to add the new user to atomically (sc-5591). If specified, registration adds the new user as a member of this org in the same flow; the resulting token's org_id is set to it. Membership is Zyphr-attested at mint time. Requires Pro/Enterprise. | [optional] |
12
+ | **organization_role** | **String** | Optional role label to attach to the membership created by organization_id. Opaque to Zyphr — your application interprets it (e.g. \"owner\", \"admin\", \"member\"). Ignored when organization_id is absent. When omitted, the membership is created with role=null (set later via PATCH organizations/:id/members/:user_id). | [optional] |
11
13
 
12
14
  ## Example
13
15
 
@@ -18,7 +20,9 @@ instance = Zyphr::RegisterRequest.new(
18
20
  email: null,
19
21
  password: null,
20
22
  name: null,
21
- metadata: null
23
+ metadata: null,
24
+ organization_id: null,
25
+ organization_role: null
22
26
  )
23
27
  ```
24
28
 
@@ -0,0 +1,18 @@
1
+ # Zyphr::SetDomainInboundRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **enabled** | **Boolean** | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'zyphr'
13
+
14
+ instance = Zyphr::SetDomainInboundRequest.new(
15
+ enabled: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,20 @@
1
+ # Zyphr::SwitchOrganizationRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **refresh_token** | **String** | | |
8
+ | **organization_id** | **String** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zyphr'
14
+
15
+ instance = Zyphr::SwitchOrganizationRequest.new(
16
+ refresh_token: null,
17
+ organization_id: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # Zyphr::SwitchOrganizationResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**SwitchOrganizationResponseData**](SwitchOrganizationResponseData.md) | | |
8
+ | **meta** | [**GetDomain200ResponseMeta**](GetDomain200ResponseMeta.md) | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zyphr'
14
+
15
+ instance = Zyphr::SwitchOrganizationResponse.new(
16
+ data: null,
17
+ meta: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,22 @@
1
+ # Zyphr::SwitchOrganizationResponseData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **tokens** | [**SwitchOrganizationResponseDataTokens**](SwitchOrganizationResponseDataTokens.md) | | |
8
+ | **organization_id** | **String** | | |
9
+ | **user** | [**SwitchOrganizationResponseDataUser**](SwitchOrganizationResponseDataUser.md) | | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'zyphr'
15
+
16
+ instance = Zyphr::SwitchOrganizationResponseData.new(
17
+ tokens: null,
18
+ organization_id: null,
19
+ user: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,24 @@
1
+ # Zyphr::SwitchOrganizationResponseDataTokens
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **access_token** | **String** | | |
8
+ | **refresh_token** | **String** | | |
9
+ | **expires_in** | **Integer** | | |
10
+ | **token_type** | **String** | | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'zyphr'
16
+
17
+ instance = Zyphr::SwitchOrganizationResponseDataTokens.new(
18
+ access_token: null,
19
+ refresh_token: null,
20
+ expires_in: null,
21
+ token_type: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,20 @@
1
+ # Zyphr::SwitchOrganizationResponseDataUser
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | [optional] |
8
+ | **email** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zyphr'
14
+
15
+ instance = Zyphr::SwitchOrganizationResponseDataUser.new(
16
+ id: null,
17
+ email: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,18 @@
1
+ # Zyphr::UpdateOrganizationMemberRoleRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **role** | **String** | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'zyphr'
13
+
14
+ instance = Zyphr::UpdateOrganizationMemberRoleRequest.new(
15
+ role: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,22 @@
1
+ # Zyphr::UpdateOrganizationRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | | [optional] |
8
+ | **slug** | **String** | | [optional] |
9
+ | **metadata** | **Object** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'zyphr'
15
+
16
+ instance = Zyphr::UpdateOrganizationRequest.new(
17
+ name: null,
18
+ slug: null,
19
+ metadata: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,24 @@
1
+ # Zyphr::V1MuseSubjectsSuggestPostRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **template_id** | **String** | Optional template id. When provided, the route resolves the template body server-side. Cannot be combined with template_body. | [optional] |
8
+ | **template_body** | **String** | Optional raw template body. Empty/missing is allowed — the prompt handles sparse input by falling back to channel best-practices. | [optional] |
9
+ | **channel** | **String** | | |
10
+ | **project_id** | **String** | | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'zyphr'
16
+
17
+ instance = Zyphr::V1MuseSubjectsSuggestPostRequest.new(
18
+ template_id: null,
19
+ template_body: null,
20
+ channel: null,
21
+ project_id: null
22
+ )
23
+ ```
24
+