xero-ruby 3.9.0 → 7.0.0

data/lib/xero-ruby/api/app_store_api.rb

@@ -83,5 +83,249 @@ module XeroRuby
       end
       return data, status_code, headers
     end
+
+    # Gets all usage records related to the subscription
+    # @param subscription_id [String] Unique identifier for Subscription object
+    # @param [Hash] opts the optional parameters
+    # @return [UsageRecordsList]
+    def get_usage_records(subscription_id, opts = {})
+      data, _status_code, _headers = get_usage_records_with_http_info(subscription_id, opts)
+      data
+    end
+
+    # Gets all usage records related to the subscription
+    # @param subscription_id [String] Unique identifier for Subscription object
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UsageRecordsList, Integer, Hash)>] UsageRecordsList data, response status code and response headers
+    def get_usage_records_with_http_info(subscription_id, options = {})
+      opts = options.dup
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AppStoreApi.get_usage_records ...'
+      end
+      # verify the required parameter 'subscription_id' is set
+      if @api_client.config.client_side_validation && subscription_id.nil?
+        fail ArgumentError, "Missing the required parameter 'subscription_id' when calling AppStoreApi.get_usage_records"
+      end
+      # resource path
+      local_var_path = '/subscriptions/{subscriptionId}/usage-records'.sub('{' + 'subscriptionId' + '}', subscription_id.to_s)
+
+      # camelize keys of incoming `where` opts
+      opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      
+      # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
+      query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
+      query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'UsageRecordsList' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, "AppStoreApi", new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AppStoreApi#get_usage_records\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Send metered usage belonging to this subscription and subscription item
+    # @param subscription_id [String] Unique identifier for Subscription object
+    # @param subscription_item_id [String] The unique identifier of the subscriptionItem
+    # @param create_usage_record [CreateUsageRecord] Contains the quantity for the usage record to create
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
+    # @return [UsageRecord]
+    def post_usage_records(subscription_id, subscription_item_id, create_usage_record, opts = {})
+      data, _status_code, _headers = post_usage_records_with_http_info(subscription_id, subscription_item_id, create_usage_record, opts)
+      data
+    end
+
+    # Send metered usage belonging to this subscription and subscription item
+    # @param subscription_id [String] Unique identifier for Subscription object
+    # @param subscription_item_id [String] The unique identifier of the subscriptionItem
+    # @param create_usage_record [CreateUsageRecord] Contains the quantity for the usage record to create
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
+    # @return [Array<(UsageRecord, Integer, Hash)>] UsageRecord data, response status code and response headers
+    def post_usage_records_with_http_info(subscription_id, subscription_item_id, create_usage_record, options = {})
+      opts = options.dup
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AppStoreApi.post_usage_records ...'
+      end
+      # verify the required parameter 'subscription_id' is set
+      if @api_client.config.client_side_validation && subscription_id.nil?
+        fail ArgumentError, "Missing the required parameter 'subscription_id' when calling AppStoreApi.post_usage_records"
+      end
+      # verify the required parameter 'subscription_item_id' is set
+      if @api_client.config.client_side_validation && subscription_item_id.nil?
+        fail ArgumentError, "Missing the required parameter 'subscription_item_id' when calling AppStoreApi.post_usage_records"
+      end
+      # verify the required parameter 'create_usage_record' is set
+      if @api_client.config.client_side_validation && create_usage_record.nil?
+        fail ArgumentError, "Missing the required parameter 'create_usage_record' when calling AppStoreApi.post_usage_records"
+      end
+      # resource path
+      local_var_path = '/subscriptions/{subscriptionId}/items/{subscriptionItemId}/usage-records'.sub('{' + 'subscriptionId' + '}', subscription_id.to_s).sub('{' + 'subscriptionItemId' + '}', subscription_item_id.to_s)
+
+      # camelize keys of incoming `where` opts
+      opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      
+      # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
+      query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
+      query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(create_usage_record) 
+
+      # return_type
+      return_type = opts[:return_type] || 'UsageRecord' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, "AppStoreApi", new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AppStoreApi#post_usage_records\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update and existing metered usage belonging to this subscription and subscription item
+    # @param subscription_id [String] Unique identifier for Subscription object
+    # @param subscription_item_id [String] The unique identifier of the subscriptionItem
+    # @param usage_record_id [String] The unique identifier of the usage record
+    # @param update_usage_record [UpdateUsageRecord] Contains the quantity for the usage record to update
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
+    # @return [UsageRecord]
+    def put_usage_records(subscription_id, subscription_item_id, usage_record_id, update_usage_record, opts = {})
+      data, _status_code, _headers = put_usage_records_with_http_info(subscription_id, subscription_item_id, usage_record_id, update_usage_record, opts)
+      data
+    end
+
+    # Update and existing metered usage belonging to this subscription and subscription item
+    # @param subscription_id [String] Unique identifier for Subscription object
+    # @param subscription_item_id [String] The unique identifier of the subscriptionItem
+    # @param usage_record_id [String] The unique identifier of the usage record
+    # @param update_usage_record [UpdateUsageRecord] Contains the quantity for the usage record to update
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
+    # @return [Array<(UsageRecord, Integer, Hash)>] UsageRecord data, response status code and response headers
+    def put_usage_records_with_http_info(subscription_id, subscription_item_id, usage_record_id, update_usage_record, options = {})
+      opts = options.dup
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AppStoreApi.put_usage_records ...'
+      end
+      # verify the required parameter 'subscription_id' is set
+      if @api_client.config.client_side_validation && subscription_id.nil?
+        fail ArgumentError, "Missing the required parameter 'subscription_id' when calling AppStoreApi.put_usage_records"
+      end
+      # verify the required parameter 'subscription_item_id' is set
+      if @api_client.config.client_side_validation && subscription_item_id.nil?
+        fail ArgumentError, "Missing the required parameter 'subscription_item_id' when calling AppStoreApi.put_usage_records"
+      end
+      # verify the required parameter 'usage_record_id' is set
+      if @api_client.config.client_side_validation && usage_record_id.nil?
+        fail ArgumentError, "Missing the required parameter 'usage_record_id' when calling AppStoreApi.put_usage_records"
+      end
+      # verify the required parameter 'update_usage_record' is set
+      if @api_client.config.client_side_validation && update_usage_record.nil?
+        fail ArgumentError, "Missing the required parameter 'update_usage_record' when calling AppStoreApi.put_usage_records"
+      end
+      # resource path
+      local_var_path = '/subscriptions/{subscriptionId}/items/{subscriptionItemId}/usage-records/{usageRecordId}'.sub('{' + 'subscriptionId' + '}', subscription_id.to_s).sub('{' + 'subscriptionItemId' + '}', subscription_item_id.to_s).sub('{' + 'usageRecordId' + '}', usage_record_id.to_s)
+
+      # camelize keys of incoming `where` opts
+      opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      
+      # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
+      query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
+      query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(update_usage_record) 
+
+      # return_type
+      return_type = opts[:return_type] || 'UsageRecord' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, "AppStoreApi", new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AppStoreApi#put_usage_records\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/xero-ruby/api/asset_api.rb

