Class: Fastly::BillingInvoicesApi
- Inherits:
-
Object
- Object
- Fastly::BillingInvoicesApi
- Defined in:
- lib/fastly/api/billing_invoices_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#get_invoice_by_invoice_id(opts = {}) ⇒ InvoiceResponse
Get invoice by ID.
-
#get_invoice_by_invoice_id_with_http_info(opts = {}) ⇒ Array<(InvoiceResponse, Integer, Hash)>
Get invoice by ID.
-
#initialize(api_client = ApiClient.default) ⇒ BillingInvoicesApi
constructor
A new instance of BillingInvoicesApi.
-
#list_invoices(opts = {}) ⇒ ListInvoicesResponse
List of invoices.
-
#list_invoices_with_http_info(opts = {}) ⇒ Array<(ListInvoicesResponse, Integer, Hash)>
List of invoices.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ BillingInvoicesApi
Returns a new instance of BillingInvoicesApi.
17 18 19 |
# File 'lib/fastly/api/billing_invoices_api.rb', line 17 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
15 16 17 |
# File 'lib/fastly/api/billing_invoices_api.rb', line 15 def api_client @api_client end |
Instance Method Details
#get_invoice_by_invoice_id(opts = {}) ⇒ InvoiceResponse
Get invoice by ID. Returns invoice associated with the invoice id.
24 25 26 27 |
# File 'lib/fastly/api/billing_invoices_api.rb', line 24 def get_invoice_by_invoice_id(opts = {}) data, _status_code, _headers = get_invoice_by_invoice_id_with_http_info(opts) data end |
#get_invoice_by_invoice_id_with_http_info(opts = {}) ⇒ Array<(InvoiceResponse, Integer, Hash)>
Get invoice by ID. Returns invoice associated with the invoice id.
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/fastly/api/billing_invoices_api.rb', line 33 def get_invoice_by_invoice_id_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BillingInvoicesApi.get_invoice_by_invoice_id ...' end # unbox the parameters from the hash invoice_id = opts[:'invoice_id'] # verify the required parameter 'invoice_id' is set if @api_client.config.client_side_validation && invoice_id.nil? fail ArgumentError, "Missing the required parameter 'invoice_id' when calling BillingInvoicesApi.get_invoice_by_invoice_id" end # resource path local_var_path = '/billing/v3/invoices/{invoice_id}'.sub('{' + 'invoice_id' + '}', CGI.escape(invoice_id.to_s)) # query parameters query_params = opts[:query_params] || {} # 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[:debug_body] # return_type return_type = opts[:debug_return_type] || 'InvoiceResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] = opts.merge( :operation => :"BillingInvoicesApi.get_invoice_by_invoice_id", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: BillingInvoicesApi#get_invoice_by_invoice_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_invoices(opts = {}) ⇒ ListInvoicesResponse
List of invoices. Returns the list of invoices, sorted by billing start date (newest to oldest).
90 91 92 93 |
# File 'lib/fastly/api/billing_invoices_api.rb', line 90 def list_invoices(opts = {}) data, _status_code, _headers = list_invoices_with_http_info(opts) data end |
#list_invoices_with_http_info(opts = {}) ⇒ Array<(ListInvoicesResponse, Integer, Hash)>
List of invoices. Returns the list of invoices, sorted by billing start date (newest to oldest).
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 |
# File 'lib/fastly/api/billing_invoices_api.rb', line 102 def list_invoices_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BillingInvoicesApi.list_invoices ...' end # unbox the parameters from the hash # resource path local_var_path = '/billing/v3/invoices' # query parameters query_params = opts[:query_params] || {} query_params[:'billing_start_date'] = opts[:'billing_start_date'] if !opts[:'billing_start_date'].nil? query_params[:'billing_end_date'] = opts[:'billing_end_date'] if !opts[:'billing_end_date'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].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[:debug_body] # return_type return_type = opts[:debug_return_type] || 'ListInvoicesResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] = opts.merge( :operation => :"BillingInvoicesApi.list_invoices", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: BillingInvoicesApi#list_invoices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |