zyphr 0.1.32 → 0.1.33
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.
- checksums.yaml +4 -4
- data/README.md +41 -0
- data/docs/AddOrganizationMemberRequest.md +20 -0
- data/docs/AuthOrganizationsApi.md +864 -0
- data/docs/AuthUserProfileApi.md +76 -0
- data/docs/CreateOrganizationRequest.md +22 -0
- data/docs/LoginRequest.md +3 -1
- data/docs/MuseApi.md +681 -0
- data/docs/Organization.md +34 -0
- data/docs/OrganizationListResponse.md +20 -0
- data/docs/OrganizationListResponseMeta.md +20 -0
- data/docs/OrganizationMembersListResponse.md +20 -0
- data/docs/OrganizationMembership.md +30 -0
- data/docs/OrganizationMembershipResponse.md +20 -0
- data/docs/OrganizationMembershipWithUser.md +34 -0
- data/docs/OrganizationResponse.md +20 -0
- data/docs/RegisterRequest.md +5 -1
- data/docs/SwitchOrganizationRequest.md +20 -0
- data/docs/SwitchOrganizationResponse.md +20 -0
- data/docs/SwitchOrganizationResponseData.md +22 -0
- data/docs/SwitchOrganizationResponseDataTokens.md +24 -0
- data/docs/SwitchOrganizationResponseDataUser.md +20 -0
- data/docs/UpdateOrganizationMemberRoleRequest.md +18 -0
- data/docs/UpdateOrganizationRequest.md +22 -0
- data/docs/V1MuseSubjectsSuggestPostRequest.md +24 -0
- data/lib/zyphr/api/auth_organizations_api.rb +773 -0
- data/lib/zyphr/api/auth_user_profile_api.rb +61 -0
- data/lib/zyphr/api/muse_api.rb +644 -0
- data/lib/zyphr/models/add_organization_member_request.rb +248 -0
- data/lib/zyphr/models/create_organization_request.rb +258 -0
- data/lib/zyphr/models/login_request.rb +14 -4
- data/lib/zyphr/models/organization.rb +434 -0
- data/lib/zyphr/models/organization_list_response.rb +265 -0
- data/lib/zyphr/models/organization_list_response_meta.rb +230 -0
- data/lib/zyphr/models/organization_members_list_response.rb +265 -0
- data/lib/zyphr/models/organization_membership.rb +379 -0
- data/lib/zyphr/models/organization_membership_response.rb +263 -0
- data/lib/zyphr/models/organization_membership_with_user.rb +405 -0
- data/lib/zyphr/models/organization_response.rb +263 -0
- data/lib/zyphr/models/register_request.rb +43 -4
- data/lib/zyphr/models/switch_organization_request.rb +263 -0
- data/lib/zyphr/models/switch_organization_response.rb +263 -0
- data/lib/zyphr/models/switch_organization_response_data.rb +289 -0
- data/lib/zyphr/models/switch_organization_response_data_tokens.rb +339 -0
- data/lib/zyphr/models/switch_organization_response_data_user.rb +230 -0
- data/lib/zyphr/models/update_organization_member_role_request.rb +223 -0
- data/lib/zyphr/models/update_organization_request.rb +239 -0
- data/lib/zyphr/models/v1_muse_subjects_suggest_post_request.rb +326 -0
- data/lib/zyphr.rb +20 -0
- data/spec/api/auth_organizations_api_spec.rb +171 -0
- data/spec/api/auth_user_profile_api_spec.rb +12 -0
- data/spec/api/muse_api_spec.rb +156 -0
- data/spec/models/add_organization_member_request_spec.rb +42 -0
- data/spec/models/create_organization_request_spec.rb +48 -0
- data/spec/models/login_request_spec.rb +6 -0
- data/spec/models/organization_list_response_meta_spec.rb +42 -0
- data/spec/models/organization_list_response_spec.rb +42 -0
- data/spec/models/organization_members_list_response_spec.rb +42 -0
- data/spec/models/organization_membership_response_spec.rb +42 -0
- data/spec/models/organization_membership_spec.rb +72 -0
- data/spec/models/organization_membership_with_user_spec.rb +84 -0
- data/spec/models/organization_response_spec.rb +42 -0
- data/spec/models/organization_spec.rb +84 -0
- data/spec/models/register_request_spec.rb +12 -0
- data/spec/models/switch_organization_request_spec.rb +42 -0
- data/spec/models/switch_organization_response_data_spec.rb +48 -0
- data/spec/models/switch_organization_response_data_tokens_spec.rb +58 -0
- data/spec/models/switch_organization_response_data_user_spec.rb +42 -0
- data/spec/models/switch_organization_response_spec.rb +42 -0
- data/spec/models/update_organization_member_role_request_spec.rb +36 -0
- data/spec/models/update_organization_request_spec.rb +48 -0
- data/spec/models/v1_muse_subjects_suggest_post_request_spec.rb +58 -0
- data/zyphr.gemspec +1 -1
- metadata +82 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: b97a355b1b3ed8acec6bb8fd281575915b1fd1ff645e9bce7946b105909a3923
|
|
4
|
+
data.tar.gz: 158ef2bc65f0e52255b1b3ed50122334305ddeea220c8c28ed77cb62ab19dbea
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: '078800f631c0017f2b93a2f30d3258439fbb8c0647b132131464072677e37236170e881de4dce27235f4d05d31d2bca9ace1856ae55ed7d910fbf7776e72176f'
|
|
7
|
+
data.tar.gz: 1dce8ca6758d35c99b0aabfb3a20c3c42347e9315a924b5432532f14846773599ff6769babe238776391e1d3d3cd380d32901e045e3d1ef4e657746b840dd0bb
|
data/README.md
CHANGED
|
@@ -160,6 +160,17 @@ Class | Method | HTTP request | Description
|
|
|
160
160
|
*Zyphr::AuthOAuthApi* | [**list_o_auth_connections**](docs/AuthOAuthApi.md#list_o_auth_connections) | **GET** /auth/oauth/connections | List OAuth connections
|
|
161
161
|
*Zyphr::AuthOAuthApi* | [**list_o_auth_providers**](docs/AuthOAuthApi.md#list_o_auth_providers) | **GET** /auth/oauth/providers | List OAuth providers
|
|
162
162
|
*Zyphr::AuthOAuthApi* | [**refresh_o_auth_tokens**](docs/AuthOAuthApi.md#refresh_o_auth_tokens) | **POST** /auth/oauth/tokens/{provider}/refresh | Refresh OAuth provider tokens
|
|
163
|
+
*Zyphr::AuthOrganizationsApi* | [**add_organization_member**](docs/AuthOrganizationsApi.md#add_organization_member) | **POST** /auth/organizations/{id}/members | Add a member to an organization
|
|
164
|
+
*Zyphr::AuthOrganizationsApi* | [**create_organization**](docs/AuthOrganizationsApi.md#create_organization) | **POST** /auth/organizations | Create an organization
|
|
165
|
+
*Zyphr::AuthOrganizationsApi* | [**delete_organization**](docs/AuthOrganizationsApi.md#delete_organization) | **DELETE** /auth/organizations/{id} | Delete an organization
|
|
166
|
+
*Zyphr::AuthOrganizationsApi* | [**get_organization**](docs/AuthOrganizationsApi.md#get_organization) | **GET** /auth/organizations/{id} | Get organization by id
|
|
167
|
+
*Zyphr::AuthOrganizationsApi* | [**list_organization_members**](docs/AuthOrganizationsApi.md#list_organization_members) | **GET** /auth/organizations/{id}/members | List organization members
|
|
168
|
+
*Zyphr::AuthOrganizationsApi* | [**list_organizations**](docs/AuthOrganizationsApi.md#list_organizations) | **GET** /auth/organizations | List organizations
|
|
169
|
+
*Zyphr::AuthOrganizationsApi* | [**list_organizations_for_end_user**](docs/AuthOrganizationsApi.md#list_organizations_for_end_user) | **GET** /auth/end-users/{user_id}/organizations | List organizations an end user belongs to
|
|
170
|
+
*Zyphr::AuthOrganizationsApi* | [**remove_organization_member**](docs/AuthOrganizationsApi.md#remove_organization_member) | **DELETE** /auth/organizations/{id}/members/{user_id} | Remove a member from an organization
|
|
171
|
+
*Zyphr::AuthOrganizationsApi* | [**switch_organization**](docs/AuthOrganizationsApi.md#switch_organization) | **POST** /auth/sessions/switch-organization | Switch the active organization on a session
|
|
172
|
+
*Zyphr::AuthOrganizationsApi* | [**update_organization**](docs/AuthOrganizationsApi.md#update_organization) | **PATCH** /auth/organizations/{id} | Update an organization
|
|
173
|
+
*Zyphr::AuthOrganizationsApi* | [**update_organization_member_role**](docs/AuthOrganizationsApi.md#update_organization_member_role) | **PATCH** /auth/organizations/{id}/members/{user_id} | Update a member's role
|
|
163
174
|
*Zyphr::AuthPasswordResetApi* | [**forgot_password**](docs/AuthPasswordResetApi.md#forgot_password) | **POST** /auth/forgot-password | Request a password reset
|
|
164
175
|
*Zyphr::AuthPasswordResetApi* | [**reset_end_user_password**](docs/AuthPasswordResetApi.md#reset_end_user_password) | **POST** /auth/reset-password | Reset password
|
|
165
176
|
*Zyphr::AuthPasswordResetApi* | [**validate_reset_token**](docs/AuthPasswordResetApi.md#validate_reset_token) | **POST** /auth/validate-reset-token | Validate a password reset token
|
|
@@ -176,6 +187,7 @@ Class | Method | HTTP request | Description
|
|
|
176
187
|
*Zyphr::AuthSessionsApi* | [**revoke_all_end_user_sessions**](docs/AuthSessionsApi.md#revoke_all_end_user_sessions) | **POST** /auth/sessions/revoke-all | Revoke all sessions
|
|
177
188
|
*Zyphr::AuthSessionsApi* | [**revoke_end_user_session**](docs/AuthSessionsApi.md#revoke_end_user_session) | **POST** /auth/sessions/revoke | Revoke a session
|
|
178
189
|
*Zyphr::AuthUserProfileApi* | [**delete_end_user**](docs/AuthUserProfileApi.md#delete_end_user) | **DELETE** /auth/users/me | Delete current end user account
|
|
190
|
+
*Zyphr::AuthUserProfileApi* | [**delete_end_user_by_application**](docs/AuthUserProfileApi.md#delete_end_user_by_application) | **DELETE** /auth/users/{user_id} | Delete an end user (test environment only)
|
|
179
191
|
*Zyphr::AuthUserProfileApi* | [**get_end_user**](docs/AuthUserProfileApi.md#get_end_user) | **GET** /auth/users/me | Get current end user profile
|
|
180
192
|
*Zyphr::AuthUserProfileApi* | [**update_end_user**](docs/AuthUserProfileApi.md#update_end_user) | **PATCH** /auth/users/me | Update current end user profile
|
|
181
193
|
*Zyphr::AuthWebAuthnApi* | [**delete_web_authn_credential**](docs/AuthWebAuthnApi.md#delete_web_authn_credential) | **DELETE** /auth/webauthn/credentials/{id} | Delete a WebAuthn credential
|
|
@@ -227,6 +239,17 @@ Class | Method | HTTP request | Description
|
|
|
227
239
|
*Zyphr::InboxApi* | [**send_batch_in_app**](docs/InboxApi.md#send_batch_in_app) | **POST** /inbox/send/batch | Send batch in-app notifications
|
|
228
240
|
*Zyphr::InboxApi* | [**send_in_app**](docs/InboxApi.md#send_in_app) | **POST** /inbox/send | Send an in-app notification
|
|
229
241
|
*Zyphr::InboxApi* | [**update_subscriber_preferences**](docs/InboxApi.md#update_subscriber_preferences) | **PUT** /subscriber-inbox/preferences | Update subscriber preferences
|
|
242
|
+
*Zyphr::MuseApi* | [**v1_muse_audit_log_get**](docs/MuseApi.md#v1_muse_audit_log_get) | **GET** /v1/muse/audit-log | Paginated per-call audit log for Muse
|
|
243
|
+
*Zyphr::MuseApi* | [**v1_muse_broadcasts_analyze_post**](docs/MuseApi.md#v1_muse_broadcasts_analyze_post) | **POST** /v1/muse/broadcasts/analyze | Stream a pre-send advisory for a draft broadcast
|
|
244
|
+
*Zyphr::MuseApi* | [**v1_muse_entitlement_get**](docs/MuseApi.md#v1_muse_entitlement_get) | **GET** /v1/muse/entitlement | Return the current account's Zyphr Muse entitlement
|
|
245
|
+
*Zyphr::MuseApi* | [**v1_muse_eval_baselines_get**](docs/MuseApi.md#v1_muse_eval_baselines_get) | **GET** /v1/muse/eval-baselines | Per-prompt eval baseline snapshots
|
|
246
|
+
*Zyphr::MuseApi* | [**v1_muse_settings_project_id_get**](docs/MuseApi.md#v1_muse_settings_project_id_get) | **GET** /v1/muse/settings/{project_id} | Read Muse settings for a project
|
|
247
|
+
*Zyphr::MuseApi* | [**v1_muse_settings_project_id_patch**](docs/MuseApi.md#v1_muse_settings_project_id_patch) | **PATCH** /v1/muse/settings/{project_id} | Update Muse settings for a project (admin or developer only)
|
|
248
|
+
*Zyphr::MuseApi* | [**v1_muse_subjects_suggest_post**](docs/MuseApi.md#v1_muse_subjects_suggest_post) | **POST** /v1/muse/subjects/suggest | Suggest 5 ranked subject-line candidates for a template
|
|
249
|
+
*Zyphr::MuseApi* | [**v1_muse_templates_draft_post**](docs/MuseApi.md#v1_muse_templates_draft_post) | **POST** /v1/muse/templates/draft | Stream a draft template from a natural-language brief
|
|
250
|
+
*Zyphr::MuseApi* | [**v1_muse_templates_rewrite_post**](docs/MuseApi.md#v1_muse_templates_rewrite_post) | **POST** /v1/muse/templates/rewrite | Stream a rewritten block per the user's instruction
|
|
251
|
+
*Zyphr::MuseApi* | [**v1_muse_usage_get**](docs/MuseApi.md#v1_muse_usage_get) | **GET** /v1/muse/usage | Per-account Zyphr Muse usage + budget tier
|
|
252
|
+
*Zyphr::MuseApi* | [**v1_muse_workflows_generate_post**](docs/MuseApi.md#v1_muse_workflows_generate_post) | **POST** /v1/muse/workflows/generate | Stream a generated workflow from a natural-language description
|
|
230
253
|
*Zyphr::PushApi* | [**get_push**](docs/PushApi.md#get_push) | **GET** /push/{id} | Get push notification details
|
|
231
254
|
*Zyphr::PushApi* | [**get_push_stats**](docs/PushApi.md#get_push_stats) | **GET** /push/stats | Get push notification statistics
|
|
232
255
|
*Zyphr::PushApi* | [**list_device_push_topics**](docs/PushApi.md#list_device_push_topics) | **GET** /push/devices/{id}/topics | List topics for a device
|
|
@@ -342,6 +365,7 @@ Class | Method | HTTP request | Description
|
|
|
342
365
|
- [Zyphr::AddDomain200Response](docs/AddDomain200Response.md)
|
|
343
366
|
- [Zyphr::AddDomain200ResponseMeta](docs/AddDomain200ResponseMeta.md)
|
|
344
367
|
- [Zyphr::AddDomainRequest](docs/AddDomainRequest.md)
|
|
368
|
+
- [Zyphr::AddOrganizationMemberRequest](docs/AddOrganizationMemberRequest.md)
|
|
345
369
|
- [Zyphr::AddTopicSubscribersRequest](docs/AddTopicSubscribersRequest.md)
|
|
346
370
|
- [Zyphr::ApiError](docs/ApiError.md)
|
|
347
371
|
- [Zyphr::ApiErrorError](docs/ApiErrorError.md)
|
|
@@ -397,6 +421,7 @@ Class | Method | HTTP request | Description
|
|
|
397
421
|
- [Zyphr::ConvertAnonymousUserRequestOneOf1AppleUser](docs/ConvertAnonymousUserRequestOneOf1AppleUser.md)
|
|
398
422
|
- [Zyphr::ConvertAnonymousUserRequestOneOf1AppleUserName](docs/ConvertAnonymousUserRequestOneOf1AppleUserName.md)
|
|
399
423
|
- [Zyphr::CreateCategoryRequest](docs/CreateCategoryRequest.md)
|
|
424
|
+
- [Zyphr::CreateOrganizationRequest](docs/CreateOrganizationRequest.md)
|
|
400
425
|
- [Zyphr::CreateSubscriberRequest](docs/CreateSubscriberRequest.md)
|
|
401
426
|
- [Zyphr::CreateTemplateRequest](docs/CreateTemplateRequest.md)
|
|
402
427
|
- [Zyphr::CreateTopicRequest](docs/CreateTopicRequest.md)
|
|
@@ -506,6 +531,14 @@ Class | Method | HTTP request | Description
|
|
|
506
531
|
- [Zyphr::OAuthTokensRefreshResponseData](docs/OAuthTokensRefreshResponseData.md)
|
|
507
532
|
- [Zyphr::OAuthTokensResponse](docs/OAuthTokensResponse.md)
|
|
508
533
|
- [Zyphr::OAuthTokensResponseData](docs/OAuthTokensResponseData.md)
|
|
534
|
+
- [Zyphr::Organization](docs/Organization.md)
|
|
535
|
+
- [Zyphr::OrganizationListResponse](docs/OrganizationListResponse.md)
|
|
536
|
+
- [Zyphr::OrganizationListResponseMeta](docs/OrganizationListResponseMeta.md)
|
|
537
|
+
- [Zyphr::OrganizationMembersListResponse](docs/OrganizationMembersListResponse.md)
|
|
538
|
+
- [Zyphr::OrganizationMembership](docs/OrganizationMembership.md)
|
|
539
|
+
- [Zyphr::OrganizationMembershipResponse](docs/OrganizationMembershipResponse.md)
|
|
540
|
+
- [Zyphr::OrganizationMembershipWithUser](docs/OrganizationMembershipWithUser.md)
|
|
541
|
+
- [Zyphr::OrganizationResponse](docs/OrganizationResponse.md)
|
|
509
542
|
- [Zyphr::PaginationMeta](docs/PaginationMeta.md)
|
|
510
543
|
- [Zyphr::PasswordRequirements](docs/PasswordRequirements.md)
|
|
511
544
|
- [Zyphr::PasswordRequirementsResponse](docs/PasswordRequirementsResponse.md)
|
|
@@ -618,6 +651,11 @@ Class | Method | HTTP request | Description
|
|
|
618
651
|
- [Zyphr::SubscriberPreference](docs/SubscriberPreference.md)
|
|
619
652
|
- [Zyphr::SubscriberResponse](docs/SubscriberResponse.md)
|
|
620
653
|
- [Zyphr::SuccessResult](docs/SuccessResult.md)
|
|
654
|
+
- [Zyphr::SwitchOrganizationRequest](docs/SwitchOrganizationRequest.md)
|
|
655
|
+
- [Zyphr::SwitchOrganizationResponse](docs/SwitchOrganizationResponse.md)
|
|
656
|
+
- [Zyphr::SwitchOrganizationResponseData](docs/SwitchOrganizationResponseData.md)
|
|
657
|
+
- [Zyphr::SwitchOrganizationResponseDataTokens](docs/SwitchOrganizationResponseDataTokens.md)
|
|
658
|
+
- [Zyphr::SwitchOrganizationResponseDataUser](docs/SwitchOrganizationResponseDataUser.md)
|
|
621
659
|
- [Zyphr::Template](docs/Template.md)
|
|
622
660
|
- [Zyphr::TemplateListResponse](docs/TemplateListResponse.md)
|
|
623
661
|
- [Zyphr::TemplateRenderResponse](docs/TemplateRenderResponse.md)
|
|
@@ -646,6 +684,8 @@ Class | Method | HTTP request | Description
|
|
|
646
684
|
- [Zyphr::UnsubscribeResponse](docs/UnsubscribeResponse.md)
|
|
647
685
|
- [Zyphr::UpdateCategoryRequest](docs/UpdateCategoryRequest.md)
|
|
648
686
|
- [Zyphr::UpdateEndUserRequest](docs/UpdateEndUserRequest.md)
|
|
687
|
+
- [Zyphr::UpdateOrganizationMemberRoleRequest](docs/UpdateOrganizationMemberRoleRequest.md)
|
|
688
|
+
- [Zyphr::UpdateOrganizationRequest](docs/UpdateOrganizationRequest.md)
|
|
649
689
|
- [Zyphr::UpdateSubscriberPreferencesRequest](docs/UpdateSubscriberPreferencesRequest.md)
|
|
650
690
|
- [Zyphr::UpdateSubscriberPreferencesRequestPreferencesInner](docs/UpdateSubscriberPreferencesRequestPreferencesInner.md)
|
|
651
691
|
- [Zyphr::UpdateSubscriberRequest](docs/UpdateSubscriberRequest.md)
|
|
@@ -659,6 +699,7 @@ Class | Method | HTTP request | Description
|
|
|
659
699
|
- [Zyphr::UpsertSmsConfigRequest](docs/UpsertSmsConfigRequest.md)
|
|
660
700
|
- [Zyphr::UserDevicesDeleteResponse](docs/UserDevicesDeleteResponse.md)
|
|
661
701
|
- [Zyphr::UserDevicesDeleteResponseData](docs/UserDevicesDeleteResponseData.md)
|
|
702
|
+
- [Zyphr::V1MuseSubjectsSuggestPostRequest](docs/V1MuseSubjectsSuggestPostRequest.md)
|
|
662
703
|
- [Zyphr::ValidateResetTokenRequest](docs/ValidateResetTokenRequest.md)
|
|
663
704
|
- [Zyphr::ValidateResetTokenResponse](docs/ValidateResetTokenResponse.md)
|
|
664
705
|
- [Zyphr::ValidateResetTokenResponseData](docs/ValidateResetTokenResponseData.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zyphr::AddOrganizationMemberRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **user_id** | **String** | | |
|
|
8
|
+
| **role** | **String** | Opaque role string. Not interpreted by Zyphr in v1. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zyphr'
|
|
14
|
+
|
|
15
|
+
instance = Zyphr::AddOrganizationMemberRequest.new(
|
|
16
|
+
user_id: null,
|
|
17
|
+
role: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|