Class: Stripe::FileLink

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List
Includes:
APIOperations::Save
Defined in:
lib/stripe/resources/file_link.rb

Overview

To share the contents of a ‘File` object with non-Stripe users, you can create a `FileLink`. `FileLink`s contain a URL that you can use to retrieve the contents of the file without authentication.

Constant Summary collapse

OBJECT_NAME = 
"file_link"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods included from APIOperations::Save

included, #save

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Class Method Details

.create(params = {}, opts = {}) ⇒ Object

Creates a new file link object.



19
20
21
 
# File 'lib/stripe/resources/file_link.rb', line 19

def self.create(params = {}, opts = {})
  request_stripe_object(method: :post, path: "/v1/file_links", params: params, opts: opts)
end

.list(filters = {}, opts = {}) ⇒ Object

Returns a list of file links.



24
25
26
 
# File 'lib/stripe/resources/file_link.rb', line 24

def self.list(filters = {}, opts = {})
  request_stripe_object(method: :get, path: "/v1/file_links", params: filters, opts: opts)
end

.object_name ⇒ Object 



14
15
16
 
# File 'lib/stripe/resources/file_link.rb', line 14

def self.object_name
  "file_link"
end

.update(id, params = {}, opts = {}) ⇒ Object

Updates an existing file link object. Expired links can no longer be updated.



29
30
31
32
33
34
35
36
 
# File 'lib/stripe/resources/file_link.rb', line 29

def self.update(id, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/file_links/%<id>s", { id: CGI.escape(id) }),
    params: params,
    opts: opts
  )
end