google-apis-apigee_v1 0.9.0 → 0.14.0

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.
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module ApigeeV1
18
18
  # Version of the google-apis-apigee_v1 gem
19
- GEM_VERSION = "0.9.0"
19
+ GEM_VERSION = "0.14.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.2.0"
22
+ GENERATOR_VERSION = "0.3.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20210326"
25
+ REVISION = "20210604"
26
26
  end
27
27
  end
28
28
  end
@@ -322,6 +322,12 @@ module Google
322
322
  include Google::Apis::Core::JsonObjectSupport
323
323
  end
324
324
 
325
+ class GoogleCloudApigeeV1DeveloperSubscription
326
+ class Representation < Google::Apis::Core::JsonRepresentation; end
327
+
328
+ include Google::Apis::Core::JsonObjectSupport
329
+ end
330
+
325
331
  class GoogleCloudApigeeV1DimensionMetric
326
332
  class Representation < Google::Apis::Core::JsonRepresentation; end
327
333
 
@@ -364,6 +370,12 @@ module Google
364
370
  include Google::Apis::Core::JsonObjectSupport
365
371
  end
366
372
 
373
+ class GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest
374
+ class Representation < Google::Apis::Core::JsonRepresentation; end
375
+
376
+ include Google::Apis::Core::JsonObjectSupport
377
+ end
378
+
367
379
  class GoogleCloudApigeeV1Export
368
380
  class Representation < Google::Apis::Core::JsonRepresentation; end
369
381
 
@@ -544,6 +556,12 @@ module Google
544
556
  include Google::Apis::Core::JsonObjectSupport
545
557
  end
546
558
 
559
+ class GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse
560
+ class Representation < Google::Apis::Core::JsonRepresentation; end
561
+
562
+ include Google::Apis::Core::JsonObjectSupport
563
+ end
564
+
547
565
  class GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse
548
566
  class Representation < Google::Apis::Core::JsonRepresentation; end
549
567
 
@@ -604,6 +622,12 @@ module Google
604
622
  include Google::Apis::Core::JsonObjectSupport
605
623
  end
606
624
 
625
+ class GoogleCloudApigeeV1ListRatePlansResponse
626
+ class Representation < Google::Apis::Core::JsonRepresentation; end
627
+
628
+ include Google::Apis::Core::JsonObjectSupport
629
+ end
630
+
607
631
  class GoogleCloudApigeeV1ListSharedFlowsResponse
608
632
  class Representation < Google::Apis::Core::JsonRepresentation; end
609
633
 
@@ -664,6 +688,12 @@ module Google
664
688
  include Google::Apis::Core::JsonObjectSupport
665
689
  end
666
690
 
691
+ class GoogleCloudApigeeV1OperationMetadataProgress
692
+ class Representation < Google::Apis::Core::JsonRepresentation; end
693
+
694
+ include Google::Apis::Core::JsonObjectSupport
695
+ end
696
+
667
697
  class GoogleCloudApigeeV1OptimizedStats
668
698
  class Representation < Google::Apis::Core::JsonRepresentation; end
669
699
 
@@ -748,6 +778,18 @@ module Google
748
778
  include Google::Apis::Core::JsonObjectSupport
749
779
  end
750
780
 
781
+ class GoogleCloudApigeeV1RatePlan
782
+ class Representation < Google::Apis::Core::JsonRepresentation; end
783
+
784
+ include Google::Apis::Core::JsonObjectSupport
785
+ end
786
+
787
+ class GoogleCloudApigeeV1RateRange
788
+ class Representation < Google::Apis::Core::JsonRepresentation; end
789
+
790
+ include Google::Apis::Core::JsonObjectSupport
791
+ end
792
+
751
793
  class GoogleCloudApigeeV1Reference
752
794
  class Representation < Google::Apis::Core::JsonRepresentation; end
753
795
 
@@ -808,6 +850,12 @@ module Google
808
850
  include Google::Apis::Core::JsonObjectSupport
809
851
  end
810
852
 
853
+ class GoogleCloudApigeeV1RevenueShareRange
854
+ class Representation < Google::Apis::Core::JsonRepresentation; end
855
+
856
+ include Google::Apis::Core::JsonObjectSupport
857
+ end
858
+
811
859
  class GoogleCloudApigeeV1RevisionStatus
812
860
  class Representation < Google::Apis::Core::JsonRepresentation; end
813
861
 
@@ -1060,6 +1108,12 @@ module Google
1060
1108
  include Google::Apis::Core::JsonObjectSupport
1061
1109
  end
1062
1110
 
1111
+ class GoogleTypeMoney
1112
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1113
+
1114
+ include Google::Apis::Core::JsonObjectSupport
1115
+ end
1116
+
1063
1117
  class GoogleApiHttpBody
1064
1118
  # @private
1065
1119
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1622,6 +1676,7 @@ module Google
1622
1676
  property :location, as: 'location'
1623
1677
  property :name, as: 'name'
1624
1678
  property :proxy_uid, as: 'proxyUid'
1679
+ property :service_account, as: 'serviceAccount'
1625
1680
  property :uid, as: 'uid'
1626
1681
  end
1627
1682
  end
@@ -1684,6 +1739,18 @@ module Google
1684
1739
  end
1685
1740
  end
1686
1741
 
1742
+ class GoogleCloudApigeeV1DeveloperSubscription
1743
+ # @private
1744
+ class Representation < Google::Apis::Core::JsonRepresentation
1745
+ property :apiproduct, as: 'apiproduct'
1746
+ property :created_at, :numeric_string => true, as: 'createdAt'
1747
+ property :end_time, :numeric_string => true, as: 'endTime'
1748
+ property :last_modified_at, :numeric_string => true, as: 'lastModifiedAt'
1749
+ property :name, as: 'name'
1750
+ property :start_time, :numeric_string => true, as: 'startTime'
1751
+ end
1752
+ end
1753
+
1687
1754
  class GoogleCloudApigeeV1DimensionMetric
1688
1755
  # @private
1689
1756
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1780,6 +1847,12 @@ module Google
1780
1847
  end
1781
1848
  end
1782
1849
 
1850
+ class GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest
1851
+ # @private
1852
+ class Representation < Google::Apis::Core::JsonRepresentation
1853
+ end
1854
+ end
1855
+
1783
1856
  class GoogleCloudApigeeV1Export
1784
1857
  # @private
1785
1858
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2064,6 +2137,15 @@ module Google
2064
2137
  end
2065
2138
  end
2066
2139
 
2140
+ class GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse
2141
+ # @private
2142
+ class Representation < Google::Apis::Core::JsonRepresentation
2143
+ collection :developer_subscriptions, as: 'developerSubscriptions', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperSubscription, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperSubscription::Representation
2144
+
2145
+ property :next_start_key, as: 'nextStartKey'
2146
+ end
2147
+ end
2148
+
2067
2149
  class GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse
2068
2150
  # @private
2069
2151
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2149,6 +2231,15 @@ module Google
2149
2231
  end
2150
2232
  end
2151
2233
 
2234
+ class GoogleCloudApigeeV1ListRatePlansResponse
2235
+ # @private
2236
+ class Representation < Google::Apis::Core::JsonRepresentation
2237
+ property :next_start_key, as: 'nextStartKey'
2238
+ collection :rate_plans, as: 'ratePlans', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan::Representation
2239
+
2240
+ end
2241
+ end
2242
+
2152
2243
  class GoogleCloudApigeeV1ListSharedFlowsResponse
2153
2244
  # @private
2154
2245
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2232,11 +2323,23 @@ module Google
2232
2323
  # @private
2233
2324
  class Representation < Google::Apis::Core::JsonRepresentation
2234
2325
  property :operation_type, as: 'operationType'
2326
+ property :progress, as: 'progress', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1OperationMetadataProgress, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1OperationMetadataProgress::Representation
2327
+
2235
2328
  property :state, as: 'state'
2236
2329
  property :target_resource_name, as: 'targetResourceName'
2237
2330
  end
2238
2331
  end
2239
2332
 
2333
+ class GoogleCloudApigeeV1OperationMetadataProgress
2334
+ # @private
2335
+ class Representation < Google::Apis::Core::JsonRepresentation
2336
+ property :description, as: 'description'
2337
+ hash :details, as: 'details'
2338
+ property :percent_done, as: 'percentDone'
2339
+ property :state, as: 'state'
2340
+ end
2341
+ end
2342
+
2240
2343
  class GoogleCloudApigeeV1OptimizedStats
2241
2344
  # @private
2242
2345
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2400,6 +2503,45 @@ module Google
2400
2503
  end
2401
2504
  end
2402
2505
 
2506
+ class GoogleCloudApigeeV1RatePlan
2507
+ # @private
2508
+ class Representation < Google::Apis::Core::JsonRepresentation
2509
+ property :apiproduct, as: 'apiproduct'
2510
+ property :billing_period, as: 'billingPeriod'
2511
+ collection :consumption_pricing_rates, as: 'consumptionPricingRates', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1RateRange, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1RateRange::Representation
2512
+
2513
+ property :consumption_pricing_type, as: 'consumptionPricingType'
2514
+ property :created_at, :numeric_string => true, as: 'createdAt'
2515
+ property :currency_code, as: 'currencyCode'
2516
+ property :description, as: 'description'
2517
+ property :display_name, as: 'displayName'
2518
+ property :end_time, :numeric_string => true, as: 'endTime'
2519
+ property :fixed_fee_frequency, as: 'fixedFeeFrequency'
2520
+ property :fixed_recurring_fee, as: 'fixedRecurringFee', class: Google::Apis::ApigeeV1::GoogleTypeMoney, decorator: Google::Apis::ApigeeV1::GoogleTypeMoney::Representation
2521
+
2522
+ property :last_modified_at, :numeric_string => true, as: 'lastModifiedAt'
2523
+ property :name, as: 'name'
2524
+ property :payment_funding_model, as: 'paymentFundingModel'
2525
+ collection :revenue_share_rates, as: 'revenueShareRates', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1RevenueShareRange, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1RevenueShareRange::Representation
2526
+
2527
+ property :revenue_share_type, as: 'revenueShareType'
2528
+ property :setup_fee, as: 'setupFee', class: Google::Apis::ApigeeV1::GoogleTypeMoney, decorator: Google::Apis::ApigeeV1::GoogleTypeMoney::Representation
2529
+
2530
+ property :start_time, :numeric_string => true, as: 'startTime'
2531
+ property :state, as: 'state'
2532
+ end
2533
+ end
2534
+
2535
+ class GoogleCloudApigeeV1RateRange
2536
+ # @private
2537
+ class Representation < Google::Apis::Core::JsonRepresentation
2538
+ property :end, :numeric_string => true, as: 'end'
2539
+ property :fee, as: 'fee', class: Google::Apis::ApigeeV1::GoogleTypeMoney, decorator: Google::Apis::ApigeeV1::GoogleTypeMoney::Representation
2540
+
2541
+ property :start, :numeric_string => true, as: 'start'
2542
+ end
2543
+ end
2544
+
2403
2545
  class GoogleCloudApigeeV1Reference
2404
2546
  # @private
2405
2547
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2497,6 +2639,15 @@ module Google
2497
2639
  end
2498
2640
  end
2499
2641
 
2642
+ class GoogleCloudApigeeV1RevenueShareRange
2643
+ # @private
2644
+ class Representation < Google::Apis::Core::JsonRepresentation
2645
+ property :end, :numeric_string => true, as: 'end'
2646
+ property :share_percentage, as: 'sharePercentage'
2647
+ property :start, :numeric_string => true, as: 'start'
2648
+ end
2649
+ end
2650
+
2500
2651
  class GoogleCloudApigeeV1RevisionStatus
2501
2652
  # @private
2502
2653
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2698,6 +2849,7 @@ module Google
2698
2849
  property :is_enabled, as: 'isEnabled'
2699
2850
  property :name, as: 'name'
2700
2851
  property :port, as: 'port'
2852
+ property :protocol, as: 'protocol'
2701
2853
  property :s_sl_info, as: 'sSLInfo', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1TlsInfo, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1TlsInfo::Representation
2702
2854
 
2703
2855
  end
@@ -2709,6 +2861,7 @@ module Google
2709
2861
  property :host, as: 'host'
2710
2862
  property :name, as: 'name'
2711
2863
  property :port, as: 'port'
2864
+ property :protocol, as: 'protocol'
2712
2865
  property :tls_info, as: 'tlsInfo', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1TlsInfoConfig, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1TlsInfoConfig::Representation
2713
2866
 
2714
2867
  end
@@ -2925,6 +3078,15 @@ module Google
2925
3078
  property :title, as: 'title'
2926
3079
  end
2927
3080
  end
3081
+
3082
+ class GoogleTypeMoney
3083
+ # @private
3084
+ class Representation < Google::Apis::Core::JsonRepresentation
3085
+ property :currency_code, as: 'currencyCode'
3086
+ property :nanos, as: 'nanos'
3087
+ property :units, :numeric_string => true, as: 'units'
3088
+ end
3089
+ end
2928
3090
  end
2929
3091
  end
2930
3092
  end
@@ -653,12 +653,12 @@ module Google
653
653
  # collection of API resources combined with quota settings and metadata that you
654
654
  # can use to deliver customized and productized API bundles to your developer
655
655
  # community. This metadata can include: - Scope - Environments - API proxies -
656
- # Extensible profile API products enable you repackage APIs on-the-fly, without
656
+ # Extensible profile API products enable you repackage APIs on the fly, without
657
657
  # having to do any additional coding or configuration. Apigee recommends that
658
658
  # you start with a simple API product including only required elements. You then
659
659
  # provision credentials to apps to enable them to start testing your APIs. After
660
660
  # you have authentication and authorization working against a simple API product,
661
- # you can iterate to create finer grained API products, defining different sets
661
+ # you can iterate to create finer-grained API products, defining different sets
662
662
  # of API resources for each API product. **WARNING:** - If you don't specify an
663
663
  # API proxy in the request body, *any* app associated with the product can make
664
664
  # calls to *any* API in your entire organization. - If you don't specify an
@@ -771,9 +771,9 @@ module Google
771
771
  end
772
772
 
773
773
  # Lists all API product names for an organization. Filter the list by passing an
774
- # `attributename` and `attibutevalue`. The limit on the number of API products
775
- # returned by the API is 1000. You can paginate the list of API products
776
- # returned using the `startKey` and `count` query parameters.
774
+ # `attributename` and `attibutevalue`. The maximum number of API products
775
+ # returned is 1000. You can paginate the list of API products returned using the
776
+ # `startKey` and `count` query parameters.
777
777
  # @param [String] parent
778
778
  # Required. Name of the organization. Use the following structure in your
779
779
  # request: `organizations/`org``
@@ -828,7 +828,7 @@ module Google
828
828
  # Updates an existing API product. You must include all required values, whether
829
829
  # or not you are updating them, as well as any optional values that you are
830
830
  # updating. The API product name required in the request URL is the internal
831
- # name of the product, not the Display Name. While they may be the same, it
831
+ # name of the product, not the display name. While they may be the same, it
832
832
  # depends on whether the API product was created via UI or API. View the list of
833
833
  # API products to identify their internal names.
834
834
  # @param [String] name
@@ -998,6 +998,202 @@ module Google
998
998
  execute_or_queue_command(command, &block)
999
999
  end
1000
1000
 