@@ -21,6 +21,7 @@ module XeroRuby
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param asset [Asset] Fixed asset you are creating
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
     # @return [Asset]
     def create_asset(xero_tenant_id, asset, opts = {})
       data, _status_code, _headers = create_asset_with_http_info(xero_tenant_id, asset, opts)
@@ -32,6 +33,7 @@ module XeroRuby
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param asset [Asset] Fixed asset you are creating
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
     # @return [Array<(Asset, Integer, Hash)>] Asset data, response status code and response headers
     def create_asset_with_http_info(xero_tenant_id, asset, options = {})
       opts = options.dup
@@ -66,6 +68,7 @@ module XeroRuby
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       header_params[:'xero-tenant-id'] = xero_tenant_id
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -98,21 +101,23 @@ module XeroRuby
     # adds a fixed asset type
     # Adds an fixed asset type to the system
     # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param asset_type [AssetType] Asset type to add
     # @param [Hash] opts the optional parameters
-    # @option opts [AssetType] :asset_type Asset type to add
+    # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
     # @return [AssetType]
-    def create_asset_type(xero_tenant_id, opts = {})
-      data, _status_code, _headers = create_asset_type_with_http_info(xero_tenant_id, opts)
+    def create_asset_type(xero_tenant_id, asset_type, opts = {})
+      data, _status_code, _headers = create_asset_type_with_http_info(xero_tenant_id, asset_type, opts)
       data
     end
 
     # adds a fixed asset type
     # Adds an fixed asset type to the system
     # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param asset_type [AssetType] Asset type to add
     # @param [Hash] opts the optional parameters
-    # @option opts [AssetType] :asset_type Asset type to add
+    # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
     # @return [Array<(AssetType, Integer, Hash)>] AssetType data, response status code and response headers
-    def create_asset_type_with_http_info(xero_tenant_id, options = {})
+    def create_asset_type_with_http_info(xero_tenant_id, asset_type, options = {})
       opts = options.dup
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AssetApi.create_asset_type ...'
@@ -121,6 +126,10 @@ module XeroRuby
       if @api_client.config.client_side_validation && xero_tenant_id.nil?
         fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AssetApi.create_asset_type"
       end
+      # verify the required parameter 'asset_type' is set
+      if @api_client.config.client_side_validation && asset_type.nil?
+        fail ArgumentError, "Missing the required parameter 'asset_type' when calling AssetApi.create_asset_type"
+      end
       # resource path
       local_var_path = '/AssetTypes'
 
@@ -141,12 +150,13 @@ module XeroRuby
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       header_params[:'xero-tenant-id'] = xero_tenant_id
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'asset_type']) 
+      post_body = opts[:body] || @api_client.object_to_http_body(asset_type) 
 
       # return_type
       return_type = opts[:return_type] || 'AssetType'