launchdarkly_api 3.3.2 → 3.7.1
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 +198 -168
- data/docs/AccessTokensApi.md +333 -0
- data/docs/ClientSideAvailability.md +9 -0
- data/docs/EnvironmentsApi.md +120 -0
- data/docs/FeatureFlag.md +1 -0
- data/docs/FeatureFlagBody.md +1 -0
- data/docs/FeatureFlagScheduledChange.md +11 -0
- data/docs/FeatureFlagScheduledChanges.md +9 -0
- data/docs/FeatureFlagScheduledChangesConflicts.md +8 -0
- data/docs/FeatureFlagScheduledChangesConflictsInstructions.md +9 -0
- data/docs/FeatureFlagsApi.md +2 -2
- data/docs/Project.md +1 -0
- data/docs/ProjectBody.md +1 -0
- data/docs/RelayProxyConfig.md +15 -0
- data/docs/RelayProxyConfigBody.md +9 -0
- data/docs/RelayProxyConfigs.md +8 -0
- data/docs/RelayProxyConfigurationsApi.md +326 -0
- data/docs/ScheduledChangesFeatureFlagConflict.md +9 -0
- data/docs/SemanticPatchInstruction.md +7 -0
- data/docs/{SemanticPatchOperationInstructions.md → SemanticPatchInstructionInner.md} +1 -1
- data/docs/SemanticPatchOperation.md +1 -1
- data/docs/Token.md +22 -0
- data/docs/TokenBody.md +13 -0
- data/docs/Tokens.md +9 -0
- data/docs/UnboundedSegmentTargetChanges.md +9 -0
- data/docs/UnboundedSegmentTargetsBody.md +9 -0
- data/docs/UserSegment.md +1 -0
- data/docs/UserSegmentBody.md +1 -0
- data/docs/UserSegmentsApi.md +61 -0
- data/launchdarkly_api.gemspec +1 -1
- data/lib/launchdarkly_api.rb +19 -2
- data/lib/launchdarkly_api/api/access_tokens_api.rb +340 -0
- data/lib/launchdarkly_api/api/audit_log_api.rb +1 -1
- data/lib/launchdarkly_api/api/custom_roles_api.rb +1 -1
- data/lib/launchdarkly_api/api/customer_metrics_api.rb +1 -1
- data/lib/launchdarkly_api/api/data_export_destinations_api.rb +1 -1
- data/lib/launchdarkly_api/api/environments_api.rb +123 -1
- data/lib/launchdarkly_api/api/feature_flags_api.rb +3 -3
- data/lib/launchdarkly_api/api/projects_api.rb +1 -1
- data/lib/launchdarkly_api/api/relay_proxy_configurations_api.rb +337 -0
- data/lib/launchdarkly_api/api/root_api.rb +1 -1
- data/lib/launchdarkly_api/api/team_members_api.rb +1 -1
- data/lib/launchdarkly_api/api/user_segments_api.rb +70 -1
- data/lib/launchdarkly_api/api/user_settings_api.rb +1 -1
- data/lib/launchdarkly_api/api/users_api.rb +1 -1
- data/lib/launchdarkly_api/api/webhooks_api.rb +1 -1
- data/lib/launchdarkly_api/api_client.rb +1 -1
- data/lib/launchdarkly_api/api_error.rb +1 -1
- data/lib/launchdarkly_api/configuration.rb +1 -1
- data/lib/launchdarkly_api/models/audit_log_entries.rb +1 -1
- data/lib/launchdarkly_api/models/audit_log_entry.rb +1 -1
- data/lib/launchdarkly_api/models/audit_log_entry_target.rb +1 -1
- data/lib/launchdarkly_api/models/clause.rb +1 -1
- data/lib/launchdarkly_api/models/client_side_availability.rb +194 -0
- data/lib/launchdarkly_api/models/copy_actions.rb +1 -1
- data/lib/launchdarkly_api/models/custom_property.rb +1 -1
- data/lib/launchdarkly_api/models/custom_property_values.rb +1 -1
- data/lib/launchdarkly_api/models/custom_role.rb +1 -1
- data/lib/launchdarkly_api/models/custom_role_body.rb +1 -1
- data/lib/launchdarkly_api/models/custom_roles.rb +1 -1
- data/lib/launchdarkly_api/models/defaults.rb +1 -1
- data/lib/launchdarkly_api/models/destination.rb +1 -1
- data/lib/launchdarkly_api/models/destination_amazon_kinesis.rb +1 -1
- data/lib/launchdarkly_api/models/destination_body.rb +1 -1
- data/lib/launchdarkly_api/models/destination_google_pub_sub.rb +1 -1
- data/lib/launchdarkly_api/models/destination_m_particle.rb +1 -1
- data/lib/launchdarkly_api/models/destination_segment.rb +1 -1
- data/lib/launchdarkly_api/models/destinations.rb +1 -1
- data/lib/launchdarkly_api/models/environment.rb +1 -1
- data/lib/launchdarkly_api/models/environment_post.rb +1 -1
- data/lib/launchdarkly_api/models/evaluation_usage_error.rb +1 -1
- data/lib/launchdarkly_api/models/events.rb +1 -1
- data/lib/launchdarkly_api/models/fallthrough.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag.rb +11 -2
- data/lib/launchdarkly_api/models/feature_flag_body.rb +11 -2
- data/lib/launchdarkly_api/models/feature_flag_config.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_copy_body.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_copy_object.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_scheduled_change.rb +211 -0
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes.rb +194 -0
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts.rb +185 -0
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts_instructions.rb +195 -0
- data/lib/launchdarkly_api/models/feature_flag_status.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_status_across_environments.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_status_for_queried_environment.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_statuses.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flags.rb +1 -1
- data/lib/launchdarkly_api/models/flag_list_item.rb +1 -1
- data/lib/launchdarkly_api/models/id.rb +1 -1
- data/lib/launchdarkly_api/models/link.rb +1 -1
- data/lib/launchdarkly_api/models/links.rb +1 -1
- data/lib/launchdarkly_api/models/ma_uby_category.rb +1 -1
- data/lib/launchdarkly_api/models/mau.rb +1 -1
- data/lib/launchdarkly_api/models/mau_metadata.rb +1 -1
- data/lib/launchdarkly_api/models/member.rb +1 -1
- data/lib/launchdarkly_api/models/members.rb +1 -1
- data/lib/launchdarkly_api/models/members_body.rb +1 -1
- data/lib/launchdarkly_api/models/patch_comment.rb +1 -1
- data/lib/launchdarkly_api/models/patch_operation.rb +1 -1
- data/lib/launchdarkly_api/models/policy.rb +1 -1
- data/lib/launchdarkly_api/models/prerequisite.rb +1 -1
- data/lib/launchdarkly_api/models/project.rb +14 -5
- data/lib/launchdarkly_api/models/project_body.rb +14 -5
- data/lib/launchdarkly_api/models/projects.rb +1 -1
- data/lib/launchdarkly_api/models/relay_proxy_config.rb +288 -0
- data/lib/launchdarkly_api/models/relay_proxy_config_body.rb +195 -0
- data/lib/launchdarkly_api/models/relay_proxy_configs.rb +185 -0
- data/lib/launchdarkly_api/models/role.rb +1 -1
- data/lib/launchdarkly_api/models/rollout.rb +1 -1
- data/lib/launchdarkly_api/models/rule.rb +1 -1
- data/lib/launchdarkly_api/models/scheduled_changes_feature_flag_conflict.rb +194 -0
- data/lib/launchdarkly_api/models/semantic_patch_instruction.rb +174 -0
- data/lib/launchdarkly_api/models/{semantic_patch_operation_instructions.rb → semantic_patch_instruction_inner.rb} +2 -2
- data/lib/launchdarkly_api/models/semantic_patch_operation.rb +3 -5
- data/lib/launchdarkly_api/models/site.rb +1 -1
- data/lib/launchdarkly_api/models/statement.rb +1 -1
- data/lib/launchdarkly_api/models/stream.rb +1 -1
- data/lib/launchdarkly_api/models/stream_by_sdk.rb +1 -1
- data/lib/launchdarkly_api/models/stream_by_sdk_links.rb +1 -1
- data/lib/launchdarkly_api/models/stream_by_sdk_links_metadata.rb +1 -1
- data/lib/launchdarkly_api/models/stream_links.rb +1 -1
- data/lib/launchdarkly_api/models/stream_sdk_version.rb +1 -1
- data/lib/launchdarkly_api/models/stream_sdk_version_data.rb +1 -1
- data/lib/launchdarkly_api/models/stream_usage_error.rb +1 -1
- data/lib/launchdarkly_api/models/stream_usage_links.rb +1 -1
- data/lib/launchdarkly_api/models/stream_usage_metadata.rb +1 -1
- data/lib/launchdarkly_api/models/stream_usage_series.rb +1 -1
- data/lib/launchdarkly_api/models/streams.rb +1 -1
- data/lib/launchdarkly_api/models/target.rb +1 -1
- data/lib/launchdarkly_api/models/token.rb +322 -0
- data/lib/launchdarkly_api/models/token_body.rb +237 -0
- data/lib/launchdarkly_api/models/tokens.rb +194 -0
- data/lib/launchdarkly_api/models/unbounded_segment_target_changes.rb +198 -0
- data/lib/launchdarkly_api/models/unbounded_segment_targets_body.rb +192 -0
- data/lib/launchdarkly_api/models/usage.rb +1 -1
- data/lib/launchdarkly_api/models/usage_error.rb +1 -1
- data/lib/launchdarkly_api/models/usage_links.rb +1 -1
- data/lib/launchdarkly_api/models/user.rb +1 -1
- data/lib/launchdarkly_api/models/user_flag_setting.rb +1 -1
- data/lib/launchdarkly_api/models/user_flag_settings.rb +1 -1
- data/lib/launchdarkly_api/models/user_record.rb +1 -1
- data/lib/launchdarkly_api/models/user_segment.rb +12 -2
- data/lib/launchdarkly_api/models/user_segment_body.rb +12 -2
- data/lib/launchdarkly_api/models/user_segment_rule.rb +1 -1
- data/lib/launchdarkly_api/models/user_segments.rb +1 -1
- data/lib/launchdarkly_api/models/user_settings_body.rb +1 -1
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_flag.rb +1 -1
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_flags.rb +1 -1
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_segment.rb +1 -1
- data/lib/launchdarkly_api/models/user_targeting_expiration_on_flags_for_user.rb +1 -1
- data/lib/launchdarkly_api/models/user_targeting_expiration_resource_id_for_flag.rb +1 -1
- data/lib/launchdarkly_api/models/users.rb +1 -1
- data/lib/launchdarkly_api/models/variation.rb +1 -1
- data/lib/launchdarkly_api/models/webhook.rb +1 -1
- data/lib/launchdarkly_api/models/webhook_body.rb +1 -1
- data/lib/launchdarkly_api/models/webhooks.rb +1 -1
- data/lib/launchdarkly_api/models/weighted_variation.rb +1 -1
- data/lib/launchdarkly_api/version.rb +2 -2
- data/openapi.yml +639 -12
- data/spec/api/access_tokens_api_spec.rb +103 -0
- data/spec/api/audit_log_api_spec.rb +1 -1
- data/spec/api/custom_roles_api_spec.rb +1 -1
- data/spec/api/customer_metrics_api_spec.rb +1 -1
- data/spec/api/data_export_destinations_api_spec.rb +1 -1
- data/spec/api/environments_api_spec.rb +27 -1
- data/spec/api/feature_flags_api_spec.rb +2 -2
- data/spec/api/projects_api_spec.rb +1 -1
- data/spec/api/relay_proxy_configurations_api_spec.rb +102 -0
- data/spec/api/root_api_spec.rb +1 -1
- data/spec/api/team_members_api_spec.rb +1 -1
- data/spec/api/user_segments_api_spec.rb +15 -1
- data/spec/api/user_settings_api_spec.rb +1 -1
- data/spec/api/users_api_spec.rb +1 -1
- data/spec/api/webhooks_api_spec.rb +1 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/audit_log_entries_spec.rb +1 -1
- data/spec/models/audit_log_entry_spec.rb +1 -1
- data/spec/models/audit_log_entry_target_spec.rb +1 -1
- data/spec/models/clause_spec.rb +1 -1
- data/spec/models/client_side_availability_spec.rb +47 -0
- data/spec/models/copy_actions_spec.rb +1 -1
- data/spec/models/custom_property_spec.rb +1 -1
- data/spec/models/custom_property_values_spec.rb +1 -1
- data/spec/models/custom_role_body_spec.rb +1 -1
- data/spec/models/custom_role_spec.rb +1 -1
- data/spec/models/custom_roles_spec.rb +1 -1
- data/spec/models/defaults_spec.rb +1 -1
- data/spec/models/destination_amazon_kinesis_spec.rb +1 -1
- data/spec/models/destination_body_spec.rb +1 -1
- data/spec/models/destination_google_pub_sub_spec.rb +1 -1
- data/spec/models/destination_m_particle_spec.rb +1 -1
- data/spec/models/destination_segment_spec.rb +1 -1
- data/spec/models/destination_spec.rb +1 -1
- data/spec/models/destinations_spec.rb +1 -1
- data/spec/models/environment_post_spec.rb +1 -1
- data/spec/models/environment_spec.rb +1 -1
- data/spec/models/evaluation_usage_error_spec.rb +1 -1
- data/spec/models/events_spec.rb +1 -1
- data/spec/models/fallthrough_spec.rb +1 -1
- data/spec/models/feature_flag_body_spec.rb +7 -1
- data/spec/models/feature_flag_config_spec.rb +1 -1
- data/spec/models/feature_flag_copy_body_spec.rb +1 -1
- data/spec/models/feature_flag_copy_object_spec.rb +1 -1
- data/spec/models/feature_flag_scheduled_change_spec.rb +59 -0
- data/spec/models/feature_flag_scheduled_changes_conflicts_instructions_spec.rb +47 -0
- data/spec/models/feature_flag_scheduled_changes_conflicts_spec.rb +41 -0
- data/spec/models/feature_flag_scheduled_changes_spec.rb +47 -0
- data/spec/models/feature_flag_spec.rb +7 -1
- data/spec/models/feature_flag_status_across_environments_spec.rb +1 -1
- data/spec/models/feature_flag_status_for_queried_environment_spec.rb +1 -1
- data/spec/models/feature_flag_status_spec.rb +1 -1
- data/spec/models/feature_flag_statuses_spec.rb +1 -1
- data/spec/models/feature_flags_spec.rb +1 -1
- data/spec/models/flag_list_item_spec.rb +1 -1
- data/spec/models/id_spec.rb +1 -1
- data/spec/models/link_spec.rb +1 -1
- data/spec/models/links_spec.rb +1 -1
- data/spec/models/ma_uby_category_spec.rb +1 -1
- data/spec/models/mau_metadata_spec.rb +1 -1
- data/spec/models/mau_spec.rb +1 -1
- data/spec/models/member_spec.rb +1 -1
- data/spec/models/members_body_spec.rb +1 -1
- data/spec/models/members_spec.rb +1 -1
- data/spec/models/patch_comment_spec.rb +1 -1
- data/spec/models/patch_operation_spec.rb +1 -1
- data/spec/models/policy_spec.rb +1 -1
- data/spec/models/prerequisite_spec.rb +1 -1
- data/spec/models/project_body_spec.rb +7 -1
- data/spec/models/project_spec.rb +7 -1
- data/spec/models/projects_spec.rb +1 -1
- data/spec/models/relay_proxy_config_body_spec.rb +47 -0
- data/spec/models/relay_proxy_config_spec.rb +83 -0
- data/spec/models/relay_proxy_configs_spec.rb +41 -0
- data/spec/models/role_spec.rb +1 -1
- data/spec/models/rollout_spec.rb +1 -1
- data/spec/models/rule_spec.rb +1 -1
- data/spec/models/scheduled_changes_feature_flag_conflict_spec.rb +47 -0
- data/spec/models/{semantic_patch_operation_instructions_spec.rb → semantic_patch_instruction_inner_spec.rb} +7 -7
- data/spec/models/semantic_patch_instruction_spec.rb +35 -0
- data/spec/models/semantic_patch_operation_spec.rb +1 -1
- data/spec/models/site_spec.rb +1 -1
- data/spec/models/statement_spec.rb +1 -1
- data/spec/models/stream_by_sdk_links_metadata_spec.rb +1 -1
- data/spec/models/stream_by_sdk_links_spec.rb +1 -1
- data/spec/models/stream_by_sdk_spec.rb +1 -1
- data/spec/models/stream_links_spec.rb +1 -1
- data/spec/models/stream_sdk_version_data_spec.rb +1 -1
- data/spec/models/stream_sdk_version_spec.rb +1 -1
- data/spec/models/stream_spec.rb +1 -1
- data/spec/models/stream_usage_error_spec.rb +1 -1
- data/spec/models/stream_usage_links_spec.rb +1 -1
- data/spec/models/stream_usage_metadata_spec.rb +1 -1
- data/spec/models/stream_usage_series_spec.rb +1 -1
- data/spec/models/streams_spec.rb +1 -1
- data/spec/models/target_spec.rb +1 -1
- data/spec/models/token_body_spec.rb +71 -0
- data/spec/models/token_spec.rb +125 -0
- data/spec/models/tokens_spec.rb +47 -0
- data/spec/models/unbounded_segment_target_changes_spec.rb +47 -0
- data/spec/models/unbounded_segment_targets_body_spec.rb +47 -0
- data/spec/models/usage_error_spec.rb +1 -1
- data/spec/models/usage_links_spec.rb +1 -1
- data/spec/models/usage_spec.rb +1 -1
- data/spec/models/user_flag_setting_spec.rb +1 -1
- data/spec/models/user_flag_settings_spec.rb +1 -1
- data/spec/models/user_record_spec.rb +1 -1
- data/spec/models/user_segment_body_spec.rb +7 -1
- data/spec/models/user_segment_rule_spec.rb +1 -1
- data/spec/models/user_segment_spec.rb +7 -1
- data/spec/models/user_segments_spec.rb +1 -1
- data/spec/models/user_settings_body_spec.rb +1 -1
- data/spec/models/user_spec.rb +1 -1
- data/spec/models/user_targeting_expiration_for_flag_spec.rb +1 -1
- data/spec/models/user_targeting_expiration_for_flags_spec.rb +1 -1
- data/spec/models/user_targeting_expiration_for_segment_spec.rb +1 -1
- data/spec/models/user_targeting_expiration_on_flags_for_user_spec.rb +1 -1
- data/spec/models/user_targeting_expiration_resource_id_for_flag_spec.rb +1 -1
- data/spec/models/users_spec.rb +1 -1
- data/spec/models/variation_spec.rb +1 -1
- data/spec/models/webhook_body_spec.rb +1 -1
- data/spec/models/webhook_spec.rb +1 -1
- data/spec/models/webhooks_spec.rb +1 -1
- data/spec/models/weighted_variation_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +160 -92
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# LaunchDarklyApi::ScheduledChangesFeatureFlagConflict
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**_id** | **String** | Feature flag scheduled change id this change will conflict with | [optional]
|
|
7
|
+
**reason** | **String** | Feature flag scheduled change conflict reason | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -4,6 +4,6 @@
|
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**comment** | **String** | | [optional]
|
|
7
|
-
**instructions** | [**
|
|
7
|
+
**instructions** | [**SemanticPatchInstruction**](SemanticPatchInstruction.md) | |
|
|
8
8
|
|
|
9
9
|
|
data/docs/Token.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# LaunchDarklyApi::Token
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**_links** | [**Links**](Links.md) | | [optional]
|
|
7
|
+
**_id** | [**Id**](Id.md) | | [optional]
|
|
8
|
+
**owner_id** | [**Id**](Id.md) | | [optional]
|
|
9
|
+
**member_id** | [**Id**](Id.md) | | [optional]
|
|
10
|
+
**_member** | [**Member**](Member.md) | | [optional]
|
|
11
|
+
**creation_date** | **Integer** | A unix epoch time in milliseconds specifying the creation time of this access token. | [optional]
|
|
12
|
+
**last_modified** | **Integer** | A unix epoch time in milliseconds specifying the last time this access token was modified. | [optional]
|
|
13
|
+
**last_used** | **Integer** | A unix epoch time in milliseconds specifying the last time this access token was used to authorize access to the LaunchDarkly REST API. | [optional]
|
|
14
|
+
**token** | **String** | The last 4 digits of the unique secret key for this access token. If creating or resetting the token, this will be the full token secret. | [optional]
|
|
15
|
+
**name** | **String** | A human-friendly name for the access token | [optional]
|
|
16
|
+
**role** | **String** | The name of a built-in role for the token | [optional]
|
|
17
|
+
**custom_role_ids** | **Array<String>** | A list of custom role IDs to use as access limits for the access token | [optional]
|
|
18
|
+
**inline_role** | [**Array<Statement>**](Statement.md) | | [optional]
|
|
19
|
+
**service_token** | **BOOLEAN** | Whether the token will be a service token https://docs.launchdarkly.com/home/account-security/api-access-tokens#service-tokens | [optional]
|
|
20
|
+
**default_api_version** | **Integer** | The default API version for this token | [optional]
|
|
21
|
+
|
|
22
|
+
|
data/docs/TokenBody.md
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# LaunchDarklyApi::TokenBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**name** | **String** | A human-friendly name for the access token | [optional]
|
|
7
|
+
**role** | **String** | The name of a built-in role for the token | [optional]
|
|
8
|
+
**custom_role_ids** | **Array<String>** | A list of custom role IDs to use as access limits for the access token | [optional]
|
|
9
|
+
**inline_role** | [**Array<Statement>**](Statement.md) | | [optional]
|
|
10
|
+
**service_token** | **BOOLEAN** | Whether the token will be a service token https://docs.launchdarkly.com/home/account-security/api-access-tokens#service-tokens | [optional]
|
|
11
|
+
**default_api_version** | **Integer** | The default API version for this token | [optional]
|
|
12
|
+
|
|
13
|
+
|
data/docs/Tokens.md
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# LaunchDarklyApi::UnboundedSegmentTargetChanges
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**add** | **Array<String>** | Users to add to this list of targets | [optional]
|
|
7
|
+
**remove** | **Array<String>** | Users to remove from this list of targets | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# LaunchDarklyApi::UnboundedSegmentTargetsBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**included** | [**UnboundedSegmentTargetChanges**](UnboundedSegmentTargetChanges.md) | | [optional]
|
|
7
|
+
**excluded** | [**UnboundedSegmentTargetChanges**](UnboundedSegmentTargetChanges.md) | | [optional]
|
|
8
|
+
|
|
9
|
+
|
data/docs/UserSegment.md
CHANGED
|
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**included** | **Array<String>** | An array of user keys that are included in this segment. | [optional]
|
|
12
12
|
**excluded** | **Array<String>** | An array of user keys that should not be included in this segment, unless they are also listed in \"included\". | [optional]
|
|
13
13
|
**rules** | [**Array<UserSegmentRule>**](UserSegmentRule.md) | An array of rules that can cause a user to be included in this segment. | [optional]
|
|
14
|
+
**unbounded** | **BOOLEAN** | Controls whether this segment can support unlimited numbers of users. Requires the beta API and additional setup. Include/exclude lists in this payload are not used in unbounded segments. | [optional]
|
|
14
15
|
**version** | **Integer** | | [optional]
|
|
15
16
|
**_links** | [**Links**](Links.md) | | [optional]
|
|
16
17
|
**_flags** | [**Array<FlagListItem>**](FlagListItem.md) | | [optional]
|
data/docs/UserSegmentBody.md
CHANGED
|
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
**name** | **String** | A human-friendly name for the user segment. |
|
|
7
7
|
**key** | **String** | A unique key that will be used to reference the user segment in feature flags. |
|
|
8
8
|
**description** | **String** | A description for the user segment. | [optional]
|
|
9
|
+
**unbounded** | **BOOLEAN** | Controls whether this segment can support unlimited numbers of users. Requires the beta API and additional setup. Include/exclude lists in this payload are not used in unbounded segments. | [optional]
|
|
9
10
|
**tags** | **Array<String>** | Tags for the user segment. | [optional]
|
|
10
11
|
|
|
11
12
|
|
data/docs/UserSegmentsApi.md
CHANGED
|
@@ -11,6 +11,7 @@ Method | HTTP request | Description
|
|
|
11
11
|
[**patch_expiring_user_targets_on_segment**](UserSegmentsApi.md#patch_expiring_user_targets_on_segment) | **PATCH** /segments/{projectKey}/{userSegmentKey}/expiring-user-targets/{environmentKey} | Update, add, or delete expiring user targets on user segment
|
|
12
12
|
[**patch_user_segment**](UserSegmentsApi.md#patch_user_segment) | **PATCH** /segments/{projectKey}/{environmentKey}/{userSegmentKey} | Perform a partial update to a user segment.
|
|
13
13
|
[**post_user_segment**](UserSegmentsApi.md#post_user_segment) | **POST** /segments/{projectKey}/{environmentKey} | Creates a new user segment.
|
|
14
|
+
[**updated_unbounded_segment_targets**](UserSegmentsApi.md#updated_unbounded_segment_targets) | **POST** /segments/{projectKey}/{environmentKey}/{userSegmentKey}/unbounded-users | Update targets included or excluded in an unbounded segment
|
|
14
15
|
|
|
15
16
|
|
|
16
17
|
# **delete_user_segment**
|
|
@@ -425,3 +426,63 @@ Name | Type | Description | Notes
|
|
|
425
426
|
|
|
426
427
|
|
|
427
428
|
|
|
429
|
+
# **updated_unbounded_segment_targets**
|
|
430
|
+
> updated_unbounded_segment_targets(project_key, environment_key, user_segment_key, unbounded_segment_targets_body)
|
|
431
|
+
|
|
432
|
+
Update targets included or excluded in an unbounded segment
|
|
433
|
+
|
|
434
|
+
### Example
|
|
435
|
+
```ruby
|
|
436
|
+
# load the gem
|
|
437
|
+
require 'launchdarkly_api'
|
|
438
|
+
# setup authorization
|
|
439
|
+
LaunchDarklyApi.configure do |config|
|
|
440
|
+
# Configure API key authorization: Token
|
|
441
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
442
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
443
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
444
|
+
end
|
|
445
|
+
|
|
446
|
+
api_instance = LaunchDarklyApi::UserSegmentsApi.new
|
|
447
|
+
|
|
448
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
449
|
+
|
|
450
|
+
environment_key = 'environment_key_example' # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
|
|
451
|
+
|
|
452
|
+
user_segment_key = 'user_segment_key_example' # String | The user segment's key. The key identifies the user segment in your code.
|
|
453
|
+
|
|
454
|
+
unbounded_segment_targets_body = LaunchDarklyApi::UnboundedSegmentTargetsBody.new # UnboundedSegmentTargetsBody | Add or remove user targets to the included or excluded lists on an unbounded segment
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
begin
|
|
458
|
+
#Update targets included or excluded in an unbounded segment
|
|
459
|
+
api_instance.updated_unbounded_segment_targets(project_key, environment_key, user_segment_key, unbounded_segment_targets_body)
|
|
460
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
461
|
+
puts "Exception when calling UserSegmentsApi->updated_unbounded_segment_targets: #{e}"
|
|
462
|
+
end
|
|
463
|
+
```
|
|
464
|
+
|
|
465
|
+
### Parameters
|
|
466
|
+
|
|
467
|
+
Name | Type | Description | Notes
|
|
468
|
+
------------- | ------------- | ------------- | -------------
|
|
469
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
470
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
471
|
+
**user_segment_key** | **String**| The user segment's key. The key identifies the user segment in your code. |
|
|
472
|
+
**unbounded_segment_targets_body** | [**UnboundedSegmentTargetsBody**](UnboundedSegmentTargetsBody.md)| Add or remove user targets to the included or excluded lists on an unbounded segment |
|
|
473
|
+
|
|
474
|
+
### Return type
|
|
475
|
+
|
|
476
|
+
nil (empty response body)
|
|
477
|
+
|
|
478
|
+
### Authorization
|
|
479
|
+
|
|
480
|
+
[Token](../README.md#Token)
|
|
481
|
+
|
|
482
|
+
### HTTP request headers
|
|
483
|
+
|
|
484
|
+
- **Content-Type**: application/json
|
|
485
|
+
- **Accept**: application/json
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
|
data/launchdarkly_api.gemspec
CHANGED
data/lib/launchdarkly_api.rb
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#Build custom integrations with the LaunchDarkly REST API
|
|
5
5
|
|
|
6
|
-
OpenAPI spec version: 3.
|
|
6
|
+
OpenAPI spec version: 3.7.1
|
|
7
7
|
Contact: support@launchdarkly.com
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
9
|
Swagger Codegen version: 2.4.8
|
|
@@ -21,6 +21,7 @@ require 'launchdarkly_api/models/audit_log_entries'
|
|
|
21
21
|
require 'launchdarkly_api/models/audit_log_entry'
|
|
22
22
|
require 'launchdarkly_api/models/audit_log_entry_target'
|
|
23
23
|
require 'launchdarkly_api/models/clause'
|
|
24
|
+
require 'launchdarkly_api/models/client_side_availability'
|
|
24
25
|
require 'launchdarkly_api/models/copy_actions'
|
|
25
26
|
require 'launchdarkly_api/models/custom_property'
|
|
26
27
|
require 'launchdarkly_api/models/custom_property_values'
|
|
@@ -45,6 +46,10 @@ require 'launchdarkly_api/models/feature_flag_body'
|
|
|
45
46
|
require 'launchdarkly_api/models/feature_flag_config'
|
|
46
47
|
require 'launchdarkly_api/models/feature_flag_copy_body'
|
|
47
48
|
require 'launchdarkly_api/models/feature_flag_copy_object'
|
|
49
|
+
require 'launchdarkly_api/models/feature_flag_scheduled_change'
|
|
50
|
+
require 'launchdarkly_api/models/feature_flag_scheduled_changes'
|
|
51
|
+
require 'launchdarkly_api/models/feature_flag_scheduled_changes_conflicts'
|
|
52
|
+
require 'launchdarkly_api/models/feature_flag_scheduled_changes_conflicts_instructions'
|
|
48
53
|
require 'launchdarkly_api/models/feature_flag_status'
|
|
49
54
|
require 'launchdarkly_api/models/feature_flag_status_across_environments'
|
|
50
55
|
require 'launchdarkly_api/models/feature_flag_status_for_queried_environment'
|
|
@@ -67,11 +72,16 @@ require 'launchdarkly_api/models/prerequisite'
|
|
|
67
72
|
require 'launchdarkly_api/models/project'
|
|
68
73
|
require 'launchdarkly_api/models/project_body'
|
|
69
74
|
require 'launchdarkly_api/models/projects'
|
|
75
|
+
require 'launchdarkly_api/models/relay_proxy_config'
|
|
76
|
+
require 'launchdarkly_api/models/relay_proxy_config_body'
|
|
77
|
+
require 'launchdarkly_api/models/relay_proxy_configs'
|
|
70
78
|
require 'launchdarkly_api/models/role'
|
|
71
79
|
require 'launchdarkly_api/models/rollout'
|
|
72
80
|
require 'launchdarkly_api/models/rule'
|
|
81
|
+
require 'launchdarkly_api/models/scheduled_changes_feature_flag_conflict'
|
|
82
|
+
require 'launchdarkly_api/models/semantic_patch_instruction'
|
|
83
|
+
require 'launchdarkly_api/models/semantic_patch_instruction_inner'
|
|
73
84
|
require 'launchdarkly_api/models/semantic_patch_operation'
|
|
74
|
-
require 'launchdarkly_api/models/semantic_patch_operation_instructions'
|
|
75
85
|
require 'launchdarkly_api/models/site'
|
|
76
86
|
require 'launchdarkly_api/models/statement'
|
|
77
87
|
require 'launchdarkly_api/models/stream'
|
|
@@ -87,6 +97,11 @@ require 'launchdarkly_api/models/stream_usage_metadata'
|
|
|
87
97
|
require 'launchdarkly_api/models/stream_usage_series'
|
|
88
98
|
require 'launchdarkly_api/models/streams'
|
|
89
99
|
require 'launchdarkly_api/models/target'
|
|
100
|
+
require 'launchdarkly_api/models/token'
|
|
101
|
+
require 'launchdarkly_api/models/token_body'
|
|
102
|
+
require 'launchdarkly_api/models/tokens'
|
|
103
|
+
require 'launchdarkly_api/models/unbounded_segment_target_changes'
|
|
104
|
+
require 'launchdarkly_api/models/unbounded_segment_targets_body'
|
|
90
105
|
require 'launchdarkly_api/models/usage'
|
|
91
106
|
require 'launchdarkly_api/models/usage_error'
|
|
92
107
|
require 'launchdarkly_api/models/usage_links'
|
|
@@ -112,6 +127,7 @@ require 'launchdarkly_api/models/webhooks'
|
|
|
112
127
|
require 'launchdarkly_api/models/weighted_variation'
|
|
113
128
|
|
|
114
129
|
# APIs
|
|
130
|
+
require 'launchdarkly_api/api/access_tokens_api'
|
|
115
131
|
require 'launchdarkly_api/api/audit_log_api'
|
|
116
132
|
require 'launchdarkly_api/api/custom_roles_api'
|
|
117
133
|
require 'launchdarkly_api/api/customer_metrics_api'
|
|
@@ -119,6 +135,7 @@ require 'launchdarkly_api/api/data_export_destinations_api'
|
|
|
119
135
|
require 'launchdarkly_api/api/environments_api'
|
|
120
136
|
require 'launchdarkly_api/api/feature_flags_api'
|
|
121
137
|
require 'launchdarkly_api/api/projects_api'
|
|
138
|
+
require 'launchdarkly_api/api/relay_proxy_configurations_api'
|
|
122
139
|
require 'launchdarkly_api/api/root_api'
|
|
123
140
|
require 'launchdarkly_api/api/team_members_api'
|
|
124
141
|
require 'launchdarkly_api/api/user_segments_api'
|
|
@@ -0,0 +1,340 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#LaunchDarkly REST API
|
|
3
|
+
|
|
4
|
+
#Build custom integrations with the LaunchDarkly REST API
|
|
5
|
+
|
|
6
|
+
OpenAPI spec version: 3.7.1
|
|
7
|
+
Contact: support@launchdarkly.com
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
+
Swagger Codegen version: 2.4.8
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'uri'
|
|
14
|
+
|
|
15
|
+
module LaunchDarklyApi
|
|
16
|
+
class AccessTokensApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Delete an access token by ID.
|
|
23
|
+
# @param token_id The access token ID.
|
|
24
|
+
# @param [Hash] opts the optional parameters
|
|
25
|
+
# @return [nil]
|
|
26
|
+
def delete_token(token_id, opts = {})
|
|
27
|
+
delete_token_with_http_info(token_id, opts)
|
|
28
|
+
nil
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
# Delete an access token by ID.
|
|
32
|
+
# @param token_id The access token ID.
|
|
33
|
+
# @param [Hash] opts the optional parameters
|
|
34
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
35
|
+
def delete_token_with_http_info(token_id, opts = {})
|
|
36
|
+
if @api_client.config.debugging
|
|
37
|
+
@api_client.config.logger.debug 'Calling API: AccessTokensApi.delete_token ...'
|
|
38
|
+
end
|
|
39
|
+
# verify the required parameter 'token_id' is set
|
|
40
|
+
if @api_client.config.client_side_validation && token_id.nil?
|
|
41
|
+
fail ArgumentError, "Missing the required parameter 'token_id' when calling AccessTokensApi.delete_token"
|
|
42
|
+
end
|
|
43
|
+
# resource path
|
|
44
|
+
local_var_path = '/tokens/{tokenId}'.sub('{' + 'tokenId' + '}', token_id.to_s)
|
|
45
|
+
|
|
46
|
+
# query parameters
|
|
47
|
+
query_params = {}
|
|
48
|
+
|
|
49
|
+
# header parameters
|
|
50
|
+
header_params = {}
|
|
51
|
+
# HTTP header 'Accept' (if needed)
|
|
52
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
53
|
+
# HTTP header 'Content-Type'
|
|
54
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
55
|
+
|
|
56
|
+
# form parameters
|
|
57
|
+
form_params = {}
|
|
58
|
+
|
|
59
|
+
# http body (model)
|
|
60
|
+
post_body = nil
|
|
61
|
+
auth_names = ['Token']
|
|
62
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
|
63
|
+
:header_params => header_params,
|
|
64
|
+
:query_params => query_params,
|
|
65
|
+
:form_params => form_params,
|
|
66
|
+
:body => post_body,
|
|
67
|
+
:auth_names => auth_names)
|
|
68
|
+
if @api_client.config.debugging
|
|
69
|
+
@api_client.config.logger.debug "API called: AccessTokensApi#delete_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
70
|
+
end
|
|
71
|
+
return data, status_code, headers
|
|
72
|
+
end
|
|
73
|
+
# Get a single access token by ID.
|
|
74
|
+
# @param token_id The access token ID.
|
|
75
|
+
# @param [Hash] opts the optional parameters
|
|
76
|
+
# @return [Token]
|
|
77
|
+
def get_token(token_id, opts = {})
|
|
78
|
+
data, _status_code, _headers = get_token_with_http_info(token_id, opts)
|
|
79
|
+
data
|
|
80
|
+
end
|
|
81
|
+
|
|
82
|
+
# Get a single access token by ID.
|
|
83
|
+
# @param token_id The access token ID.
|
|
84
|
+
# @param [Hash] opts the optional parameters
|
|
85
|
+
# @return [Array<(Token, Fixnum, Hash)>] Token data, response status code and response headers
|
|
86
|
+
def get_token_with_http_info(token_id, opts = {})
|
|
87
|
+
if @api_client.config.debugging
|
|
88
|
+
@api_client.config.logger.debug 'Calling API: AccessTokensApi.get_token ...'
|
|
89
|
+
end
|
|
90
|
+
# verify the required parameter 'token_id' is set
|
|
91
|
+
if @api_client.config.client_side_validation && token_id.nil?
|
|
92
|
+
fail ArgumentError, "Missing the required parameter 'token_id' when calling AccessTokensApi.get_token"
|
|
93
|
+
end
|
|
94
|
+
# resource path
|
|
95
|
+
local_var_path = '/tokens/{tokenId}'.sub('{' + 'tokenId' + '}', token_id.to_s)
|
|
96
|
+
|
|
97
|
+
# query parameters
|
|
98
|
+
query_params = {}
|
|
99
|
+
|
|
100
|
+
# header parameters
|
|
101
|
+
header_params = {}
|
|
102
|
+
# HTTP header 'Accept' (if needed)
|
|
103
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
104
|
+
# HTTP header 'Content-Type'
|
|
105
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
106
|
+
|
|
107
|
+
# form parameters
|
|
108
|
+
form_params = {}
|
|
109
|
+
|
|
110
|
+
# http body (model)
|
|
111
|
+
post_body = nil
|
|
112
|
+
auth_names = ['Token']
|
|
113
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
114
|
+
:header_params => header_params,
|
|
115
|
+
:query_params => query_params,
|
|
116
|
+
:form_params => form_params,
|
|
117
|
+
:body => post_body,
|
|
118
|
+
:auth_names => auth_names,
|
|
119
|
+
:return_type => 'Token')
|
|
120
|
+
if @api_client.config.debugging
|
|
121
|
+
@api_client.config.logger.debug "API called: AccessTokensApi#get_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
122
|
+
end
|
|
123
|
+
return data, status_code, headers
|
|
124
|
+
end
|
|
125
|
+
# Returns a list of tokens in the account.
|
|
126
|
+
# @param [Hash] opts the optional parameters
|
|
127
|
+
# @option opts [BOOLEAN] :show_all If set to true, and the authentication access token has the \"Admin\" role, personal access tokens for all members will be retrieved.
|
|
128
|
+
# @return [Tokens]
|
|
129
|
+
def get_tokens(opts = {})
|
|
130
|
+
data, _status_code, _headers = get_tokens_with_http_info(opts)
|
|
131
|
+
data
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
# Returns a list of tokens in the account.
|
|
135
|
+
# @param [Hash] opts the optional parameters
|
|
136
|
+
# @option opts [BOOLEAN] :show_all If set to true, and the authentication access token has the \"Admin\" role, personal access tokens for all members will be retrieved.
|
|
137
|
+
# @return [Array<(Tokens, Fixnum, Hash)>] Tokens data, response status code and response headers
|
|
138
|
+
def get_tokens_with_http_info(opts = {})
|
|
139
|
+
if @api_client.config.debugging
|
|
140
|
+
@api_client.config.logger.debug 'Calling API: AccessTokensApi.get_tokens ...'
|
|
141
|
+
end
|
|
142
|
+
# resource path
|
|
143
|
+
local_var_path = '/tokens'
|
|
144
|
+
|
|
145
|
+
# query parameters
|
|
146
|
+
query_params = {}
|
|
147
|
+
query_params[:'showAll'] = opts[:'show_all'] if !opts[:'show_all'].nil?
|
|
148
|
+
|
|
149
|
+
# header parameters
|
|
150
|
+
header_params = {}
|
|
151
|
+
# HTTP header 'Accept' (if needed)
|
|
152
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
153
|
+
# HTTP header 'Content-Type'
|
|
154
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
155
|
+
|
|
156
|
+
# form parameters
|
|
157
|
+
form_params = {}
|
|
158
|
+
|
|
159
|
+
# http body (model)
|
|
160
|
+
post_body = nil
|
|
161
|
+
auth_names = ['Token']
|
|
162
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
163
|
+
:header_params => header_params,
|
|
164
|
+
:query_params => query_params,
|
|
165
|
+
:form_params => form_params,
|
|
166
|
+
:body => post_body,
|
|
167
|
+
:auth_names => auth_names,
|
|
168
|
+
:return_type => 'Tokens')
|
|
169
|
+
if @api_client.config.debugging
|
|
170
|
+
@api_client.config.logger.debug "API called: AccessTokensApi#get_tokens\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
171
|
+
end
|
|
172
|
+
return data, status_code, headers
|
|
173
|
+
end
|
|
174
|
+
# Modify an access token by ID.
|
|
175
|
+
# @param token_id The access token ID.
|
|
176
|
+
# @param patch_delta Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/'
|
|
177
|
+
# @param [Hash] opts the optional parameters
|
|
178
|
+
# @return [Token]
|
|
179
|
+
def patch_token(token_id, patch_delta, opts = {})
|
|
180
|
+
data, _status_code, _headers = patch_token_with_http_info(token_id, patch_delta, opts)
|
|
181
|
+
data
|
|
182
|
+
end
|
|
183
|
+
|
|
184
|
+
# Modify an access token by ID.
|
|
185
|
+
# @param token_id The access token ID.
|
|
186
|
+
# @param patch_delta Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/'
|
|
187
|
+
# @param [Hash] opts the optional parameters
|
|
188
|
+
# @return [Array<(Token, Fixnum, Hash)>] Token data, response status code and response headers
|
|
189
|
+
def patch_token_with_http_info(token_id, patch_delta, opts = {})
|
|
190
|
+
if @api_client.config.debugging
|
|
191
|
+
@api_client.config.logger.debug 'Calling API: AccessTokensApi.patch_token ...'
|
|
192
|
+
end
|
|
193
|
+
# verify the required parameter 'token_id' is set
|
|
194
|
+
if @api_client.config.client_side_validation && token_id.nil?
|
|
195
|
+
fail ArgumentError, "Missing the required parameter 'token_id' when calling AccessTokensApi.patch_token"
|
|
196
|
+
end
|
|
197
|
+
# verify the required parameter 'patch_delta' is set
|
|
198
|
+
if @api_client.config.client_side_validation && patch_delta.nil?
|
|
199
|
+
fail ArgumentError, "Missing the required parameter 'patch_delta' when calling AccessTokensApi.patch_token"
|
|
200
|
+
end
|
|
201
|
+
# resource path
|
|
202
|
+
local_var_path = '/tokens/{tokenId}'.sub('{' + 'tokenId' + '}', token_id.to_s)
|
|
203
|
+
|
|
204
|
+
# query parameters
|
|
205
|
+
query_params = {}
|
|
206
|
+
|
|
207
|
+
# header parameters
|
|
208
|
+
header_params = {}
|
|
209
|
+
# HTTP header 'Accept' (if needed)
|
|
210
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
211
|
+
# HTTP header 'Content-Type'
|
|
212
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
213
|
+
|
|
214
|
+
# form parameters
|
|
215
|
+
form_params = {}
|
|
216
|
+
|
|
217
|
+
# http body (model)
|
|
218
|
+
post_body = @api_client.object_to_http_body(patch_delta)
|
|
219
|
+
auth_names = ['Token']
|
|
220
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
|
|
221
|
+
:header_params => header_params,
|
|
222
|
+
:query_params => query_params,
|
|
223
|
+
:form_params => form_params,
|
|
224
|
+
:body => post_body,
|
|
225
|
+
:auth_names => auth_names,
|
|
226
|
+
:return_type => 'Token')
|
|
227
|
+
if @api_client.config.debugging
|
|
228
|
+
@api_client.config.logger.debug "API called: AccessTokensApi#patch_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
229
|
+
end
|
|
230
|
+
return data, status_code, headers
|
|
231
|
+
end
|
|
232
|
+
# Create a new token.
|
|
233
|
+
# @param token_body Create a new access token.
|
|
234
|
+
# @param [Hash] opts the optional parameters
|
|
235
|
+
# @return [Token]
|
|
236
|
+
def post_token(token_body, opts = {})
|
|
237
|
+
data, _status_code, _headers = post_token_with_http_info(token_body, opts)
|
|
238
|
+
data
|
|
239
|
+
end
|
|
240
|
+
|
|
241
|
+
# Create a new token.
|
|
242
|
+
# @param token_body Create a new access token.
|
|
243
|
+
# @param [Hash] opts the optional parameters
|
|
244
|
+
# @return [Array<(Token, Fixnum, Hash)>] Token data, response status code and response headers
|
|
245
|
+
def post_token_with_http_info(token_body, opts = {})
|
|
246
|
+
if @api_client.config.debugging
|
|
247
|
+
@api_client.config.logger.debug 'Calling API: AccessTokensApi.post_token ...'
|
|
248
|
+
end
|
|
249
|
+
# verify the required parameter 'token_body' is set
|
|
250
|
+
if @api_client.config.client_side_validation && token_body.nil?
|
|
251
|
+
fail ArgumentError, "Missing the required parameter 'token_body' when calling AccessTokensApi.post_token"
|
|
252
|
+
end
|
|
253
|
+
# resource path
|
|
254
|
+
local_var_path = '/tokens'
|
|
255
|
+
|
|
256
|
+
# query parameters
|
|
257
|
+
query_params = {}
|
|
258
|
+
|
|
259
|
+
# header parameters
|
|
260
|
+
header_params = {}
|
|
261
|
+
# HTTP header 'Accept' (if needed)
|
|
262
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
263
|
+
# HTTP header 'Content-Type'
|
|
264
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
265
|
+
|
|
266
|
+
# form parameters
|
|
267
|
+
form_params = {}
|
|
268
|
+
|
|
269
|
+
# http body (model)
|
|
270
|
+
post_body = @api_client.object_to_http_body(token_body)
|
|
271
|
+
auth_names = ['Token']
|
|
272
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
273
|
+
:header_params => header_params,
|
|
274
|
+
:query_params => query_params,
|
|
275
|
+
:form_params => form_params,
|
|
276
|
+
:body => post_body,
|
|
277
|
+
:auth_names => auth_names,
|
|
278
|
+
:return_type => 'Token')
|
|
279
|
+
if @api_client.config.debugging
|
|
280
|
+
@api_client.config.logger.debug "API called: AccessTokensApi#post_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
281
|
+
end
|
|
282
|
+
return data, status_code, headers
|
|
283
|
+
end
|
|
284
|
+
# Reset an access token's secret key with an optional expiry time for the old key.
|
|
285
|
+
# @param token_id The access token ID.
|
|
286
|
+
# @param [Hash] opts the optional parameters
|
|
287
|
+
# @option opts [Integer] :expiry An expiration time for the old token key, expressed as a Unix epoch time in milliseconds. By default, the token will expire immediately.
|
|
288
|
+
# @return [Token]
|
|
289
|
+
def reset_token(token_id, opts = {})
|
|
290
|
+
data, _status_code, _headers = reset_token_with_http_info(token_id, opts)
|
|
291
|
+
data
|
|
292
|
+
end
|
|
293
|
+
|
|
294
|
+
# Reset an access token's secret key with an optional expiry time for the old key.
|
|
295
|
+
# @param token_id The access token ID.
|
|
296
|
+
# @param [Hash] opts the optional parameters
|
|
297
|
+
# @option opts [Integer] :expiry An expiration time for the old token key, expressed as a Unix epoch time in milliseconds. By default, the token will expire immediately.
|
|
298
|
+
# @return [Array<(Token, Fixnum, Hash)>] Token data, response status code and response headers
|
|
299
|
+
def reset_token_with_http_info(token_id, opts = {})
|
|
300
|
+
if @api_client.config.debugging
|
|
301
|
+
@api_client.config.logger.debug 'Calling API: AccessTokensApi.reset_token ...'
|
|
302
|
+
end
|
|
303
|
+
# verify the required parameter 'token_id' is set
|
|
304
|
+
if @api_client.config.client_side_validation && token_id.nil?
|
|
305
|
+
fail ArgumentError, "Missing the required parameter 'token_id' when calling AccessTokensApi.reset_token"
|
|
306
|
+
end
|
|
307
|
+
# resource path
|
|
308
|
+
local_var_path = '/tokens/{tokenId}/reset'.sub('{' + 'tokenId' + '}', token_id.to_s)
|
|
309
|
+
|
|
310
|
+
# query parameters
|
|
311
|
+
query_params = {}
|
|
312
|
+
query_params[:'expiry'] = opts[:'expiry'] if !opts[:'expiry'].nil?
|
|
313
|
+
|
|
314
|
+
# header parameters
|
|
315
|
+
header_params = {}
|
|
316
|
+
# HTTP header 'Accept' (if needed)
|
|
317
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
318
|
+
# HTTP header 'Content-Type'
|
|
319
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
320
|
+
|
|
321
|
+
# form parameters
|
|
322
|
+
form_params = {}
|
|
323
|
+
|
|
324
|
+
# http body (model)
|
|
325
|
+
post_body = nil
|
|
326
|
+
auth_names = ['Token']
|
|
327
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
328
|
+
:header_params => header_params,
|
|
329
|
+
:query_params => query_params,
|
|
330
|
+
:form_params => form_params,
|
|
331
|
+
:body => post_body,
|
|
332
|
+
:auth_names => auth_names,
|
|
333
|
+
:return_type => 'Token')
|
|
334
|
+
if @api_client.config.debugging
|
|
335
|
+
@api_client.config.logger.debug "API called: AccessTokensApi#reset_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
336
|
+
end
|
|
337
|
+
return data, status_code, headers
|
|
338
|
+
end
|
|
339
|
+
end
|
|
340
|
+
end
|