1001
+ # Create a rate plan that is associated with an API product in an organization.
1002
+ # Using rate plans, API product owners can monetize their API products by
1003
+ # configuring one or more of the following: - Billing frequency - Initial setup
1004
+ # fees for using an API product - Payment funding model (postpaid only) - Fixed
1005
+ # recurring or consumption-based charges for using an API product - Revenue
1006
+ # sharing with developer partners An API product can have multiple rate plans
1007
+ # associated with it but *only one* rate plan can be active at any point of time.
1008
+ # **Note: From the developer's perspective, they purchase API products not rate
1009
+ # plans.
1010
+ # @param [String] parent
1011
+ # Required. Name of the API product that is associated with the rate plan. Use
1012
+ # the following structure in your request: `organizations/`org`/apiproducts/`
1013
+ # apiproduct``
1014
+ # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan] google_cloud_apigee_v1_rate_plan_object
1015
+ # @param [String] fields
1016
+ # Selector specifying which fields to include in a partial response.
1017
+ # @param [String] quota_user
1018
+ # Available to use for quota purposes for server-side applications. Can be any
1019
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1020
+ # @param [Google::Apis::RequestOptions] options
1021
+ # Request-specific options
1022
+ #
1023
+ # @yield [result, err] Result & error if block supplied
1024
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan] parsed result object
1025
+ # @yieldparam err [StandardError] error object if request failed
1026
+ #
1027
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan]
1028
+ #
1029
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1030
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1031
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1032
+ def create_organization_apiproduct_rateplan(parent, google_cloud_apigee_v1_rate_plan_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1033
+ command = make_simple_command(:post, 'v1/{+parent}/rateplans', options)
1034
+ command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan::Representation
1035
+ command.request_object = google_cloud_apigee_v1_rate_plan_object
1036
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan::Representation
1037
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan
1038
+ command.params['parent'] = parent unless parent.nil?
1039
+ command.query['fields'] = fields unless fields.nil?
1040
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1041
+ execute_or_queue_command(command, &block)
1042
+ end
1043
+
1044
+ # Deletes a rate plan.
1045
+ # @param [String] name
1046
+ # Required. ID of the rate plan. Use the following structure in your request: `
1047
+ # organizations/`org`/apiproducts/`apiproduct`/rateplans/`rateplan``
1048
+ # @param [String] fields
1049
+ # Selector specifying which fields to include in a partial response.
1050
+ # @param [String] quota_user
1051
+ # Available to use for quota purposes for server-side applications. Can be any
1052
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1053
+ # @param [Google::Apis::RequestOptions] options
1054
+ # Request-specific options
1055
+ #
1056
+ # @yield [result, err] Result & error if block supplied
1057
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan] parsed result object
1058
+ # @yieldparam err [StandardError] error object if request failed
1059
+ #
1060
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan]
1061
+ #
1062
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1063
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1064
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1065
+ def delete_organization_apiproduct_rateplan(name, fields: nil, quota_user: nil, options: nil, &block)
1066
+ command = make_simple_command(:delete, 'v1/{+name}', options)
1067
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan::Representation
1068
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan
1069
+ command.params['name'] = name unless name.nil?
1070
+ command.query['fields'] = fields unless fields.nil?
1071
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1072
+ execute_or_queue_command(command, &block)
1073
+ end
1074
+
1075
+ # Gets the details of a rate plan.
1076
+ # @param [String] name
1077
+ # Required. Name of the rate plan. Use the following structure in your request: `
1078
+ # organizations/`org`/apiproducts/`apiproduct`/rateplans/`rateplan``
1079
+ # @param [String] fields
1080
+ # Selector specifying which fields to include in a partial response.
1081
+ # @param [String] quota_user
1082
+ # Available to use for quota purposes for server-side applications. Can be any
1083
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1084
+ # @param [Google::Apis::RequestOptions] options
1085
+ # Request-specific options
1086
+ #
1087
+ # @yield [result, err] Result & error if block supplied
1088
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan] parsed result object
1089
+ # @yieldparam err [StandardError] error object if request failed
1090
+ #
1091
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan]
1092
+ #
1093
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1094
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1095
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1096
+ def get_organization_apiproduct_rateplan(name, fields: nil, quota_user: nil, options: nil, &block)
1097
+ command = make_simple_command(:get, 'v1/{+name}', options)
1098
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan::Representation
1099
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan
1100
+ command.params['name'] = name unless name.nil?
1101
+ command.query['fields'] = fields unless fields.nil?
1102
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1103
+ execute_or_queue_command(command, &block)
1104
+ end
1105
+
1106
+ # Lists all the rate plans for an API product.
1107
+ # @param [String] parent
1108
+ # Required. Name of the API product. Use the following structure in your request:
1109
+ # `organizations/`org`/apiproducts/`apiproduct`` Use `organizations/`org`/
1110
+ # apiproducts/-` to return rate plans for all API products within the
1111
+ # organization.
1112
+ # @param [Fixnum] count
1113
+ # Number of rate plans to return in the API call. Use with the `startKey`
1114
+ # parameter to provide more targeted filtering. The maximum limit is 1000.
1115
+ # Defaults to 100.
1116
+ # @param [Boolean] expand
1117
+ # Flag that specifies whether to expand the results. Set to `true` to get
1118
+ # expanded details about each API. Defaults to `false`.
1119
+ # @param [String] order_by
1120
+ # Name of the attribute used for sorting. Valid values include: * `name`: Name
1121
+ # of the rate plan. * `state`: State of the rate plan (`DRAFT`, `PUBLISHED`). * `
1122
+ # startTime`: Time when the rate plan becomes active. * `endTime`: Time when the
1123
+ # rate plan expires. **Note**: Not supported by Apigee at this time.
1124
+ # @param [String] start_key
1125
+ # Name of the rate plan from which to start displaying the list of rate plans.
1126
+ # If omitted, the list starts from the first item. For example, to view the rate
1127
+ # plans from 51-150, set the value of `startKey` to the name of the 51st rate
1128
+ # plan and set the value of `count` to 100.
1129
+ # @param [String] state
1130
+ # State of the rate plans (`DRAFT`, `PUBLISHED`) that you want to display.
1131
+ # @param [String] fields
1132
+ # Selector specifying which fields to include in a partial response.
1133
+ # @param [String] quota_user
1134
+ # Available to use for quota purposes for server-side applications. Can be any
1135
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1136
+ # @param [Google::Apis::RequestOptions] options
1137
+ # Request-specific options
1138
+ #
1139
+ # @yield [result, err] Result & error if block supplied
1140
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListRatePlansResponse] parsed result object
1141
+ # @yieldparam err [StandardError] error object if request failed
1142
+ #
1143
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListRatePlansResponse]
1144
+ #
1145
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1146
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1147
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1148
+ def list_organization_apiproduct_rateplans(parent, count: nil, expand: nil, order_by: nil, start_key: nil, state: nil, fields: nil, quota_user: nil, options: nil, &block)
1149
+ command = make_simple_command(:get, 'v1/{+parent}/rateplans', options)
1150
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListRatePlansResponse::Representation
1151
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListRatePlansResponse
1152
+ command.params['parent'] = parent unless parent.nil?
1153
+ command.query['count'] = count unless count.nil?
1154
+ command.query['expand'] = expand unless expand.nil?
1155
+ command.query['orderBy'] = order_by unless order_by.nil?
1156
+ command.query['startKey'] = start_key unless start_key.nil?
1157
+ command.query['state'] = state unless state.nil?
1158
+ command.query['fields'] = fields unless fields.nil?
1159
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1160
+ execute_or_queue_command(command, &block)
1161
+ end
1162
+
1163
+ # Updates an existing rate plan.
1164
+ # @param [String] name
1165
+ # Required. Name of the rate plan. Use the following structure in your request: `
1166
+ # organizations/`org`/apiproducts/`apiproduct`/rateplans/`rateplan``
1167
+ # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan] google_cloud_apigee_v1_rate_plan_object
1168
+ # @param [String] fields
1169
+ # Selector specifying which fields to include in a partial response.
1170
+ # @param [String] quota_user
1171
+ # Available to use for quota purposes for server-side applications. Can be any
1172
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1173
+ # @param [Google::Apis::RequestOptions] options
1174
+ # Request-specific options
1175
+ #
1176
+ # @yield [result, err] Result & error if block supplied
1177
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan] parsed result object
1178
+ # @yieldparam err [StandardError] error object if request failed
1179
+ #
1180
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan]
1181
+ #
1182
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1183
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1184
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1185
+ def update_organization_apiproduct_rateplan(name, google_cloud_apigee_v1_rate_plan_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1186
+ command = make_simple_command(:put, 'v1/{+name}', options)
1187
+ command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan::Representation
1188
+ command.request_object = google_cloud_apigee_v1_rate_plan_object
1189
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan::Representation
1190
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan
1191
+ command.params['name'] = name unless name.nil?
1192
+ command.query['fields'] = fields unless fields.nil?
1193
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1194
+ execute_or_queue_command(command, &block)
1195
+ end
1196
+
1001
1197
  # Creates an API proxy. The API proxy created will not be accessible at runtime
1002
1198
  # until it is deployed to an environment. Create a new API proxy by setting the `
1003
1199
  # name` query parameter to the name of the API proxy. Import an API proxy
@@ -2445,12 +2641,12 @@ module Google
2445
2641
 
2446
2642
  # Creates a custom consumer key and secret for a developer app. This is
2447
2643
  # particularly useful if you want to migrate existing consumer keys and secrets
2448
- # to Apigee hybrid from another system. Consumer keys and secrets can contain
2449
- # letters, numbers, underscores, and hyphens. No other special characters are
2450
- # allowed. To avoid service disruptions, a consumer key and secret should not
2451
- # exceed 2 KBs each. **Note**: When creating the consumer key and secret, an
2452
- # association to API products will not be made. Therefore, you should not
2453
- # specify the associated API products in your request. Instead, use the
2644
+ # to Apigee from another system. Consumer keys and secrets can contain letters,
2645
+ # numbers, underscores, and hyphens. No other special characters are allowed. To
2646
+ # avoid service disruptions, a consumer key and secret should not exceed 2 KBs
2647
+ # each. **Note**: When creating the consumer key and secret, an association to
2648
+ # API products will not be made. Therefore, you should not specify the
2649
+ # associated API products in your request. Instead, use the
2454
2650
  # UpdateDeveloperAppKey API to make the association after the consumer key and
2455
2651
  # secret are created. If a consumer key and secret already exist, you can keep
2456
2652
  # them or delete them using the DeleteDeveloperAppKey API.
@@ -2524,7 +2720,7 @@ module Google
2524
2720
  execute_or_queue_command(command, &block)
2525
2721
  end
2526
2722
 
2527
- # Returns details for a consumer key for a developer app, including the key and
2723
+ # Gets details for a consumer key for a developer app, including the key and
2528
2724
  # secret value, associated API products, and other information.
2529
2725
  # @param [String] name
2530
2726
  # Name of the developer app key. Use the following structure in your request: `
@@ -2672,11 +2868,11 @@ module Google
2672
2868
  execute_or_queue_command(command, &block)
2673
2869
  end
2674
2870
 
2675
- # Approve or revoke an app's consumer key. After a consumer key is approved, the
2676
- # app can use it to access APIs. A consumer key that is revoked or pending
2677
- # cannot be used to access an API. Any access tokens associated with a revoked
2678
- # consumer key will remain active. However, Apigee hybrid checks the status of
2679
- # the consumer key and if set to `revoked` will not allow access to the API.
2871
+ # Approves or revokes the consumer key for an API product. After a consumer key
2872
+ # is approved, the app can use it to access APIs. A consumer key that is revoked
2873
+ # or pending cannot be used to access an API. Any access tokens associated with
2874
+ # a revoked consumer key will remain active. However, Apigee checks the status
2875
+ # of the consumer key and if set to `revoked` will not allow access to the API.
2680
2876
  # @param [String] name
2681
2877
  # Name of the API product in the developer app key in the following format: `
2682
2878
  # organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key`/
@@ -2714,12 +2910,12 @@ module Google
2714
2910
 
2715
2911
  # Creates a custom consumer key and secret for a developer app. This is
2716
2912
  # particularly useful if you want to migrate existing consumer keys and secrets
2717
- # to Apigee hybrid from another system. Consumer keys and secrets can contain
2718
- # letters, numbers, underscores, and hyphens. No other special characters are
2719
- # allowed. To avoid service disruptions, a consumer key and secret should not
2720
- # exceed 2 KBs each. **Note**: When creating the consumer key and secret, an
2721
- # association to API products will not be made. Therefore, you should not
2722
- # specify the associated API products in your request. Instead, use the
2913
+ # to Apigee from another system. Consumer keys and secrets can contain letters,
2914
+ # numbers, underscores, and hyphens. No other special characters are allowed. To
2915
+ # avoid service disruptions, a consumer key and secret should not exceed 2 KBs
2916
+ # each. **Note**: When creating the consumer key and secret, an association to
2917
+ # API products will not be made. Therefore, you should not specify the
2918
+ # associated API products in your request. Instead, use the
2723
2919
  # UpdateDeveloperAppKey API to make the association after the consumer key and
2724
2920
  # secret are created. If a consumer key and secret already exist, you can keep
2725
2921
  # them or delete them using the DeleteDeveloperAppKey API.
@@ -2891,6 +3087,150 @@ module Google
2891
3087
  execute_or_queue_command(command, &block)
2892
3088
  end
2893
3089
 
3090
+ # Creates a subscription to an API product.
3091
+ # @param [String] parent
3092
+ # Required. Email address of the developer that is purchasing a subscription to
3093
+ # the API product. Use the following structure in your request: `organizations/`
3094
+ # org`/developers/`developer_email``
3095
+ # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperSubscription] google_cloud_apigee_v1_developer_subscription_object
3096
+ # @param [String] fields
3097
+ # Selector specifying which fields to include in a partial response.
3098
+ # @param [String] quota_user
3099
+ # Available to use for quota purposes for server-side applications. Can be any
3100
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3101
+ # @param [Google::Apis::RequestOptions] options
3102
+ # Request-specific options
3103
+ #
3104
+ # @yield [result, err] Result & error if block supplied
3105
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperSubscription] parsed result object
3106
+ # @yieldparam err [StandardError] error object if request failed
3107
+ #
3108
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperSubscription]
3109
+ #
3110
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3111
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3112
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3113
+ def create_organization_developer_subscription(parent, google_cloud_apigee_v1_developer_subscription_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3114
+ command = make_simple_command(:post, 'v1/{+parent}/subscriptions', options)
3115
+ command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperSubscription::Representation
3116
+ command.request_object = google_cloud_apigee_v1_developer_subscription_object
3117
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperSubscription::Representation
3118
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperSubscription
3119
+ command.params['parent'] = parent unless parent.nil?
3120
+ command.query['fields'] = fields unless fields.nil?
3121
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3122
+ execute_or_queue_command(command, &block)
3123
+ end
3124
+
3125
+ # Expires an API product subscription immediately.
3126
+ # @param [String] name
3127
+ # Required. Name of the API product subscription. Use the following structure in
3128
+ # your request: `organizations/`org`/developers/`developer_email`/subscriptions/`
3129
+ # subscription``
3130
+ # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest] google_cloud_apigee_v1_expire_developer_subscription_request_object
3131
+ # @param [String] fields
3132
+ # Selector specifying which fields to include in a partial response.
3133
+ # @param [String] quota_user
3134
+ # Available to use for quota purposes for server-side applications. Can be any
3135
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3136
+ # @param [Google::Apis::RequestOptions] options
3137
+ # Request-specific options
3138
+ #
3139
+ # @yield [result, err] Result & error if block supplied
3140
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperSubscription] parsed result object
3141
+ # @yieldparam err [StandardError] error object if request failed
3142
+ #
3143
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperSubscription]
3144
+ #
3145
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3146
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3147
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3148
+ def expire_organization_developer_subscription(name, google_cloud_apigee_v1_expire_developer_subscription_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3149
+ command = make_simple_command(:post, 'v1/{+name}:expire', options)
3150
+ command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest::Representation
3151
+ command.request_object = google_cloud_apigee_v1_expire_developer_subscription_request_object
3152
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperSubscription::Representation
3153
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperSubscription
3154
+ command.params['name'] = name unless name.nil?
3155
+ command.query['fields'] = fields unless fields.nil?
3156
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3157
+ execute_or_queue_command(command, &block)
3158
+ end
3159
+
3160
+ # Gets details for an API product subscription.
3161
+ # @param [String] name
3162
+ # Required. Name of the API product subscription. Use the following structure in
3163
+ # your request: `organizations/`org`/developers/`developer_email`/subscriptions/`
3164
+ # subscription``
3165
+ # @param [String] fields
3166
+ # Selector specifying which fields to include in a partial response.
3167
+ # @param [String] quota_user
3168
+ # Available to use for quota purposes for server-side applications. Can be any
3169
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3170
+ # @param [Google::Apis::RequestOptions] options
3171
+ # Request-specific options
3172
+ #
3173
+ # @yield [result, err] Result & error if block supplied
3174
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperSubscription] parsed result object
3175
+ # @yieldparam err [StandardError] error object if request failed
3176
+ #
3177
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperSubscription]
3178
+ #
3179
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3180
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3181
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3182
+ def get_organization_developer_subscription(name, fields: nil, quota_user: nil, options: nil, &block)
3183
+ command = make_simple_command(:get, 'v1/{+name}', options)
3184
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperSubscription::Representation
3185
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperSubscription
3186
+ command.params['name'] = name unless name.nil?
3187
+ command.query['fields'] = fields unless fields.nil?
3188
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3189
+ execute_or_queue_command(command, &block)
3190
+ end
3191
+
3192
+ # Lists all API product subscriptions for a developer.
3193
+ # @param [String] parent
3194
+ # Required. Email address of the developer. Use the following structure in your
3195
+ # request: `organizations/`org`/developers/`developer_email``
3196
+ # @param [Fixnum] count
3197
+ # Number of API product subscriptions to return in the API call. Use with `
3198
+ # startKey` to provide more targeted filtering. Defaults to 100. The maximum
3199
+ # limit is 1000.
3200
+ # @param [String] start_key
3201
+ # Name of the API product subscription from which to start displaying the list
3202
+ # of subscriptions. If omitted, the list starts from the first item. For example,
3203
+ # to view the API product subscriptions from 51-150, set the value of `startKey`
3204
+ # to the name of the 51st subscription and set the value of `count` to 100.
3205
+ # @param [String] fields
3206
+ # Selector specifying which fields to include in a partial response.
3207
+ # @param [String] quota_user
3208
+ # Available to use for quota purposes for server-side applications. Can be any
3209
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3210
+ # @param [Google::Apis::RequestOptions] options
3211
+ # Request-specific options
3212
+ #
3213
+ # @yield [result, err] Result & error if block supplied
3214
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse] parsed result object
3215
+ # @yieldparam err [StandardError] error object if request failed
3216
+ #
3217
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse]
3218
+ #
3219
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3220
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3221
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3222
+ def list_organization_developer_subscriptions(parent, count: nil, start_key: nil, fields: nil, quota_user: nil, options: nil, &block)
3223
+ command = make_simple_command(:get, 'v1/{+parent}/subscriptions', options)
3224
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse::Representation
3225
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse
3226
+ command.params['parent'] = parent unless parent.nil?
3227
+ command.query['count'] = count unless count.nil?
3228
+ command.query['startKey'] = start_key unless start_key.nil?
3229
+ command.query['fields'] = fields unless fields.nil?
3230
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3231
+ execute_or_queue_command(command, &block)
3232
+ end
3233
+
2894
3234
  # Creates a new environment group.
2895
3235
  # @param [String] parent
2896
3236
  # Required. Name of the organization in which to create the environment group in